Uses of Package
org.apache.lucene.index
-
Packages that use org.apache.lucene.index Package Description org.apache.lucene.analysis API and code to convert text into indexable/searchable tokens.org.apache.lucene.analysis.payloads Provides various convenience classes for creating payloads on Tokens.org.apache.lucene.analysis.query Automatically filter high-frequency stopwords.org.apache.lucene.analysis.tokenattributes UsefulAttribute
s for text analysis.org.apache.lucene.benchmark.byTask Benchmarking Lucene By Tasks.org.apache.lucene.benchmark.byTask.tasks Extendable benchmark tasks.org.apache.lucene.document The logical representation of aDocument
for indexing and searching.org.apache.lucene.facet.enhancements Enhanced category featuresorg.apache.lucene.facet.enhancements.association Association category enhancementsorg.apache.lucene.facet.index Indexing of document categoriesorg.apache.lucene.facet.index.params Indexing-time specifications for handling facetsorg.apache.lucene.facet.index.streaming Expert: attributes streaming definition for indexing facetsorg.apache.lucene.facet.search Faceted Search APIorg.apache.lucene.facet.search.aggregator.association Association-based aggregators.org.apache.lucene.facet.search.cache Caching to speed up facets accumulation.org.apache.lucene.facet.search.params Parameters for Faceted Searchorg.apache.lucene.facet.search.params.association Association-based Parameters for Faceted Search.org.apache.lucene.facet.search.sampling Sampling for facets accumulationorg.apache.lucene.facet.taxonomy.directory Taxonomy implemented using a Lucene-Indexorg.apache.lucene.facet.util Various utilities for faceted searchorg.apache.lucene.index Code to maintain and access indices.org.apache.lucene.index.pruning Static Index Pruning Toolsorg.apache.lucene.misc Miscellaneous index tools.org.apache.lucene.queryParser A simple query parser implemented with JavaCC.org.apache.lucene.queryParser.complexPhrase QueryParser which permits complex phrase query syntax eg "(john jon jonathan~) peters*"org.apache.lucene.queryParser.surround.query This package contains SrndQuery and its subclasses.org.apache.lucene.search Code to search indices.org.apache.lucene.search.function Programmatic control over documents scores.org.apache.lucene.search.grouping This module enables search result grouping with Lucene, where hits with the same value in the specified single-valued group field are grouped together.org.apache.lucene.search.highlight The highlight package contains classes to provide "keyword in context" features typically used to highlight search terms in the text of results pages.org.apache.lucene.search.join This modules support index-time and query-time joins.org.apache.lucene.search.payloads The payloads package provides Query mechanisms for finding and using payloads.org.apache.lucene.search.regex Regular expression Query.org.apache.lucene.search.similar Document similarity query generators.org.apache.lucene.search.spans The calculus of spans.org.apache.lucene.search.spell Suggest alternate spellings for words.org.apache.lucene.search.vectorhighlight This is an another highlighter implementation.org.apache.lucene.spatial.geohash Support for Geohash encoding, decoding, and filtering.org.apache.lucene.spatial.tier Support for filtering based upon geographic location.org.apache.lucene.store Binary i/o API, used for all index data.org.apache.lucene.store.instantiated InstantiatedIndex, alternative RAM store for small corpora.org.apache.lucene.util Some utility classes. -
Classes in org.apache.lucene.index used by org.apache.lucene.analysis Class Description Payload A Payload is metadata that can be stored together with each occurrence of a term. -
Classes in org.apache.lucene.index used by org.apache.lucene.analysis.payloads Class Description Payload A Payload is metadata that can be stored together with each occurrence of a term. -
Classes in org.apache.lucene.index used by org.apache.lucene.analysis.query Class Description IndexReader IndexReader is an abstract class, providing an interface for accessing an index.Term A Term represents a word from text. -
Classes in org.apache.lucene.index used by org.apache.lucene.analysis.tokenattributes Class Description Payload A Payload is metadata that can be stored together with each occurrence of a term. -
Classes in org.apache.lucene.index used by org.apache.lucene.benchmark.byTask Class Description IndexReader IndexReader is an abstract class, providing an interface for accessing an index.IndexWriter AnIndexWriter
creates and maintains an index. -
Classes in org.apache.lucene.index used by org.apache.lucene.benchmark.byTask.tasks Class Description CorruptIndexException This exception is thrown when Lucene detects an inconsistency in the index.IndexCommit Expert: represents a single commit into an index as seen by theIndexDeletionPolicy
orIndexReader
.IndexDeletionPolicy Expert: policy for deletion of staleindex commits
.IndexReader IndexReader is an abstract class, providing an interface for accessing an index.IndexWriter AnIndexWriter
creates and maintains an index.IndexWriterConfig Holds all the configuration ofIndexWriter
.IndexWriterConfig.OpenMode Specifies the open mode forIndexWriter
:IndexWriterConfig.OpenMode.CREATE
- creates a new index or overwrites an existing one. -
Classes in org.apache.lucene.index used by org.apache.lucene.document Class Description FieldInfo.IndexOptions Controls how much information is stored in the postings lists. -
Classes in org.apache.lucene.index used by org.apache.lucene.facet.enhancements Class Description IndexReader IndexReader is an abstract class, providing an interface for accessing an index.Term A Term represents a word from text. -
Classes in org.apache.lucene.index used by org.apache.lucene.facet.enhancements.association Class Description IndexReader IndexReader is an abstract class, providing an interface for accessing an index.Term A Term represents a word from text. -
Classes in org.apache.lucene.index used by org.apache.lucene.facet.index Class Description IndexReader IndexReader is an abstract class, providing an interface for accessing an index.PayloadProcessorProvider Provides aPayloadProcessorProvider.ReaderPayloadProcessor
to be used for aDirectory
.PayloadProcessorProvider.PayloadProcessor Processes the given payload.PayloadProcessorProvider.ReaderPayloadProcessor Returns aPayloadProcessorProvider.PayloadProcessor
for a givenTerm
which allows processing the payloads of different terms differently.Term A Term represents a word from text. -
Classes in org.apache.lucene.index used by org.apache.lucene.facet.index.params Class Description IndexReader IndexReader is an abstract class, providing an interface for accessing an index.Term A Term represents a word from text. -
Classes in org.apache.lucene.index used by org.apache.lucene.facet.index.streaming Class Description Payload A Payload is metadata that can be stored together with each occurrence of a term. -
Classes in org.apache.lucene.index used by org.apache.lucene.facet.search Class Description IndexReader IndexReader is an abstract class, providing an interface for accessing an index.Term A Term represents a word from text. -
Classes in org.apache.lucene.index used by org.apache.lucene.facet.search.aggregator.association Class Description IndexReader IndexReader is an abstract class, providing an interface for accessing an index. -
Classes in org.apache.lucene.index used by org.apache.lucene.facet.search.cache Class Description IndexReader IndexReader is an abstract class, providing an interface for accessing an index. -
Classes in org.apache.lucene.index used by org.apache.lucene.facet.search.params Class Description IndexReader IndexReader is an abstract class, providing an interface for accessing an index. -
Classes in org.apache.lucene.index used by org.apache.lucene.facet.search.params.association Class Description IndexReader IndexReader is an abstract class, providing an interface for accessing an index. -
Classes in org.apache.lucene.index used by org.apache.lucene.facet.search.sampling Class Description IndexReader IndexReader is an abstract class, providing an interface for accessing an index. -
Classes in org.apache.lucene.index used by org.apache.lucene.facet.taxonomy.directory Class Description CorruptIndexException This exception is thrown when Lucene detects an inconsistency in the index.IndexReader IndexReader is an abstract class, providing an interface for accessing an index.IndexWriter AnIndexWriter
creates and maintains an index.IndexWriterConfig Holds all the configuration ofIndexWriter
.IndexWriterConfig.OpenMode Specifies the open mode forIndexWriter
:IndexWriterConfig.OpenMode.CREATE
- creates a new index or overwrites an existing one. -
Classes in org.apache.lucene.index used by org.apache.lucene.facet.util Class Description IndexReader IndexReader is an abstract class, providing an interface for accessing an index. -
Classes in org.apache.lucene.index used by org.apache.lucene.index Class Description BalancedSegmentMergePolicy.MergePolicyParams Deprecated.Specifies configuration parameters for BalancedSegmentMergePolicy.CheckIndex.Status Returned fromCheckIndex.checkIndex()
detailing the health and status of the index.CheckIndex.Status.FieldNormStatus Status from testing field norms.CheckIndex.Status.SegmentInfoStatus Holds the status of each segment in the index.CheckIndex.Status.StoredFieldStatus Status from testing stored fields.CheckIndex.Status.TermIndexStatus Status from testing term index.CheckIndex.Status.TermVectorStatus Status from testing stored fields.ConcurrentMergeScheduler.MergeThread CorruptIndexException This exception is thrown when Lucene detects an inconsistency in the index.FieldInfo Access to the Fieldable Info file that describes document fields and whether or not they are indexed.FieldInfo.IndexOptions Controls how much information is stored in the postings lists.FieldInfos Collection ofFieldInfo
s (accessible by number or by name).FilterIndexReader AFilterIndexReader
contains another IndexReader, which it uses as its basic source of data, possibly transforming the data along the way or providing additional functionality.FilterIndexReader.FilterTermDocs Base class for filteringTermDocs
implementations.IndexCommit Expert: represents a single commit into an index as seen by theIndexDeletionPolicy
orIndexReader
.IndexDeletionPolicy Expert: policy for deletion of staleindex commits
.IndexFileNameFilter Filename filter that accept filenames and extensions only created by Lucene.IndexReader IndexReader is an abstract class, providing an interface for accessing an index.IndexReader.ReaderClosedListener A custom listener that's invoked when the IndexReader is closed.IndexWriter AnIndexWriter
creates and maintains an index.IndexWriter.IndexReaderWarmer IfIndexWriter.getReader()
has been called (ie, this writer is in near real-time mode), then after a merge completes, this class can be invoked to warm the reader on the newly merged segment, before the merge commits.IndexWriter.MaxFieldLength Deprecated.useLimitTokenCountAnalyzer
instead.IndexWriterConfig Holds all the configuration ofIndexWriter
.IndexWriterConfig.OpenMode Specifies the open mode forIndexWriter
:IndexWriterConfig.OpenMode.CREATE
- creates a new index or overwrites an existing one.LogByteSizeMergePolicy This is aLogMergePolicy
that measures size of a segment as the total byte size of the segment's files.LogMergePolicy This class implements aMergePolicy
that tries to merge segments into levels of exponentially increasing size, where each level has fewer segments than the value of the merge factor.MergePolicy Expert: a MergePolicy determines the sequence of primitive merge operations.MergePolicy.MergeSpecification A MergeSpecification instance provides the information necessary to perform multiple merges.MergePolicy.OneMerge OneMerge provides the information necessary to perform an individual primitive merge operation, resulting in a single new segment.MergeScheduler Expert:IndexWriter
uses an instance implementing this interface to execute the merges selected by aMergePolicy
.MultiReader An IndexReader which reads multiple indexes, appending their content.PayloadProcessorProvider Provides aPayloadProcessorProvider.ReaderPayloadProcessor
to be used for aDirectory
.PayloadProcessorProvider.DirPayloadProcessor Deprecated.UsePayloadProcessorProvider.ReaderPayloadProcessor
instead.PayloadProcessorProvider.PayloadProcessor Processes the given payload.PayloadProcessorProvider.ReaderPayloadProcessor Returns aPayloadProcessorProvider.PayloadProcessor
for a givenTerm
which allows processing the payloads of different terms differently.PositionBasedTermVectorMapper.TVPositionInfo Container for a term at a positionSegmentInfo Information about a segment such as it's name, directory, and files related to the segment.SegmentInfos A collection of segmentInfo objects with methods for operating on those segments in relation to the file system.SegmentReader IndexReader implementation over a single segment.SegmentReader.CoreClosedListener Called when the shared core for this SegmentReader is closed.SnapshotDeletionPolicy AnIndexDeletionPolicy
that wraps around any otherIndexDeletionPolicy
and adds the ability to hold and later release snapshots of an index.StaleReaderException This exception is thrown when anIndexReader
tries to make changes to the index (viaIndexReader.deleteDocument(int)
,IndexReader.undeleteAll()
orIndexReader.setNorm(int, java.lang.String, byte)
) but changes have already been committed to the index since this reader was instantiated.Term A Term represents a word from text.TermDocs TermDocs provides an interface for enumerating <document, frequency> pairs for a term.TermEnum Abstract class for enumerating terms.TermFreqVector Provides access to stored term vector of a document field.TermPositions TermPositions provides an interface for enumerating the <document, frequency, <position>* > tuples for a term.TermVectorEntry Convenience class for holding TermVector information.TermVectorMapper The TermVectorMapper can be used to map Term Vectors into your own structure instead of the parallel array structure used byIndexReader.getTermFreqVector(int,String)
.TermVectorOffsetInfo The TermVectorOffsetInfo class holds information pertaining to a Term in aTermPositionVector
's offset information.TieredMergePolicy Merges segments of approximately equal size, subject to an allowed number of segments per tier.TieredMergePolicy.MergeScore Holds score and explanation for a single candidate merge. -
Classes in org.apache.lucene.index used by org.apache.lucene.index.pruning Class Description FieldInfos Collection ofFieldInfo
s (accessible by number or by name).IndexReader IndexReader is an abstract class, providing an interface for accessing an index.Term A Term represents a word from text.TermEnum Abstract class for enumerating terms.TermFreqVector Provides access to stored term vector of a document field.TermPositions TermPositions provides an interface for enumerating the <document, frequency, <position>* > tuples for a term. -
Classes in org.apache.lucene.index used by org.apache.lucene.misc Class Description FieldInvertState This class tracks the number and position / offset parameters of terms being added to the index.IndexReader IndexReader is an abstract class, providing an interface for accessing an index.Term A Term represents a word from text. -
Classes in org.apache.lucene.index used by org.apache.lucene.queryParser Class Description Term A Term represents a word from text. -
Classes in org.apache.lucene.index used by org.apache.lucene.queryParser.complexPhrase Class Description Term A Term represents a word from text. -
Classes in org.apache.lucene.index used by org.apache.lucene.queryParser.surround.query Class Description IndexReader IndexReader is an abstract class, providing an interface for accessing an index.Term A Term represents a word from text.TermEnum Abstract class for enumerating terms. -
Classes in org.apache.lucene.index used by org.apache.lucene.search Class Description CorruptIndexException This exception is thrown when Lucene detects an inconsistency in the index.FieldInvertState This class tracks the number and position / offset parameters of terms being added to the index.IndexReader IndexReader is an abstract class, providing an interface for accessing an index.IndexWriter AnIndexWriter
creates and maintains an index.Term A Term represents a word from text.TermEnum Abstract class for enumerating terms.TermFreqVector Provides access to stored term vector of a document field. -
Classes in org.apache.lucene.index used by org.apache.lucene.search.function Class Description IndexReader IndexReader is an abstract class, providing an interface for accessing an index.Term A Term represents a word from text. -
Classes in org.apache.lucene.index used by org.apache.lucene.search.grouping Class Description IndexReader IndexReader is an abstract class, providing an interface for accessing an index. -
Classes in org.apache.lucene.index used by org.apache.lucene.search.highlight Class Description IndexReader IndexReader is an abstract class, providing an interface for accessing an index.TermPositionVector ExtendsTermFreqVector
to provide additional information about positions in which each of the terms is found. -
Classes in org.apache.lucene.index used by org.apache.lucene.search.join Class Description IndexReader IndexReader is an abstract class, providing an interface for accessing an index.Term A Term represents a word from text. -
Classes in org.apache.lucene.index used by org.apache.lucene.search.payloads Class Description IndexReader IndexReader is an abstract class, providing an interface for accessing an index.Term A Term represents a word from text.TermPositions TermPositions provides an interface for enumerating the <document, frequency, <position>* > tuples for a term. -
Classes in org.apache.lucene.index used by org.apache.lucene.search.regex Class Description IndexReader IndexReader is an abstract class, providing an interface for accessing an index.Term A Term represents a word from text.TermEnum Abstract class for enumerating terms. -
Classes in org.apache.lucene.index used by org.apache.lucene.search.similar Class Description IndexReader IndexReader is an abstract class, providing an interface for accessing an index. -
Classes in org.apache.lucene.index used by org.apache.lucene.search.spans Class Description IndexReader IndexReader is an abstract class, providing an interface for accessing an index.Term A Term represents a word from text.TermPositions TermPositions provides an interface for enumerating the <document, frequency, <position>* > tuples for a term. -
Classes in org.apache.lucene.index used by org.apache.lucene.search.spell Class Description IndexReader IndexReader is an abstract class, providing an interface for accessing an index.IndexWriterConfig Holds all the configuration ofIndexWriter
. -
Classes in org.apache.lucene.index used by org.apache.lucene.search.vectorhighlight Class Description IndexReader IndexReader is an abstract class, providing an interface for accessing an index. -
Classes in org.apache.lucene.index used by org.apache.lucene.spatial.geohash Class Description IndexReader IndexReader is an abstract class, providing an interface for accessing an index. -
Classes in org.apache.lucene.index used by org.apache.lucene.spatial.tier Class Description IndexReader IndexReader is an abstract class, providing an interface for accessing an index. -
Classes in org.apache.lucene.index used by org.apache.lucene.store Class Description MergeScheduler Expert:IndexWriter
uses an instance implementing this interface to execute the merges selected by aMergePolicy
. -
Classes in org.apache.lucene.index used by org.apache.lucene.store.instantiated Class Description CorruptIndexException This exception is thrown when Lucene detects an inconsistency in the index.FieldInfos Collection ofFieldInfo
s (accessible by number or by name).IndexReader IndexReader is an abstract class, providing an interface for accessing an index.Term A Term represents a word from text.TermDocs TermDocs provides an interface for enumerating <document, frequency> pairs for a term.TermEnum Abstract class for enumerating terms.TermFreqVector Provides access to stored term vector of a document field.TermPositions TermPositions provides an interface for enumerating the <document, frequency, <position>* > tuples for a term.TermPositionVector ExtendsTermFreqVector
to provide additional information about positions in which each of the terms is found.TermVectorMapper The TermVectorMapper can be used to map Term Vectors into your own structure instead of the parallel array structure used byIndexReader.getTermFreqVector(int,String)
.TermVectorOffsetInfo The TermVectorOffsetInfo class holds information pertaining to a Term in aTermPositionVector
's offset information. -
Classes in org.apache.lucene.index used by org.apache.lucene.util Class Description CheckIndex.Status Returned fromCheckIndex.checkIndex()
detailing the health and status of the index.FieldInfos Collection ofFieldInfo
s (accessible by number or by name).IndexReader IndexReader is an abstract class, providing an interface for accessing an index.IndexWriter AnIndexWriter
creates and maintains an index.IndexWriterConfig Holds all the configuration ofIndexWriter
.LogMergePolicy This class implements aMergePolicy
that tries to merge segments into levels of exponentially increasing size, where each level has fewer segments than the value of the merge factor.MergePolicy Expert: a MergePolicy determines the sequence of primitive merge operations.MergeScheduler Expert:IndexWriter
uses an instance implementing this interface to execute the merges selected by aMergePolicy
.TieredMergePolicy Merges segments of approximately equal size, subject to an allowed number of segments per tier.