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 |
Useful
Attribute 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 a
Document for indexing and searching. |
org.apache.lucene.facet.enhancements |
Enhanced category features
|
org.apache.lucene.facet.enhancements.association |
Association category enhancements
|
org.apache.lucene.facet.index |
Indexing of document categories
|
org.apache.lucene.facet.index.params |
Indexing-time specifications for handling facets
|
org.apache.lucene.facet.index.streaming |
Expert: attributes streaming definition for indexing facets
|
org.apache.lucene.facet.search |
Faceted Search API
|
org.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 Search
|
org.apache.lucene.facet.search.params.association |
Association-based Parameters for Faceted Search.
|
org.apache.lucene.facet.search.sampling |
Sampling for facets accumulation
|
org.apache.lucene.facet.taxonomy.directory |
Taxonomy implemented using a Lucene-Index
|
org.apache.lucene.facet.util |
Various utilities for faceted search
|
org.apache.lucene.index |
Code to maintain and access indices.
|
org.apache.lucene.index.pruning |
Static Index Pruning Tools
|
org.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.
|
Class and Description |
---|
Payload
A Payload is metadata that can be stored together with each occurrence
of a term.
|
Class and Description |
---|
Payload
A Payload is metadata that can be stored together with each occurrence
of a term.
|
Class and Description |
---|
IndexReader
IndexReader is an abstract class, providing an interface for accessing an
index.
|
Term
A Term represents a word from text.
|
Class and Description |
---|
Payload
A Payload is metadata that can be stored together with each occurrence
of a term.
|
Class and Description |
---|
IndexReader
IndexReader is an abstract class, providing an interface for accessing an
index.
|
IndexWriter
An
IndexWriter creates and maintains an index. |
Class and 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 the
IndexDeletionPolicy or IndexReader . |
IndexDeletionPolicy
Expert: policy for deletion of stale
index commits . |
IndexReader
IndexReader is an abstract class, providing an interface for accessing an
index.
|
IndexWriter
An
IndexWriter creates and maintains an index. |
IndexWriterConfig
Holds all the configuration of
IndexWriter . |
IndexWriterConfig.OpenMode
Specifies the open mode for
IndexWriter :
IndexWriterConfig.OpenMode.CREATE - creates a new index or overwrites an existing one. |
Class and Description |
---|
FieldInfo.IndexOptions
Controls how much information is stored in the postings lists.
|
Class and Description |
---|
IndexReader
IndexReader is an abstract class, providing an interface for accessing an
index.
|
Term
A Term represents a word from text.
|
Class and Description |
---|
IndexReader
IndexReader is an abstract class, providing an interface for accessing an
index.
|
Term
A Term represents a word from text.
|
Class and Description |
---|
IndexReader
IndexReader is an abstract class, providing an interface for accessing an
index.
|
PayloadProcessorProvider
Provides a
PayloadProcessorProvider.ReaderPayloadProcessor to be used for a Directory . |
PayloadProcessorProvider.PayloadProcessor
Processes the given payload.
|
PayloadProcessorProvider.ReaderPayloadProcessor
Returns a
PayloadProcessorProvider.ReaderPayloadProcessor for a given Term which allows
processing the payloads of different terms differently. |
Term
A Term represents a word from text.
|
Class and Description |
---|
IndexReader
IndexReader is an abstract class, providing an interface for accessing an
index.
|
Term
A Term represents a word from text.
|
Class and Description |
---|
Payload
A Payload is metadata that can be stored together with each occurrence
of a term.
|
Class and Description |
---|
IndexReader
IndexReader is an abstract class, providing an interface for accessing an
index.
|
Term
A Term represents a word from text.
|
Class and Description |
---|
IndexReader
IndexReader is an abstract class, providing an interface for accessing an
index.
|
Class and Description |
---|
IndexReader
IndexReader is an abstract class, providing an interface for accessing an
index.
|
Class and Description |
---|
IndexReader
IndexReader is an abstract class, providing an interface for accessing an
index.
|
Class and Description |
---|
IndexReader
IndexReader is an abstract class, providing an interface for accessing an
index.
|
Class and Description |
---|
IndexReader
IndexReader is an abstract class, providing an interface for accessing an
index.
|
Class and 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
An
IndexWriter creates and maintains an index. |
IndexWriterConfig
Holds all the configuration of
IndexWriter . |
IndexWriterConfig.OpenMode
Specifies the open mode for
IndexWriter :
IndexWriterConfig.OpenMode.CREATE - creates a new index or overwrites an existing one. |
Class and Description |
---|
IndexReader
IndexReader is an abstract class, providing an interface for accessing an
index.
|
Class and Description |
---|
BalancedSegmentMergePolicy.MergePolicyParams
Specifies configuration parameters for BalancedSegmentMergePolicy.
|
CheckIndex.Status
Returned from
CheckIndex.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 of
FieldInfo s (accessible by number or by name). |
FilterIndexReader
A
FilterIndexReader 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 filtering
TermDocs implementations. |
IndexCommit
Expert: represents a single commit into an index as seen by the
IndexDeletionPolicy or IndexReader . |
IndexDeletionPolicy
Expert: policy for deletion of stale
index 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
An
IndexWriter creates and maintains an index. |
IndexWriter.IndexReaderWarmer
If
IndexWriter.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.
use
LimitTokenCountAnalyzer instead. |
IndexWriterConfig
Holds all the configuration of
IndexWriter . |
IndexWriterConfig.OpenMode
Specifies the open mode for
IndexWriter :
IndexWriterConfig.OpenMode.CREATE - creates a new index or overwrites an existing one. |
LogByteSizeMergePolicy
This is a
LogMergePolicy that measures size of a
segment as the total byte size of the segment's files. |
LogMergePolicy
This class implements a
MergePolicy 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 a MergePolicy . |
MultiReader
An IndexReader which reads multiple indexes, appending
their content.
|
PayloadProcessorProvider
Provides a
PayloadProcessorProvider.ReaderPayloadProcessor to be used for a Directory . |
PayloadProcessorProvider.DirPayloadProcessor
Deprecated.
Use
PayloadProcessorProvider.ReaderPayloadProcessor instead. |
PayloadProcessorProvider.PayloadProcessor
Processes the given payload.
|
PayloadProcessorProvider.ReaderPayloadProcessor
Returns a
PayloadProcessorProvider.ReaderPayloadProcessor for a given Term which allows
processing the payloads of different terms differently. |
PositionBasedTermVectorMapper.TVPositionInfo
Container for a term at a position
|
SegmentInfo
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
An
IndexDeletionPolicy that wraps around any other
IndexDeletionPolicy and adds the ability to hold and later release
snapshots of an index. |
StaleReaderException
This exception is thrown when an
IndexReader
tries to make changes to the index (via IndexReader.deleteDocument(int) , IndexReader.undeleteAll() or IndexReader.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 by
IndexReader.getTermFreqVector(int,String) . |
TermVectorOffsetInfo
The TermVectorOffsetInfo class holds information pertaining to a Term in a
TermPositionVector '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.
|
Class and Description |
---|
FieldInfos
Collection of
FieldInfo 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.
|
Class and 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.
|
Class and Description |
---|
Term
A Term represents a word from text.
|
Class and Description |
---|
Term
A Term represents a word from text.
|
Class and 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.
|
Class and 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
An
IndexWriter 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.
|
Class and Description |
---|
IndexReader
IndexReader is an abstract class, providing an interface for accessing an
index.
|
Term
A Term represents a word from text.
|
Class and Description |
---|
IndexReader
IndexReader is an abstract class, providing an interface for accessing an
index.
|
Class and Description |
---|
IndexReader
IndexReader is an abstract class, providing an interface for accessing an
index.
|
TermPositionVector
Extends
TermFreqVector to provide additional information about
positions in which each of the terms is found. |
Class and Description |
---|
IndexReader
IndexReader is an abstract class, providing an interface for accessing an
index.
|
Term
A Term represents a word from text.
|
Class and 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.
|
Class and 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.
|
Class and Description |
---|
IndexReader
IndexReader is an abstract class, providing an interface for accessing an
index.
|
Class and 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.
|
Class and Description |
---|
IndexReader
IndexReader is an abstract class, providing an interface for accessing an
index.
|
IndexWriterConfig
Holds all the configuration of
IndexWriter . |
Class and Description |
---|
IndexReader
IndexReader is an abstract class, providing an interface for accessing an
index.
|
Class and Description |
---|
IndexReader
IndexReader is an abstract class, providing an interface for accessing an
index.
|
Class and Description |
---|
IndexReader
IndexReader is an abstract class, providing an interface for accessing an
index.
|
Class and Description |
---|
MergeScheduler
Expert:
IndexWriter uses an instance
implementing this interface to execute the merges
selected by a MergePolicy . |
Class and Description |
---|
CorruptIndexException
This exception is thrown when Lucene detects
an inconsistency in the index.
|
FieldInfos
Collection of
FieldInfo 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
Extends
TermFreqVector 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 by
IndexReader.getTermFreqVector(int,String) . |
TermVectorOffsetInfo
The TermVectorOffsetInfo class holds information pertaining to a Term in a
TermPositionVector 's
offset information. |
Class and Description |
---|
CheckIndex.Status
Returned from
CheckIndex.checkIndex() detailing the health and status of the index. |
FieldInfos
Collection of
FieldInfo s (accessible by number or by name). |
IndexReader
IndexReader is an abstract class, providing an interface for accessing an
index.
|
IndexWriter
An
IndexWriter creates and maintains an index. |
IndexWriterConfig
Holds all the configuration of
IndexWriter . |
LogMergePolicy
This class implements a
MergePolicy 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 a MergePolicy . |
TieredMergePolicy
Merges segments of approximately equal size, subject to
an allowed number of segments per tier.
|