{
    "content": [
        {
            "type": "text",
            "text": "# Plucene::Search::Filter (perldoc)\n\n## NAME\n\nPlucene::Search::Filter - A search filter base class\n\n## DESCRIPTION\n\nThis doesn't seem to be being used just yet. But here is some info on filters:\n\n## Sections\n\n- **NAME**\n- **DESCRIPTION**\n- **METHODS**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n"
        }
    ],
    "structuredContent": {
        "command": "Plucene::Search::Filter",
        "section": "",
        "mode": "perldoc",
        "summary": "Plucene::Search::Filter - A search filter base class",
        "synopsis": null,
        "tldr_summary": null,
        "tldr_examples": [],
        "tldr_source": null,
        "flags": [],
        "examples": [],
        "see_also": [],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "DESCRIPTION",
                "lines": 16,
                "subsections": []
            },
            {
                "name": "METHODS",
                "lines": 3,
                "subsections": []
            }
        ],
        "sections": {
            "NAME": {
                "content": "Plucene::Search::Filter - A search filter base class\n",
                "subsections": []
            },
            "DESCRIPTION": {
                "content": "This doesn't seem to be being used just yet. But here is some info on filters:\n\nFiltering means imposing additional restriction on the hit list to eliminate hits that otherwise\nwould be included in the search results.\n\nThere are two ways to filter hits:\n\n*   Search Query - in this approach, provide your custom filter object to the when you call the\nsearch() method. This filter will be called exactly once to evaluate every document that\nresulted in non zero score.\n\n*   Selective Collection - in this approach you perform the regular search and when you get back\nthe hit list, collect only those that matches your filtering criteria. In this approach,\nyour filter is called only for hits that returned by the search method which may be only a\nsubset of the non zero matches (useful when evaluating your search filter is expensive).\n",
                "subsections": []
            },
            "METHODS": {
                "content": "bits\nThis must be defined in a subclass\n",
                "subsections": []
            }
        }
    }
}