Package org.apache.lucene.codecs.idversion

Class IDVersionPostingsWriter

java.lang.Object

org.apache.lucene.codecs.PostingsWriterBase

org.apache.lucene.codecs.PushPostingsWriterBase

org.apache.lucene.codecs.idversion.IDVersionPostingsWriter

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

final class IDVersionPostingsWriter
extends PushPostingsWriterBase

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static IDVersionTermState	emptyState
(package private) int	lastDocID
private long	lastEncodedVersion
private int	lastPosition
(package private) IDVersionTermState	lastState
private long	lastVersion
private Bits	liveDocs
(package private) static java.lang.String	TERMS_CODEC
(package private) static int	VERSION_CURRENT
(package private) static int	VERSION_START

Fields inherited from class org.apache.lucene.codecs.PushPostingsWriterBase

fieldInfo, indexOptions, writeFreqs, writeOffsets, writePayloads, writePositions

Constructor Summary

Constructors

Constructor	Description
IDVersionPostingsWriter(Bits liveDocs)

Method Summary

Modifier and Type	Method	Description
void	addPosition(int position, BytesRef payload, int startOffset, int endOffset)	Add a new position and payload, and start/end offset.
void	close()
void	encodeTerm(DataOutput out, FieldInfo fieldInfo, BlockTermState _state, boolean absolute)	Encode metadata as long[] and byte[].
void	finishDoc()	Called when we are done adding positions and payloads for each doc.
void	finishTerm(BlockTermState _state)	Called when we are done adding docs to this term
void	init(IndexOutput termsOut, SegmentWriteState state)	Called once after startup, before any terms have been added.
BlockTermState	newTermState()	Return a newly created empty TermState
void	setField(FieldInfo fieldInfo)	Sets the current field for writing, and returns the fixed length of long[] metadata (which is fixed per field), called when the writing switches to another field.
void	startDoc(int docID, int termDocFreq)	Adds a new doc in this term.
void	startTerm(NumericDocValues norms)	Start a new term.

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

writeTerm

Methods inherited from class java.lang.Object

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

Field Detail

TERMS_CODEC

static final java.lang.String TERMS_CODEC

See Also:

Constant Field Values

VERSION_START

static final int VERSION_START

See Also:

Constant Field Values

VERSION_CURRENT

static final int VERSION_CURRENT

See Also:

Constant Field Values

emptyState

static final IDVersionTermState emptyState

lastState

IDVersionTermState lastState

lastDocID

int lastDocID

lastPosition

private int lastPosition

lastVersion

private long lastVersion

liveDocs

private final Bits liveDocs

lastEncodedVersion

private long lastEncodedVersion

Constructor Detail

IDVersionPostingsWriter

public IDVersionPostingsWriter(Bits liveDocs)

Method Detail

newTermState

public BlockTermState newTermState()

Description copied from class: PushPostingsWriterBase

Return a newly created empty TermState

Specified by:

newTermState in class PushPostingsWriterBase

init

public void init(IndexOutput termsOut,
                 SegmentWriteState state)
          throws java.io.IOException

Description copied from class: PostingsWriterBase

Called once after startup, before any terms have been added. Implementations typically write a header to the provided termsOut.

Specified by:

init in class PostingsWriterBase

Throws:

java.io.IOException

setField

public void setField(FieldInfo fieldInfo)

Description copied from class: PushPostingsWriterBase

Sets the current field for writing, and returns the fixed length of long[] metadata (which is fixed per field), called when the writing switches to another field.

Overrides:

setField in class PushPostingsWriterBase

startTerm

public void startTerm(NumericDocValues norms)

Description copied from class: PushPostingsWriterBase

Start a new term. Note that a matching call to PushPostingsWriterBase.finishTerm(BlockTermState) is done, only if the term has at least one document.

Specified by:

startTerm in class PushPostingsWriterBase

startDoc

public void startDoc(int docID,
                     int termDocFreq)
              throws java.io.IOException

Description copied from class: PushPostingsWriterBase

Adds a new doc in this term. freq will be -1 when term frequencies are omitted for the field.

Specified by:

startDoc in class PushPostingsWriterBase

Throws:

java.io.IOException

addPosition

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

Description copied from class: PushPostingsWriterBase

Add a new position and payload, and start/end offset. A null payload means no payload; a non-null payload with zero length also means no payload. Caller may reuse the BytesRef for the payload between calls (method must fully consume the payload). startOffset and endOffset will be -1 when offsets are not indexed.

Specified by:

addPosition in class PushPostingsWriterBase

Throws:

java.io.IOException

finishDoc

public void finishDoc()
               throws java.io.IOException

Description copied from class: PushPostingsWriterBase

Called when we are done adding positions and payloads for each doc.

Specified by:

finishDoc in class PushPostingsWriterBase

Throws:

java.io.IOException

finishTerm

public void finishTerm(BlockTermState _state)
                throws java.io.IOException

Called when we are done adding docs to this term

Specified by:

finishTerm in class PushPostingsWriterBase

Throws:

java.io.IOException

encodeTerm

public void encodeTerm(DataOutput out,
                       FieldInfo fieldInfo,
                       BlockTermState _state,
                       boolean absolute)
                throws java.io.IOException

Description copied from class: PostingsWriterBase

Encode metadata as long[] and byte[]. absolute controls whether current term is delta encoded according to latest term. Usually elements in longs are file pointers, so each one always increases when a new term is consumed. out is used to write generic bytes, which are not monotonic.

Specified by:

encodeTerm in class PostingsWriterBase

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

Specified by:

close in class PostingsWriterBase

Throws:

java.io.IOException