Module org.apache.lucene.core

Package org.apache.lucene.codecs.lucene101

Class Lucene101PostingsWriter

java.lang.Object

org.apache.lucene.codecs.PostingsWriterBase

org.apache.lucene.codecs.PushPostingsWriterBase

org.apache.lucene.codecs.lucene101.Lucene101PostingsWriter

All Implemented Interfaces:

Closeable, AutoCloseable

public class Lucene101PostingsWriter
extends PushPostingsWriterBase

Writer for Lucene101PostingsFormat.

Field Summary

Fields

Modifier and Type	Field	Description
private int	docBufferUpto
private int	docCount
(package private) final int[]	docDeltaBuffer
private int	docID
(package private) IndexOutput	docOut
private long	docStartFP
(package private) static final Lucene101PostingsFormat.IntBlockTermState	EMPTY_STATE
private boolean	fieldHasNorms
private final ForDeltaUtil	forDeltaUtil
(package private) final int[]	freqBuffer
private int	lastDocID
private int	lastPosition
private int	lastStartOffset
(package private) Lucene101PostingsFormat.IntBlockTermState	lastState
private final CompetitiveImpactAccumulator	level0FreqNormAccumulator
private int	level0LastDocID
private long	level0LastPayFP
private long	level0LastPosFP
private final ByteBuffersDataOutput	level0Output	Output for a single block.
private final CompetitiveImpactAccumulator	level1CompetitiveFreqNormAccumulator
private int	level1LastDocID
private long	level1LastPayFP
private long	level1LastPosFP
private final ByteBuffersDataOutput	level1Output	Output for groups of 32 blocks.
private int	maxImpactNumBytesAtLevel0
private int	maxImpactNumBytesAtLevel1
private int	maxNumImpactsAtLevel0
private int	maxNumImpactsAtLevel1
(package private) IndexOutput	metaOut
private NumericDocValues	norms
(package private) final int[]	offsetLengthBuffer
(package private) final int[]	offsetStartDeltaBuffer
private byte[]	payloadBytes
private int	payloadByteUpto
(package private) final int[]	payloadLengthBuffer
(package private) IndexOutput	payOut
private long	payStartFP
private final PForUtil	pforUtil
private int	posBufferUpto
(package private) final int[]	posDeltaBuffer
(package private) IndexOutput	posOut
private long	posStartFP
private final ByteBuffersDataOutput	scratchOutput	Scratch output that we use to be able to prepend the encoded length, e.g.

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

fieldInfo, indexOptions, writeFreqs, writeOffsets, writePayloads, writePositions

Constructor Summary

Constructors

Constructor	Description
Lucene101PostingsWriter(SegmentWriteState state)	Sole constructor.

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
private void	flushDocBlock(boolean finishTerm)
void	init(IndexOutput termsOut, SegmentWriteState state)	Called once after startup, before any terms have been added.
Lucene101PostingsFormat.IntBlockTermState	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.
(package private) static void	writeImpacts(Collection<Impact> impacts, DataOutput out)
private void	writeLevel1SkipData()
(package private) static void	writeVInt15(DataOutput out, int v)	Special vints that are encoded on 2 bytes if they require 15 bits or less.
(package private) static void	writeVLong15(DataOutput out, long v)

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 Details

EMPTY_STATE

static final Lucene101PostingsFormat.IntBlockTermState EMPTY_STATE

metaOut

IndexOutput metaOut

docOut

IndexOutput docOut

posOut

IndexOutput posOut

payOut

IndexOutput payOut

lastState

Lucene101PostingsFormat.IntBlockTermState lastState

docStartFP

private long docStartFP

posStartFP

private long posStartFP

payStartFP

private long payStartFP

docDeltaBuffer

final int[] docDeltaBuffer

freqBuffer

final int[] freqBuffer

docBufferUpto

private int docBufferUpto

posDeltaBuffer

final int[] posDeltaBuffer

payloadLengthBuffer

final int[] payloadLengthBuffer

offsetStartDeltaBuffer

final int[] offsetStartDeltaBuffer

offsetLengthBuffer

final int[] offsetLengthBuffer

posBufferUpto

private int posBufferUpto

payloadBytes

private byte[] payloadBytes

payloadByteUpto

private int payloadByteUpto

level0LastDocID

private int level0LastDocID

level0LastPosFP

private long level0LastPosFP

level0LastPayFP

private long level0LastPayFP

level1LastDocID

private int level1LastDocID

level1LastPosFP

private long level1LastPosFP

level1LastPayFP

private long level1LastPayFP

docID

private int docID

lastDocID

private int lastDocID

lastPosition

private int lastPosition

lastStartOffset

private int lastStartOffset

docCount

private int docCount

pforUtil

private final PForUtil pforUtil

forDeltaUtil

private final ForDeltaUtil forDeltaUtil

fieldHasNorms

private boolean fieldHasNorms

norms

private NumericDocValues norms

level0FreqNormAccumulator

private final CompetitiveImpactAccumulator level0FreqNormAccumulator

level1CompetitiveFreqNormAccumulator

private final CompetitiveImpactAccumulator level1CompetitiveFreqNormAccumulator

maxNumImpactsAtLevel0

private int maxNumImpactsAtLevel0

maxImpactNumBytesAtLevel0

private int maxImpactNumBytesAtLevel0

maxNumImpactsAtLevel1

private int maxNumImpactsAtLevel1

maxImpactNumBytesAtLevel1

private int maxImpactNumBytesAtLevel1

scratchOutput

private final ByteBuffersDataOutput scratchOutput

Scratch output that we use to be able to prepend the encoded length, e.g. impacts.

level0Output

private final ByteBuffersDataOutput level0Output

Output for a single block. This is useful to be able to prepend skip data before each block, which can only be computed once the block is encoded. The content is then typically copied to level1Output.

level1Output

private final ByteBuffersDataOutput level1Output

Output for groups of 32 blocks. This is useful to prepend skip data for these 32 blocks, which can only be done once we have encoded these 32 blocks. The content is then typically copied to docCount.

Constructor Details

Lucene101PostingsWriter

public Lucene101PostingsWriter(SegmentWriteState state)
                        throws IOException

Sole constructor.

Throws:

IOException

Method Details

newTermState

public Lucene101PostingsFormat.IntBlockTermState 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 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:

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 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:

IOException

addPosition

public void addPosition(int position,
 BytesRef payload,
 int startOffset,
 int endOffset)
                 throws 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:

IOException

finishDoc

public void finishDoc()

Description copied from class: PushPostingsWriterBase

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

Specified by:

finishDoc in class PushPostingsWriterBase

writeVInt15

static void writeVInt15(DataOutput out,
 int v)
                 throws IOException

Special vints that are encoded on 2 bytes if they require 15 bits or less. VInt becomes especially slow when the number of bytes is variable, so this special layout helps in the case when the number likely requires 15 bits or less

Throws:

IOException

writeVLong15

static void writeVLong15(DataOutput out,
 long v)
                  throws IOException

Throws:

IOException

See Also:

• writeVInt15(DataOutput, int)

flushDocBlock

private void flushDocBlock(boolean finishTerm)
                    throws IOException

Throws:

IOException

writeLevel1SkipData

private void writeLevel1SkipData()
                          throws IOException

Throws:

IOException

writeImpacts

static void writeImpacts(Collection<Impact> impacts,
 DataOutput out)
                  throws IOException

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 PushPostingsWriterBase

Throws:

IOException

encodeTerm

public void encodeTerm(DataOutput out,
 FieldInfo fieldInfo,
 BlockTermState _state,
 boolean absolute)
                throws 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:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in class PostingsWriterBase

Throws:

IOException