Uses of Package
org.apache.lucene.util
Package
Description
Text analysis.
Fast, general-purpose grammar-based tokenizer
StandardTokenizer
implements the Word Break rules from the
Unicode Text Segmentation algorithm, as specified in Unicode Standard Annex #29.General-purpose attributes for text analysis.
Codecs API: API for customization of the encoding and structure of the index.
Compressing helper classes.
Lucene 9.0 file format.
BlockTree terms dictionary.
Lucene 9.0 compressing format.
Lucene 9.1 file format.
Postings format that can delegate to different formats per-field.
The logical representation of a
Document
for indexing and
searching.Code to maintain and access indices.
Code to search indices.
Binary i/o API, used for all index data.
Some utility classes.
Finite-state automaton for regular expressions.
Block KD-tree, implementing the generic spatial data structure described in this paper.
Finite state transducers
Utility classes for working with token streams as graphs.
Navigable Small-World graph, nominally Hierarchical but currently only has a single layer.
Comparable object wrappers
Packed integer arrays and streams.
-
ClassDescriptionAn AttributeFactory creates instances of
AttributeImpl
s.An AttributeSource contains a list of differentAttributeImpl
s, and methods to add and get them.Represents byte[], as a slice (offset + length) into an existing byte[].Annotation to not test a class or constructor withTestRandomChains
integration test.Abstraction for loading resources (streams, files, and classes).An object with this interface is a wrapper around another object (e.g., a filter with a delegate).Use by certain classes to match version compatibility across releases of Lucene. -
ClassDescriptionAn AttributeFactory creates instances of
AttributeImpl
s.An AttributeSource contains a list of differentAttributeImpl
s, and methods to add and get them. -
ClassDescriptionBase interface for attributes.Base class for Attributes that can be added to a
AttributeSource
.This interface is used to reflect contents ofAttributeSource
orAttributeImpl
.Represents byte[], as a slice (offset + length) into an existing byte[].A builder forBytesRef
instances. -
ClassDescriptionAn object whose RAM usage can be computed.Interface for Bitset-like structures.Represents byte[], as a slice (offset + length) into an existing byte[].BitSet of fixed length (numBits), backed by accessible (
FixedBitSet.getBits()
) long[], accessed with an int index, implementingBits
andDocIdSet
.Interface to supportNamedSPILoader.lookup(String)
by name. -
-
ClassDescriptionInterface for Bitset-like structures.Represents byte[], as a slice (offset + length) into an existing byte[].Interface to support
NamedSPILoader.lookup(String)
by name. -
-
ClassDescriptionAn object whose RAM usage can be computed.Represents byte[], as a slice (offset + length) into an existing byte[].
-
ClassDescriptionAn object whose RAM usage can be computed.Interface for Bitset-like structures.Interface to support
NamedSPILoader.lookup(String)
by name. -
ClassDescriptionAn object whose RAM usage can be computed.Interface for Bitset-like structures.Interface to support
NamedSPILoader.lookup(String)
by name. -
-
ClassDescriptionAn object whose RAM usage can be computed.An AttributeSource contains a list of different
AttributeImpl
s, and methods to add and get them.Interface for Bitset-like structures.Represents byte[], as a slice (offset + length) into an existing byte[].A builder forBytesRef
instances.A simple iterator interface forBytesRef
iteration.BitSet of fixed length (numBits), backed by accessible (FixedBitSet.getBits()
) long[], accessed with an int index, implementingBits
andDocIdSet
.Debugging API for Lucene classes such asIndexWriter
andSegmentInfos
.This is a result supplier that is allowed to throw an IOException.Abstraction over an array of longs.Interface to supportNamedSPILoader.lookup(String)
by name.Annotation to suppress forbidden-apis errors inside a whole class, a method, or a field.An object with this interface is a wrapper around another object (e.g., a filter with a delegate).Use by certain classes to match version compatibility across releases of Lucene. -
ClassDescriptionAn object whose RAM usage can be computed.Base interface for attributes.Base class for Attributes that can be added to a
AttributeSource
.This interface is used to reflect contents ofAttributeSource
orAttributeImpl
.An AttributeSource contains a list of differentAttributeImpl
s, and methods to add and get them.Interface for Bitset-like structures.Represents byte[], as a slice (offset + length) into an existing byte[].A simple iterator interface forBytesRef
iteration.Simple counter classThis is a result supplier that is allowed to throw an IOException.Interface to supportNamedSPILoader.lookup(String)
by name.A priority queue maintains a partial ordering of its elements such that the least element can always be found in constant time.An object with this interface is a wrapper around another object (e.g., a filter with a delegate). -
ClassDescriptionAn object whose RAM usage can be computed.Annotation to suppress forbidden-apis errors inside a whole class, a method, or a field.
-
ClassDescriptionAn object whose RAM usage can be computed.Comparator for a fixed number of bytes.Base interface for attributes.An AttributeFactory creates instances of
AttributeImpl
s.Base class for Attributes that can be added to aAttributeSource
.This interface is used to reflect contents ofAttributeSource
orAttributeImpl
.An AttributeSource contains a list of differentAttributeImpl
s, and methods to add and get them.This class holds the state of an AttributeSource.Interface for Bitset-like structures.Base implementation for a bit set.Class that Posting and PostingVector use to write byte streams into shared fixed-size byte[] arrays.Abstract class for allocating and freeing byte blocks.Represents byte[], as a slice (offset + length) into an existing byte[].An extension ofBytesRefIterator
that allows retrieving the index of the current elementUsed to iterate the elements of an array in a given order.A builder forBytesRef
instances.Manages allocation of the per-term addresses.A simple iterator interface forBytesRef
iteration.Represents char[], as a slice (offset + length) into an existing char[].A builder forCharsRef
instances.Simple counter classUtility class to efficiently add many docs in one go.BitSet of fixed length (numBits), backed by accessible (FixedBitSet.getBits()
) long[], accessed with an int index, implementingBits
andDocIdSet
.Debugging API for Lucene classes such asIndexWriter
andSegmentInfos
.A pool for int blocks similar toByteBlockPool
Abstract class for allocating and freeing int blocks.Represents int[], as a slice (offset + length) into an existing int[].Deprecated, for removal: This API element is subject to removal in a future version.Deprecated, for removal: This API element is subject to removal in a future version.was replaced byIOFunction
.BitSet of fixed length (numBits), backed by accessible (LongBitSet.getBits()
) long[], accessed with a long index.A min heap that stores longs; a primitive priority queue that like all priority queues maintains a partial ordering of its elements such that the least element can always be found in constant time.Represents long[], as a slice (offset + length) into an existing long[].Abstraction over an array of longs.Radix sorter for variable-length strings.Interface to supportNamedSPILoader.lookup(String)
by name.A bit more descriptive unit for constructors.Utility class to read length-prefixed byte[] entries from an input.Utility class to emit length-prefixed byte[] entries to an output stream for sorting.Input that transparently iterates over pagesOutput that transparently spills to new pages as necessaryProvides methods to read BytesRefs from a frozen PagedBytes.Wraps a term and boostAbstraction for loading resources (streams, files, and classes).DocIdSet
implementation inspired from http://roaringbitmap.org/A builder ofRoaringDocIdSet
s.Implement to reset an instanceAn implementation of a selection algorithm, ie.Base class for sorting algorithms implementations.A bit set that only stores longs that have at least one bit which is set.Annotation to suppress forbidden-apis errors inside a whole class, a method, or a field.Use by certain classes to match version compatibility across releases of Lucene.A utility for keeping backwards compatibility on previously abstract methods (or similar replacements).Implements a combination ofWeakHashMap
andIdentityHashMap
. -
ClassDescriptionAn object whose RAM usage can be computed.Represents byte[], as a slice (offset + length) into an existing byte[].A builder for
BytesRef
instances.Represents char[], as a slice (offset + length) into an existing char[].Represents int[], as a slice (offset + length) into an existing int[]. -
ClassDescriptionRepresents byte[], as a slice (offset + length) into an existing byte[].BitSet of fixed length (numBits), backed by accessible (
FixedBitSet.getBits()
) long[], accessed with an int index, implementingBits
andDocIdSet
. -
ClassDescriptionAn object whose RAM usage can be computed.Represents byte[], as a slice (offset + length) into an existing byte[].A builder for
BytesRef
instances.Represents char[], as a slice (offset + length) into an existing char[].Represents int[], as a slice (offset + length) into an existing int[].A builder forIntsRef
instances.Annotation to suppress forbidden-apis errors inside a whole class, a method, or a field. -
ClassDescriptionAn AttributeSource contains a list of different
AttributeImpl
s, and methods to add and get them. -
ClassDescriptionInterface for Bitset-like structures.Debugging API for Lucene classes such as
IndexWriter
andSegmentInfos
. -
-
ClassDescriptionAn object whose RAM usage can be computed.Represents long[], as a slice (offset + length) into an existing long[].Abstraction over an array of longs.
IOConsumer
.