org.apache.lucene.codecs.pulsing

Class PulsingPostingsWriter

java.lang.Object

org.apache.lucene.codecs.PostingsConsumer

org.apache.lucene.codecs.PostingsWriterBase

org.apache.lucene.codecs.pulsing.PulsingPostingsWriter

All Implemented Interfaces:

Closeable, AutoCloseable

public final class PulsingPostingsWriter
extends PostingsWriterBase

Writer for the pulsing format.

Wraps another postings implementation and decides (based on total number of occurrences), whether a terms postings should be inlined into the term dictionary, or passed through to the wrapped writer.

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

Constructor Summary

Constructors

Constructor and Description
PulsingPostingsWriter(SegmentWriteState state, int maxPositions, PostingsWriterBase wrappedPostingsWriter) If the total number of positions (summed across all docs for this term) is <= maxPositions, then the postings are inlined into terms dict

Method Summary

Methods

Modifier and Type	Method and Description
void	addPosition(int position, BytesRef payload, int startOffset, int endOffset)
void	close()
void	encodeTerm(long[] empty, DataOutput out, FieldInfo fieldInfo, BlockTermState _state, boolean absolute)
void	finishDoc()
void	finishTerm(BlockTermState _state) Called when we are done adding docs to this term
void	init(IndexOutput termsOut)
BlockTermState	newTermState()
int	setField(FieldInfo fieldInfo)
void	startDoc(int docID, int termDocFreq)
void	startTerm()

Methods inherited from class org.apache.lucene.codecs.PostingsConsumer

merge

Methods inherited from class java.lang.Object

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

Constructor Detail

PulsingPostingsWriter

public PulsingPostingsWriter(SegmentWriteState state,
                     int maxPositions,
                     PostingsWriterBase wrappedPostingsWriter)

If the total number of positions (summed across all docs for this term) is <= maxPositions, then the postings are inlined into terms dict

Method Detail

init

public void init(IndexOutput termsOut)
          throws IOException

Specified by:

init in class PostingsWriterBase

Throws:

IOException

newTermState

public BlockTermState newTermState()
                            throws IOException

Specified by:

newTermState in class PostingsWriterBase

Throws:

IOException

startTerm

public void startTerm()

Specified by:

startTerm in class PostingsWriterBase

setField

public int setField(FieldInfo fieldInfo)

Specified by:

setField in class PostingsWriterBase

startDoc

public void startDoc(int docID,
            int termDocFreq)
              throws IOException

Specified by:

startDoc in class PostingsConsumer

Throws:

IOException

addPosition

public void addPosition(int position,
               BytesRef payload,
               int startOffset,
               int endOffset)
                 throws IOException

Specified by:

addPosition in class PostingsConsumer

Throws:

IOException

finishDoc

public void finishDoc()
               throws IOException

Specified by:

finishDoc in class PostingsConsumer

Throws:

IOException

finishTerm

public void finishTerm(BlockTermState _state)
                throws IOException

Called when we are done adding docs to this term

Specified by:

finishTerm in class PostingsWriterBase

Throws:

IOException

encodeTerm

public void encodeTerm(long[] empty,
              DataOutput out,
              FieldInfo fieldInfo,
              BlockTermState _state,
              boolean absolute)
                throws IOException

Specified by:

encodeTerm in class PostingsWriterBase

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 PostingsWriterBase

Throws:

IOException