{
    "mode": "perldoc",
    "parameter": "Plucene::Index::SegmentReader",
    "section": "",
    "url": "https://www.chedong.com/phpMan.php/perldoc/Plucene%3A%3AIndex%3A%3ASegmentReader/json",
    "generated": "2026-07-05T15:59:25Z",
    "synopsis": "my $segreader =\nPlucene::Index::SegmentReader->new( Plucene::Index::SegmentInfo $si);\nmy @files = $segreader->files;\nmy @terms = $segreader->terms;\nmy $doc = $segreader->document($id);\nmy $docfreq = $segreader->docfreq($term);\nmy $maxdoc = $segreader->maxdoc;\nmy $norms = $segreader->norms($field, $offset);\nmy Plucene::Index::SegmentTermDocs $docs\n= $segreader->termdocs($term);\nmy Plucene::Index::SegmentTermPositions $pos\n= $segreader->termpositions($term);\nmy Plucene::Store::InputStream $stream\n= $segreader->normstream($field);\nif ($segreader->isdeleted($id)) {  .. }\nif ($segreader->hasdeletions(Plucene::Index::SegmentInfo $si))\n{  ... }",
    "sections": {
        "NAME": {
            "content": "Plucene::Index::SegmentReader - the Segment reader\n",
            "subsections": []
        },
        "SYNOPSIS": {
            "content": "my $segreader =\nPlucene::Index::SegmentReader->new( Plucene::Index::SegmentInfo $si);\n\nmy @files = $segreader->files;\nmy @terms = $segreader->terms;\nmy $doc = $segreader->document($id);\nmy $docfreq = $segreader->docfreq($term);\nmy $maxdoc = $segreader->maxdoc;\nmy $norms = $segreader->norms($field, $offset);\n\nmy Plucene::Index::SegmentTermDocs $docs\n= $segreader->termdocs($term);\n\nmy Plucene::Index::SegmentTermPositions $pos\n= $segreader->termpositions($term);\n\nmy Plucene::Store::InputStream $stream\n= $segreader->normstream($field);\n\nif ($segreader->isdeleted($id)) {  .. }\nif ($segreader->hasdeletions(Plucene::Index::SegmentInfo $si))\n{  ... }\n",
            "subsections": []
        },
        "DESCRIPTION": {
            "content": "The segment reader class.\n",
            "subsections": []
        },
        "METHODS": {
            "content": "new\nmy $segreader =\nPlucene::Index::SegmentReader->new( Plucene::Index::SegmentInfo $si);\n\nThis will create a new Plucene::Index::SegmentReader object.\n\nhasdeletions\nif ($segreader->hasdeletions(Plucene::Index::SegmentInfo $si))\n{  ... }\n\nfiles\nmy @files = $segreader->files;\n\nterms\nmy @terms = $segreader->terms;\n\ndocument\nmy $doc = $segreader->document($id);\n\nisdeleted\nif ($segreader->isdeleted($id)) {  .. }\n\ntermdocs\nmy Plucene::Index::SegmentTermDocs $docs\n= $segreader->termdocs($term);\n\nThis will return the Plucene::Index::SegmentTermDocs object for the given term.\n\ntermpositions\nmy Plucene::Index::SegmentTermPositions $pos\n= $segreader->termpositions($term);\n\nThis will return the Plucene::Index::SegmentTermPositions object for the given term.\n\ndocfreq\nmy $docfreq = $segreader->docfreq($term);\n\nThis returns the number of documents containing the passed term.\n\nnumdocs\nmy $numdocs = $segreader->numdocs;\n\nThis is the number of documents, excluding deleted ones.\n\nmaxdoc\nmy $maxdoc = $segreader->maxdoc;\n\nnorms\nmy $norms = $segreader->norms($field, $offset);\n\nThis returns the byte-encoded normalisation factor for the passed field. This is used by the\nsearch code to score documents.\n\nNote we are not using the 'offset' and 'bytes' arguments per the Java. Instead, callers should\nuse substr to put the result of \"norms\" into the appropriate place in a string.\n\nnormstream\nmy Plucene::Store::InputStream $stream\n= $segreader->normstream($field);\n\nThis will return the Plucene::Store::InputStream for the passed field.\n",
            "subsections": []
        }
    },
    "summary": "Plucene::Index::SegmentReader - the Segment reader",
    "flags": [],
    "examples": [],
    "see_also": []
}