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, AutoCloseable

public class PulsingPostingsReader
extends PostingsReaderBase

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

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(SegmentReadState state, PostingsReaderBase wrappedPostingsReader)

Method Summary

Methods

Modifier and Type	Method and Description
void	checkIntegrity() Checks consistency of this reader.
void	close()
void	decodeTerm(long[] empty, DataInput in, FieldInfo fieldInfo, BlockTermState _termState, boolean absolute) Actually decode metadata for next term
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) Performs any initialization, such as reading and verifying the header from the provided terms dictionary IndexInput.
BlockTermState	newTermState() Return a newly created empty TermState
long	ramBytesUsed() Returns approximate RAM bytes used

Methods inherited from class java.lang.Object

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

Constructor Detail

PulsingPostingsReader

public PulsingPostingsReader(SegmentReadState state,
                     PostingsReaderBase wrappedPostingsReader)

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 BlockTermState newTermState()
                            throws IOException

Description copied from class: PostingsReaderBase

Return a newly created empty TermState

Specified by:

newTermState in class PostingsReaderBase

Throws:

IOException

decodeTerm

public void decodeTerm(long[] empty,
              DataInput in,
              FieldInfo fieldInfo,
              BlockTermState _termState,
              boolean absolute)
                throws IOException

Description copied from class: PostingsReaderBase

Actually decode metadata for next term

Specified by:

decodeTerm in class PostingsReaderBase

Throws:

IOException

See Also:

PostingsWriterBase.encodeTerm(long[], org.apache.lucene.store.DataOutput, org.apache.lucene.index.FieldInfo, org.apache.lucene.codecs.BlockTermState, boolean)

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 interface AutoCloseable

Specified by:

close in class PostingsReaderBase

Throws:

IOException

ramBytesUsed

public long ramBytesUsed()

Description copied from class: PostingsReaderBase

Returns approximate RAM bytes used

Specified by:

ramBytesUsed in class PostingsReaderBase

checkIntegrity

public void checkIntegrity()
                    throws IOException

Description copied from class: PostingsReaderBase

Checks consistency of this reader.

Note that this may be costly in terms of I/O, e.g. may involve computing a checksum value against large data files.

Specified by:

checkIntegrity in class PostingsReaderBase

Throws:

IOException