Package | Description |
---|---|
org.apache.lucene.codecs |
Codecs API: API for customization of the encoding and structure of the index.
|
org.apache.lucene.codecs.blocktree |
BlockTree terms dictionary.
|
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.lucene60 |
Components from the Lucene 6.0 index format.
|
org.apache.lucene.codecs.lucene70 |
Components from the Lucene 7.0 index format.
|
org.apache.lucene.codecs.lucene80 |
Lucene 8.0 file format.
|
org.apache.lucene.codecs.perfield |
Postings format that can delegate to different formats per-field.
|
org.apache.lucene.index |
Code to maintain and access indices.
|
org.apache.lucene.search |
Code to search indices.
|
org.apache.lucene.store |
Binary i/o API, used for all index data.
|
org.apache.lucene.util |
Some utility classes.
|
org.apache.lucene.util.automaton |
Finite-state automaton for regular expressions.
|
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 |
---|---|
class |
DocValuesProducer
Abstract API that produces numeric, binary, sorted, sortedset,
and sortednumeric docvalues.
|
class |
FieldsProducer
Abstract API that produces terms, doc, freq, prox, offset and
payloads postings.
|
class |
NormsProducer
Abstract API that produces field normalization values
|
class |
PointsReader
Abstract API to visit point values.
|
class |
PostingsReaderBase
The core terms dictionaries (BlockTermsReader,
BlockTreeTermsReader) interact with a single instance
of this class to manage creation of
PostingsEnum and
PostingsEnum instances. |
class |
StoredFieldsReader
Codec API for reading stored fields.
|
class |
TermVectorsReader
Codec API for reading term vectors:
|
Modifier and Type | Class and Description |
---|---|
class |
BlockTreeTermsReader
A block-based terms index and dictionary that assigns
terms to variable length blocks according to how they
share prefixes.
|
class |
FieldReader
BlockTree's implementation of
Terms . |
Modifier and Type | Method and Description |
---|---|
java.util.Collection<Accountable> |
FieldReader.getChildResources() |
java.util.Collection<Accountable> |
BlockTreeTermsReader.getChildResources() |
Modifier and Type | Class and Description |
---|---|
class |
CompressingStoredFieldsIndexReader
Random-access reader for
CompressingStoredFieldsIndexWriter . |
class |
CompressingStoredFieldsReader
|
class |
CompressingTermVectorsReader
|
Modifier and Type | Method and Description |
---|---|
java.util.Collection<Accountable> |
CompressingTermVectorsReader.getChildResources() |
java.util.Collection<Accountable> |
CompressingStoredFieldsReader.getChildResources() |
java.util.Collection<Accountable> |
CompressingStoredFieldsIndexReader.getChildResources() |
Modifier and Type | Class and Description |
---|---|
(package private) class |
IDVersionPostingsReader |
class |
VersionBlockTreeTermsReader
|
(package private) class |
VersionFieldReader
BlockTree's implementation of
Terms . |
Modifier and Type | Method and Description |
---|---|
java.util.Collection<Accountable> |
VersionFieldReader.getChildResources() |
java.util.Collection<Accountable> |
VersionBlockTreeTermsReader.getChildResources() |
Modifier and Type | Class and Description |
---|---|
class |
Lucene50PostingsReader
Concrete class that reads docId(maybe frq,pos,offset,payloads) list
with postings format.
|
Modifier and Type | Class and Description |
---|---|
class |
Lucene60PointsReader
Reads point values previously written with
Lucene60PointsWriter |
Modifier and Type | Method and Description |
---|---|
java.util.Collection<Accountable> |
Lucene60PointsReader.getChildResources() |
Modifier and Type | Class and Description |
---|---|
(package private) class |
Lucene70DocValuesProducer
reader for
Lucene70DocValuesFormat |
(package private) class |
Lucene70NormsProducer
Reader for
Lucene70NormsFormat |
Modifier and Type | Class and Description |
---|---|
(package private) class |
Lucene80DocValuesProducer
reader for
Lucene80DocValuesFormat |
(package private) class |
Lucene80NormsProducer
Reader for
Lucene80NormsFormat |
Modifier and Type | Class and Description |
---|---|
private class |
PerFieldDocValuesFormat.FieldsReader |
private static class |
PerFieldMergeState.FilterFieldsProducer |
private static class |
PerFieldPostingsFormat.FieldsReader |
Modifier and Type | Method and Description |
---|---|
java.util.Collection<Accountable> |
PerFieldPostingsFormat.FieldsReader.getChildResources() |
java.util.Collection<Accountable> |
PerFieldDocValuesFormat.FieldsReader.getChildResources() |
Modifier and Type | Class and Description |
---|---|
(package private) class |
BinaryDocValuesFieldUpdates
A
DocValuesFieldUpdates which holds updates of documents, of a single
BinaryDocValuesField . |
(package private) class |
BufferedUpdates
Holds buffered deletes and updates, by docID, term or query for a
single segment.
|
(package private) class |
BufferedUpdatesStream
Tracks the stream of
FrozenBufferedUpdates . |
class |
CodecReader
LeafReader implemented by codec APIs.
|
(package private) class |
DocsWithFieldSet
Accumulator for documents that have a value for a field.
|
(package private) class |
DocumentsWriter
This class accepts multiple added documents and directly
writes segment files.
|
(package private) class |
DocumentsWriterDeleteQueue
DocumentsWriterDeleteQueue is a non-blocking linked pending deletes
queue. |
(package private) class |
DocumentsWriterFlushControl
This class controls
DocumentsWriterPerThread flushing during
indexing. |
(package private) class |
DocValuesFieldUpdates
Holds updates of a single DocValues field, for a set of documents within one segment.
|
(package private) static class |
DocValuesFieldUpdates.SingleValueDocValuesFieldUpdates |
class |
EmptyDocValuesProducer
Abstract base class implementing a
DocValuesProducer that has no doc values. |
class |
FilterCodecReader
A
FilterCodecReader contains another CodecReader, which it
uses as its basic source of data, possibly transforming the data along the
way or providing additional functionality. |
class |
IndexWriter
An
IndexWriter creates and maintains an index. |
private static class |
MultiPassIndexSplitter.FakeDeleteLeafIndexReader |
(package private) class |
NumericDocValuesFieldUpdates
A
DocValuesFieldUpdates which holds updates of documents, of a single
NumericDocValuesField . |
(package private) static class |
NumericDocValuesFieldUpdates.SingleValueNumericDocValuesFieldUpdates |
class |
OrdinalMap
Maps per-segment ordinals to/from global ordinal space, using a compact packed-ints representation.
|
private static class |
OrdinalMap.SegmentMap |
private static class |
PKIndexSplitter.DocumentFilteredLeafIndexReader |
class |
PrefixCodedTerms
Prefix codes term instances (prefixes are shared).
|
(package private) class |
SegmentDocValuesProducer
Encapsulates multiple producers when there are docvalues updates as one producer
|
class |
SegmentReader
IndexReader implementation over a single segment.
|
(package private) static class |
SoftDeletesDirectoryReaderWrapper.SoftDeletesFilterCodecReader |
Modifier and Type | Method and Description |
---|---|
java.util.Collection<Accountable> |
FilterCodecReader.getChildResources() |
java.util.Collection<Accountable> |
OrdinalMap.getChildResources() |
java.util.Collection<Accountable> |
CodecReader.getChildResources() |
java.util.Collection<Accountable> |
SegmentDocValuesProducer.getChildResources() |
Modifier and Type | Class and Description |
---|---|
class |
DocIdSet
A DocIdSet contains a set of doc ids.
|
class |
LRUQueryCache
A
QueryCache that evicts queries using a LRU (least-recently-used)
eviction policy in order to remain under a given maximum size and number of
bytes used. |
private class |
LRUQueryCache.LeafCache |
class |
TermInSetQuery
Specialization for a disjunction over many terms that behaves like a
ConstantScoreQuery over a BooleanQuery containing only
BooleanClause.Occur.SHOULD clauses. |
Modifier and Type | Method and Description |
---|---|
java.util.Collection<Accountable> |
LRUQueryCache.getChildResources() |
java.util.Collection<Accountable> |
TermInSetQuery.getChildResources() |
Modifier and Type | Class and Description |
---|---|
class |
ByteBuffersDataInput
|
class |
ByteBuffersDataOutput
A
DataOutput storing data in a list of ByteBuffer s. |
class |
NRTCachingDirectory
Wraps a
RAMDirectory
around any provided delegate directory, to
be used during NRT search. |
class |
RAMDirectory
Deprecated.
This class uses inefficient synchronization and is discouraged
in favor of
MMapDirectory . It will be removed in future versions
of Lucene. |
class |
RAMFile
Deprecated.
This class uses inefficient synchronization and is discouraged
in favor of
MMapDirectory . It will be removed in future versions
of Lucene. |
class |
RAMOutputStream
Deprecated.
This class uses inefficient synchronization and is discouraged
in favor of
MMapDirectory . It will be removed in future versions
of Lucene. |
Modifier and Type | Method and Description |
---|---|
java.util.Collection<Accountable> |
RAMDirectory.getChildResources()
Deprecated.
|
java.util.Collection<Accountable> |
RAMOutputStream.getChildResources()
Deprecated.
|
java.util.Collection<Accountable> |
NRTCachingDirectory.getChildResources() |
Modifier and Type | Class and Description |
---|---|
class |
BitDocIdSet
|
class |
BitSet
Base implementation for a bit set.
|
class |
FixedBitSet
BitSet of fixed length (numBits), backed by accessible (
FixedBitSet.getBits() )
long[], accessed with an int index, implementing Bits and
DocIdSet . |
class |
FrequencyTrackingRingBuffer
A ring buffer that tracks the frequency of the integers that it contains.
|
private static class |
FrequencyTrackingRingBuffer.IntBag
A bag of integers.
|
(package private) class |
IntArrayDocIdSet |
class |
NotDocIdSet
|
class |
PagedBytes
Represents a logical byte[] as a series of pages.
|
static class |
PagedBytes.Reader
Provides methods to read BytesRefs from a frozen
PagedBytes.
|
class |
RoaringDocIdSet
DocIdSet implementation inspired from http://roaringbitmap.org/
The space is divided into blocks of 2^16 bits and each block is encoded
independently. |
private static class |
RoaringDocIdSet.ShortArrayDocIdSet
DocIdSet implementation that can store documents up to 2^16-1 in a short[]. |
class |
SparseFixedBitSet
A bit set that only stores longs that have at least one bit which is set.
|
Modifier and Type | Method and Description |
---|---|
static Accountable |
Accountables.namedAccountable(java.lang.String description,
Accountable in)
Augments an existing accountable with the provided description.
|
static Accountable |
Accountables.namedAccountable(java.lang.String description,
java.util.Collection<Accountable> children,
long bytes)
Returns an accountable with the provided description, children and bytes.
|
static Accountable |
Accountables.namedAccountable(java.lang.String description,
long bytes)
Returns an accountable with the provided description and bytes.
|
Modifier and Type | Method and Description |
---|---|
default java.util.Collection<Accountable> |
Accountable.getChildResources()
Returns nested resources of this class.
|
static java.util.Collection<Accountable> |
Accountables.namedAccountables(java.lang.String prefix,
java.util.Map<?,? extends Accountable> in)
Converts a map of resources to a collection.
|
Modifier and Type | Method and Description |
---|---|
static Accountable |
Accountables.namedAccountable(java.lang.String description,
Accountable in)
Augments an existing accountable with the provided description.
|
static long |
RamUsageEstimator.sizeOf(Accountable[] accountables)
Return the size of the provided array of
Accountable s by summing
up the shallow size of the array and the
memory usage reported by each
Accountable . |
static java.lang.String |
Accountables.toString(Accountable a)
Returns a String description of an Accountable and any nested resources.
|
private static java.lang.StringBuilder |
Accountables.toString(java.lang.StringBuilder dest,
Accountable a,
int depth) |
Modifier and Type | Method and Description |
---|---|
static Accountable |
Accountables.namedAccountable(java.lang.String description,
java.util.Collection<Accountable> children,
long bytes)
Returns an accountable with the provided description, children and bytes.
|
static java.util.Collection<Accountable> |
Accountables.namedAccountables(java.lang.String prefix,
java.util.Map<?,? extends Accountable> in)
Converts a map of resources to a collection.
|
Modifier and Type | Class and Description |
---|---|
class |
Automaton
Represents an automaton and all its states and transitions.
|
Modifier and Type | Class and Description |
---|---|
class |
BKDReader
Handles intersection of an multi-dimensional shape in byte[] space with a block KD-tree previously written with
BKDWriter . |
Modifier and Type | Interface and Description |
---|---|
interface |
FSTStore
Abstraction for reading/writing bytes necessary for FST.
|
Modifier and Type | Class and Description |
---|---|
(package private) class |
BytesStore |
class |
FST<T>
Represents an finite state machine (FST), using a
compact byte[] format.
|
class |
OffHeapFSTStore
Provides off heap storage of finite state machine (FST),
using underlying index input instead of byte store on heap
|
class |
OnHeapFSTStore
Provides storage of finite state machine (FST),
using byte array or byte store allocated on heap.
|
Modifier and Type | Class and Description |
---|---|
class |
AbstractPagedMutable<T extends AbstractPagedMutable<T>>
Base implementation for
PagedMutable and PagedGrowableWriter . |
class |
BlockPackedReader
Provides random access to a stream written with
BlockPackedWriter . |
(package private) class |
DeltaPackedLongValues |
(package private) static class |
DeltaPackedLongValues.Builder |
(package private) class |
Direct16
Direct wrapping of 16-bits values to a backing array.
|
(package private) class |
Direct32
Direct wrapping of 32-bits values to a backing array.
|
(package private) class |
Direct64
Direct wrapping of 64-bits values to a backing array.
|
(package private) class |
Direct8
Direct wrapping of 8-bits values to a backing array.
|
static class |
DirectMonotonicReader.Meta
In-memory metadata that needs to be kept around for
DirectMonotonicReader to read data from disk. |
(package private) class |
DirectPacked64SingleBlockReader |
(package private) class |
DirectPackedReader |
class |
GrowableWriter
Implements
PackedInts.Mutable , but grows the
bit count of the underlying packed ints on-demand. |
class |
MonotonicBlockPackedReader
Provides random access to a stream written with
MonotonicBlockPackedWriter . |
(package private) class |
MonotonicLongValues |
(package private) static class |
MonotonicLongValues.Builder |
(package private) class |
Packed16ThreeBlocks
Packs integers into 3 shorts (48 bits per value).
|
(package private) class |
Packed64
Space optimized random access capable array of values with a fixed number of
bits/value.
|
(package private) class |
Packed64SingleBlock
This class is similar to
Packed64 except that it trades space for
speed by ensuring that a single block needs to be read/written in order to
read/write a value. |
(package private) static class |
Packed64SingleBlock.Packed64SingleBlock1 |
(package private) static class |
Packed64SingleBlock.Packed64SingleBlock10 |
(package private) static class |
Packed64SingleBlock.Packed64SingleBlock12 |
(package private) static class |
Packed64SingleBlock.Packed64SingleBlock16 |
(package private) static class |
Packed64SingleBlock.Packed64SingleBlock2 |
(package private) static class |
Packed64SingleBlock.Packed64SingleBlock21 |
(package private) static class |
Packed64SingleBlock.Packed64SingleBlock3 |
(package private) static class |
Packed64SingleBlock.Packed64SingleBlock32 |
(package private) static class |
Packed64SingleBlock.Packed64SingleBlock4 |
(package private) static class |
Packed64SingleBlock.Packed64SingleBlock5 |
(package private) static class |
Packed64SingleBlock.Packed64SingleBlock6 |
(package private) static class |
Packed64SingleBlock.Packed64SingleBlock7 |
(package private) static class |
Packed64SingleBlock.Packed64SingleBlock8 |
(package private) static class |
Packed64SingleBlock.Packed64SingleBlock9 |
(package private) class |
Packed8ThreeBlocks
Packs integers into 3 bytes (24 bits per value).
|
static class |
PackedInts.Mutable
A packed integer array that can be modified.
|
(package private) static class |
PackedInts.MutableImpl |
static class |
PackedInts.NullReader
A
PackedInts.Reader which has all its values equal to 0 (bitsPerValue = 0). |
static class |
PackedInts.Reader
A read-only random access array of positive integers.
|
(package private) static class |
PackedInts.ReaderImpl
A simple base for Readers that keeps track of valueCount and bitsPerValue.
|
class |
PackedLongValues
Utility class to compress integers into a
LongValues instance. |
static class |
PackedLongValues.Builder
A Builder for a
PackedLongValues instance. |
class |
PagedGrowableWriter
|
class |
PagedMutable
A
PagedMutable . |