| Cache<K, V> |
Base class for cache implementations. |
| CachingSpanFilter |
Wraps another SpanFilter's result and caches it. |
| CachingTokenFilter |
This class can be used if the token attributes of a TokenStream
are intended to be consumed more than once. |
| CachingWrapperFilter |
Wraps another filter's result and caches it. |
| CachingWrapperFilter.DeletesMode |
Expert: Specifies how new deletions against a reopened
reader should be handled. |
| CharArraySet |
A simple class that stores Strings as char[]'s in a
hash table. |
| CharArraySet.CharArraySetIterator |
The Iterator for this set. |
| CharFilter |
Subclasses of CharFilter can be chained to filter CharStream. |
| CharReader |
CharReader is a Reader wrapper. |
| CharStream |
CharStream adds correctOffset(int)
functionality over Reader. |
| CharStream |
This interface describes a character stream that maintains line and
column number positions of the characters. |
| CharTokenizer |
An abstract base class for simple, character-oriented tokenizers. |
| CheckIndex |
Basic tool and API to check the health of an index and
write a new segments file that removes reference to
problematic segments. |
| CheckIndex.Status |
Returned from 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. |
| ChecksumIndexInput |
Writes bytes through to a primary IndexOutput, computing
checksum as it goes. |
| ChecksumIndexOutput |
Writes bytes through to a primary IndexOutput, computing
checksum. |
| CloseableThreadLocal<T> |
Java's builtin ThreadLocal has a serious flaw:
it can take an arbitrarily long amount of time to
dereference the things you had stored in it, even once the
ThreadLocal instance itself is no longer referenced. |
| Collector |
Expert: Collectors are primarily meant to be used to
gather raw results from a search, and implement sorting
or custom result filtering, collation, etc. |
| ComplexExplanation |
Expert: Describes the score computation for document and query, and
can distinguish a match independent of a positive value. |
| CompressionTools |
Simple utility class providing static methods to
compress and decompress binary data for stored fields. |
| ConcurrentMergeScheduler |
A MergeScheduler that runs each merge using a
separate thread, up until a maximum number of threads
(setMaxThreadCount(int)) at which when a merge is
needed, the thread(s) that are updating the index will
pause until one or more merges completes. |
| ConcurrentMergeScheduler.MergeThread |
|
| Constants |
Some useful constants. |
| ConstantScoreQuery |
A query that wraps a filter and simply returns a constant score equal to the
query boost for every document in the filter. |
| ConstantScoreQuery.ConstantScorer |
|
| ConstantScoreQuery.ConstantWeight |
|
| CorruptIndexException |
This exception is thrown when Lucene detects
an inconsistency in the index. |
| CustomScoreProvider |
An instance of this subclass should be returned by
getCustomScoreProvider(IndexReader), if you want
to modify the custom score calculation of a CustomScoreQuery. |
| CustomScoreQuery |
Query that sets document score as a programmatic function of several (sub) scores:
- the score of its subQuery (any query)
- (optional) the score of its ValueSourceQuery (or queries).
|
| DateField |
This class is deprecated.
If you build a new index, use DateTools or
NumericField instead.
This class is included for use with existing
indices and will be removed in a future release (possibly Lucene 4.0).
|
| DateTools |
Provides support for converting dates to strings and vice-versa. |
| DateTools.Resolution |
Specifies the time granularity. |
| DefaultSimilarity |
Expert: Default scoring implementation. |
| Directory |
A Directory is a flat list of files. |
| DisjunctionMaxQuery |
A query that generates the union of documents produced by its subqueries, and that scores each document with the maximum
score for that document as produced by any subquery, plus a tie breaking increment for any additional matching subqueries. |
| DisjunctionMaxQuery.DisjunctionMaxWeight |
Expert: the Weight for DisjunctionMaxQuery, used to
normalize, score and explain these queries. |
| DocIdBitSet |
Simple DocIdSet and DocIdSetIterator backed by a BitSet |
| DocIdSet |
A DocIdSet contains a set of doc ids. |
| DocIdSetIterator |
This abstract class defines methods to iterate over a set of non-decreasing
doc ids. |
| Document |
Documents are the unit of indexing and search. |
| DocValues |
Expert: represents field values as different types. |
| DummyConcurrentLock |
A dummy lock as a replacement for ReentrantLock to disable locking
|
| FastCharStream |
An efficient implementation of JavaCC's CharStream interface. |
| Field |
A field is a section of a Document. |
| Field.Index |
Specifies whether and how a field should be indexed. |
| Field.Store |
Specifies whether and how a field should be stored. |
| Field.TermVector |
Specifies whether and how a field should have term vectors. |
| Fieldable |
Synonymous with Field. |
| FieldCache |
Expert: Maintains caches of term values. |
| FieldCache.ByteParser |
Interface to parse bytes from document fields. |
| FieldCache.CacheEntry |
EXPERT: A unique Identifier/Description for each item in the FieldCache. |
| FieldCache.CreationPlaceholder |
|
| FieldCache.DoubleParser |
Interface to parse doubles from document fields. |
| FieldCache.FloatParser |
Interface to parse floats from document fields. |
| FieldCache.IntParser |
Interface to parse ints from document fields. |
| FieldCache.LongParser |
Interface to parse long from document fields. |
| FieldCache.Parser |
Marker interface as super-interface to all parsers. |
| FieldCache.ShortParser |
Interface to parse shorts from document fields. |
| FieldCache.StringIndex |
Expert: Stores term text values and document ordering data. |
| FieldCacheRangeFilter<T> |
A range filter built on top of a cached single term field (in FieldCache). |
| FieldCacheSanityChecker |
Provides methods for sanity checking that entries in the FieldCache
are not wasteful or inconsistent. |
| FieldCacheSanityChecker.Insanity |
Simple container for a collection of related CacheEntry objects that
in conjunction with each other represent some "insane" usage of the
FieldCache. |
| FieldCacheSanityChecker.InsanityType |
An Enumeration of the different types of "insane" behavior that
may be detected in a FieldCache. |
| FieldCacheSource |
Expert: A base class for ValueSource implementations that retrieve values for
a single field from the FieldCache. |
| FieldCacheTermsFilter |
A Filter that only accepts documents whose single
term value in the specified field is contained in the
provided set of allowed terms. |
| FieldCacheTermsFilter.FieldCacheTermsFilterDocIdSet |
|
| FieldCacheTermsFilter.FieldCacheTermsFilterDocIdSet.FieldCacheTermsFilterDocIdSetIterator |
|
| FieldComparator |
Expert: a FieldComparator compares hits so as to determine their
sort order when collecting the top results with TopFieldCollector. |
| FieldComparator.ByteComparator |
Parses field's values as byte (using getBytes(IndexReader, String) and sorts by ascending value |
| FieldComparator.DocComparator |
Sorts by ascending docID |
| FieldComparator.DoubleComparator |
Parses field's values as double (using getDoubles(IndexReader, String) and sorts by ascending value |
| FieldComparator.FloatComparator |
Parses field's values as float (using getFloats(IndexReader, String) and sorts by ascending value |
| FieldComparator.IntComparator |
Parses field's values as int (using getInts(IndexReader, String) and sorts by ascending value |
| FieldComparator.LongComparator |
Parses field's values as long (using getLongs(IndexReader, String) and sorts by ascending value |
| FieldComparator.RelevanceComparator |
Sorts by descending relevance. |
| FieldComparator.ShortComparator |
Parses field's values as short (using getShorts(IndexReader, String) and sorts by ascending value |
| FieldComparator.StringComparatorLocale |
Sorts by a field's value using the Collator for a
given Locale. |
| FieldComparator.StringOrdValComparator |
Sorts by field's natural String sort order, using
ordinals. |
| FieldComparator.StringValComparator |
Sorts by field's natural String sort order. |
| FieldComparatorSource |
Provides a FieldComparator for custom field sorting. |
| FieldDoc |
Expert: A ScoreDoc which also contains information about
how to sort the referenced document. |
| FieldInvertState |
This class tracks the number and position / offset parameters of terms
being added to the index. |
| FieldMaskingSpanQuery |
Wrapper to allow SpanQuery objects participate in composite
single-field SpanQueries by 'lying' about their search field. |
| FieldReaderException |
|
| FieldScoreQuery |
A query that scores each document as the value of the numeric input field. |
| FieldScoreQuery.Type |
Type of score field, indicating how field values are interpreted/parsed. |
| FieldSelector |
Similar to a java.io.FileFilter, the FieldSelector allows one to make decisions about
what Fields get loaded on a Document by document(int, org.apache.lucene.document.FieldSelector)
|
| FieldSelectorResult |
Provides information about what should be done with this Field
|
| FieldSortedTermVectorMapper |
For each Field, store a sorted collection of TermVectorEntrys
This is not thread-safe. |
| FieldValueHitQueue |
Expert: A hit queue for sorting by hits by terms in more than one field. |
| FileSwitchDirectory |
Expert: A Directory instance that switches files between
two other Directory instances. |
| Filter |
Abstract base class for restricting which documents may
be returned during searching. |
| FilteredDocIdSet |
Abstract decorator class for a DocIdSet implementation
that provides on-demand filtering/validation
mechanism on a given DocIdSet. |
| FilteredDocIdSetIterator |
Abstract decorator class of a DocIdSetIterator
implementation that provides on-demand filter/validation
mechanism on an underlying DocIdSetIterator. |
| FilteredQuery |
A query that applies a filter to the results of another query. |
| FilteredTermEnum |
Abstract class for enumerating a subset of all terms. |
| 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. |
| FilterIndexReader.FilterTermEnum |
Base class for filtering TermEnum implementations. |
| FilterIndexReader.FilterTermPositions |
Base class for filtering TermPositions implementations. |
| FilterManager |
Filter caching singleton. |
| FilterManager.FilterCleaner |
Keeps the cache from getting too big. |
| FilterManager.FilterItem |
Holds the filter and the last time the filter was used, to make LRU-based
cache cleaning possible. |
| FlagsAttribute |
This attribute can be used to pass different flags down the Tokenizer chain,
eg from one TokenFilter to another one. |
| FlagsAttributeImpl |
This attribute can be used to pass different flags down the tokenizer chain,
eg from one TokenFilter to another one. |
| FloatFieldSource |
Expert: obtains float field values from the
FieldCache
using getFloats() and makes those values
available as other numeric types, casting as needed. |
| FSDirectory |
Base class for Directory implementations that store index
files in the file system. |
| FSLockFactory |
Base class for file system based locking implementation. |
| FuzzyQuery |
Implements the fuzzy search query. |
| FuzzyTermEnum |
Subclass of FilteredTermEnum for enumerating all terms that are similar
to the specified filter term. |
| NamedThreadFactory |
A default ThreadFactory implementation that accepts the name prefix
of the created threads as a constructor argument. |
| NativeFSLockFactory |
Implements LockFactory using native OS file
locks. |
| NearSpansOrdered |
A Spans that is formed from the ordered subspans of a SpanNearQuery
where the subspans do not overlap and have a maximum slop between them. |
| NearSpansUnordered |
Similar to NearSpansOrdered, but for the unordered case. |
| NIOFSDirectory |
An FSDirectory implementation that uses java.nio's FileChannel's
positional read, which allows multiple threads to read from the same file
without synchronizing. |
| NIOFSDirectory.NIOFSIndexInput |
|
| NLS |
MessageBundles classes extend this class, to implement a bundle. |
| NLSException |
Interface that exceptions should implement to support lazy loading of messages. |
| NoLockFactory |
Use this LockFactory to disable locking entirely. |
| NormalizeCharMap |
Holds a map of String input to String output, to be used
with MappingCharFilter. |
| NoSuchDirectoryException |
This exception is thrown when you try to list a
non-existent directory. |
| NumberTools |
This class is deprecated.
For new indexes use NumericUtils instead, which
provides a sortable binary representation (prefix encoded) of numeric
values.
To index and efficiently query numeric values use NumericField
and NumericRangeQuery.
This class is included for use with existing
indices and will be removed in a future release (possibly Lucene 4.0).
|
| NumericField |
This class provides a Field that enables indexing
of numeric values for efficient range filtering and
sorting. |
| NumericRangeFilter<T extends Number> |
A Filter that only accepts numeric values within
a specified range. |
| NumericRangeQuery<T extends Number> |
A Query that matches numeric values within a
specified range. |
| NumericTokenStream |
Expert: This class provides a TokenStream
for indexing numeric values that can be used by NumericRangeQuery or NumericRangeFilter. |
| NumericUtils |
This is a helper class to generate prefix-encoded representations for numerical values
and supplies converters to represent float/double values as sortable integers/longs. |
| NumericUtils.IntRangeBuilder |
Expert: Callback for splitIntRange(NumericUtils.IntRangeBuilder, int, int, int). |
| NumericUtils.LongRangeBuilder |
Expert: Callback for splitLongRange(NumericUtils.LongRangeBuilder, int, long, long). |
| ScoreCachingWrappingScorer |
A Scorer which wraps another scorer and caches the score of the
current document. |
| ScoreDoc |
Expert: Returned by low-level search implementations. |
| Scorer |
Expert: Common scoring functionality for different types of queries. |
| ScorerDocQueue |
A ScorerDocQueue maintains a partial ordering of its Scorers such that the
least Scorer can always be found in constant time. |
| Searchable |
The interface for search implementations. |
| Searcher |
An abstract base class for search implementations. |
| 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. |
| SegmentInfos.FindSegmentsFile |
Utility class for executing code that needs to do
something with the current segments file. |
| SegmentReader |
NOTE: This API is new and still experimental
(subject to change suddenly in the next release)
|
| SerialMergeScheduler |
A MergeScheduler that simply does each merge
sequentially, using the current thread. |
| SetBasedFieldSelector |
Declare what fields to load normally and what fields to load lazily
|
| ShortFieldSource |
Expert: obtains short field values from the
FieldCache
using getShorts() and makes those values
available as other numeric types, casting as needed. |
| Similarity |
Expert: Scoring API. |
| SimilarityDelegator |
Expert: Delegating scoring implementation. |
| SimpleAnalyzer |
An Analyzer that filters LetterTokenizer
with LowerCaseFilter |
| SimpleFSDirectory |
A straightforward implementation of FSDirectory
using java.io.RandomAccessFile. |
| SimpleFSDirectory.SimpleFSIndexInput |
|
| SimpleFSDirectory.SimpleFSIndexInput.Descriptor |
|
| SimpleFSDirectory.SimpleFSIndexOutput |
|
| SimpleFSLockFactory |
Implements LockFactory using createNewFile(). |
| SimpleLRUCache<K, V> |
Simple LRU cache implementation that uses a LinkedHashMap. |
| SimpleMapCache<K, V> |
Simple cache implementation that uses a HashMap to store (key, value) pairs. |
| SimpleStringInterner |
Simple lockless and memory barrier free String intern cache that is guaranteed
to return the same String instance as String.intern() does. |
| SingleInstanceLockFactory |
Implements LockFactory for a single in-process instance,
meaning all locking will take place through this one instance. |
| SingleTermEnum |
Subclass of FilteredTermEnum for enumerating a single term. |
| SmallFloat |
Floating point numbers smaller than 32 bits. |
| SnapshotDeletionPolicy |
A IndexDeletionPolicy that wraps around any other
IndexDeletionPolicy and adds the ability to hold and
later release a single "snapshot" of an index. |
| Sort |
Encapsulates sort criteria for returned hits. |
| SortedTermVectorMapper |
Store a sorted collection of TermVectorEntrys. |
| SortedVIntList |
Stores and iterate on sorted integers in compressed form in RAM. |
| SorterTemplate |
Borrowed from Cglib. |
| SortField |
Stores information about how to sort documents by terms in an individual
field. |
| SpanFilter |
Abstract base class providing a mechanism to restrict searches to a subset
of an index and also maintains and returns position information. |
| SpanFilterResult |
The results of a SpanQueryFilter. |
| SpanFilterResult.PositionInfo |
|
| SpanFilterResult.StartEnd |
|
| SpanFirstQuery |
Matches spans near the beginning of a field. |
| SpanNearQuery |
Matches spans which are near one another. |
| SpanNotQuery |
Removes matches which overlap with another SpanQuery. |
| SpanOrQuery |
Matches the union of its clauses. |
| SpanQuery |
Base class for span-based queries. |
| SpanQueryFilter |
Constrains search results to only match those which also match a provided
query. |
| Spans |
Expert: an enumeration of span matches. |
| SpanScorer |
Public for extension only. |
| SpanTermQuery |
Matches spans containing a term. |
| SpanWeight |
Expert-only. |
| StaleReaderException |
This exception is thrown when an IndexReader
tries to make changes to the index (via deleteDocument(int), undeleteAll() or setNorm(int, String, byte))
but changes have already been committed to the index
since this reader was instantiated. |
| StandardAnalyzer |
Filters StandardTokenizer with StandardFilter, LowerCaseFilter and StopFilter, using a list of
English stop words. |
| StandardFilter |
Normalizes tokens extracted with StandardTokenizer. |
| StandardTokenizer |
A grammar-based tokenizer constructed with JFlex
This should be a good tokenizer for most European-language documents:
- Splits words at punctuation characters, removing punctuation.
|
| StopAnalyzer |
Filters LetterTokenizer with LowerCaseFilter and StopFilter. |
| StopFilter |
Removes stop words from a token stream. |
| StringHelper |
Methods for manipulating strings. |
| StringInterner |
Subclasses of StringInterner are required to
return the same single String object for all equal strings. |
| TeeSinkTokenFilter |
This TokenFilter provides the ability to set aside attribute states
that have already been analyzed. |
| TeeSinkTokenFilter.SinkFilter |
A filter that decides which AttributeSource states to store in the sink. |
| TeeSinkTokenFilter.SinkTokenStream |
|
| Term |
A Term represents a word from text. |
| TermAttribute |
The term text of a Token. |
| TermAttributeImpl |
The term text of a Token. |
| 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. |
| TermQuery |
A Query that matches documents containing a term. |
| TermRangeFilter |
A Filter that restricts search results to a range of term
values in a given field. |
| TermRangeQuery |
A Query that matches documents within an range of terms. |
| TermRangeTermEnum |
Subclass of FilteredTermEnum for enumerating all terms that match the
specified range parameters. |
| TermSpans |
Expert:
Public for extension only
|
| TermVectorEntry |
Convenience class for holding TermVector information. |
| TermVectorEntryFreqSortedComparator |
Compares TermVectorEntrys first by frequency and then by
the term (case-sensitive)
|
| TermVectorMapper |
The TermVectorMapper can be used to map Term Vectors into your own
structure instead of the parallel array structure used by
getTermFreqVector(int, String). |
| TermVectorOffsetInfo |
The TermVectorOffsetInfo class holds information pertaining to a Term in a TermPositionVector's
offset information. |
| ThreadInterruptedException |
Thrown by lucene on detecting that Thread.interrupt() had
been called. |
| TimeLimitingCollector |
The TimeLimitingCollector is used to timeout search requests that
take longer than the maximum allowed search time limit. |
| TimeLimitingCollector.TimeExceededException |
Thrown when elapsed search time exceeds allowed search time. |
| Token |
A Token is an occurrence of a term from the text of a field. |
| Token |
Describes the input token stream. |
| Token.TokenAttributeFactory |
Expert: Creates a TokenAttributeFactory returning Token as instance for the basic attributes
and for all other attributes calls the given delegate factory. |
| TokenFilter |
A TokenFilter is a TokenStream whose input is another TokenStream. |
| Tokenizer |
A Tokenizer is a TokenStream whose input is a Reader. |
| TokenMgrError |
Token Manager Error. |
| TokenStream |
A TokenStream enumerates the sequence of tokens, either from
Fields of a Document or from query text. |
| TopDocs |
Represents hits returned by search(Query, Filter, int) and search(Query, int). |
| TopDocsCollector<T extends ScoreDoc> |
A base class for all collectors that return a TopDocs output. |
| TopFieldCollector |
A Collector that sorts by SortField using
FieldComparators. |
| TopFieldDocs |
Represents hits returned by search(Query, Filter, int, Sort). |
| TopScoreDocCollector |
A Collector implementation that collects the top-scoring hits,
returning them as a TopDocs. |
| ToStringUtils |
Helper methods to ease implementing toString(). |
| TypeAttribute |
A Token's lexical type. |
| TypeAttributeImpl |
A Token's lexical type. |