org.apache.lucene.codecs.pulsing

Class PulsingPostingsReader

java.lang.Object

org.apache.lucene.codecs.PostingsReaderBase

org.apache.lucene.codecs.pulsing.PulsingPostingsReader

All Implemented Interfaces:

Closeable

public class PulsingPostingsReader
extends PostingsReaderBase

Concrete class that reads the current doc/freq/skip postings format

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PulsingPostingsReader.PulsingEnumAttribute A per-docsenum attribute that stores additional reuse information so that pulsing enums can keep a reference to their wrapped enums, and vice versa.
static class	PulsingPostingsReader.PulsingEnumAttributeImpl Implementation of PulsingPostingsReader.PulsingEnumAttribute for reuse of wrapped postings readers underneath pulsing.

Constructor Summary

Constructors

Constructor and Description
PulsingPostingsReader(PostingsReaderBase wrappedPostingsReader)

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
DocsEnum	docs(FieldInfo field, BlockTermState _termState, Bits liveDocs, DocsEnum reuse, int flags) Must fully consume state, since after this call that TermState may be reused.
DocsAndPositionsEnum	docsAndPositions(FieldInfo field, 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)
BlockTermState	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

PulsingPostingsReader

public PulsingPostingsReader(PostingsReaderBase wrappedPostingsReader)

Method Detail

init

public void init(IndexInput termsIn)
          throws IOException

Specified by:

init 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

newTermState

public BlockTermState newTermState()
                            throws IOException

Description copied from class: PostingsReaderBase

Return a newly created empty TermState

Specified by:

newTermState 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 field,
            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 field,
                                    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

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in class PostingsReaderBase

Throws:

IOException