java.lang.Object
- org.apache.lucene.codecs.PostingsWriterBase
- - org.apache.lucene.codecs.PushPostingsWriterBase
  - - org.apache.lucene.codecs.lucene84.Lucene84PostingsWriter

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable
```
public final class Lucene84PostingsWriter
extends PushPostingsWriterBase
```
Concrete class that writes docId(maybe frq,pos,offset,payloads) list with postings format. Postings list for each term will be stored separately.

See Also:

for details about skipping setting and postings layout.

Field Summary

Fields
Modifier and Type	Field	Description
`private CompetitiveImpactAccumulator`	`competitiveFreqNormAccumulator`
`private int`	`docBufferUpto`
`private int`	`docCount`
`(package private) long[]`	`docDeltaBuffer`
`(package private) IndexOutput`	`docOut`
`private long`	`docStartFP`
`(package private) static Lucene84PostingsFormat.IntBlockTermState`	`emptyState`
`private boolean`	`fieldHasNorms`
`private ForDeltaUtil`	`forDeltaUtil`
`(package private) long[]`	`freqBuffer`
`private int`	`lastBlockDocID`
`private long`	`lastBlockPayFP`
`private int`	`lastBlockPayloadByteUpto`
`private int`	`lastBlockPosBufferUpto`
`private long`	`lastBlockPosFP`
`private int`	`lastDocID`
`private int`	`lastPosition`
`private int`	`lastStartOffset`
`(package private) Lucene84PostingsFormat.IntBlockTermState`	`lastState`
`private NumericDocValues`	`norms`
`(package private) long[]`	`offsetLengthBuffer`
`(package private) long[]`	`offsetStartDeltaBuffer`
`private byte[]`	`payloadBytes`
`private int`	`payloadByteUpto`
`(package private) long[]`	`payloadLengthBuffer`
`(package private) IndexOutput`	`payOut`
`private long`	`payStartFP`
`private PForUtil`	`pforUtil`
`private int`	`posBufferUpto`
`(package private) long[]`	`posDeltaBuffer`
`(package private) IndexOutput`	`posOut`
`private long`	`posStartFP`
`private Lucene84SkipWriter`	`skipWriter`

Fields inherited from class org.apache.lucene.codecs.PushPostingsWriterBase
fieldInfo, indexOptions, writeFreqs, writeOffsets, writePayloads, writePositions

Constructor Summary

Constructors
Constructor Description

Lucene84PostingsWriter(SegmentWriteState state)
Creates a postings writer

Method Summary

All Methods Instance Methods Concrete Methods
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.
`Lucene84PostingsFormat.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.

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
  - docOut
```
IndexOutput docOut
```
  - posOut
```
IndexOutput posOut
```
  - payOut
```
IndexOutput payOut
```
  - emptyState
```
static final Lucene84PostingsFormat.IntBlockTermState emptyState
```
  - lastState
```
Lucene84PostingsFormat.IntBlockTermState lastState
```
  - docStartFP
```
private long docStartFP
```
  - posStartFP
```
private long posStartFP
```
  - payStartFP
```
private long payStartFP
```
  - docDeltaBuffer
```
final long[] docDeltaBuffer
```
  - freqBuffer
```
final long[] freqBuffer
```
  - docBufferUpto
```
private int docBufferUpto
```
  - posDeltaBuffer
```
final long[] posDeltaBuffer
```
  - payloadLengthBuffer
```
final long[] payloadLengthBuffer
```
  - offsetStartDeltaBuffer
```
final long[] offsetStartDeltaBuffer
```
  - offsetLengthBuffer
```
final long[] offsetLengthBuffer
```
  - posBufferUpto
```
private int posBufferUpto
```
  - payloadBytes
```
private byte[] payloadBytes
```
  - payloadByteUpto
```
private int payloadByteUpto
```
  - lastBlockDocID
```
private int lastBlockDocID
```
  - lastBlockPosFP
```
private long lastBlockPosFP
```
  - lastBlockPayFP
```
private long lastBlockPayFP
```
  - lastBlockPosBufferUpto
```
private int lastBlockPosBufferUpto
```
  - lastBlockPayloadByteUpto
```
private int lastBlockPayloadByteUpto
```
  - 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
```
  - skipWriter
```
private final Lucene84SkipWriter skipWriter
```
  - fieldHasNorms
```
private boolean fieldHasNorms
```
  - norms
```
private NumericDocValues norms
```
  - competitiveFreqNormAccumulator
```
private final CompetitiveImpactAccumulator competitiveFreqNormAccumulator
```
- Constructor Detail
  - Lucene84PostingsWriter
```
public Lucene84PostingsWriter(SegmentWriteState state)
                       throws java.io.IOException
```
    Creates a postings writer
    
    Throws:
    
    java.io.IOException
- Method Detail
  - newTermState
```
public Lucene84PostingsFormat.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 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

Class Lucene84PostingsWriter

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

docOut

posOut

payOut

emptyState

lastState

docStartFP

posStartFP

payStartFP

docDeltaBuffer

freqBuffer

docBufferUpto

posDeltaBuffer

payloadLengthBuffer

offsetStartDeltaBuffer

offsetLengthBuffer

posBufferUpto

payloadBytes

payloadByteUpto

lastBlockDocID

lastBlockPosFP

lastBlockPayFP

lastBlockPosBufferUpto

lastBlockPayloadByteUpto

lastDocID

lastPosition

lastStartOffset

docCount

pforUtil

forDeltaUtil

skipWriter

fieldHasNorms

norms

competitiveFreqNormAccumulator

Constructor Detail

Lucene84PostingsWriter

Method Detail

newTermState

init

setField

startTerm

startDoc

addPosition

finishDoc

finishTerm

encodeTerm

close