Uses of Package
org.apache.lucene.store
-
Packages that use org.apache.lucene.store Package Description org.apache.lucene.analysis.hunspell Stemming TokenFilter using a Java implementation of the Hunspell stemming algorithm.org.apache.lucene.analysis.synonym Analysis components for Synonyms.org.apache.lucene.classification.utils Utilities for evaluation, data preparation, etc.org.apache.lucene.codecs Codecs API: API for customization of the encoding and structure of the index.org.apache.lucene.codecs.blockterms Pluggable term index / block terms dictionary implementations.org.apache.lucene.codecs.blocktree BlockTree terms dictionary.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 Seeorg.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 Components from the Lucene 8.0 index format Seeorg.apache.lucene.codecs.lucene84
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.misc Miscellaneous index tools.org.apache.lucene.monitor Monitoring frameworkorg.apache.lucene.search Code to search indices.org.apache.lucene.search.spell Suggest alternate spellings for words.org.apache.lucene.search.suggest Support for Autocomplete/Autosuggestorg.apache.lucene.search.suggest.analyzing Analyzer based autosuggest.org.apache.lucene.search.suggest.document Support for document suggestionorg.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 transducersorg.apache.lucene.util.packed Packed integer arrays and streams. -
Classes in org.apache.lucene.store used by org.apache.lucene.analysis.hunspell Class Description ByteArrayDataInput DataInput backed by a byte array.Directory ADirectory
provides an abstraction layer for storing a list of files. -
Classes in org.apache.lucene.store used by org.apache.lucene.analysis.synonym Class Description ByteArrayDataInput DataInput backed by a byte array. -
Classes in org.apache.lucene.store used by org.apache.lucene.classification.utils Class Description Directory ADirectory
provides an abstraction layer for storing a list of files. -
Classes in org.apache.lucene.store used by org.apache.lucene.codecs Class Description ChecksumIndexInput Extension of IndexInput, computing checksum as it goes.DataInput Abstract base class for performing read operations of Lucene's low-level data types.DataOutput Abstract base class for performing write operations of Lucene's low-level data types.Directory ADirectory
provides an abstraction layer for storing a list of files.IndexInput Abstract base class for input from a file in aDirectory
.IndexOutput ADataOutput
for appending data to a file in aDirectory
.IOContext IOContext holds additional details on the merge/search context.RAMOutputStream Deprecated.This class uses inefficient synchronization and is discouraged in favor ofMMapDirectory
. -
Classes in org.apache.lucene.store used by org.apache.lucene.codecs.blockterms Class Description ByteArrayDataInput DataInput backed by a byte array.IndexInput Abstract base class for input from a file in aDirectory
.IndexOutput ADataOutput
for appending data to a file in aDirectory
.RAMOutputStream Deprecated.This class uses inefficient synchronization and is discouraged in favor ofMMapDirectory
. -
Classes in org.apache.lucene.store used by org.apache.lucene.codecs.blocktree Class Description ByteArrayDataInput DataInput backed by a byte array.IndexInput Abstract base class for input from a file in aDirectory
.IndexOutput ADataOutput
for appending data to a file in aDirectory
.RAMOutputStream Deprecated.This class uses inefficient synchronization and is discouraged in favor ofMMapDirectory
. -
Classes in org.apache.lucene.store used by org.apache.lucene.codecs.blocktreeords Class Description ByteArrayDataInput DataInput backed by a byte array.DataInput Abstract base class for performing read operations of Lucene's low-level data types.DataOutput Abstract base class for performing write operations of Lucene's low-level data types.IndexInput Abstract base class for input from a file in aDirectory
.IndexOutput ADataOutput
for appending data to a file in aDirectory
.RAMOutputStream Deprecated.This class uses inefficient synchronization and is discouraged in favor ofMMapDirectory
. -
Classes in org.apache.lucene.store used by org.apache.lucene.codecs.bloom Class Description DataInput Abstract base class for performing read operations of Lucene's low-level data types.DataOutput Abstract base class for performing write operations of Lucene's low-level data types.IndexOutput ADataOutput
for appending data to a file in aDirectory
. -
Classes in org.apache.lucene.store used by org.apache.lucene.codecs.compressing Class Description AlreadyClosedException This exception is thrown when there is an attempt to access something that has already been closed.ByteArrayDataInput DataInput backed by a byte array.DataInput Abstract base class for performing read operations of Lucene's low-level data types.DataOutput Abstract base class for performing write operations of Lucene's low-level data types.Directory ADirectory
provides an abstraction layer for storing a list of files.GrowableByteArrayDataOutput ADataOutput
that can be used to build a byte[].IndexInput Abstract base class for input from a file in aDirectory
.IndexOutput ADataOutput
for appending data to a file in aDirectory
.IOContext IOContext holds additional details on the merge/search context. -
Classes in org.apache.lucene.store used by org.apache.lucene.codecs.idversion Class Description ByteArrayDataInput DataInput backed by a byte array.DataInput Abstract base class for performing read operations of Lucene's low-level data types.DataOutput Abstract base class for performing write operations of Lucene's low-level data types.IndexInput Abstract base class for input from a file in aDirectory
.IndexOutput ADataOutput
for appending data to a file in aDirectory
.RAMOutputStream Deprecated.This class uses inefficient synchronization and is discouraged in favor ofMMapDirectory
. -
Classes in org.apache.lucene.store used by org.apache.lucene.codecs.lucene50 Class Description ByteArrayDataInput DataInput backed by a byte array.DataInput Abstract base class for performing read operations of Lucene's low-level data types.DataOutput Abstract base class for performing write operations of Lucene's low-level data types.Directory ADirectory
provides an abstraction layer for storing a list of files.IndexInput Abstract base class for input from a file in aDirectory
.IndexOutput ADataOutput
for appending data to a file in aDirectory
.IOContext IOContext holds additional details on the merge/search context.Lock An interprocess mutex lock. -
Classes in org.apache.lucene.store used by org.apache.lucene.codecs.lucene60 Class Description Directory ADirectory
provides an abstraction layer for storing a list of files.IndexInput Abstract base class for input from a file in aDirectory
.IndexOutput ADataOutput
for appending data to a file in aDirectory
.IOContext IOContext holds additional details on the merge/search context. -
Classes in org.apache.lucene.store used by org.apache.lucene.codecs.lucene70 Class Description ChecksumIndexInput Extension of IndexInput, computing checksum as it goes.Directory ADirectory
provides an abstraction layer for storing a list of files.GrowableByteArrayDataOutput ADataOutput
that can be used to build a byte[].IndexInput Abstract base class for input from a file in aDirectory
.IndexOutput ADataOutput
for appending data to a file in aDirectory
.IOContext IOContext holds additional details on the merge/search context.RandomAccessInput Random Access Index API. -
Classes in org.apache.lucene.store used by org.apache.lucene.codecs.lucene80 Class Description ByteBuffersDataOutput ADataOutput
storing data in a list ofByteBuffer
s.ChecksumIndexInput Extension of IndexInput, computing checksum as it goes.IndexInput Abstract base class for input from a file in aDirectory
.IndexOutput ADataOutput
for appending data to a file in aDirectory
.RandomAccessInput Random Access Index API. -
Classes in org.apache.lucene.store used by org.apache.lucene.codecs.lucene84 Class Description ByteArrayDataInput DataInput backed by a byte array.ByteBuffersDataOutput ADataOutput
storing data in a list ofByteBuffer
s.DataInput Abstract base class for performing read operations of Lucene's low-level data types.DataOutput Abstract base class for performing write operations of Lucene's low-level data types.IndexInput Abstract base class for input from a file in aDirectory
.IndexOutput ADataOutput
for appending data to a file in aDirectory
. -
Classes in org.apache.lucene.store used by org.apache.lucene.codecs.memory Class Description ByteArrayDataInput DataInput backed by a byte array.DataInput Abstract base class for performing read operations of Lucene's low-level data types.DataOutput Abstract base class for performing write operations of Lucene's low-level data types.IndexInput Abstract base class for input from a file in aDirectory
.IndexOutput ADataOutput
for appending data to a file in aDirectory
.RAMOutputStream Deprecated.This class uses inefficient synchronization and is discouraged in favor ofMMapDirectory
. -
Classes in org.apache.lucene.store used by org.apache.lucene.codecs.simpletext Class Description ChecksumIndexInput Extension of IndexInput, computing checksum as it goes.DataInput Abstract base class for performing read operations of Lucene's low-level data types.DataOutput Abstract base class for performing write operations of Lucene's low-level data types.Directory ADirectory
provides an abstraction layer for storing a list of files.IndexInput Abstract base class for input from a file in aDirectory
.IndexOutput ADataOutput
for appending data to a file in aDirectory
.IOContext IOContext holds additional details on the merge/search context.TrackingDirectoryWrapper A delegating Directory that records which files were written to and deleted. -
Classes in org.apache.lucene.store used by org.apache.lucene.codecs.uniformsplit Class Description ByteArrayDataInput DataInput backed by a byte array.ByteBuffersDataOutput ADataOutput
storing data in a list ofByteBuffer
s.DataInput Abstract base class for performing read operations of Lucene's low-level data types.DataOutput Abstract base class for performing write operations of Lucene's low-level data types.IndexInput Abstract base class for input from a file in aDirectory
.IndexOutput ADataOutput
for appending data to a file in aDirectory
. -
Classes in org.apache.lucene.store used by org.apache.lucene.codecs.uniformsplit.sharedterms Class Description DataInput Abstract base class for performing read operations of Lucene's low-level data types.DataOutput Abstract base class for performing write operations of Lucene's low-level data types.IndexInput Abstract base class for input from a file in aDirectory
.IndexOutput ADataOutput
for appending data to a file in aDirectory
. -
Classes in org.apache.lucene.store used by org.apache.lucene.index Class Description AlreadyClosedException This exception is thrown when there is an attempt to access something that has already been closed.ChecksumIndexInput Extension of IndexInput, computing checksum as it goes.DataInput Abstract base class for performing read operations of Lucene's low-level data types.DataOutput Abstract base class for performing write operations of Lucene's low-level data types.Directory ADirectory
provides an abstraction layer for storing a list of files.FilterDirectory Directory implementation that delegates calls to another directory.FSDirectory Base class for Directory implementations that store index files in the file system.IndexInput Abstract base class for input from a file in aDirectory
.IndexOutput ADataOutput
for appending data to a file in aDirectory
.IOContext IOContext holds additional details on the merge/search context.Lock An interprocess mutex lock.MergeInfo A MergeInfo provides information required for a MERGE context.RAMFile Deprecated.This class uses inefficient synchronization and is discouraged in favor ofMMapDirectory
.RAMOutputStream Deprecated.This class uses inefficient synchronization and is discouraged in favor ofMMapDirectory
.RateLimiter Abstract base class to rate limit IO.TrackingDirectoryWrapper A delegating Directory that records which files were written to and deleted. -
Classes in org.apache.lucene.store used by org.apache.lucene.misc Class Description Directory ADirectory
provides an abstraction layer for storing a list of files. -
Classes in org.apache.lucene.store used by org.apache.lucene.monitor Class Description Directory ADirectory
provides an abstraction layer for storing a list of files. -
Classes in org.apache.lucene.store used by org.apache.lucene.search Class Description Directory ADirectory
provides an abstraction layer for storing a list of files. -
Classes in org.apache.lucene.store used by org.apache.lucene.search.spell Class Description Directory ADirectory
provides an abstraction layer for storing a list of files. -
Classes in org.apache.lucene.store used by org.apache.lucene.search.suggest Class Description ByteArrayDataInput DataInput backed by a byte array.ByteArrayDataOutput DataOutput backed by a byte array.DataInput Abstract base class for performing read operations of Lucene's low-level data types.DataOutput Abstract base class for performing write operations of Lucene's low-level data types.Directory ADirectory
provides an abstraction layer for storing a list of files.IndexOutput ADataOutput
for appending data to a file in aDirectory
. -
Classes in org.apache.lucene.store used by org.apache.lucene.search.suggest.analyzing Class Description ByteArrayDataInput DataInput backed by a byte array.DataInput Abstract base class for performing read operations of Lucene's low-level data types.DataOutput Abstract base class for performing write operations of Lucene's low-level data types.Directory ADirectory
provides an abstraction layer for storing a list of files. -
Classes in org.apache.lucene.store used by org.apache.lucene.search.suggest.document Class Description DataOutput Abstract base class for performing write operations of Lucene's low-level data types.IndexInput Abstract base class for input from a file in aDirectory
.IndexOutput ADataOutput
for appending data to a file in aDirectory
. -
Classes in org.apache.lucene.store used by org.apache.lucene.search.suggest.fst Class Description ByteArrayDataInput DataInput backed by a byte array.ByteArrayDataOutput DataOutput backed by a byte array.DataInput Abstract base class for performing read operations of Lucene's low-level data types.DataOutput Abstract base class for performing write operations of Lucene's low-level data types.Directory ADirectory
provides an abstraction layer for storing a list of files.IndexOutput ADataOutput
for appending data to a file in aDirectory
. -
Classes in org.apache.lucene.store used by org.apache.lucene.search.suggest.jaspell Class Description DataInput Abstract base class for performing read operations of Lucene's low-level data types.DataOutput Abstract base class for performing write operations of Lucene's low-level data types. -
Classes in org.apache.lucene.store used by org.apache.lucene.search.suggest.tst Class Description DataInput Abstract base class for performing read operations of Lucene's low-level data types.DataOutput Abstract base class for performing write operations of Lucene's low-level data types.Directory ADirectory
provides an abstraction layer for storing a list of files. -
Classes in org.apache.lucene.store used by org.apache.lucene.store Class Description AlreadyClosedException This exception is thrown when there is an attempt to access something that has already been closed.BaseDirectory Base implementation for a concreteDirectory
that uses aLockFactory
for locking.BufferedIndexInput Base implementation class for bufferedIndexInput
.BufferedIndexInput.SlicedIndexInput Implementation of an IndexInput that reads from a portion of a file.ByteBufferGuard A guard that is created for everyByteBufferIndexInput
that tries on best effort to reject any access to theByteBuffer
behind, once it is unmapped.ByteBufferGuard.BufferCleaner Pass in an implementation of this interface to cleanup ByteBuffers.ByteBufferIndexInput Base IndexInput implementation that uses an array of ByteBuffers to represent a file.ByteBuffersDataInput ByteBuffersDataOutput ADataOutput
storing data in a list ofByteBuffer
s.ByteBuffersDirectory.FileEntry ByteBuffersIndexInput ChecksumIndexInput Extension of IndexInput, computing checksum as it goes.DataInput Abstract base class for performing read operations of Lucene's low-level data types.DataOutput Abstract base class for performing write operations of Lucene's low-level data types.Directory ADirectory
provides an abstraction layer for storing a list of files.FilterDirectory Directory implementation that delegates calls to another directory.FlushInfo A FlushInfo provides information required for a FLUSH context.FSDirectory Base class for Directory implementations that store index files in the file system.FSLockFactory Base class for file system based locking implementation.IndexInput Abstract base class for input from a file in aDirectory
.IndexOutput ADataOutput
for appending data to a file in aDirectory
.IOContext IOContext holds additional details on the merge/search context.IOContext.Context Context is a enumerator which specifies the context in which the Directory is being used for.Lock An interprocess mutex lock.LockFactory Base class for Locking implementation.MergeInfo A MergeInfo provides information required for a MERGE context.NativeFSLockFactory ImplementsLockFactory
using native OS file locks.NativeUnixDirectory.NativeUnixIndexInput NIOFSDirectory.NIOFSIndexInput Reads bytes withFileChannel.read(ByteBuffer, long)
NoLockFactory Use thisLockFactory
to disable locking entirely.NoLockFactory.NoLock OutputStreamIndexOutput Implementation class for bufferedIndexOutput
that writes to anOutputStream
.RAFDirectory.RAFIndexInput Reads bytes withRandomAccessFile.seek(long)
followed byRandomAccessFile.read(byte[], int, int)
.RAMDirectory Deprecated.This class uses inefficient synchronization and is discouraged in favor ofMMapDirectory
.RAMFile Deprecated.This class uses inefficient synchronization and is discouraged in favor ofMMapDirectory
.RandomAccessInput Random Access Index API.RateLimiter Abstract base class to rate limit IO.SimpleFSDirectory.SimpleFSIndexInput Reads bytes withSeekableByteChannel.read(ByteBuffer)
SimpleFSLockFactory ImplementsLockFactory
usingFiles.createFile(java.nio.file.Path, java.nio.file.attribute.FileAttribute<?>...)
.WindowsDirectory.WindowsIndexInput -
Classes in org.apache.lucene.store used by org.apache.lucene.util Class Description ChecksumIndexInput Extension of IndexInput, computing checksum as it goes.DataInput Abstract base class for performing read operations of Lucene's low-level data types.DataOutput Abstract base class for performing write operations of Lucene's low-level data types.Directory ADirectory
provides an abstraction layer for storing a list of files.FSDirectory Base class for Directory implementations that store index files in the file system.IndexInput Abstract base class for input from a file in aDirectory
.IndexOutput ADataOutput
for appending data to a file in aDirectory
.LockFactory Base class for Locking implementation. -
Classes in org.apache.lucene.store used by org.apache.lucene.util.bkd Class Description ByteArrayDataInput DataInput backed by a byte array.DataInput Abstract base class for performing read operations of Lucene's low-level data types.DataOutput Abstract base class for performing write operations of Lucene's low-level data types.Directory ADirectory
provides an abstraction layer for storing a list of files.GrowableByteArrayDataOutput ADataOutput
that can be used to build a byte[].IndexInput Abstract base class for input from a file in aDirectory
.IndexOutput ADataOutput
for appending data to a file in aDirectory
.RAMOutputStream Deprecated.This class uses inefficient synchronization and is discouraged in favor ofMMapDirectory
.TrackingDirectoryWrapper A delegating Directory that records which files were written to and deleted. -
Classes in org.apache.lucene.store used by org.apache.lucene.util.fst Class Description ByteArrayDataOutput DataOutput backed by a byte array.DataInput Abstract base class for performing read operations of Lucene's low-level data types.DataOutput Abstract base class for performing write operations of Lucene's low-level data types.IndexInput Abstract base class for input from a file in aDirectory
.RandomAccessInput Random Access Index API. -
Classes in org.apache.lucene.store used by org.apache.lucene.util.packed Class Description DataInput Abstract base class for performing read operations of Lucene's low-level data types.DataOutput Abstract base class for performing write operations of Lucene's low-level data types.IndexInput Abstract base class for input from a file in aDirectory
.IndexOutput ADataOutput
for appending data to a file in aDirectory
.RandomAccessInput Random Access Index API.