Package | Description |
---|---|
org.apache.lucene.codecs |
Codecs API: API for customization of the encoding and structure of the index.
|
org.apache.lucene.codecs.blocktreeords |
Same postings format as Lucene50, except the terms dictionary also
supports ords, i.e.
|
org.apache.lucene.codecs.bloom |
Codec PostingsFormat for fast access to low-frequency terms
such as primary key fields.
|
org.apache.lucene.codecs.compressing |
StoredFieldsFormat that allows cross-document and cross-field compression of stored fields.
|
org.apache.lucene.codecs.idversion |
A primary-key postings format that associates a version (long) with each term and
can provide fail-fast lookups by ID and version.
|
org.apache.lucene.codecs.lucene50 |
Components from the Lucene 5.0 index format
See
org.apache.lucene.codecs.lucene80 for an overview
of the index format. |
org.apache.lucene.codecs.lucene84 |
Lucene 8.4 file format.
|
org.apache.lucene.codecs.memory |
Term dictionary, DocValues or Postings formats that are read
entirely into memory.
|
org.apache.lucene.codecs.simpletext |
Simpletext Codec: writes human readable postings.
|
org.apache.lucene.codecs.uniformsplit |
Pluggable term index / block terms dictionary implementations.
|
org.apache.lucene.codecs.uniformsplit.sharedterms |
Pluggable term index / block terms dictionary implementations.
|
org.apache.lucene.index |
Code to maintain and access indices.
|
org.apache.lucene.search.suggest |
Support for Autocomplete/Autosuggest
|
org.apache.lucene.search.suggest.analyzing |
Analyzer based autosuggest.
|
org.apache.lucene.search.suggest.document |
Support for document suggestion
|
org.apache.lucene.search.suggest.fst |
Finite-state based autosuggest.
|
org.apache.lucene.search.suggest.jaspell |
JaSpell-based autosuggest.
|
org.apache.lucene.search.suggest.tst |
Ternary Search Tree based autosuggest.
|
org.apache.lucene.store |
Binary i/o API, used for all index data.
|
org.apache.lucene.util |
Some utility classes.
|
org.apache.lucene.util.bkd |
Block KD-tree, implementing the generic spatial data structure described in
this paper.
|
org.apache.lucene.util.fst |
Finite state transducers
|
org.apache.lucene.util.packed |
Packed integer arrays and streams.
|
Modifier and Type | Method and Description |
---|---|
abstract void |
PostingsWriterBase.encodeTerm(long[] longs,
DataOutput out,
FieldInfo fieldInfo,
BlockTermState state,
boolean absolute)
Encode metadata as long[] and byte[].
|
static void |
CodecUtil.verifyAndCopyIndexHeader(IndexInput in,
DataOutput out,
byte[] expectedID)
Expert: verifies the incoming
IndexInput has an index header
and that its segment ID matches the expected one, and then copies
that index header into the provided DataOutput . |
static void |
CodecUtil.writeHeader(DataOutput out,
java.lang.String codec,
int version)
Writes a codec header, which records both a string to
identify the file and a version number.
|
static void |
CodecUtil.writeIndexHeader(DataOutput out,
java.lang.String codec,
int version,
byte[] id,
java.lang.String suffix)
Writes a codec header for an index file, which records both a string to
identify the format of the file, a version number, and data to identify
the file instance (ID and auxiliary suffix such as generation).
|
Modifier and Type | Method and Description |
---|---|
void |
FSTOrdsOutputs.write(FSTOrdsOutputs.Output prefix,
DataOutput out) |
Modifier and Type | Method and Description |
---|---|
void |
FuzzySet.serialize(DataOutput out)
Serializes the data set to file using the following format:
FuzzySet -->FuzzySetVersion,HashFunctionName,BloomSize,
NumBitSetWords,BitSetWordNumBitSetWords
HashFunctionName -->
String The
name of a ServiceProvider registered HashFunction
FuzzySetVersion --> Uint32 The version number of the FuzzySet class
BloomSize --> Uint32 The modulo value used
to project hashes into the field's Bitset
NumBitSetWords --> Uint32 The number of
longs (as returned from FixedBitSet.getBits() )
BitSetWord --> Long A long from the array
returned by FixedBitSet.getBits()
|
Modifier and Type | Method and Description |
---|---|
void |
CompressionMode.LZ4FastCompressor.compress(byte[] bytes,
int off,
int len,
DataOutput out) |
void |
CompressionMode.LZ4HighCompressor.compress(byte[] bytes,
int off,
int len,
DataOutput out) |
void |
CompressionMode.DeflateCompressor.compress(byte[] bytes,
int off,
int len,
DataOutput out) |
abstract void |
Compressor.compress(byte[] bytes,
int off,
int len,
DataOutput out)
Compress bytes into
out . |
static void |
LZ4.compress(byte[] bytes,
int off,
int len,
DataOutput out,
LZ4.HashTable ht)
Compress
bytes[off:off+len] into out using
at most 16KB of memory. |
static void |
LZ4.compressHC(byte[] src,
int srcOff,
int srcLen,
DataOutput out,
LZ4.HCHashTable ht)
Compress
bytes[off:off+len] into out . |
private static void |
LZ4.encodeLastLiterals(byte[] bytes,
int anchor,
int literalLen,
DataOutput out) |
private static void |
LZ4.encodeLen(int l,
DataOutput out) |
private static void |
LZ4.encodeLiterals(byte[] bytes,
int token,
int anchor,
int literalLen,
DataOutput out) |
private static void |
LZ4.encodeSequence(byte[] bytes,
int anchor,
int matchRef,
int matchOff,
int matchLen,
DataOutput out) |
private static void |
CompressingStoredFieldsWriter.saveInts(int[] values,
int length,
DataOutput out) |
(package private) static void |
CompressingStoredFieldsWriter.writeTLong(DataOutput out,
long l)
Writes a long in a variable-length format.
|
(package private) static void |
CompressingStoredFieldsWriter.writeZDouble(DataOutput out,
double d)
Writes a float in a variable-length format.
|
(package private) static void |
CompressingStoredFieldsWriter.writeZFloat(DataOutput out,
float f)
Writes a float in a variable-length format.
|
Modifier and Type | Method and Description |
---|---|
void |
IDVersionPostingsWriter.encodeTerm(long[] longs,
DataOutput out,
FieldInfo fieldInfo,
BlockTermState _state,
boolean absolute) |
Constructor and Description |
---|
ForUtil(float acceptableOverheadRatio,
DataOutput out)
Create a new
ForUtil instance and save state into out . |
Modifier and Type | Method and Description |
---|---|
(package private) void |
PForUtil.encode(long[] longs,
DataOutput out)
Encode 128 integers from
longs into out . |
(package private) void |
ForUtil.encode(long[] longs,
int bitsPerValue,
DataOutput out)
Encode 128 integers from
longs into out . |
(package private) void |
ForDeltaUtil.encodeDeltas(long[] longs,
DataOutput out)
Encode deltas of a strictly monotonically increasing sequence of integers.
|
void |
Lucene84PostingsWriter.encodeTerm(long[] longs,
DataOutput out,
FieldInfo fieldInfo,
BlockTermState _state,
boolean absolute) |
(package private) static void |
Lucene84SkipWriter.writeImpacts(CompetitiveImpactAccumulator acc,
DataOutput out) |
Modifier and Type | Method and Description |
---|---|
void |
FSTTermOutputs.write(FSTTermOutputs.TermData data,
DataOutput out) |
Modifier and Type | Method and Description |
---|---|
static void |
SimpleTextUtil.write(DataOutput out,
BytesRef b) |
static void |
SimpleTextUtil.write(DataOutput out,
java.lang.String s,
BytesRefBuilder scratch) |
static void |
SimpleTextUtil.writeNewline(DataOutput out) |
Modifier and Type | Method and Description |
---|---|
void |
BlockHeader.write(DataOutput output) |
void |
FieldMetadata.write(DataOutput output) |
void |
IndexDictionary.write(DataOutput output,
BlockEncoder blockEncoder)
Writes this dictionary to the provided output.
|
void |
FSTDictionary.write(DataOutput output,
BlockEncoder blockEncoder) |
protected int |
UniformSplitTermsWriter.writeFieldTerms(BlockWriter blockWriter,
DataOutput fieldsOutput,
TermsEnum termsEnum,
FieldInfo fieldInfo,
NormsProducer normsProducer) |
protected static void |
BlockLine.Serializer.writeIncrementallyEncodedTerm(TermBytes termBytes,
TermBytes previousTermBytes,
boolean isIncrementalEncodingSeed,
DataOutput blockOutput) |
static void |
BlockLine.Serializer.writeLine(DataOutput blockOutput,
BlockLine line,
BlockLine previousLine,
int termStateRelativeOffset,
boolean isIncrementalEncodingSeed)
Writes a line and its offset to the corresponding term state details in
the details region.
|
protected static void |
BlockLine.Serializer.writeLineTermState(DataOutput termStatesOutput,
BlockLine line,
FieldInfo fieldInfo,
DeltaBaseTermStateSerializer encoder)
Writes the term state details of a line in the details region.
|
void |
DeltaBaseTermStateSerializer.writeTermState(DataOutput termStatesOutput,
FieldInfo fieldInfo,
BlockTermState termState)
Writes a
BlockTermState to the provided DataOutput . |
void |
BlockEncoder.WritableBytes.writeTo(DataOutput dataOutput)
Writes the bytes to the provided
DataOutput . |
Modifier and Type | Method and Description |
---|---|
static void |
STBlockLine.Serializer.writeLineTermStates(DataOutput termStatesOutput,
STBlockLine line,
DeltaBaseTermStateSerializer encoder)
Writes all the
BlockTermState of the provided STBlockLine to the given output. |
Modifier and Type | Class and Description |
---|---|
(package private) class |
ByteSliceWriter
Class to write byte streams into slices of shared
byte[].
|
Modifier and Type | Field and Description |
---|---|
private DataOutput |
BinaryDocValuesWriter.bytesOut |
Modifier and Type | Method and Description |
---|---|
long |
ByteSliceReader.writeTo(DataOutput out) |
(package private) abstract void |
DocValuesUpdate.writeTo(DataOutput output) |
(package private) void |
DocValuesUpdate.BinaryDocValuesUpdate.writeTo(DataOutput out) |
(package private) void |
DocValuesUpdate.NumericDocValuesUpdate.writeTo(DataOutput out) |
Constructor and Description |
---|
CorruptIndexException(java.lang.String message,
DataOutput output)
Create exception with a message only
|
CorruptIndexException(java.lang.String message,
DataOutput output,
java.lang.Throwable cause)
Create exception with message and root cause.
|
Modifier and Type | Method and Description |
---|---|
abstract boolean |
Lookup.store(DataOutput output)
Persist the constructed lookup data to a directory.
|
Modifier and Type | Method and Description |
---|---|
boolean |
AnalyzingSuggester.store(DataOutput output) |
boolean |
AnalyzingInfixSuggester.store(DataOutput in) |
boolean |
FreeTextSuggester.store(DataOutput output) |
Modifier and Type | Method and Description |
---|---|
boolean |
NRTSuggesterBuilder.store(DataOutput output)
Builds and stores a FST that can be loaded with
NRTSuggester.load(IndexInput, CompletionPostingsFormat.FSTLoadMode) )} |
Modifier and Type | Method and Description |
---|---|
boolean |
FSTCompletionLookup.store(DataOutput output) |
boolean |
WFSTCompletionLookup.store(DataOutput output) |
Modifier and Type | Method and Description |
---|---|
boolean |
JaspellLookup.store(DataOutput output)
Deprecated.
|
private void |
JaspellLookup.writeRecursively(DataOutput out,
JaspellTernarySearchTrie.TSTNode node)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
boolean |
TSTLookup.store(DataOutput output) |
private void |
TSTLookup.writeRecursively(DataOutput out,
TernaryTreeNode node) |
Modifier and Type | Class and Description |
---|---|
class |
ByteArrayDataOutput
DataOutput backed by a byte array.
|
class |
ByteBuffersDataOutput
A
DataOutput storing data in a list of ByteBuffer s. |
class |
ByteBuffersIndexOutput
An
IndexOutput writing to a ByteBuffersDataOutput . |
(package private) class |
FSDirectory.FSIndexOutput |
class |
GrowableByteArrayDataOutput
A
DataOutput that can be used to build a byte[]. |
class |
IndexOutput
A
DataOutput for appending data to a file in a Directory . |
private static class |
NativeUnixDirectory.NativeUnixIndexOutput |
class |
OutputStreamDataOutput
A
DataOutput wrapping a plain OutputStream . |
class |
OutputStreamIndexOutput
Implementation class for buffered
IndexOutput that writes to an OutputStream . |
class |
RAMOutputStream
Deprecated.
This class uses inefficient synchronization and is discouraged
in favor of
MMapDirectory . It will be removed in future versions
of Lucene. |
class |
RateLimitedIndexOutput
|
Modifier and Type | Method and Description |
---|---|
void |
ByteBuffersDataOutput.copyTo(DataOutput output)
Copy the current content of this object into another
DataOutput . |
void |
RAMOutputStream.writeTo(DataOutput out)
Deprecated.
Copy the current contents of this buffer to the provided
DataOutput . |
Modifier and Type | Class and Description |
---|---|
class |
PagedBytes.PagedBytesDataOutput |
Modifier and Type | Method and Description |
---|---|
private void |
BKDWriter.writeActualBounds(DataOutput out,
int[] commonPrefixLengths,
int count,
java.util.function.IntFunction<BytesRef> packedValues) |
private void |
BKDWriter.writeCommonPrefixes(DataOutput out,
int[] commonPrefixes,
byte[] packedValue) |
(package private) static void |
DocIdsWriter.writeDocIds(int[] docIds,
int start,
int count,
DataOutput out) |
private void |
BKDWriter.writeHighCardinalityLeafBlockPackedValues(DataOutput out,
int[] commonPrefixLengths,
int count,
int sortedDim,
java.util.function.IntFunction<BytesRef> packedValues,
int compressedByteOffset) |
private void |
BKDWriter.writeLeafBlockDocs(DataOutput out,
int[] docIDs,
int start,
int count) |
private void |
BKDWriter.writeLeafBlockPackedValues(DataOutput out,
int[] commonPrefixLengths,
int count,
int sortedDim,
java.util.function.IntFunction<BytesRef> packedValues,
int leafCardinality) |
private void |
BKDWriter.writeLeafBlockPackedValuesRange(DataOutput out,
int[] commonPrefixLengths,
int start,
int end,
java.util.function.IntFunction<BytesRef> packedValues) |
private void |
BKDWriter.writeLowCardinalityLeafBlockPackedValues(DataOutput out,
int[] commonPrefixLengths,
int count,
java.util.function.IntFunction<BytesRef> packedValues) |
Modifier and Type | Class and Description |
---|---|
(package private) class |
BytesStore |
Modifier and Type | Method and Description |
---|---|
void |
FST.save(DataOutput out) |
void |
ByteSequenceOutputs.write(BytesRef prefix,
DataOutput out) |
void |
CharSequenceOutputs.write(CharsRef prefix,
DataOutput out) |
void |
IntSequenceOutputs.write(IntsRef prefix,
DataOutput out) |
void |
PositiveIntOutputs.write(java.lang.Long output,
DataOutput out) |
void |
NoOutputs.write(java.lang.Object prefix,
DataOutput out) |
void |
ListOfOutputs.write(java.lang.Object output,
DataOutput out) |
void |
UpToTwoPositiveIntOutputs.write(java.lang.Object _output,
DataOutput out) |
void |
PairOutputs.write(PairOutputs.Pair<A,B> output,
DataOutput writer) |
abstract void |
Outputs.write(T output,
DataOutput out)
Encode an output value into a
DataOutput . |
void |
ListOfOutputs.writeFinalOutput(java.lang.Object output,
DataOutput out) |
void |
Outputs.writeFinalOutput(T output,
DataOutput out)
Encode an final node output value into a
DataOutput . |
private void |
FST.writeLabel(DataOutput out,
int v) |
void |
OnHeapFSTStore.writeTo(DataOutput out) |
void |
OffHeapFSTStore.writeTo(DataOutput out) |
void |
BytesStore.writeTo(DataOutput out)
Writes all of our bytes to the target
DataOutput . |
void |
FSTStore.writeTo(DataOutput out) |
Modifier and Type | Field and Description |
---|---|
protected DataOutput |
AbstractBlockPackedWriter.out |
protected DataOutput |
PackedInts.Writer.out |
(package private) DataOutput |
PackedDataOutput.out |
(package private) DataOutput |
DirectWriter.output |
Modifier and Type | Method and Description |
---|---|
static DirectWriter |
DirectWriter.getInstance(DataOutput output,
long numValues,
int bitsPerValue)
Returns an instance suitable for encoding
numValues using bitsPerValue |
static PackedInts.Writer |
PackedInts.getWriter(DataOutput out,
int valueCount,
int bitsPerValue,
float acceptableOverheadRatio)
Create a packed integer array writer for the given output, format, value
count, and number of bits per value.
|
static PackedInts.Writer |
PackedInts.getWriterNoHeader(DataOutput out,
PackedInts.Format format,
int valueCount,
int bitsPerValue,
int mem)
Expert: Create a packed integer array writer for the given output, format,
value count, and number of bits per value.
|
void |
AbstractBlockPackedWriter.reset(DataOutput out)
Reset this writer to wrap
out . |
void |
PackedInts.Mutable.save(DataOutput out)
Save this mutable into
out . |
void |
GrowableWriter.save(DataOutput out) |
(package private) static void |
AbstractBlockPackedWriter.writeVLong(DataOutput out,
long i) |
Constructor and Description |
---|
AbstractBlockPackedWriter(DataOutput out,
int blockSize)
Sole constructor.
|
BlockPackedWriter(DataOutput out,
int blockSize)
Sole constructor.
|
DirectWriter(DataOutput output,
long numValues,
int bitsPerValue) |
MonotonicBlockPackedWriter(DataOutput out,
int blockSize)
Sole constructor.
|
PackedDataOutput(DataOutput out)
Create a new instance that wraps
out . |
PackedWriter(PackedInts.Format format,
DataOutput out,
int valueCount,
int bitsPerValue,
int mem) |
Writer(DataOutput out,
int valueCount,
int bitsPerValue) |