Uses of Package
org.apache.lucene.index
Packages that use org.apache.lucene.index
Package
Description
Codecs API: API for customization of the encoding and structure of the index.
StoredFieldsFormat that allows cross-document and cross-field compression of stored fields.
Codec to support Lucene 3.x indexes (readonly)
Lucene 4.0 file format.
Lucene 4.1 file format.
Lucene 4.2 file format.
Lucene 4.5 file format.
Lucene 4.6 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.
The payloads package provides Query mechanisms for finding and using payloads.
This package contains the various ranking models that can be used in Lucene.
The calculus of spans.
Some utility classes.
Finite-state automaton for regular expressions.
Packed integer arrays and streams.
-
Classes in org.apache.lucene.index used by org.apache.lucene.codecsClassDescriptionA per-document byte[]Also iterates through positions.Iterates through the documents and term freqs.Access to the Field Info file that describes document fields and whether or not they are indexed.Controls how much information is stored in the postings lists.Collection of
FieldInfos (accessible by number or by name).Flex API for access to fields and termsRepresents a single field for indexing.Holds common state used during segment merging.Holds aDocsAndPositionsEnumalong with the correspondingReaderSlice.Holds aDocsEnumalong with the correspondingReaderSlice.A per-document numeric value.An ordinal basedTermStateEmbeds a [read-only] SegmentInfo and adds per-commit fields.Information about a segment such as it's name, directory, and files related to the segment.Holder class for common parameters used during read.Holder class for common parameters used during write.A per-document byte[] with presorted values.A per-document set of presorted byte[] values.Expert: provides a low-level means of accessing the stored field values in an index.Access to the terms in a specific field.Iterator to seek (TermsEnum.seekCeil(BytesRef),TermsEnum.seekExact(BytesRef)) or step through (BytesRefIterator.next()terms to obtain frequency information (TermsEnum.docFreq()),DocsEnumorDocsAndPositionsEnumfor the current term (TermsEnum.docs(org.apache.lucene.util.Bits, org.apache.lucene.index.DocsEnum).Encapsulates all required internal state to position the associatedTermsEnumwithout re-seeking. -
Classes in org.apache.lucene.index used by org.apache.lucene.codecs.compressingClassDescriptionAccess to the Field Info file that describes document fields and whether or not they are indexed.Collection of
FieldInfos (accessible by number or by name).Flex API for access to fields and termsRepresents a single field for indexing.Holds common state used during segment merging.Information about a segment such as it's name, directory, and files related to the segment.Expert: provides a low-level means of accessing the stored field values in an index. -
Classes in org.apache.lucene.index used by org.apache.lucene.codecs.lucene3xClassDescriptionInformation about a segment such as it's name, directory, and files related to the segment.A collection of segmentInfo objects with methods for operating on those segments in relation to the file system.
-
Classes in org.apache.lucene.index used by org.apache.lucene.codecs.lucene40ClassDescriptionAlso iterates through positions.Iterates through the documents and term freqs.Access to the Field Info file that describes document fields and whether or not they are indexed.Collection of
FieldInfos (accessible by number or by name).Flex API for access to fields and termsRepresents a single field for indexing.Holds common state used during segment merging.Embeds a [read-only] SegmentInfo and adds per-commit fields.Information about a segment such as it's name, directory, and files related to the segment.Holder class for common parameters used during read.Holder class for common parameters used during write.Expert: provides a low-level means of accessing the stored field values in an index. -
Classes in org.apache.lucene.index used by org.apache.lucene.codecs.lucene41ClassDescriptionAlso iterates through positions.Iterates through the documents and term freqs.Access to the Field Info file that describes document fields and whether or not they are indexed.Collection of
FieldInfos (accessible by number or by name).Information about a segment such as it's name, directory, and files related to the segment.Holder class for common parameters used during read.Holder class for common parameters used during write. -
Classes in org.apache.lucene.index used by org.apache.lucene.codecs.lucene42ClassDescriptionHolder class for common parameters used during read.Holder class for common parameters used during write.
-
Classes in org.apache.lucene.index used by org.apache.lucene.codecs.lucene45ClassDescriptionA per-document byte[]Access to the Field Info file that describes document fields and whether or not they are indexed.A per-document numeric value.Holder class for common parameters used during read.Holder class for common parameters used during write.A per-document byte[] with presorted values.A per-document set of presorted byte[] values.
-
Classes in org.apache.lucene.index used by org.apache.lucene.codecs.lucene46ClassDescriptionCollection of
FieldInfos (accessible by number or by name).Information about a segment such as it's name, directory, and files related to the segment. -
Classes in org.apache.lucene.index used by org.apache.lucene.codecs.perfieldClassDescriptionHolder class for common parameters used during read.Holder class for common parameters used during write.
-
Classes in org.apache.lucene.index used by org.apache.lucene.documentClassDescriptionAccess to the Field Info file that describes document fields and whether or not they are indexed.DocValues types.Controls how much information is stored in the postings lists.Represents a single field for indexing.Describes the properties of a field.Expert: provides a low-level means of accessing the stored field values in an index.Enumeration of possible return values for
StoredFieldVisitor.needsField(org.apache.lucene.index.FieldInfo). -
Classes in org.apache.lucene.index used by org.apache.lucene.indexClassDescription
AtomicReaderis an abstract class, providing an interface for accessing an index.IndexReaderContextforAtomicReaderinstances.Base class for implementingCompositeReaders based on an array of sub-readers.A per-document byte[]Returned fromCheckIndex.checkIndex()detailing the health and status of the index.Status from testing DocValuesStatus from testing field norms.Holds the status of each segment in the index.Status from testing stored fields.Status from testing term index.Status from testing stored fields.Instances of this reader type can only be used to get stored fields from the underlying AtomicReaders, but it is not possible to directly retrieve postings.IndexReaderContextforCompositeReaderinstance.Runs a merge thread, which may run one or more merges in sequence.This exception is thrown when Lucene detects an inconsistency in the index.DirectoryReader is an implementation ofCompositeReaderthat can read indexes in aDirectory.Also iterates through positions.Iterates through the documents and term freqs.Access to the Field Info file that describes document fields and whether or not they are indexed.DocValues types.Controls how much information is stored in the postings lists.Collection ofFieldInfos (accessible by number or by name).Flex API for access to fields and termsFactory class passed to FilterDirectoryReader constructor that allows subclasses to wrap the filtered DirectoryReader's subreaders.Abstract class for enumerating a subset of all terms.Return value, if term should be accepted or the iteration shouldEND.Represents a single field for indexing.Describes the properties of a field.Expert: represents a single commit into an index as seen by theIndexDeletionPolicyorIndexReader.Expert: policy for deletion of staleindex commits.IndexReader is an abstract class, providing an interface for accessing an index.A custom listener that's invoked when the IndexReader is closed.A struct like class that represents a hierarchical relationship betweenIndexReaderinstances.AnIndexWritercreates and maintains an index.IfDirectoryReader.open(IndexWriter,boolean)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.Holds all the configuration that is used to create anIndexWriter.Specifies the open mode forIndexWriter.Holds all the configuration used byIndexWriterwith few setters for settings that can be changed on anIndexWriterinstance "live".This class implements aMergePolicythat tries to merge segments into levels of exponentially increasing size, where each level has fewer segments than the value of the merge factor.Expert: a MergePolicy determines the sequence of primitive merge operations.A map of doc IDs.Thrown when a merge was explicity aborted becauseIndexWriter.close(boolean)was called withfalse.A MergeSpecification instance provides the information necessary to perform multiple merges.MergeTrigger is passed toMergePolicy.findMerges(MergeTrigger, SegmentInfos)to indicate the event that triggered the merge.OneMerge provides the information necessary to perform an individual primitive merge operation, resulting in a single new segment.Expert:IndexWriteruses an instance implementing this interface to execute the merges selected by aMergePolicy.Holds common state used during segment merging.Class for recording units of work when merging segments.Remaps docids around deletes during mergeExposes flex API, merged from flex API of sub-segments.Holds aDocsAndPositionsEnumalong with the correspondingReaderSlice.Holds aDocsEnumalong with the correspondingReaderSlice.maps per-segment ordinals to/from global ordinal spaceA per-document numeric value.Subreader slice from a parent composite reader.Embeds a [read-only] SegmentInfo and adds per-commit fields.Information about a segment such as it's name, directory, and files related to the segment.A collection of segmentInfo objects with methods for operating on those segments in relation to the file system.IndexReader implementation over a single segment.Called when the shared core for this SegmentReader is closed.Holder class for common parameters used during read.Holder class for common parameters used during write.AnIndexDeletionPolicythat wraps any otherIndexDeletionPolicyand adds the ability to hold and later release snapshots of an index.A per-document byte[] with presorted values.A per-document set of presorted byte[] values.Expert: provides a low-level means of accessing the stored field values in an index.Enumeration of possible return values forStoredFieldVisitor.needsField(org.apache.lucene.index.FieldInfo).A Term represents a word from text.Access to the terms in a specific field.Iterator to seek (TermsEnum.seekCeil(BytesRef),TermsEnum.seekExact(BytesRef)) or step through (BytesRefIterator.next()terms to obtain frequency information (TermsEnum.docFreq()),DocsEnumorDocsAndPositionsEnumfor the current term (TermsEnum.docs(org.apache.lucene.util.Bits, org.apache.lucene.index.DocsEnum).Represents returned result fromTermsEnum.seekCeil(org.apache.lucene.util.BytesRef).Encapsulates all required internal state to position the associatedTermsEnumwithout re-seeking.Merges segments of approximately equal size, subject to an allowed number of segments per tier.Holds score and explanation for a single candidate merge.An interface for implementations that support 2-phase commit.Thrown byTwoPhaseCommitTool.execute(TwoPhaseCommit...)when an object fails to commit().Thrown byTwoPhaseCommitTool.execute(TwoPhaseCommit...)when an object fails to prepareCommit(). -
Classes in org.apache.lucene.index used by org.apache.lucene.searchClassDescription
AtomicReaderis an abstract class, providing an interface for accessing an index.IndexReaderContextforAtomicReaderinstances.A per-document byte[]Also iterates through positions.Iterates through the documents and term freqs.Abstract class for enumerating a subset of all terms.Return value, if term should be accepted or the iteration shouldEND.IndexReader is an abstract class, providing an interface for accessing an index.A struct like class that represents a hierarchical relationship betweenIndexReaderinstances.AnIndexWritercreates and maintains an index.A per-document byte[] with presorted values.A per-document set of presorted byte[] values.Expert: provides a low-level means of accessing the stored field values in an index.A Term represents a word from text.Access to the terms in a specific field.Iterator to seek (TermsEnum.seekCeil(BytesRef),TermsEnum.seekExact(BytesRef)) or step through (BytesRefIterator.next()terms to obtain frequency information (TermsEnum.docFreq()),DocsEnumorDocsAndPositionsEnumfor the current term (TermsEnum.docs(org.apache.lucene.util.Bits, org.apache.lucene.index.DocsEnum).Represents returned result fromTermsEnum.seekCeil(org.apache.lucene.util.BytesRef).Encapsulates all required internal state to position the associatedTermsEnumwithout re-seeking.Class that tracks changes to a delegated IndexWriter, used byControlledRealTimeReopenThreadto ensure specific changes are visible. -
Classes in org.apache.lucene.index used by org.apache.lucene.search.payloadsClassDescription
IndexReaderContextforAtomicReaderinstances.Iterates through the documents and term freqs.A struct like class that represents a hierarchical relationship betweenIndexReaderinstances.A Term represents a word from text. -
Classes in org.apache.lucene.index used by org.apache.lucene.search.similaritiesClassDescription
IndexReaderContextforAtomicReaderinstances.This class tracks the number and position / offset parameters of terms being added to the index. -
Classes in org.apache.lucene.index used by org.apache.lucene.search.spansClassDescription
IndexReaderContextforAtomicReaderinstances.Also iterates through positions.Iterates through the documents and term freqs.IndexReader is an abstract class, providing an interface for accessing an index.A Term represents a word from text. -
Classes in org.apache.lucene.index used by org.apache.lucene.utilClassDescriptionA per-document numeric value.A Term represents a word from text.Iterator to seek (
TermsEnum.seekCeil(BytesRef),TermsEnum.seekExact(BytesRef)) or step through (BytesRefIterator.next()terms to obtain frequency information (TermsEnum.docFreq()),DocsEnumorDocsAndPositionsEnumfor the current term (TermsEnum.docs(org.apache.lucene.util.Bits, org.apache.lucene.index.DocsEnum). -
Classes in org.apache.lucene.index used by org.apache.lucene.util.automatonClassDescriptionAccess to the terms in a specific field.Iterator to seek (
TermsEnum.seekCeil(BytesRef),TermsEnum.seekExact(BytesRef)) or step through (BytesRefIterator.next()terms to obtain frequency information (TermsEnum.docFreq()),DocsEnumorDocsAndPositionsEnumfor the current term (TermsEnum.docs(org.apache.lucene.util.Bits, org.apache.lucene.index.DocsEnum). -
Classes in org.apache.lucene.index used by org.apache.lucene.util.packed