org.apache.lucene.codecs.lucene41
Class Lucene41PostingsReader

java.lang.Object
  org.apache.lucene.codecs.PostingsReaderBase
      org.apache.lucene.codecs.lucene41.Lucene41PostingsReader

All Implemented Interfaces:

Closeable

public final class Lucene41PostingsReader
extends PostingsReaderBase

Concrete class that reads docId(maybe frq,pos,offset,payloads) list with postings format.

See Also:

for details

WARNING: This API is experimental and might change in incompatible ways in the next release.

Constructor Summary

Lucene41PostingsReader(Directory dir, FieldInfos fieldInfos, SegmentInfo segmentInfo, IOContext ioContext, String segmentSuffix)
Sole constructor.

Method Summary

void	close()
DocsEnum	docs(FieldInfo fieldInfo, BlockTermState termState, Bits liveDocs, DocsEnum reuse, int flags) Must fully consume state, since after this call that TermState may be reused.
DocsAndPositionsEnum	docsAndPositions(FieldInfo fieldInfo, BlockTermState termState, Bits liveDocs, DocsAndPositionsEnum reuse, int flags) Must fully consume state, since after this call that TermState may be reused.
void	init(IndexInput termsIn) Performs any initialization, such as reading and verifying the header from the provided terms dictionary IndexInput.
org.apache.lucene.codecs.lucene41.Lucene41PostingsReader.IntBlockTermState	newTermState() Return a newly created empty TermState
void	nextTerm(FieldInfo fieldInfo, BlockTermState _termState) Actually decode metadata for next term
void	readTermsBlock(IndexInput termsIn, FieldInfo fieldInfo, BlockTermState _termState) Reads data for all terms in the next block; this method should merely load the byte[] blob but not decode, which is done in PostingsReaderBase.nextTerm(org.apache.lucene.index.FieldInfo, org.apache.lucene.codecs.BlockTermState).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Lucene41PostingsReader

public Lucene41PostingsReader(Directory dir,
                              FieldInfos fieldInfos,
                              SegmentInfo segmentInfo,
                              IOContext ioContext,
                              String segmentSuffix)
                       throws IOException

Sole constructor.

Throws:

IOException

Method Detail

init

public void init(IndexInput termsIn)
          throws IOException

Description copied from class: PostingsReaderBase

Performs any initialization, such as reading and verifying the header from the provided terms dictionary IndexInput.

Specified by:

init in class PostingsReaderBase

Throws:

IOException

newTermState

public org.apache.lucene.codecs.lucene41.Lucene41PostingsReader.IntBlockTermState newTermState()

Description copied from class: PostingsReaderBase

Return a newly created empty TermState

Specified by:

newTermState in class PostingsReaderBase

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in class PostingsReaderBase

Throws:

IOException

readTermsBlock

public void readTermsBlock(IndexInput termsIn,
                           FieldInfo fieldInfo,
                           BlockTermState _termState)
                    throws IOException

Description copied from class: PostingsReaderBase

Reads data for all terms in the next block; this method should merely load the byte[] blob but not decode, which is done in PostingsReaderBase.nextTerm(org.apache.lucene.index.FieldInfo, org.apache.lucene.codecs.BlockTermState).

Specified by:

readTermsBlock in class PostingsReaderBase

Throws:

IOException

nextTerm

public void nextTerm(FieldInfo fieldInfo,
                     BlockTermState _termState)
              throws IOException

Description copied from class: PostingsReaderBase

Actually decode metadata for next term

Specified by:

nextTerm in class PostingsReaderBase

Throws:

IOException

docs

public DocsEnum docs(FieldInfo fieldInfo,
                     BlockTermState termState,
                     Bits liveDocs,
                     DocsEnum reuse,
                     int flags)
              throws IOException

Description copied from class: PostingsReaderBase

Must fully consume state, since after this call that TermState may be reused.

Specified by:

docs in class PostingsReaderBase

Throws:

IOException

docsAndPositions

public DocsAndPositionsEnum docsAndPositions(FieldInfo fieldInfo,
                                             BlockTermState termState,
                                             Bits liveDocs,
                                             DocsAndPositionsEnum reuse,
                                             int flags)
                                      throws IOException

Description copied from class: PostingsReaderBase

Must fully consume state, since after this call that TermState may be reused.

Specified by:

docsAndPositions in class PostingsReaderBase

Throws:

IOException