{
    "mode": "perldoc",
    "parameter": "Plucene::Index::Reader",
    "section": "",
    "url": "https://www.chedong.com/phpMan.php/perldoc/Plucene%3A%3AIndex%3A%3AReader/json",
    "generated": "2026-06-16T09:56:52Z",
    "sections": {
        "NAME": {
            "content": "Plucene::Index::Reader - Abstract class for accessing an index\n",
            "subsections": []
        },
        "DESCRIPTION": {
            "content": "IndexReader is an abstract class, providing an interface for accessing an index. Search of an\nindex is done entirely through this abstract interface, so that any subclass which implements it\nis searchable.\n\nConcrete subclasses of IndexReader are usually constructed with a call to the static method\n\"open\".\n\nFor efficiency, in this API documents are often referred to via document numbers, non-negative\nintegers which each name a unique document in the index. These document numbers are\nephemeral--they may change as documents are added to and deleted from an index. Clients should\nthus not rely on a given document having the same number between sessions.\n",
            "subsections": []
        },
        "METHODS": {
            "content": "new\nmy $reader = Plucene::Index::Reader->new($dirname);\n\nThis will create a new Plucene::Index::Reader with the passed in directory.\n\nopen\n# If there is only one segment\nmy Plucene::Index::SegmentReader $segread = $reader->open;\n\n# If there are many segments\nmy Plucene::Index::SegmentsReader $segread = $reader->open;\n\nReturns an IndexReader reading the index in the given Directory.\n\nlastmodified\nmy $lastmodified = Plucene::Index::Reader->lastmodified($directory);\n\nindexexists\nif (Plucene::Index::Reader->indexexists($directory)){ ... }\n\nislocked\nif (Plucene::Index::Reader->islocked($directory)){ ... }\n\ndelete\n$reader->delete($doc);\n\ndeleteterm\n$reader->deleteterm($term);\n\nThis will delete all the documents which contain the passed term.\n\nclose\n$reader->close;\n\nunlock\n$reader->unlock($directory);\n\nnumdocs / maxdoc / document / isdeleted / norms / terms /\ndocfreq / termdocs / termpositions / dodelete / doclose\nThese must be defined in a subclass\n",
            "subsections": []
        }
    },
    "summary": "Plucene::Index::Reader - Abstract class for accessing an index",
    "flags": [],
    "examples": [],
    "see_also": []
}