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.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 | Class and Description |
---|---|
private static class |
MultiLevelSkipListReader.SkipBuffer
used to buffer the top skip levels
|
Modifier and Type | Method and Description |
---|---|
void |
TermVectorsWriter.addProx(int numProx,
DataInput positions,
DataInput offsets)
Called by IndexWriter when writing new segments.
|
static int |
CodecUtil.checkHeader(DataInput in,
java.lang.String codec,
int minVersion,
int maxVersion)
Reads and validates a header previously written with
CodecUtil.writeHeader(DataOutput, String, int) . |
static int |
CodecUtil.checkHeaderNoMagic(DataInput in,
java.lang.String codec,
int minVersion,
int maxVersion)
Like
CodecUtil.checkHeader(DataInput,String,int,int) except this
version assumes the first int has already been read
and validated from the input. |
static int |
CodecUtil.checkIndexHeader(DataInput in,
java.lang.String codec,
int minVersion,
int maxVersion,
byte[] expectedID,
java.lang.String expectedSuffix)
Reads and validates a header previously written with
CodecUtil.writeIndexHeader(DataOutput, String, int, byte[], String) . |
static byte[] |
CodecUtil.checkIndexHeaderID(DataInput in,
byte[] expectedID)
Expert: just reads and verifies the object ID of an index header
|
static java.lang.String |
CodecUtil.checkIndexHeaderSuffix(DataInput in,
java.lang.String expectedSuffix)
Expert: just reads and verifies the suffix of an index header
|
abstract void |
PostingsReaderBase.decodeTerm(long[] longs,
DataInput in,
FieldInfo fieldInfo,
BlockTermState state,
boolean absolute)
Actually decode metadata for next term
|
Modifier and Type | Method and Description |
---|---|
FSTOrdsOutputs.Output |
FSTOrdsOutputs.read(DataInput in) |
void |
FSTOrdsOutputs.skipFinalOutput(DataInput in) |
void |
FSTOrdsOutputs.skipOutput(DataInput in) |
Modifier and Type | Method and Description |
---|---|
static FuzzySet |
FuzzySet.deserialize(DataInput in) |
Modifier and Type | Field and Description |
---|---|
(package private) DataInput |
CompressingStoredFieldsReader.SerializedDocument.in |
Modifier and Type | Method and Description |
---|---|
void |
CompressingTermVectorsWriter.addProx(int numProx,
DataInput positions,
DataInput offsets) |
static int |
LZ4.decompress(DataInput compressed,
int decompressedLen,
byte[] dest,
int dOff)
Decompress at least
decompressedLen bytes into
dest[dOff:] . |
void |
CompressionMode.DeflateDecompressor.decompress(DataInput in,
int originalLength,
int offset,
int length,
BytesRef bytes) |
abstract void |
Decompressor.decompress(DataInput in,
int originalLength,
int offset,
int length,
BytesRef bytes)
Decompress bytes that were stored between offsets
offset and
offset+length in the original stream from the compressed
stream in to bytes . |
private static void |
CompressingStoredFieldsReader.readField(DataInput in,
StoredFieldVisitor visitor,
FieldInfo info,
int bits) |
(package private) static long |
CompressingStoredFieldsReader.readTLong(DataInput in)
Reads a long in a variable-length format.
|
(package private) static double |
CompressingStoredFieldsReader.readZDouble(DataInput in)
Reads a double in a variable-length format.
|
(package private) static float |
CompressingStoredFieldsReader.readZFloat(DataInput in)
Reads a float in a variable-length format.
|
private static void |
CompressingStoredFieldsReader.skipField(DataInput in,
int bits) |
Constructor and Description |
---|
SerializedDocument(DataInput in,
int length,
int numStoredFields) |
Modifier and Type | Method and Description |
---|---|
void |
IDVersionPostingsReader.decodeTerm(long[] longs,
DataInput in,
FieldInfo fieldInfo,
BlockTermState _termState,
boolean absolute) |
Modifier and Type | Method and Description |
---|---|
void |
Lucene50PostingsReader.decodeTerm(long[] longs,
DataInput in,
FieldInfo fieldInfo,
BlockTermState _termState,
boolean absolute) |
Constructor and Description |
---|
ForUtil(DataInput in)
|
Modifier and Type | Method and Description |
---|---|
(package private) void |
PForUtil.decode(DataInput in,
long[] longs)
Decode 128 integers into
ints . |
(package private) void |
ForUtil.decode(int bitsPerValue,
DataInput in,
long[] longs)
Decode 128 integers into
longs . |
private static void |
ForUtil.decode1(DataInput in,
long[] tmp,
long[] longs) |
private static void |
ForUtil.decode10(DataInput in,
long[] tmp,
long[] longs) |
private static void |
ForUtil.decode11(DataInput in,
long[] tmp,
long[] longs) |
private static void |
ForUtil.decode12(DataInput in,
long[] tmp,
long[] longs) |
private static void |
ForUtil.decode13(DataInput in,
long[] tmp,
long[] longs) |
private static void |
ForUtil.decode14(DataInput in,
long[] tmp,
long[] longs) |
private static void |
ForUtil.decode15(DataInput in,
long[] tmp,
long[] longs) |
private static void |
ForUtil.decode16(DataInput in,
long[] tmp,
long[] longs) |
private static void |
ForUtil.decode17(DataInput in,
long[] tmp,
long[] longs) |
private static void |
ForUtil.decode18(DataInput in,
long[] tmp,
long[] longs) |
private static void |
ForUtil.decode19(DataInput in,
long[] tmp,
long[] longs) |
private static void |
ForUtil.decode2(DataInput in,
long[] tmp,
long[] longs) |
private static void |
ForUtil.decode20(DataInput in,
long[] tmp,
long[] longs) |
private static void |
ForUtil.decode21(DataInput in,
long[] tmp,
long[] longs) |
private static void |
ForUtil.decode22(DataInput in,
long[] tmp,
long[] longs) |
private static void |
ForUtil.decode23(DataInput in,
long[] tmp,
long[] longs) |
private static void |
ForUtil.decode24(DataInput in,
long[] tmp,
long[] longs) |
private static void |
ForUtil.decode3(DataInput in,
long[] tmp,
long[] longs) |
private static void |
ForUtil.decode4(DataInput in,
long[] tmp,
long[] longs) |
private static void |
ForUtil.decode5(DataInput in,
long[] tmp,
long[] longs) |
private static void |
ForUtil.decode6(DataInput in,
long[] tmp,
long[] longs) |
private static void |
ForUtil.decode7(DataInput in,
long[] tmp,
long[] longs) |
private static void |
ForUtil.decode8(DataInput in,
long[] tmp,
long[] longs) |
private static void |
ForUtil.decode9(DataInput in,
long[] tmp,
long[] longs) |
(package private) void |
ForDeltaUtil.decodeAndPrefixSum(DataInput in,
long base,
long[] longs)
Decode deltas, compute the prefix sum and add
base to all decoded longs. |
(package private) void |
ForUtil.decodeAndPrefixSum(int bitsPerValue,
DataInput in,
long base,
long[] longs)
Delta-decode 128 integers into
longs . |
private static void |
ForUtil.decodeSlow(int bitsPerValue,
DataInput in,
long[] tmp,
long[] longs) |
void |
Lucene84PostingsReader.decodeTerm(long[] longs,
DataInput in,
FieldInfo fieldInfo,
BlockTermState _termState,
boolean absolute) |
(package private) void |
ForDeltaUtil.skip(DataInput in)
Skip a sequence of 128 longs.
|
(package private) void |
PForUtil.skip(DataInput in)
Skip 128 integers.
|
Modifier and Type | Method and Description |
---|---|
FSTTermOutputs.TermData |
FSTTermOutputs.read(DataInput in) |
void |
FSTTermOutputs.skipOutput(DataInput in) |
Modifier and Type | Method and Description |
---|---|
static void |
SimpleTextUtil.readLine(DataInput in,
BytesRefBuilder scratch) |
Modifier and Type | Method and Description |
---|---|
BytesRef |
BlockDecoder.decode(DataInput blockBytes,
long length)
Decodes all the bytes of one block in a single operation.
|
BlockEncoder.WritableBytes |
BlockEncoder.encode(DataInput blockBytes,
long length)
Encodes all the bytes of one block in a single operation.
|
protected static FSTDictionary |
FSTDictionary.read(DataInput input,
BlockDecoder blockDecoder)
Reads a
FSTDictionary from the provided input. |
static BlockHeader |
BlockHeader.read(DataInput input,
BlockHeader reuse) |
static FieldMetadata |
FieldMetadata.read(DataInput input,
FieldInfos fieldInfos) |
protected static void |
BlockLine.Serializer.readBytes(DataInput input,
BytesRef bytes,
int offset,
int length)
|
protected TermBytes |
BlockLine.Serializer.readIncrementallyEncodedTerm(DataInput blockInput,
boolean isIncrementalEncodingSeed,
TermBytes reuse) |
BlockLine |
BlockLine.Serializer.readLine(DataInput blockInput,
boolean isIncrementalEncodingSeed,
BlockLine reuse)
Reads the current line.
|
BlockTermState |
DeltaBaseTermStateSerializer.readTermState(long baseDocStartFP,
long basePosStartFP,
long basePayStartFP,
DataInput termStatesInput,
FieldInfo fieldInfo,
BlockTermState reuse)
Reads a
BlockTermState from the provided DataInput . |
Modifier and Type | Method and Description |
---|---|
static int[] |
STBlockLine.Serializer.readFieldIds(DataInput termStatesInput,
int numFields)
Reads all the field ids in the current block line of the provided input.
|
static void |
STBlockLine.Serializer.readFieldTermStatesMap(DataInput termStatesInput,
DeltaBaseTermStateSerializer termStateSerializer,
BlockHeader blockHeader,
FieldInfos fieldInfos,
java.util.Map<java.lang.String,BlockTermState> fieldTermStatesMap)
Reads all the
BlockTermState of all the field in the current block line of the provided input. |
static BlockTermState |
STBlockLine.Serializer.readTermStateForField(int fieldId,
DataInput termStatesInput,
DeltaBaseTermStateSerializer termStateSerializer,
BlockHeader blockHeader,
FieldInfos fieldInfos,
BlockTermState reuse)
Reads a single
BlockTermState for the provided field in the current block line of the provided input. |
Modifier and Type | Class and Description |
---|---|
(package private) class |
ByteSliceReader |
Modifier and Type | Field and Description |
---|---|
(package private) DataInput |
BinaryDocValuesWriter.BufferedBinaryDocValues.bytesIterator |
Modifier and Type | Method and Description |
---|---|
private static Codec |
SegmentInfos.readCodec(DataInput input) |
(package private) static long |
DocValuesUpdate.NumericDocValuesUpdate.readFrom(DataInput in) |
(package private) static BytesRef |
DocValuesUpdate.BinaryDocValuesUpdate.readFrom(DataInput in,
BytesRef scratch) |
Constructor and Description |
---|
BufferedBinaryDocValues(PackedLongValues lengths,
int maxLength,
DataInput bytesIterator,
DocIdSetIterator docsWithFields) |
CorruptIndexException(java.lang.String message,
DataInput input)
Create exception with a message only
|
CorruptIndexException(java.lang.String message,
DataInput input,
java.lang.Throwable cause)
Create exception with message and root cause.
|
IndexFormatTooNewException(DataInput in,
int version,
int minVersion,
int maxVersion)
Creates an
IndexFormatTooNewException |
IndexFormatTooOldException(DataInput in,
int version,
int minVersion,
int maxVersion)
Creates an
IndexFormatTooOldException . |
IndexFormatTooOldException(DataInput in,
java.lang.String reason)
Creates an
IndexFormatTooOldException . |
Modifier and Type | Method and Description |
---|---|
abstract boolean |
Lookup.load(DataInput input)
Discard current lookup data and load it from a previously saved copy.
|
Modifier and Type | Method and Description |
---|---|
boolean |
AnalyzingInfixSuggester.load(DataInput out) |
boolean |
AnalyzingSuggester.load(DataInput input) |
boolean |
FreeTextSuggester.load(DataInput input) |
Modifier and Type | Method and Description |
---|---|
boolean |
FSTCompletionLookup.load(DataInput input) |
boolean |
WFSTCompletionLookup.load(DataInput input) |
Modifier and Type | Method and Description |
---|---|
boolean |
JaspellLookup.load(DataInput input)
Deprecated.
|
private void |
JaspellLookup.readRecursively(DataInput in,
JaspellTernarySearchTrie.TSTNode node)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
boolean |
TSTLookup.load(DataInput input) |
private void |
TSTLookup.readRecursively(DataInput in,
TernaryTreeNode node) |
Modifier and Type | Class and Description |
---|---|
class |
BufferedChecksumIndexInput
Simple implementation of
ChecksumIndexInput that wraps
another input and delegates calls. |
class |
BufferedIndexInput
Base implementation class for buffered
IndexInput . |
private static class |
BufferedIndexInput.SlicedIndexInput
Implementation of an IndexInput that reads from a portion of a file.
|
class |
ByteArrayDataInput
DataInput backed by a byte array.
|
class |
ByteBufferIndexInput
Base IndexInput implementation that uses an array
of ByteBuffers to represent a file.
|
(package private) static class |
ByteBufferIndexInput.MultiBufferImpl
This class adds offset support to ByteBufferIndexInput, which is needed for slices.
|
(package private) static class |
ByteBufferIndexInput.SingleBufferImpl
Optimization of ByteBufferIndexInput for when there is only one buffer
|
class |
ByteBuffersDataInput
|
class |
ByteBuffersIndexInput
|
class |
ChecksumIndexInput
Extension of IndexInput, computing checksum as it goes.
|
class |
IndexInput
Abstract base class for input from a file in a
Directory . |
class |
InputStreamDataInput
A
DataInput wrapping a plain InputStream . |
private static class |
NativeUnixDirectory.NativeUnixIndexInput |
(package private) static class |
NIOFSDirectory.NIOFSIndexInput
Reads bytes with
FileChannel.read(ByteBuffer, long) |
(package private) static class |
RAFDirectory.RAFIndexInput
Reads bytes with
RandomAccessFile.seek(long) followed by
RandomAccessFile.read(byte[], int, int) . |
class |
RAMInputStream
Deprecated.
This class uses inefficient synchronization and is discouraged
in favor of
MMapDirectory . It will be removed in future versions
of Lucene. |
(package private) static class |
SimpleFSDirectory.SimpleFSIndexInput
Reads bytes with
SeekableByteChannel.read(ByteBuffer) |
(package private) static class |
WindowsDirectory.WindowsIndexInput |
Modifier and Type | Method and Description |
---|---|
DataInput |
DataInput.clone()
Returns a clone of this stream.
|
Modifier and Type | Method and Description |
---|---|
void |
ByteBuffersIndexOutput.copyBytes(DataInput input,
long numBytes) |
void |
DataOutput.copyBytes(DataInput input,
long numBytes)
Copy numBytes bytes from input to ourself.
|
Modifier and Type | Class and Description |
---|---|
class |
PagedBytes.PagedBytesDataInput |
Modifier and Type | Class and Description |
---|---|
private static class |
BKDReader.BKDInput |
private static class |
BKDReader.BKDOffHeapInput |
private static class |
BKDReader.BKDOnHeapInput |
Modifier and Type | Class and Description |
---|---|
(package private) class |
ForwardBytesReader
Reads from a single byte[].
|
static class |
FST.BytesReader
Reads bytes stored in an FST.
|
(package private) class |
ReverseBytesReader
Reads in reverse from a single byte[].
|
(package private) class |
ReverseRandomAccessReader
Implements reverse read from a RandomAccessInput.
|
Modifier and Type | Method and Description |
---|---|
void |
FSTStore.init(DataInput in,
long numBytes) |
void |
OffHeapFSTStore.init(DataInput in,
long numBytes) |
void |
OnHeapFSTStore.init(DataInput in,
long numBytes) |
BytesRef |
ByteSequenceOutputs.read(DataInput in) |
CharsRef |
CharSequenceOutputs.read(DataInput in) |
IntsRef |
IntSequenceOutputs.read(DataInput in) |
java.lang.Object |
NoOutputs.read(DataInput in) |
abstract T |
Outputs.read(DataInput in)
Decode an output value previously written with
Outputs.write(Object, DataOutput) . |
PairOutputs.Pair<A,B> |
PairOutputs.read(DataInput in) |
java.lang.Long |
PositiveIntOutputs.read(DataInput in) |
java.lang.Object |
ListOfOutputs.read(DataInput in) |
java.lang.Object |
UpToTwoPositiveIntOutputs.read(DataInput in) |
T |
Outputs.readFinalOutput(DataInput in)
Decode an output value previously written with
Outputs.writeFinalOutput(Object, DataOutput) . |
java.lang.Object |
ListOfOutputs.readFinalOutput(DataInput in) |
int |
FST.readLabel(DataInput in)
Reads one BYTE1/2/4 label from the provided
DataInput . |
void |
Outputs.skipFinalOutput(DataInput in)
Skip the output previously written with
Outputs.writeFinalOutput(T, org.apache.lucene.store.DataOutput) ;
defaults to just calling Outputs.readFinalOutput(org.apache.lucene.store.DataInput) and discarding
the result. |
void |
ListOfOutputs.skipFinalOutput(DataInput in) |
void |
ByteSequenceOutputs.skipOutput(DataInput in) |
void |
CharSequenceOutputs.skipOutput(DataInput in) |
void |
IntSequenceOutputs.skipOutput(DataInput in) |
void |
Outputs.skipOutput(DataInput in)
Skip the output; defaults to just calling
Outputs.read(org.apache.lucene.store.DataInput)
and discarding the result. |
void |
PairOutputs.skipOutput(DataInput in) |
void |
ListOfOutputs.skipOutput(DataInput in) |
Constructor and Description |
---|
BytesStore(DataInput in,
long numBytes,
int maxBlockSize)
Pulls bytes from the provided IndexInput.
|
FST(DataInput in,
Outputs<T> outputs)
Load a previously saved FST.
|
FST(DataInput in,
Outputs<T> outputs,
FSTStore fstStore)
Load a previously saved FST; maxBlockBits allows you to
control the size of the byte[] pages used to hold the FST bytes.
|
Modifier and Type | Field and Description |
---|---|
(package private) DataInput |
BlockPackedReaderIterator.in |
(package private) DataInput |
PackedDataInput.in |
protected DataInput |
PackedInts.ReaderIteratorImpl.in |
Modifier and Type | Method and Description |
---|---|
static Packed64SingleBlock |
Packed64SingleBlock.create(DataInput in,
int valueCount,
int bitsPerValue) |
static PackedInts.Reader |
PackedInts.getReader(DataInput in)
Restore a
PackedInts.Reader from a stream. |
static PackedInts.ReaderIterator |
PackedInts.getReaderIterator(DataInput in,
int mem)
Retrieve PackedInts as a
PackedInts.ReaderIterator |
static PackedInts.ReaderIterator |
PackedInts.getReaderIteratorNoHeader(DataInput in,
PackedInts.Format format,
int version,
int valueCount,
int bitsPerValue,
int mem)
Expert: Restore a
PackedInts.ReaderIterator from a stream without reading
metadata at the beginning of the stream. |
static PackedInts.Reader |
PackedInts.getReaderNoHeader(DataInput in,
PackedInts.Format format,
int version,
int valueCount,
int bitsPerValue)
Expert: Restore a
PackedInts.Reader from a stream without reading metadata at
the beginning of the stream. |
(package private) static long |
BlockPackedReaderIterator.readVLong(DataInput in) |
void |
BlockPackedReaderIterator.reset(DataInput in,
long valueCount)
Reset the current reader to wrap a stream of
valueCount
values contained in in . |
Constructor and Description |
---|
BlockPackedReaderIterator(DataInput in,
int packedIntsVersion,
int blockSize,
long valueCount)
Sole constructor.
|
Direct16(int packedIntsVersion,
DataInput in,
int valueCount) |
Direct32(int packedIntsVersion,
DataInput in,
int valueCount) |
Direct64(int packedIntsVersion,
DataInput in,
int valueCount) |
Direct8(int packedIntsVersion,
DataInput in,
int valueCount) |
Packed16ThreeBlocks(int packedIntsVersion,
DataInput in,
int valueCount) |
Packed64(int packedIntsVersion,
DataInput in,
int valueCount,
int bitsPerValue)
Creates an array with content retrieved from the given DataInput.
|
Packed8ThreeBlocks(int packedIntsVersion,
DataInput in,
int valueCount) |
PackedDataInput(DataInput in)
Create a new instance that wraps
in . |
PackedReaderIterator(PackedInts.Format format,
int packedIntsVersion,
int valueCount,
int bitsPerValue,
DataInput in,
int mem) |
ReaderIteratorImpl(int valueCount,
int bitsPerValue,
DataInput in) |