Class DeltaBaseTermStateSerializer
java.lang.Object
org.apache.lucene.codecs.uniformsplit.DeltaBaseTermStateSerializer
- All Implemented Interfaces:
Accountable
TermState
serializer which encodes each file pointer as a delta relative to a base file
pointer. It differs from Lucene90PostingsWriter.encodeTerm(org.apache.lucene.store.DataOutput, org.apache.lucene.index.FieldInfo, org.apache.lucene.codecs.BlockTermState, boolean)
which encodes each file
pointer as a delta relative to the previous file pointer.
It automatically sets the base file pointer to the first valid file pointer for doc start FP,
pos start FP, pay start FP. These base file pointers have to be reset
by the caller before starting to write a new block.
- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
Field Summary
Modifier and TypeFieldDescriptionprotected long
protected long
protected long
Fields inherited from interface org.apache.lucene.util.Accountable
NULL_ACCOUNTABLE
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionlong
long
long
long
static long
ramBytesUsed
(TermState termState) readTermState
(long baseDocStartFP, long basePosStartFP, long basePayStartFP, DataInput termStatesInput, FieldInfo fieldInfo, BlockTermState reuse) Reads aBlockTermState
from the providedDataInput
.protected Lucene90PostingsFormat.IntBlockTermState
reset
(Lucene90PostingsFormat.IntBlockTermState termState) void
Resets the base file pointers to 0.void
writeTermState
(DataOutput termStatesOutput, FieldInfo fieldInfo, BlockTermState termState) Writes aBlockTermState
to the providedDataOutput
.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.apache.lucene.util.Accountable
getChildResources
-
Field Details
-
baseDocStartFP
protected long baseDocStartFP -
basePosStartFP
protected long basePosStartFP -
basePayStartFP
protected long basePayStartFP
-
-
Constructor Details
-
DeltaBaseTermStateSerializer
public DeltaBaseTermStateSerializer()
-
-
Method Details
-
resetBaseStartFP
public void resetBaseStartFP()Resets the base file pointers to 0. This method has to be called before starting to write a new block. -
getBaseDocStartFP
public long getBaseDocStartFP()- Returns:
- The base doc start file pointer. It is the file pointer of the first
TermState
written afterresetBaseStartFP()
is called.
-
getBasePosStartFP
public long getBasePosStartFP()- Returns:
- The base position start file pointer. It is the file pointer of the first
TermState
written afterresetBaseStartFP()
is called.
-
getBasePayStartFP
public long getBasePayStartFP()- Returns:
- The base payload start file pointer. It is the file pointer of the first
TermState
written afterresetBaseStartFP()
is called.
-
writeTermState
public void writeTermState(DataOutput termStatesOutput, FieldInfo fieldInfo, BlockTermState termState) throws IOException Writes aBlockTermState
to the providedDataOutput
.Simpler variant of
Lucene90PostingsWriter.encodeTerm(DataOutput, FieldInfo, BlockTermState, boolean)
.- Throws:
IOException
-
readTermState
public BlockTermState readTermState(long baseDocStartFP, long basePosStartFP, long basePayStartFP, DataInput termStatesInput, FieldInfo fieldInfo, BlockTermState reuse) throws IOException Reads aBlockTermState
from the providedDataInput
.Simpler variant of
Lucene90PostingsReader.decodeTerm(DataInput, FieldInfo, BlockTermState, boolean)
.- Parameters:
reuse
-BlockTermState
to reuse; or null to create a new one.- Throws:
IOException
-
reset
protected Lucene90PostingsFormat.IntBlockTermState reset(Lucene90PostingsFormat.IntBlockTermState termState) -
ramBytesUsed
public long ramBytesUsed()- Specified by:
ramBytesUsed
in interfaceAccountable
-
ramBytesUsed
- Returns:
- The estimated RAM usage of the given
TermState
.
-