Index (Lucene 2.4.1 API)

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV NEXT | FRAMES NO FRAMES

A B C D E F G H I J K L M N O P Q R S T U V W X Y _

## A

abort() - Method in class org.apache.lucene.index.IndexWriter
  Deprecated. Please use `IndexWriter.rollback()` instead.
AbstractField - Class in org.apache.lucene.document
AbstractField() - Constructor for class org.apache.lucene.document.AbstractField
AbstractField(String, Field.Store, Field.Index, Field.TermVector) - Constructor for class org.apache.lucene.document.AbstractField
accept(String) - Method in interface org.apache.lucene.document.FieldSelector
accept(String) - Method in class org.apache.lucene.document.LoadFirstFieldSelector
accept(String) - Method in class org.apache.lucene.document.MapFieldSelector
  Load field according to its associated value in fieldSelections
accept(String) - Method in class org.apache.lucene.document.SetBasedFieldSelector
  Indicate whether to load the field with the given name or not.
accept(File, String) - Method in class org.apache.lucene.index.IndexFileNameFilter
acquireWriteLock() - Method in class org.apache.lucene.index.IndexReader
  Does nothing by default.
ACRONYM - Static variable in class org.apache.lucene.analysis.standard.StandardTokenizer
ACRONYM_DEP - Static variable in class org.apache.lucene.analysis.standard.StandardTokenizer
  Deprecated. this solves a bug where HOSTs that end with '.' are identified as ACRONYMs. It is deprecated and will be removed in the next release.
add(CharSequence) - Method in class org.apache.lucene.analysis.CharArraySet
  Add this CharSequence into the set
add(String) - Method in class org.apache.lucene.analysis.CharArraySet
  Add this String into the set
add(char[]) - Method in class org.apache.lucene.analysis.CharArraySet
  Add this char[] directly to the set.
add(Object) - Method in class org.apache.lucene.analysis.CharArraySet
add(Token) - Method in class org.apache.lucene.analysis.SinkTokenizer
  Override this method to cache only certain tokens, or new tokens based on the old tokens.
add(Fieldable) - Method in class org.apache.lucene.document.Document
  Adds a field to a document.
add(MergePolicy.OneMerge) - Method in class org.apache.lucene.index.MergePolicy.MergeSpecification
add(IndexReader) - Method in class org.apache.lucene.index.ParallelReader
  Add an IndexReader.
add(IndexReader, boolean) - Method in class org.apache.lucene.index.ParallelReader
  Add an IndexReader whose stored fields will not be returned.
add(Query, BooleanClause.Occur) - Method in class org.apache.lucene.search.BooleanQuery
  Adds a clause to a boolean query.
add(BooleanClause) - Method in class org.apache.lucene.search.BooleanQuery
  Adds a clause to a boolean query.
add(Query) - Method in class org.apache.lucene.search.DisjunctionMaxQuery
  Add a subquery to this disjunction
add(Collection) - Method in class org.apache.lucene.search.DisjunctionMaxQuery
  Add a collection of disjuncts to this disjunction via Iterable
add(Term) - Method in class org.apache.lucene.search.MultiPhraseQuery
  Add a single term at the next position in the phrase.
add(Term[]) - Method in class org.apache.lucene.search.MultiPhraseQuery
  Add multiple terms at the next position in the phrase.
add(Term[], int) - Method in class org.apache.lucene.search.MultiPhraseQuery
  Allows to specify the relative position of terms within the phrase.
add(Term) - Method in class org.apache.lucene.search.PhraseQuery
  Adds a term to the end of the query phrase.
add(Term, int) - Method in class org.apache.lucene.search.PhraseQuery
  Adds a term to the end of the query phrase.
add_escapes(String) - Method in exception org.apache.lucene.queryParser.ParseException
  Used to convert raw characters to their escaped version when these raw version cannot be used as part of an ASCII string literal.
addAnalyzer(String, Analyzer) - Method in class org.apache.lucene.analysis.PerFieldAnalyzerWrapper
  Defines an analyzer to use for the specified field.
addClause(Vector, int, int, Query) - Method in class org.apache.lucene.queryParser.QueryParser
  Deprecated. use `QueryParser.addClause(List, int, int, Query)` instead.
addClause(List, int, int, Query) - Method in class org.apache.lucene.queryParser.QueryParser
addDetail(Explanation) - Method in class org.apache.lucene.search.Explanation
  Adds a sub-node to this explanation node.
addDocument(Document, Analyzer) - Method in class org.apache.lucene.index.IndexModifier
  Deprecated. Adds a document to this index, using the provided analyzer instead of the one specific in the constructor.
addDocument(Document) - Method in class org.apache.lucene.index.IndexModifier
  Deprecated. Adds a document to this index.
addDocument(Document) - Method in class org.apache.lucene.index.IndexWriter
  Adds a document to this index.
addDocument(Document, Analyzer) - Method in class org.apache.lucene.index.IndexWriter
  Adds a document to this index, using the provided analyzer instead of the value of `IndexWriter.getAnalyzer()`.
addEscapes(String) - Static method in error org.apache.lucene.queryParser.TokenMgrError
  Replaces unprintable characters by their escaped (or unicode escaped) equivalents in the given string
addIndexes(Directory[]) - Method in class org.apache.lucene.index.IndexWriter
  Deprecated. Use `IndexWriter.addIndexesNoOptimize(org.apache.lucene.store.Directory[])` instead, then separately call `IndexWriter.optimize()` afterwards if you need to.
addIndexes(IndexReader[]) - Method in class org.apache.lucene.index.IndexWriter
  Merges the provided indexes into this index.
addIndexesNoOptimize(Directory[]) - Method in class org.apache.lucene.index.IndexWriter
  Merges all segments from an array of indexes into this index.
addPosition(int, int) - Method in class org.apache.lucene.search.SpanFilterResult.PositionInfo
adjustTop() - Method in class org.apache.lucene.util.PriorityQueue
  Should be called when the Object at top changes values.
adjustTop() - Method in class org.apache.lucene.util.ScorerDocQueue
  Should be called when the scorer at top changes doc() value.
ALL - Static variable in class org.apache.lucene.index.IndexReader.FieldOption
  All fields
ALL - Static variable in class org.apache.lucene.index.SortedTermVectorMapper
  Stand-in name for the field in `TermVectorEntry`.
ALPHANUM - Static variable in class org.apache.lucene.analysis.standard.StandardTokenizer
AlreadyClosedException - Exception in org.apache.lucene.store
  This exception is thrown when there is an attempt to access something that has already been closed.
AlreadyClosedException(String) - Constructor for exception org.apache.lucene.store.AlreadyClosedException
ANALYZED - Static variable in class org.apache.lucene.document.Field.Index
  Index the tokens produced by running the field's value through an Analyzer.
ANALYZED_NO_NORMS - Static variable in class org.apache.lucene.document.Field.Index
  Expert: Index the tokens produced by running the field's value through an Analyzer, and also separately disable the storing of norms.
Analyzer - Class in org.apache.lucene.analysis
  An Analyzer builds TokenStreams, which analyze text.
Analyzer() - Constructor for class org.apache.lucene.analysis.Analyzer
analyzer - Variable in class org.apache.lucene.index.IndexModifier
  Deprecated.
AND - Static variable in class org.apache.lucene.queryParser.QueryParser.Operator
AND - Static variable in interface org.apache.lucene.queryParser.QueryParserConstants
  RegularExpression Id.
and(OpenBitSet) - Method in class org.apache.lucene.util.OpenBitSet
AND_OPERATOR - Static variable in class org.apache.lucene.queryParser.QueryParser
  Alternative form of QueryParser.Operator.AND
andNot(OpenBitSet) - Method in class org.apache.lucene.util.OpenBitSet
andNotCount(OpenBitSet, OpenBitSet) - Static method in class org.apache.lucene.util.OpenBitSet
  Returns the popcount or cardinality of "a and not b" or "intersection(a, not(b))".
anyUnhandledExceptions() - Static method in class org.apache.lucene.index.ConcurrentMergeScheduler
  Used for testing
APOSTROPHE - Static variable in class org.apache.lucene.analysis.standard.StandardTokenizer
ArrayUtil - Class in org.apache.lucene.util
  Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.
ArrayUtil() - Constructor for class org.apache.lucene.util.ArrayUtil
assureOpen() - Method in class org.apache.lucene.index.IndexModifier
  Deprecated. Throw an IllegalStateException if the index is closed.
AUTO - Static variable in class org.apache.lucene.search.SortField
  Guess type of sort based on field contents.

## B

backup(int) - Method in interface org.apache.lucene.queryParser.CharStream
  Backs up the input stream by amount steps.
backup(int) - Method in class org.apache.lucene.queryParser.FastCharStream
beginColumn - Variable in class org.apache.lucene.queryParser.Token
  The column number of the first character of this Token.
beginLine - Variable in class org.apache.lucene.queryParser.Token
  The line number of the first character of this Token.
BeginToken() - Method in interface org.apache.lucene.queryParser.CharStream
  Returns the next character that marks the beginning of the next token.
BeginToken() - Method in class org.apache.lucene.queryParser.FastCharStream
binaryLength - Variable in class org.apache.lucene.document.AbstractField
binaryOffset - Variable in class org.apache.lucene.document.AbstractField
binaryValue() - Method in class org.apache.lucene.document.Field
  Deprecated. This method must allocate a new byte[] if the `AbstractField.getBinaryOffset()` is non-zero or `AbstractField.getBinaryLength()` is not the full length of the byte[]. Please use `AbstractField.getBinaryValue()` instead, which simply returns the byte[].
binaryValue() - Method in interface org.apache.lucene.document.Fieldable
  The value of the field in Binary, or null.
bitlist - Static variable in class org.apache.lucene.util.OpenBitSetIterator
bits(IndexReader) - Method in class org.apache.lucene.search.CachingSpanFilter
  Deprecated. Use `CachingSpanFilter.getDocIdSet(IndexReader)` instead.
bits(IndexReader) - Method in class org.apache.lucene.search.CachingWrapperFilter
  Deprecated. Use `CachingWrapperFilter.getDocIdSet(IndexReader)` instead.
bits(IndexReader) - Method in class org.apache.lucene.search.Filter
  Deprecated. Use `Filter.getDocIdSet(IndexReader)` instead.
bits(IndexReader) - Method in class org.apache.lucene.search.PrefixFilter
  Deprecated. Use `PrefixFilter.getDocIdSet(IndexReader)` instead.
bits(IndexReader) - Method in class org.apache.lucene.search.QueryWrapperFilter
  Deprecated. Use `QueryWrapperFilter.getDocIdSet(IndexReader)` instead.
bits(IndexReader) - Method in class org.apache.lucene.search.RangeFilter
  Deprecated. Use `RangeFilter.getDocIdSet(IndexReader)` instead.
bits(IndexReader) - Method in class org.apache.lucene.search.RemoteCachingWrapperFilter
  Deprecated. Use `RemoteCachingWrapperFilter.getDocIdSet(IndexReader)` instead.
bits - Variable in class org.apache.lucene.util.OpenBitSet
bits2words(long) - Static method in class org.apache.lucene.util.OpenBitSet
  returns the number of 64 bit words it would take to hold numBits
bitSpans(IndexReader) - Method in class org.apache.lucene.search.CachingSpanFilter
bitSpans(IndexReader) - Method in class org.apache.lucene.search.SpanFilter
  Returns a SpanFilterResult with true for documents which should be permitted in search results, and false for those that should not and Spans for where the true docs match.
bitSpans(IndexReader) - Method in class org.apache.lucene.search.SpanQueryFilter
BitUtil - Class in org.apache.lucene.util
  A variety of high efficiencly bit twiddling routines.
BitUtil() - Constructor for class org.apache.lucene.util.BitUtil
BitVector - Class in org.apache.lucene.util
  Optimized implementation of a vector of bits.
BitVector(int) - Constructor for class org.apache.lucene.util.BitVector
  Constructs a vector capable of holding `n` bits.
BitVector(Directory, String) - Constructor for class org.apache.lucene.util.BitVector
  Constructs a bit vector from the file `name` in Directory `d`, as written by the `BitVector.write(org.apache.lucene.store.Directory, java.lang.String)` method.
BooleanClause - Class in org.apache.lucene.search
  A clause in a BooleanQuery.
BooleanClause(Query, BooleanClause.Occur) - Constructor for class org.apache.lucene.search.BooleanClause
  Constructs a BooleanClause.
BooleanClause.Occur - Class in org.apache.lucene.search
  Specifies how clauses are to occur in matching documents.
BooleanQuery - Class in org.apache.lucene.search
  A Query that matches documents matching boolean combinations of other queries, e.g.
BooleanQuery() - Constructor for class org.apache.lucene.search.BooleanQuery
  Constructs an empty boolean query.
BooleanQuery(boolean) - Constructor for class org.apache.lucene.search.BooleanQuery
  Constructs an empty boolean query.
BooleanQuery.TooManyClauses - Exception in org.apache.lucene.search
  Thrown when an attempt is made to add more than `BooleanQuery.getMaxClauseCount()` clauses.
BooleanQuery.TooManyClauses() - Constructor for exception org.apache.lucene.search.BooleanQuery.TooManyClauses
boost - Variable in class org.apache.lucene.document.AbstractField
Boost - Static variable in interface org.apache.lucene.queryParser.QueryParserConstants
  Lexical state.
boost(float) - Static method in class org.apache.lucene.util.ToStringUtils
  for printing boost only if not 1.0
BoostingTermQuery - Class in org.apache.lucene.search.payloads
  The BoostingTermQuery is very similar to the `SpanTermQuery` except that it factors in the value of the payload located at each of the positions where the `Term` occurs.
BoostingTermQuery(Term) - Constructor for class org.apache.lucene.search.payloads.BoostingTermQuery
BoostingTermQuery.BoostingTermWeight - Class in org.apache.lucene.search.payloads
BoostingTermQuery.BoostingTermWeight(BoostingTermQuery, Searcher) - Constructor for class org.apache.lucene.search.payloads.BoostingTermQuery.BoostingTermWeight
BoostingTermQuery.BoostingTermWeight.BoostingSpanScorer - Class in org.apache.lucene.search.payloads
BoostingTermQuery.BoostingTermWeight.BoostingSpanScorer(TermSpans, Weight, Similarity, byte[]) - Constructor for class org.apache.lucene.search.payloads.BoostingTermQuery.BoostingTermWeight.BoostingSpanScorer
boosts - Variable in class org.apache.lucene.queryParser.MultiFieldQueryParser
buffer - Variable in class org.apache.lucene.store.BufferedIndexInput
BUFFER_SIZE - Static variable in class org.apache.lucene.store.BufferedIndexInput
  Default buffer size
BufferedIndexInput - Class in org.apache.lucene.store
  Base implementation class for buffered `IndexInput`.
BufferedIndexInput() - Constructor for class org.apache.lucene.store.BufferedIndexInput
BufferedIndexInput(int) - Constructor for class org.apache.lucene.store.BufferedIndexInput
  Inits BufferedIndexInput with a specific bufferSize
BufferedIndexOutput - Class in org.apache.lucene.store
  Base implementation class for buffered `IndexOutput`.
BufferedIndexOutput() - Constructor for class org.apache.lucene.store.BufferedIndexOutput
BYTE - Static variable in class org.apache.lucene.search.function.FieldScoreQuery.Type
  field values are interpreted as numeric byte values.
BYTE - Static variable in class org.apache.lucene.search.SortField
  Sort using term values as encoded bytes.
byte315ToFloat(byte) - Static method in class org.apache.lucene.util.SmallFloat
  byteToFloat(b, mantissaBits=3, zeroExponent=15)
byte52ToFloat(byte) - Static method in class org.apache.lucene.util.SmallFloat
  byteToFloat(b, mantissaBits=5, zeroExponent=2)
byteAt(int) - Method in class org.apache.lucene.index.Payload
  Returns the byte at the given index.
ByteFieldSource - Class in org.apache.lucene.search.function
  Expert: obtains single byte field values from the `FieldCache` using `getBytes()` and makes those values available as other numeric types, casting as needed.
ByteFieldSource(String) - Constructor for class org.apache.lucene.search.function.ByteFieldSource
  Create a cached byte field source with default string-to-byte parser.
ByteFieldSource(String, FieldCache.ByteParser) - Constructor for class org.apache.lucene.search.function.ByteFieldSource
  Create a cached byte field source with a specific string-to-byte parser.
bytesDifference(byte[], int, byte[], int) - Static method in class org.apache.lucene.util.StringHelper
  Compares two byte[] arrays, element by element, and returns the number of elements common to both arrays.
byteToFloat(byte, int, int) - Static method in class org.apache.lucene.util.SmallFloat
  Converts an 8 bit float to a 32 bit float.

## C

cache - Variable in class org.apache.lucene.search.CachingSpanFilter
  A transient Filter cache.
cache - Variable in class org.apache.lucene.search.CachingWrapperFilter
  A transient Filter cache.
cache - Variable in class org.apache.lucene.search.FilterManager
  The cache itself
Cache - Class in org.apache.lucene.util.cache
  Base class for cache implementations.
Cache() - Constructor for class org.apache.lucene.util.cache.Cache
cacheCleanSize - Variable in class org.apache.lucene.search.FilterManager
  Maximum allowed cache size
cachedFieldSourceEquals(FieldCacheSource) - Method in class org.apache.lucene.search.function.ByteFieldSource
cachedFieldSourceEquals(FieldCacheSource) - Method in class org.apache.lucene.search.function.FieldCacheSource
  Check if equals to another `FieldCacheSource`, already knowing that cache and field are equal.
cachedFieldSourceEquals(FieldCacheSource) - Method in class org.apache.lucene.search.function.FloatFieldSource
cachedFieldSourceEquals(FieldCacheSource) - Method in class org.apache.lucene.search.function.IntFieldSource
cachedFieldSourceEquals(FieldCacheSource) - Method in class org.apache.lucene.search.function.ShortFieldSource
cachedFieldSourceHashCode() - Method in class org.apache.lucene.search.function.ByteFieldSource
cachedFieldSourceHashCode() - Method in class org.apache.lucene.search.function.FieldCacheSource
  Return a hash code of a `FieldCacheSource`, without the hash-codes of the field and the cache (those are taken care of elsewhere).
cachedFieldSourceHashCode() - Method in class org.apache.lucene.search.function.FloatFieldSource
cachedFieldSourceHashCode() - Method in class org.apache.lucene.search.function.IntFieldSource
cachedFieldSourceHashCode() - Method in class org.apache.lucene.search.function.ShortFieldSource
CachingSpanFilter - Class in org.apache.lucene.search
  Wraps another SpanFilter's result and caches it.
CachingSpanFilter(SpanFilter) - Constructor for class org.apache.lucene.search.CachingSpanFilter
CachingTokenFilter - Class in org.apache.lucene.analysis
  This class can be used if the Tokens of a TokenStream are intended to be consumed more than once.
CachingTokenFilter(TokenStream) - Constructor for class org.apache.lucene.analysis.CachingTokenFilter
CachingWrapperFilter - Class in org.apache.lucene.search
  Wraps another filter's result and caches it.
CachingWrapperFilter(Filter) - Constructor for class org.apache.lucene.search.CachingWrapperFilter
cantOpenSegments - Variable in class org.apache.lucene.index.CheckIndex.Status
  True if we were unable to open the segments_N file.
capacity() - Method in class org.apache.lucene.util.OpenBitSet
  Returns the current capacity in bits (1 greater than the index of the last bit)
CARAT - Static variable in interface org.apache.lucene.queryParser.QueryParserConstants
  RegularExpression Id.
cardinality() - Method in class org.apache.lucene.util.OpenBitSet
CharArraySet - Class in org.apache.lucene.analysis
  A simple class that stores Strings as char[]'s in a hash table.
CharArraySet(int, boolean) - Constructor for class org.apache.lucene.analysis.CharArraySet
  Create set with enough capacity to hold startSize terms
CharArraySet(Collection, boolean) - Constructor for class org.apache.lucene.analysis.CharArraySet
  Create set from a Collection of char[] or String
CharArraySet.CharArraySetIterator - Class in org.apache.lucene.analysis
  The Iterator for this set.
CharStream - Interface in org.apache.lucene.queryParser
  This interface describes a character stream that maintains line and column number positions of the characters.
CharTokenizer - Class in org.apache.lucene.analysis
  An abstract base class for simple, character-oriented tokenizers.
CharTokenizer(Reader) - Constructor for class org.apache.lucene.analysis.CharTokenizer
check(Directory, boolean) - Static method in class org.apache.lucene.index.CheckIndex
  Deprecated. Please instantiate a CheckIndex and then use `CheckIndex.checkIndex()` instead
check(Directory, boolean, List) - Static method in class org.apache.lucene.index.CheckIndex
  Deprecated. Please instantiate a CheckIndex and then use `CheckIndex.checkIndex(List)` instead
CheckIndex - Class in org.apache.lucene.index
  Basic tool and API to check the health of an index and write a new segments file that removes reference to problematic segments.
CheckIndex(Directory) - Constructor for class org.apache.lucene.index.CheckIndex
  Create a new CheckIndex on the directory.
checkIndex() - Method in class org.apache.lucene.index.CheckIndex
  Returns a `CheckIndex.Status` instance detailing the state of the index.
checkIndex(List) - Method in class org.apache.lucene.index.CheckIndex
  Returns a `CheckIndex.Status` instance detailing the state of the index.
CheckIndex.Status - Class in org.apache.lucene.index
  Returned from `CheckIndex.checkIndex()` detailing the health and status of the index.
CheckIndex.Status() - Constructor for class org.apache.lucene.index.CheckIndex.Status
CheckIndex.Status.SegmentInfoStatus - Class in org.apache.lucene.index
  Holds the status of each segment in the index.
CheckIndex.Status.SegmentInfoStatus() - Constructor for class org.apache.lucene.index.CheckIndex.Status.SegmentInfoStatus
ChecksumIndexInput - Class in org.apache.lucene.store
  Writes bytes through to a primary IndexOutput, computing checksum as it goes.
ChecksumIndexInput(IndexInput) - Constructor for class org.apache.lucene.store.ChecksumIndexInput
ChecksumIndexOutput - Class in org.apache.lucene.store
  Writes bytes through to a primary IndexOutput, computing checksum.
ChecksumIndexOutput(IndexOutput) - Constructor for class org.apache.lucene.store.ChecksumIndexOutput
CJ - Static variable in class org.apache.lucene.analysis.standard.StandardTokenizer
Clause(String) - Method in class org.apache.lucene.queryParser.QueryParser
clauses() - Method in class org.apache.lucene.search.BooleanQuery
  Returns the list of clauses in this query.
clean - Variable in class org.apache.lucene.index.CheckIndex.Status
  True if no problems were found with the index.
cleanSleepTime - Variable in class org.apache.lucene.search.FilterManager
  Cache cleaning frequency
clear() - Method in class org.apache.lucene.analysis.Token
  Resets the term text, payload, flags, and positionIncrement to default.
clear(int) - Method in class org.apache.lucene.util.BitVector
  Sets the value of `bit` to zero.
clear(long) - Method in class org.apache.lucene.util.OpenBitSet
  clears a bit, allowing access beyond the current set size without changing the size.
clear(long, long) - Method in class org.apache.lucene.util.OpenBitSet
  Clears a range of bits.
clear() - Method in class org.apache.lucene.util.PriorityQueue
  Removes all entries from the PriorityQueue.
clear() - Method in class org.apache.lucene.util.ScorerDocQueue
  Removes all entries from the ScorerDocQueue.
clearLock(String) - Method in class org.apache.lucene.store.Directory
  Attempt to clear (forcefully unlock and remove) the specified lock.
clearLock(String) - Method in class org.apache.lucene.store.LockFactory
  Attempt to clear (forcefully unlock and remove) the specified lock.
clearLock(String) - Method in class org.apache.lucene.store.NativeFSLockFactory
clearLock(String) - Method in class org.apache.lucene.store.NoLockFactory
clearLock(String) - Method in class org.apache.lucene.store.SimpleFSLockFactory
clearLock(String) - Method in class org.apache.lucene.store.SingleInstanceLockFactory
clearLock(String) - Method in class org.apache.lucene.store.VerifyingLockFactory
clearUnhandledExceptions() - Static method in class org.apache.lucene.index.ConcurrentMergeScheduler
clone() - Method in class org.apache.lucene.analysis.Token
clone(char[], int, int, int, int) - Method in class org.apache.lucene.analysis.Token
  Makes a clone, but replaces the term buffer & start/end offset in the process.
clone() - Method in class org.apache.lucene.index.Payload
  Clones this payload by creating a copy of the underlying byte array.
clone() - Method in class org.apache.lucene.search.BooleanQuery
clone() - Method in class org.apache.lucene.search.DisjunctionMaxQuery
  Create a shallow copy of us -- used in rewriting if necessary
clone() - Method in class org.apache.lucene.search.function.CustomScoreQuery
clone() - Method in class org.apache.lucene.search.Query
  Returns a clone of this query.
clone() - Method in class org.apache.lucene.store.BufferedIndexInput
clone() - Method in class org.apache.lucene.store.FSDirectory.FSIndexInput
clone() - Method in class org.apache.lucene.store.IndexInput
  Returns a clone of this stream.
clone() - Method in class org.apache.lucene.util.OpenBitSet
close() - Method in class org.apache.lucene.analysis.Analyzer
  Frees persistent resources used by this Analyzer
close() - Method in class org.apache.lucene.analysis.SinkTokenizer
close() - Method in class org.apache.lucene.analysis.TokenFilter
  Close the input TokenStream.
close() - Method in class org.apache.lucene.analysis.Tokenizer
  By default, closes the input Reader.
close() - Method in class org.apache.lucene.analysis.TokenStream
  Releases resources associated with this stream.
close() - Method in class org.apache.lucene.index.ConcurrentMergeScheduler
close() - Method in class org.apache.lucene.index.FilterIndexReader.FilterTermDocs
close() - Method in class org.apache.lucene.index.FilterIndexReader.FilterTermEnum
close() - Method in class org.apache.lucene.index.IndexModifier
  Deprecated. Close this index, writing all pending changes to disk.
close() - Method in class org.apache.lucene.index.IndexReader
  Closes files associated with this index.
close() - Method in class org.apache.lucene.index.IndexWriter
  Commits all changes to an index and closes all associated files.
close(boolean) - Method in class org.apache.lucene.index.IndexWriter
  Closes the index with or without waiting for currently running merges to finish.
close() - Method in class org.apache.lucene.index.LogMergePolicy
close() - Method in class org.apache.lucene.index.MultipleTermPositions
close() - Method in class org.apache.lucene.index.SerialMergeScheduler
close() - Method in interface org.apache.lucene.index.TermDocs
  Frees associated resources.
close() - Method in class org.apache.lucene.index.TermEnum
  Closes the enumeration to further activity, freeing resources.
close() - Method in class org.apache.lucene.search.FilteredTermEnum
  Closes the enumeration to further activity, freeing resources.
close() - Method in class org.apache.lucene.search.FuzzyTermEnum
close() - Method in class org.apache.lucene.search.IndexSearcher
  Note that the underlying IndexReader is not closed, if IndexSearcher was constructed with IndexSearcher(IndexReader r).
close() - Method in class org.apache.lucene.search.MultiSearcher
close() - Method in class org.apache.lucene.search.RemoteSearchable
close() - Method in interface org.apache.lucene.search.Searchable
  Frees resources associated with this Searcher.
close() - Method in class org.apache.lucene.search.Searcher
close() - Method in class org.apache.lucene.search.WildcardTermEnum
close() - Method in class org.apache.lucene.store.BufferedIndexOutput
  Closes this stream to further operations.
close() - Method in class org.apache.lucene.store.ChecksumIndexInput
close() - Method in class org.apache.lucene.store.ChecksumIndexOutput
close() - Method in class org.apache.lucene.store.Directory
  Closes the store.
close() - Method in class org.apache.lucene.store.FSDirectory
  Closes the store to future operations.
close() - Method in class org.apache.lucene.store.FSDirectory.FSIndexInput
close() - Method in class org.apache.lucene.store.FSDirectory.FSIndexInput.Descriptor
close() - Method in class org.apache.lucene.store.FSDirectory.FSIndexOutput
close() - Method in class org.apache.lucene.store.IndexInput
  Closes the stream to futher operations.
close() - Method in class org.apache.lucene.store.IndexOutput
  Closes this stream to further operations.
close() - Method in class org.apache.lucene.store.RAMDirectory
  Closes the store to future operations, releasing associated memory.
close() - Method in class org.apache.lucene.store.RAMOutputStream
close() - Method in class org.apache.lucene.util.cache.Cache
  Closes the cache.
close() - Method in class org.apache.lucene.util.cache.SimpleMapCache
close() - Method in class org.apache.lucene.util.CloseableThreadLocal
CloseableThreadLocal - Class in org.apache.lucene.util
  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.
CloseableThreadLocal() - Constructor for class org.apache.lucene.util.CloseableThreadLocal
collect(int, float) - Method in class org.apache.lucene.search.HitCollector
  Called once for every document matching a query, with the document number and its raw score.
collect(int, float) - Method in class org.apache.lucene.search.TimeLimitedCollector
  Calls collect() on the decorated HitCollector.
collect(int, float) - Method in class org.apache.lucene.search.TopDocCollector
collect(int, float) - Method in class org.apache.lucene.search.TopFieldDocCollector
COLON - Static variable in interface org.apache.lucene.queryParser.QueryParserConstants
  RegularExpression Id.
combine(Query[]) - Method in class org.apache.lucene.search.Query
  Expert: called when re-writing queries under MultiSearcher.
commit() - Method in class org.apache.lucene.index.IndexReader
  Commit changes resulting from delete, undeleteAll, or setNorm operations If an exception is hit, then either no changes or all changes will have been committed to the index (transactional semantics).
commit() - Method in class org.apache.lucene.index.IndexWriter
  Commits all pending updates (added & deleted documents) to the index, and syncs all referenced index files, such that a reader will see the changes and the index updates will survive an OS or machine crash or power loss.
COMPANY - Static variable in class org.apache.lucene.analysis.standard.StandardTokenizer
comparators - Variable in class org.apache.lucene.search.FieldSortedHitQueue
  Stores a comparator corresponding to each field being sorted by
compare(Object, Object) - Method in class org.apache.lucene.index.TermVectorEntryFreqSortedComparator
compare(ScoreDoc, ScoreDoc) - Method in interface org.apache.lucene.search.ScoreDocComparator
  Compares two ScoreDoc objects and returns a result indicating their sort order.
compareTo(Object) - Method in class org.apache.lucene.index.Term
compareTo(Term) - Method in class org.apache.lucene.index.Term
  Compares two terms, returning a negative integer if this term belongs before the argument, zero if this term is equal to the argument, and a positive integer if this term belongs after the argument.
ComplexExplanation - Class in org.apache.lucene.search
  Expert: Describes the score computation for document and query, and can distinguish a match independent of a positive value.
ComplexExplanation() - Constructor for class org.apache.lucene.search.ComplexExplanation
ComplexExplanation(boolean, float, String) - Constructor for class org.apache.lucene.search.ComplexExplanation
compound - Variable in class org.apache.lucene.index.CheckIndex.Status.SegmentInfoStatus
  True if segment is compound file format.
COMPRESS - Static variable in class org.apache.lucene.document.Field.Store
  Store the original field value in the index in a compressed form.
ConcurrentMergeScheduler - Class in org.apache.lucene.index
  A `MergeScheduler` that runs each merge using a separate thread, up until a maximum number of threads (`ConcurrentMergeScheduler.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() - Constructor for class org.apache.lucene.index.ConcurrentMergeScheduler
ConcurrentMergeScheduler.MergeThread - Class in org.apache.lucene.index
ConcurrentMergeScheduler.MergeThread(IndexWriter, MergePolicy.OneMerge) - Constructor for class org.apache.lucene.index.ConcurrentMergeScheduler.MergeThread
Conjunction() - Method in class org.apache.lucene.queryParser.QueryParser
Constants - Class in org.apache.lucene.util
  Some useful constants.
ConstantScoreQuery - Class in org.apache.lucene.search
  A query that wraps a filter and simply returns a constant score equal to the query boost for every document in the filter.
ConstantScoreQuery(Filter) - Constructor for class org.apache.lucene.search.ConstantScoreQuery
ConstantScoreQuery.ConstantScorer - Class in org.apache.lucene.search
ConstantScoreQuery.ConstantScorer(Similarity, IndexReader, Weight) - Constructor for class org.apache.lucene.search.ConstantScoreQuery.ConstantScorer
ConstantScoreQuery.ConstantWeight - Class in org.apache.lucene.search
ConstantScoreQuery.ConstantWeight(Searcher) - Constructor for class org.apache.lucene.search.ConstantScoreQuery.ConstantWeight
ConstantScoreRangeQuery - Class in org.apache.lucene.search
  A range query that returns a constant score equal to its boost for all documents in the range.
ConstantScoreRangeQuery(String, String, String, boolean, boolean) - Constructor for class org.apache.lucene.search.ConstantScoreRangeQuery
ConstantScoreRangeQuery(String, String, String, boolean, boolean, Collator) - Constructor for class org.apache.lucene.search.ConstantScoreRangeQuery
contains(char[], int, int) - Method in class org.apache.lucene.analysis.CharArraySet
  true if the `len` chars of `text` starting at `off` are in the set
contains(CharSequence) - Method in class org.apache.lucene.analysis.CharArraySet
  true if the `CharSequence` is in the set
contains(Object) - Method in class org.apache.lucene.analysis.CharArraySet
containsKey(Object) - Method in class org.apache.lucene.util.cache.Cache
  Returns whether the given key is in this cache.
containsKey(Object) - Method in class org.apache.lucene.util.cache.SimpleMapCache
coord(int, int) - Method in class org.apache.lucene.search.DefaultSimilarity
  Implemented as `overlap / maxOverlap`.
coord(int, int) - Method in class org.apache.lucene.search.Similarity
  Computes a score factor based on the fraction of all query terms that a document contains.
coord(int, int) - Method in class org.apache.lucene.search.SimilarityDelegator
copy(Directory, Directory, boolean) - Static method in class org.apache.lucene.store.Directory
  Copy contents of a directory src to a directory dest.
copyBytes(IndexInput, long) - Method in class org.apache.lucene.store.IndexOutput
  Copy numBytes bytes from input to ourself.
copyText(UnicodeUtil.UTF16Result) - Method in class org.apache.lucene.util.UnicodeUtil.UTF16Result
copyTo(byte[], int) - Method in class org.apache.lucene.index.Payload
  Copies the payload data to a byte array.
CorruptIndexException - Exception in org.apache.lucene.index
  This exception is thrown when Lucene detects an inconsistency in the index.
CorruptIndexException(String) - Constructor for exception org.apache.lucene.index.CorruptIndexException
count - Variable in class org.apache.lucene.search.spans.TermSpans
count() - Method in class org.apache.lucene.util.BitVector
  Returns the total number of one bits in this vector.
createIndexReader() - Method in class org.apache.lucene.index.IndexModifier
  Deprecated. Close the IndexWriter and open an IndexReader.
createIndexWriter() - Method in class org.apache.lucene.index.IndexModifier
  Deprecated. Close the IndexReader and open an IndexWriter.
createOutput(String) - Method in class org.apache.lucene.store.Directory
  Creates a new, empty file in the directory with the given name.
createOutput(String) - Method in class org.apache.lucene.store.FSDirectory
  Creates a new, empty file in the directory with the given name.
createOutput(String) - Method in class org.apache.lucene.store.RAMDirectory
  Creates a new, empty file in the directory with the given name.
createTerm(String) - Method in class org.apache.lucene.index.Term
  Optimized construction of new Terms by reusing same field as this Term - avoids field.intern() overhead
createWeight(Searcher) - Method in class org.apache.lucene.search.BooleanQuery
createWeight(Searcher) - Method in class org.apache.lucene.search.ConstantScoreQuery
createWeight(Searcher) - Method in class org.apache.lucene.search.DisjunctionMaxQuery
createWeight(Searcher) - Method in class org.apache.lucene.search.FilteredQuery
  Returns a Weight that applies the filter to the enclosed query's Weight.
createWeight(Searcher) - Method in class org.apache.lucene.search.function.CustomScoreQuery
createWeight(Searcher) - Method in class org.apache.lucene.search.function.ValueSourceQuery
createWeight(Searcher) - Method in class org.apache.lucene.search.MatchAllDocsQuery
createWeight(Searcher) - Method in class org.apache.lucene.search.MultiPhraseQuery
createWeight(Query) - Method in class org.apache.lucene.search.MultiSearcher
  Create weight in multiple index scenario.
createWeight(Searcher) - Method in class org.apache.lucene.search.payloads.BoostingTermQuery
createWeight(Searcher) - Method in class org.apache.lucene.search.PhraseQuery
createWeight(Searcher) - Method in class org.apache.lucene.search.Query
  Expert: Constructs an appropriate Weight implementation for this query.
createWeight(Query) - Method in class org.apache.lucene.search.Searcher
  creates a weight for `query`
createWeight(Searcher) - Method in class org.apache.lucene.search.spans.SpanQuery
createWeight(Searcher) - Method in class org.apache.lucene.search.TermQuery
curChar - Variable in class org.apache.lucene.queryParser.QueryParserTokenManager
currentToken - Variable in exception org.apache.lucene.queryParser.ParseException
  This is the last token that has been consumed successfully.
CUSTOM - Static variable in class org.apache.lucene.search.SortField
  Sort using a custom Comparator.
customExplain(int, Explanation, Explanation[]) - Method in class org.apache.lucene.search.function.CustomScoreQuery
  Explain the custom score.
customExplain(int, Explanation, Explanation) - Method in class org.apache.lucene.search.function.CustomScoreQuery
  Explain the custom score.
customScore(int, float, float[]) - Method in class org.apache.lucene.search.function.CustomScoreQuery
  Compute a custom score by the subQuery score and a number of ValueSourceQuery scores.
customScore(int, float, float) - Method in class org.apache.lucene.search.function.CustomScoreQuery
  Compute a custom score by the subQuery score and the ValueSourceQuery score.
CustomScoreQuery - Class in org.apache.lucene.search.function
  Query that sets document score as a programmatic function of several (sub) scores.
CustomScoreQuery(Query) - Constructor for class org.apache.lucene.search.function.CustomScoreQuery
  Create a CustomScoreQuery over input subQuery.
CustomScoreQuery(Query, ValueSourceQuery) - Constructor for class org.apache.lucene.search.function.CustomScoreQuery
  Create a CustomScoreQuery over input subQuery and a `ValueSourceQuery`.
CustomScoreQuery(Query, ValueSourceQuery[]) - Constructor for class org.apache.lucene.search.function.CustomScoreQuery
  Create a CustomScoreQuery over input subQuery and a `ValueSourceQuery`.

## D

data - Variable in class org.apache.lucene.index.Payload
  the byte array containing the payload data
DateField - Class in org.apache.lucene.document
  Deprecated. If you build a new index, use `DateTools` instead. This class is included for use with existing indices and will be removed in a future release.
DateTools - Class in org.apache.lucene.document
  Provides support for converting dates to strings and vice-versa.
DateTools.Resolution - Class in org.apache.lucene.document
  Specifies the time granularity.
dateToString(Date) - Static method in class org.apache.lucene.document.DateField
  Deprecated. Converts a Date to a string suitable for indexing.
dateToString(Date, DateTools.Resolution) - Static method in class org.apache.lucene.document.DateTools
  Converts a Date to a string suitable for indexing.
DAY - Static variable in class org.apache.lucene.document.DateTools.Resolution
debugStream - Variable in class org.apache.lucene.queryParser.QueryParserTokenManager
  Debug output.
decodeNorm(byte) - Static method in class org.apache.lucene.search.Similarity
  Decodes a normalization factor stored in an index.
decRef() - Method in class org.apache.lucene.index.IndexReader
  Expert: decreases the refCount of this IndexReader instance.
DEFAULT - Static variable in interface org.apache.lucene.queryParser.QueryParserConstants
  Lexical state.
DEFAULT - Static variable in interface org.apache.lucene.search.FieldCache
  Expert: The cache used internally by sorting and range query classes.
DEFAULT_CACHE_CLEAN_SIZE - Static variable in class org.apache.lucene.search.FilterManager
  The default maximum number of Filters in the cache
DEFAULT_CACHE_SLEEP_TIME - Static variable in class org.apache.lucene.search.FilterManager
  The default frequency of cache clenup
DEFAULT_GREEDY - Variable in class org.apache.lucene.search.TimeLimitedCollector
  Default for `TimeLimitedCollector.isGreedy()`.
DEFAULT_MAX_BUFFERED_DELETE_TERMS - Static variable in class org.apache.lucene.index.IndexWriter
  Disabled by default (because IndexWriter flushes by RAM usage by default).
DEFAULT_MAX_BUFFERED_DOCS - Static variable in class org.apache.lucene.index.IndexWriter
  Disabled by default (because IndexWriter flushes by RAM usage by default).
DEFAULT_MAX_FIELD_LENGTH - Static variable in class org.apache.lucene.index.IndexWriter
  Default value is 10,000.
DEFAULT_MAX_MERGE_DOCS - Static variable in class org.apache.lucene.index.IndexWriter
  Deprecated.
DEFAULT_MAX_MERGE_DOCS - Static variable in class org.apache.lucene.index.LogMergePolicy
  Default maximum segment size.
DEFAULT_MAX_MERGE_MB - Static variable in class org.apache.lucene.index.LogByteSizeMergePolicy
  Default maximum segment size.
DEFAULT_MAX_SYNC_PAUSE_SECONDS - Static variable in class org.apache.lucene.index.IndexWriter
  Default for `IndexWriter.getMaxSyncPauseSeconds()`.
DEFAULT_MAX_TOKEN_LENGTH - Static variable in class org.apache.lucene.analysis.standard.StandardAnalyzer
  Default maximum allowed token length
DEFAULT_MERGE_FACTOR - Static variable in class org.apache.lucene.index.IndexWriter
  Deprecated.
DEFAULT_MERGE_FACTOR - Static variable in class org.apache.lucene.index.LogMergePolicy
  Default merge factor, which is how many segments are merged at a time
DEFAULT_MIN_MERGE_DOCS - Static variable in class org.apache.lucene.index.LogDocMergePolicy
  Default minimum segment size.
DEFAULT_MIN_MERGE_MB - Static variable in class org.apache.lucene.index.LogByteSizeMergePolicy
  Default minimum segment size.
DEFAULT_RAM_BUFFER_SIZE_MB - Static variable in class org.apache.lucene.index.IndexWriter
  Default value is 16 MB (which means flush when buffered docs consume 16 MB RAM).
DEFAULT_RESOLUTION - Static variable in class org.apache.lucene.search.TimeLimitedCollector
  Default timer resolution.
DEFAULT_TERM_INDEX_INTERVAL - Static variable in class org.apache.lucene.index.IndexWriter
  Default value is 128.
DEFAULT_TYPE - Static variable in class org.apache.lucene.analysis.Token
defaultMinSimilarity - Static variable in class org.apache.lucene.search.FuzzyQuery
defaultPrefixLength - Static variable in class org.apache.lucene.search.FuzzyQuery
DefaultSimilarity - Class in org.apache.lucene.search
  Expert: Default scoring implementation.
DefaultSimilarity() - Constructor for class org.apache.lucene.search.DefaultSimilarity
delete() - Method in class org.apache.lucene.index.IndexCommit
  Delete this commit point.
delete() - Method in interface org.apache.lucene.index.IndexCommitPoint
  Deprecated. Delete this commit point.
deleteDocument(int) - Method in class org.apache.lucene.index.IndexModifier
  Deprecated. Deletes the document numbered `docNum`.
deleteDocument(int) - Method in class org.apache.lucene.index.IndexReader
  Deletes the document numbered `docNum`.
deleteDocuments(Term) - Method in class org.apache.lucene.index.IndexModifier
  Deprecated. Deletes all documents containing `term`.
deleteDocuments(Term) - Method in class org.apache.lucene.index.IndexReader
  Deletes all documents that have a given `term` indexed.
deleteDocuments(Term) - Method in class org.apache.lucene.index.IndexWriter
  Deletes the document(s) containing `term`.
deleteDocuments(Term[]) - Method in class org.apache.lucene.index.IndexWriter
  Deletes the document(s) containing any of the terms.
deleteDocuments(Query) - Method in class org.apache.lucene.index.IndexWriter
  Deletes the document(s) matching the provided query.
deleteDocuments(Query[]) - Method in class org.apache.lucene.index.IndexWriter
  Deletes the document(s) matching any of the provided queries.
deleteFile(String) - Method in class org.apache.lucene.store.Directory
  Removes an existing file in the directory.
deleteFile(String) - Method in class org.apache.lucene.store.FSDirectory
  Removes an existing file in the directory.
deleteFile(String) - Method in class org.apache.lucene.store.RAMDirectory
  Removes an existing file in the directory.
deletionsFileName - Variable in class org.apache.lucene.index.CheckIndex.Status.SegmentInfoStatus
  Name of the current deletions file name.
description() - Method in class org.apache.lucene.search.function.ByteFieldSource
description() - Method in class org.apache.lucene.search.function.FieldCacheSource
description() - Method in class org.apache.lucene.search.function.FloatFieldSource
description() - Method in class org.apache.lucene.search.function.IntFieldSource
description() - Method in class org.apache.lucene.search.function.OrdFieldSource
description() - Method in class org.apache.lucene.search.function.ReverseOrdFieldSource
description() - Method in class org.apache.lucene.search.function.ShortFieldSource
description() - Method in class org.apache.lucene.search.function.ValueSource
  description of field, used in explain()
difference() - Method in class org.apache.lucene.search.FilteredTermEnum
  Equality measure on the term
difference() - Method in class org.apache.lucene.search.FuzzyTermEnum
difference() - Method in class org.apache.lucene.search.WildcardTermEnum
dir - Variable in class org.apache.lucene.index.CheckIndex.Status
  Directory index is in.
dir - Variable in class org.apache.lucene.index.ConcurrentMergeScheduler
directory() - Method in class org.apache.lucene.index.FilterIndexReader
directory - Variable in class org.apache.lucene.index.IndexModifier
  Deprecated.
directory() - Method in class org.apache.lucene.index.IndexReader
  Returns the directory associated with this index.
Directory - Class in org.apache.lucene.store
  A Directory is a flat list of files.
Directory() - Constructor for class org.apache.lucene.store.Directory
DISABLE_AUTO_FLUSH - Static variable in class org.apache.lucene.index.IndexWriter
  Value to denote a flush trigger is disabled
disable_tracing() - Method in class org.apache.lucene.queryParser.QueryParser
  Disable tracing.
DisjunctionMaxQuery - Class in org.apache.lucene.search
  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(float) - Constructor for class org.apache.lucene.search.DisjunctionMaxQuery
  Creates a new empty DisjunctionMaxQuery.
DisjunctionMaxQuery(Collection, float) - Constructor for class org.apache.lucene.search.DisjunctionMaxQuery
  Creates a new DisjunctionMaxQuery
doBody() - Method in class org.apache.lucene.store.Lock.With
  Code to execute with exclusive access.
doc() - Method in class org.apache.lucene.index.FilterIndexReader.FilterTermDocs
doc() - Method in class org.apache.lucene.index.MultipleTermPositions
doc() - Method in interface org.apache.lucene.index.TermDocs
  Returns the current document number.
doc() - Method in class org.apache.lucene.search.ConstantScoreQuery.ConstantScorer
doc() - Method in class org.apache.lucene.search.DocIdSetIterator
  Returns the current document number.
doc(int) - Method in class org.apache.lucene.search.Hits
  Deprecated. Returns the stored fields of the nth document in this set.
doc(int) - Method in class org.apache.lucene.search.IndexSearcher
doc(int, FieldSelector) - Method in class org.apache.lucene.search.IndexSearcher
doc(int) - Method in class org.apache.lucene.search.MultiSearcher
doc(int, FieldSelector) - Method in class org.apache.lucene.search.MultiSearcher
doc(int) - Method in class org.apache.lucene.search.RemoteSearchable
doc(int, FieldSelector) - Method in class org.apache.lucene.search.RemoteSearchable
doc() - Method in class org.apache.lucene.search.ReqExclScorer
doc() - Method in class org.apache.lucene.search.ReqOptSumScorer
doc - Variable in class org.apache.lucene.search.ScoreDoc
  Expert: A hit document's number.
doc(int) - Method in interface org.apache.lucene.search.Searchable
  Expert: Returns the stored fields of document `i`.
doc(int, FieldSelector) - Method in interface org.apache.lucene.search.Searchable
  Get the `Document` at the `n`th position.
doc(int) - Method in class org.apache.lucene.search.Searcher
DOC - Static variable in class org.apache.lucene.search.SortField
  Sort by document number (index order).
doc() - Method in interface org.apache.lucene.search.spans.Spans
  Returns the document number of the current match.
doc - Variable in class org.apache.lucene.search.spans.SpanScorer
doc() - Method in class org.apache.lucene.search.spans.SpanScorer
doc - Variable in class org.apache.lucene.search.spans.TermSpans
doc() - Method in class org.apache.lucene.search.spans.TermSpans
doc() - Method in class org.apache.lucene.util.OpenBitSetIterator
docCount - Variable in class org.apache.lucene.index.CheckIndex.Status.SegmentInfoStatus
  Document count (does not take deletions into account).
docCount() - Method in class org.apache.lucene.index.IndexModifier
  Deprecated. Returns the number of documents currently in this index.
docCount() - Method in class org.apache.lucene.index.IndexWriter
  Deprecated. Please use `IndexWriter.maxDoc()` (same as this method) or `IndexWriter.numDocs()` (also takes deletions into account), instead.
docFreq(Term) - Method in class org.apache.lucene.index.FilterIndexReader
docFreq() - Method in class org.apache.lucene.index.FilterIndexReader.FilterTermEnum
docFreq(Term) - Method in class org.apache.lucene.index.IndexReader
  Returns the number of documents containing the term `t`.
docFreq(Term) - Method in class org.apache.lucene.index.MultiReader
docFreq(Term) - Method in class org.apache.lucene.index.ParallelReader
docFreq() - Method in class org.apache.lucene.index.TermEnum
  Returns the docFreq of the current Term in the enumeration.
docFreq() - Method in class org.apache.lucene.search.FilteredTermEnum
  Returns the docFreq of the current Term in the enumeration.
docFreq(Term) - Method in class org.apache.lucene.search.IndexSearcher
docFreq(Term) - Method in class org.apache.lucene.search.MultiSearcher
docFreq(Term) - Method in class org.apache.lucene.search.ParallelMultiSearcher
  TODO: parallelize this one too
docFreq(Term) - Method in class org.apache.lucene.search.RemoteSearchable
docFreq(Term) - Method in interface org.apache.lucene.search.Searchable
  Expert: Returns the number of documents containing `term`.
docFreq(Term) - Method in class org.apache.lucene.search.Searcher
docFreqs(Term[]) - Method in class org.apache.lucene.search.RemoteSearchable
docFreqs(Term[]) - Method in interface org.apache.lucene.search.Searchable
  Expert: For each term in the terms array, calculates the number of documents containing `term`.
docFreqs(Term[]) - Method in class org.apache.lucene.search.Searcher
DocIdBitSet - Class in org.apache.lucene.util
  Simple DocIdSet and DocIdSetIterator backed by a BitSet
DocIdBitSet(BitSet) - Constructor for class org.apache.lucene.util.DocIdBitSet
DocIdSet - Class in org.apache.lucene.search
  A DocIdSet contains a set of doc ids.
DocIdSet() - Constructor for class org.apache.lucene.search.DocIdSet
DocIdSetIterator - Class in org.apache.lucene.search
  This abstract class defines methods to iterate over a set of non-decreasing doc ids.
DocIdSetIterator() - Constructor for class org.apache.lucene.search.DocIdSetIterator
doClose() - Method in class org.apache.lucene.index.FilterIndexReader
doClose() - Method in class org.apache.lucene.index.IndexReader
  Implements close.
doClose() - Method in class org.apache.lucene.index.MultiReader
doClose() - Method in class org.apache.lucene.index.ParallelReader
doCommit() - Method in class org.apache.lucene.index.FilterIndexReader
doCommit() - Method in class org.apache.lucene.index.IndexReader
  Implements commit.
doCommit() - Method in class org.apache.lucene.index.MultiReader
doCommit() - Method in class org.apache.lucene.index.ParallelReader
docStoreCompoundFile - Variable in class org.apache.lucene.index.CheckIndex.Status.SegmentInfoStatus
  True if the shared doc store files are compound file format.
docStoreOffset - Variable in class org.apache.lucene.index.CheckIndex.Status.SegmentInfoStatus
  Doc store offset, if this segment shares the doc store files (stored fields and term vectors) with other segments.
docStoreSegment - Variable in class org.apache.lucene.index.CheckIndex.Status.SegmentInfoStatus
  String of the shared doc store segment, or null if this segment does not share the doc store files.
Document - Class in org.apache.lucene.document
  Documents are the unit of indexing and search.
Document() - Constructor for class org.apache.lucene.document.Document
  Constructs a new document with no fields.
document(int, FieldSelector) - Method in class org.apache.lucene.index.FilterIndexReader
document(int) - Method in class org.apache.lucene.index.IndexReader
  Returns the stored fields of the `n`th `Document` in this index.
document(int, FieldSelector) - Method in class org.apache.lucene.index.IndexReader
  Get the `Document` at the `n`th position.
document(int, FieldSelector) - Method in class org.apache.lucene.index.MultiReader
document(int, FieldSelector) - Method in class org.apache.lucene.index.ParallelReader
DocValues - Class in org.apache.lucene.search.function
  Expert: represents field values as different types.
DocValues() - Constructor for class org.apache.lucene.search.function.DocValues
doDelete(int) - Method in class org.apache.lucene.index.FilterIndexReader
doDelete(int) - Method in class org.apache.lucene.index.IndexReader
  Implements deletion of the document numbered `docNum`.
doDelete(int) - Method in class org.apache.lucene.index.MultiReader
doDelete(int) - Method in class org.apache.lucene.index.ParallelReader
doMerge(MergePolicy.OneMerge) - Method in class org.apache.lucene.index.ConcurrentMergeScheduler
  Does the actual merge, by calling `IndexWriter.merge(org.apache.lucene.index.MergePolicy.OneMerge)`
Done() - Method in interface org.apache.lucene.queryParser.CharStream
  The lexer calls this function to indicate that it is done with the stream and hence implementations can free any resources held by this class.
Done() - Method in class org.apache.lucene.queryParser.FastCharStream
doSetNorm(int, String, byte) - Method in class org.apache.lucene.index.FilterIndexReader
doSetNorm(int, String, byte) - Method in class org.apache.lucene.index.IndexReader
  Implements setNorm in subclass.
doSetNorm(int, String, byte) - Method in class org.apache.lucene.index.MultiReader
doSetNorm(int, String, byte) - Method in class org.apache.lucene.index.ParallelReader
DOUBLE - Static variable in class org.apache.lucene.search.SortField
  Sort using term values as encoded Doubles.
doubleVal(int) - Method in class org.apache.lucene.search.function.DocValues
  Return doc value as a double.
doUndeleteAll() - Method in class org.apache.lucene.index.FilterIndexReader
doUndeleteAll() - Method in class org.apache.lucene.index.IndexReader
  Implements actual undeleteAll() in subclass.
doUndeleteAll() - Method in class org.apache.lucene.index.MultiReader
doUndeleteAll() - Method in class org.apache.lucene.index.ParallelReader

## E

EMAIL - Static variable in class org.apache.lucene.analysis.standard.StandardTokenizer
EMPTY_OFFSET_INFO - Static variable in class org.apache.lucene.index.TermVectorOffsetInfo
  Convenience declaration when creating a `TermPositionVector` that stores only position information.
enable_tracing() - Method in class org.apache.lucene.queryParser.QueryParser
  Enable tracing.
encodeNorm(float) - Static method in class org.apache.lucene.search.Similarity
  Encodes a normalization factor for storage in an index.
end() - Method in interface org.apache.lucene.search.spans.Spans
  Returns the end position of the current match.
end() - Method in class org.apache.lucene.search.spans.TermSpans
endColumn - Variable in class org.apache.lucene.queryParser.Token
  The column number of the last character of this Token.
endEnum() - Method in class org.apache.lucene.search.FilteredTermEnum
  Indicates the end of the enumeration has been reached
endEnum() - Method in class org.apache.lucene.search.FuzzyTermEnum
endEnum() - Method in class org.apache.lucene.search.WildcardTermEnum
endLine - Variable in class org.apache.lucene.queryParser.Token
  The line number of the last character of this Token.
endOffset() - Method in class org.apache.lucene.analysis.Token
  Returns this Token's ending offset, one greater than the position of the last character corresponding to this token in the source text.
ENGLISH_STOP_WORDS - Static variable in class org.apache.lucene.analysis.StopAnalyzer
  An array containing some common English words that are not usually useful for searching.
ensureCapacity(long) - Method in class org.apache.lucene.util.OpenBitSet
  Ensure that the long[] is big enough to hold numBits, expanding it if necessary.
ensureCapacityWords(int) - Method in class org.apache.lucene.util.OpenBitSet
  Expand the long[] with the size given as a number of words (64 bit longs).
ensureOpen() - Method in class org.apache.lucene.index.IndexReader
ensureOpen(boolean) - Method in class org.apache.lucene.index.IndexWriter
  Used internally to throw an `AlreadyClosedException` if this IndexWriter has been closed.
ensureOpen() - Method in class org.apache.lucene.index.IndexWriter
ensureOpen() - Method in class org.apache.lucene.store.Directory
EOF - Static variable in interface org.apache.lucene.queryParser.QueryParserConstants
  End of File.
eol - Variable in exception org.apache.lucene.queryParser.ParseException
  The end of line string for this machine.
equals(Object) - Method in class org.apache.lucene.analysis.Token
equals(Object) - Method in class org.apache.lucene.document.FieldSelectorResult
equals(Object) - Method in class org.apache.lucene.index.IndexCommit
  Two IndexCommits are equal if both their Directory and versions are equal.
equals(Object) - Method in class org.apache.lucene.index.Payload
equals(Object) - Method in class org.apache.lucene.index.Term
  Compares two terms, returning true iff they have the same field and text.
equals(Object) - Method in class org.apache.lucene.index.TermVectorEntry
equals(Object) - Method in class org.apache.lucene.index.TermVectorOffsetInfo
  Two TermVectorOffsetInfos are equals if both the start and end offsets are the same
equals(Object) - Method in class org.apache.lucene.search.BooleanClause
  Returns true iff `o` is equal to this.
equals(Object) - Method in class org.apache.lucene.search.BooleanQuery
  Returns true iff `o` is equal to this.
equals(Object) - Method in class org.apache.lucene.search.CachingSpanFilter
equals(Object) - Method in class org.apache.lucene.search.CachingWrapperFilter
equals(Object) - Method in class org.apache.lucene.search.ConstantScoreQuery
  Returns true if `o` is equal to this.
equals(Object) - Method in class org.apache.lucene.search.ConstantScoreRangeQuery
  Returns true if `o` is equal to this.
equals(Object) - Method in class org.apache.lucene.search.DisjunctionMaxQuery
  Return true iff we represent the same query as o
equals(Object) - Method in class org.apache.lucene.search.FilteredQuery
  Returns true iff `o` is equal to this.
equals(Object) - Method in class org.apache.lucene.search.function.CustomScoreQuery
  Returns true if `o` is equal to this.
equals(Object) - Method in class org.apache.lucene.search.function.FieldCacheSource
equals(Object) - Method in class org.apache.lucene.search.function.OrdFieldSource
equals(Object) - Method in class org.apache.lucene.search.function.ReverseOrdFieldSource
equals(Object) - Method in class org.apache.lucene.search.function.ValueSource
  Needed for possible caching of query results - used by `ValueSourceQuery.equals(Object)`.
equals(Object) - Method in class org.apache.lucene.search.function.ValueSourceQuery
  Returns true if `o` is equal to this.
equals(Object) - Method in class org.apache.lucene.search.FuzzyQuery
equals(Object) - Method in class org.apache.lucene.search.MatchAllDocsQuery
equals(Object) - Method in class org.apache.lucene.search.MultiPhraseQuery
  Returns true if `o` is equal to this.
equals(Object) - Method in class org.apache.lucene.search.MultiTermQuery
equals(Object) - Method in class org.apache.lucene.search.payloads.BoostingTermQuery
equals(Object) - Method in class org.apache.lucene.search.PhraseQuery
  Returns true iff `o` is equal to this.
equals(Object) - Method in class org.apache.lucene.search.PrefixQuery
  Returns true iff `o` is equal to this.
equals(Object) - Method in class org.apache.lucene.search.QueryFilter
  Deprecated.
equals(Object) - Method in class org.apache.lucene.search.QueryWrapperFilter
equals(Object) - Method in class org.apache.lucene.search.RangeFilter
  Returns true if `o` is equal to this.
equals(Object) - Method in class org.apache.lucene.search.RangeQuery
  Returns true iff `o` is equal to this.
equals(Object) - Method in class org.apache.lucene.search.SpanQueryFilter
equals(Object) - Method in class org.apache.lucene.search.spans.SpanFirstQuery
equals(Object) - Method in class org.apache.lucene.search.spans.SpanNearQuery
  Returns true iff `o` is equal to this.
equals(Object) - Method in class org.apache.lucene.search.spans.SpanNotQuery
  Returns true iff `o` is equal to this.
equals(Object) - Method in class org.apache.lucene.search.spans.SpanOrQuery
equals(Object) - Method in class org.apache.lucene.search.spans.SpanTermQuery
  Returns true iff `o` is equal to this.
equals(Object) - Method in class org.apache.lucene.search.TermQuery
  Returns true iff `o` is equal to this.
equals(Object) - Method in class org.apache.lucene.search.WildcardQuery
equals(Object) - Method in class org.apache.lucene.util.OpenBitSet
  returns true if both sets have the same bits set
escape(String) - Static method in class org.apache.lucene.queryParser.QueryParser
  Returns a String where those characters that QueryParser expects to be escaped are escaped by a preceding `\`.
expandingWordNum(long) - Method in class org.apache.lucene.util.OpenBitSet
expectedTokenSequences - Variable in exception org.apache.lucene.queryParser.ParseException
  Each entry in this array is an array of integers.
explain(int) - Method in class org.apache.lucene.search.ConstantScoreQuery.ConstantScorer
explain(IndexReader, int) - Method in class org.apache.lucene.search.ConstantScoreQuery.ConstantWeight
explain(int) - Method in class org.apache.lucene.search.function.DocValues
  Explain the scoring value for the input doc.
explain(Weight, int) - Method in class org.apache.lucene.search.IndexSearcher
explain(Weight, int) - Method in class org.apache.lucene.search.MultiSearcher
explain(int) - Method in class org.apache.lucene.search.payloads.BoostingTermQuery.BoostingTermWeight.BoostingSpanScorer
explain(Weight, int) - Method in class org.apache.lucene.search.RemoteSearchable
explain(int) - Method in class org.apache.lucene.search.ReqExclScorer
explain(int) - Method in class org.apache.lucene.search.ReqOptSumScorer
  Explain the score of a document.
explain(int) - Method in class org.apache.lucene.search.Scorer
  Returns an explanation of the score for a document.
explain(Weight, int) - Method in interface org.apache.lucene.search.Searchable
  Expert: low-level implementation method Returns an Explanation that describes how `doc` scored against `weight`.
explain(Query, int) - Method in class org.apache.lucene.search.Searcher
  Returns an Explanation that describes how `doc` scored against `query`.
explain(Weight, int) - Method in class org.apache.lucene.search.Searcher
explain(int) - Method in class org.apache.lucene.search.spans.SpanScorer
explain(IndexReader, int) - Method in class org.apache.lucene.search.spans.SpanWeight
explain(IndexReader, int) - Method in interface org.apache.lucene.search.Weight
  An explanation of the score computation for the named document.
Explanation - Class in org.apache.lucene.search
  Expert: Describes the score computation for document and query.
Explanation() - Constructor for class org.apache.lucene.search.Explanation
Explanation(float, String) - Constructor for class org.apache.lucene.search.Explanation
expungeDeletes(boolean) - Method in class org.apache.lucene.index.IndexWriter
  Just like `IndexWriter.expungeDeletes()`, except you can specify whether the call should block until the operation completes.
expungeDeletes() - Method in class org.apache.lucene.index.IndexWriter
  Expunges all deletes from the index.
EXT_DEFAULT - Static variable in interface org.apache.lucene.search.ExtendedFieldCache
ExtendedFieldCache - Interface in org.apache.lucene.search
ExtendedFieldCache.DoubleParser - Interface in org.apache.lucene.search
ExtendedFieldCache.LongParser - Interface in org.apache.lucene.search
extractTerms(Set) - Method in class org.apache.lucene.search.BooleanQuery
extractTerms(Set) - Method in class org.apache.lucene.search.ConstantScoreQuery
extractTerms(Set) - Method in class org.apache.lucene.search.DisjunctionMaxQuery
extractTerms(Set) - Method in class org.apache.lucene.search.FilteredQuery
extractTerms(Set) - Method in class org.apache.lucene.search.function.CustomScoreQuery
extractTerms(Set) - Method in class org.apache.lucene.search.function.ValueSourceQuery
extractTerms(Set) - Method in class org.apache.lucene.search.MatchAllDocsQuery
extractTerms(Set) - Method in class org.apache.lucene.search.MultiPhraseQuery
extractTerms(Set) - Method in class org.apache.lucene.search.PhraseQuery
extractTerms(Set) - Method in class org.apache.lucene.search.Query
  Expert: adds all terms occuring in this query to the terms set.
extractTerms(Set) - Method in class org.apache.lucene.search.spans.SpanFirstQuery
extractTerms(Set) - Method in class org.apache.lucene.search.spans.SpanNearQuery
extractTerms(Set) - Method in class org.apache.lucene.search.spans.SpanNotQuery
extractTerms(Set) - Method in class org.apache.lucene.search.spans.SpanOrQuery
extractTerms(Set) - Method in class org.apache.lucene.search.spans.SpanTermQuery
extractTerms(Set) - Method in class org.apache.lucene.search.TermQuery

## F

failureReason - Variable in class org.apache.lucene.store.Lock
  If a lock obtain called, this failureReason may be set with the "root cause" Exception as to why the lock was not obtained.
FastCharStream - Class in org.apache.lucene.queryParser
  An efficient implementation of JavaCC's CharStream interface.
FastCharStream(Reader) - Constructor for class org.apache.lucene.queryParser.FastCharStream
  Constructs from a Reader.
fastClear(int) - Method in class org.apache.lucene.util.OpenBitSet
  clears a bit.
fastClear(long) - Method in class org.apache.lucene.util.OpenBitSet
  clears a bit.
fastFlip(int) - Method in class org.apache.lucene.util.OpenBitSet
  flips a bit.
fastFlip(long) - Method in class org.apache.lucene.util.OpenBitSet
  flips a bit.
fastGet(int) - Method in class org.apache.lucene.util.OpenBitSet
  Returns true or false for the specified bit index.
fastGet(long) - Method in class org.apache.lucene.util.OpenBitSet
  Returns true or false for the specified bit index.
fastSet(int) - Method in class org.apache.lucene.util.OpenBitSet
  Sets the bit at the specified index.
fastSet(long) - Method in class org.apache.lucene.util.OpenBitSet
  Sets the bit at the specified index.
Field - Class in org.apache.lucene.document
  A field is a section of a Document.
Field(String, String, Field.Store, Field.Index) - Constructor for class org.apache.lucene.document.Field
  Create a field by specifying its name, value and how it will be saved in the index.
Field(String, String, Field.Store, Field.Index, Field.TermVector) - Constructor for class org.apache.lucene.document.Field
  Create a field by specifying its name, value and how it will be saved in the index.
Field(String, Reader) - Constructor for class org.apache.lucene.document.Field
  Create a tokenized and indexed field that is not stored.
Field(String, Reader, Field.TermVector) - Constructor for class org.apache.lucene.document.Field
  Create a tokenized and indexed field that is not stored, optionally with storing term vectors.
Field(String, TokenStream) - Constructor for class org.apache.lucene.document.Field
  Create a tokenized and indexed field that is not stored.
Field(String, TokenStream, Field.TermVector) - Constructor for class org.apache.lucene.document.Field
  Create a tokenized and indexed field that is not stored, optionally with storing term vectors.
Field(String, byte[], Field.Store) - Constructor for class org.apache.lucene.document.Field
  Create a stored field with binary value.
Field(String, byte[], int, int, Field.Store) - Constructor for class org.apache.lucene.document.Field
  Create a stored field with binary value.
field() - Method in class org.apache.lucene.index.Term
  Returns the field of this term, an interned string.
field - Variable in class org.apache.lucene.search.function.OrdFieldSource
field - Variable in class org.apache.lucene.search.function.ReverseOrdFieldSource
Field.Index - Class in org.apache.lucene.document
  Specifies whether and how a field should be indexed.
Field.Store - Class in org.apache.lucene.document
  Specifies whether and how a field should be stored.
Field.TermVector - Class in org.apache.lucene.document
  Specifies whether and how a field should have term vectors.
FIELD_DOC - Static variable in class org.apache.lucene.search.SortField
  Represents sorting by document number (index order).
FIELD_SCORE - Static variable in class org.apache.lucene.search.SortField
  Represents sorting by document score (relevancy).
Fieldable - Interface in org.apache.lucene.document
  Synonymous with `Field`.
FieldCache - Interface in org.apache.lucene.search
  Expert: Maintains caches of term values.
FieldCache.ByteParser - Interface in org.apache.lucene.search
  Interface to parse bytes from document fields.
FieldCache.FloatParser - Interface in org.apache.lucene.search
  Interface to parse floats from document fields.
FieldCache.IntParser - Interface in org.apache.lucene.search
  Interface to parse ints from document fields.
FieldCache.ShortParser - Interface in org.apache.lucene.search
  Interface to parse shorts from document fields.
FieldCache.StringIndex - Class in org.apache.lucene.search
  Expert: Stores term text values and document ordering data.
FieldCache.StringIndex(int[], String[]) - Constructor for class org.apache.lucene.search.FieldCache.StringIndex
  Creates one of these objects
FieldCacheSource - Class in org.apache.lucene.search.function
  Expert: A base class for ValueSource implementations that retrieve values for a single field from the `FieldCache`.
FieldCacheSource(String) - Constructor for class org.apache.lucene.search.function.FieldCacheSource
  Create a cached field source for the input field.
FieldDoc - Class in org.apache.lucene.search
  Expert: A ScoreDoc which also contains information about how to sort the referenced document.
FieldDoc(int, float) - Constructor for class org.apache.lucene.search.FieldDoc
  Expert: Creates one of these objects with empty sort information.
FieldDoc(int, float, Comparable[]) - Constructor for class org.apache.lucene.search.FieldDoc
  Expert: Creates one of these objects with the given sort information.
FieldReaderException - Exception in org.apache.lucene.index
FieldReaderException() - Constructor for exception org.apache.lucene.index.FieldReaderException
  Constructs a new runtime exception with `null` as its detail message.
FieldReaderException(Throwable) - Constructor for exception org.apache.lucene.index.FieldReaderException
  Constructs a new runtime exception with the specified cause and a detail message of `(cause==null ? null : cause.toString())` (which typically contains the class and detail message of `cause`).
FieldReaderException(String) - Constructor for exception org.apache.lucene.index.FieldReaderException
  Constructs a new runtime exception with the specified detail message.
FieldReaderException(String, Throwable) - Constructor for exception org.apache.lucene.index.FieldReaderException
  Constructs a new runtime exception with the specified detail message and cause.
fields() - Method in class org.apache.lucene.document.Document
  Deprecated. use `Document.getFields()` instead
fields - Variable in class org.apache.lucene.queryParser.MultiFieldQueryParser
fields - Variable in class org.apache.lucene.search.FieldDoc
  Expert: The values which are used to sort the referenced document.
fields - Variable in class org.apache.lucene.search.FieldSortedHitQueue
  Stores the sort criteria being used.
fields - Variable in class org.apache.lucene.search.TopFieldDocs
  The fields which were used to sort results by.
FieldScoreQuery - Class in org.apache.lucene.search.function
  A query that scores each document as the value of the numeric input field.
FieldScoreQuery(String, FieldScoreQuery.Type) - Constructor for class org.apache.lucene.search.function.FieldScoreQuery
  Create a FieldScoreQuery - a query that scores each document as the value of the numeric input field.
FieldScoreQuery.Type - Class in org.apache.lucene.search.function
  Type of score field, indicating how field values are interpreted/parsed.
fieldsData - Variable in class org.apache.lucene.document.AbstractField
FieldSelector - Interface in org.apache.lucene.document
  Similar to a `FileFilter`, the FieldSelector allows one to make decisions about what Fields get loaded on a `Document` by `IndexReader.document(int,org.apache.lucene.document.FieldSelector)`
FieldSelectorResult - Class in org.apache.lucene.document
  Provides information about what should be done with this Field
FieldSortedHitQueue - Class in org.apache.lucene.search
  Expert: A hit queue for sorting by hits by terms in more than one field.
FieldSortedHitQueue(IndexReader, SortField[], int) - Constructor for class org.apache.lucene.search.FieldSortedHitQueue
  Creates a hit queue sorted by the given list of fields.
FieldSortedTermVectorMapper - Class in org.apache.lucene.index
  For each Field, store a sorted collection of `TermVectorEntry`s

  This is not thread-safe.
FieldSortedTermVectorMapper(Comparator) - Constructor for class org.apache.lucene.index.FieldSortedTermVectorMapper
FieldSortedTermVectorMapper(boolean, boolean, Comparator) - Constructor for class org.apache.lucene.index.FieldSortedTermVectorMapper
file - Variable in class org.apache.lucene.store.FSDirectory.FSIndexInput
fileExists(String) - Method in class org.apache.lucene.store.Directory
  Returns true iff a file with the given name exists.
fileExists(String) - Method in class org.apache.lucene.store.FSDirectory
  Returns true iff a file with the given name exists.
fileExists(String) - Method in class org.apache.lucene.store.RAMDirectory
  Returns true iff the named file exists in this directory.
fileLength(String) - Method in class org.apache.lucene.store.Directory
  Returns the length of a file in the directory.
fileLength(String) - Method in class org.apache.lucene.store.FSDirectory
  Returns the length in bytes of a file in the directory.
fileLength(String) - Method in class org.apache.lucene.store.RAMDirectory
  Returns the length in bytes of a file in the directory.
fileModified(String) - Method in class org.apache.lucene.store.Directory
  Returns the time the named file was last modified.
fileModified(String) - Method in class org.apache.lucene.store.FSDirectory
  Returns the time the named file was last modified.
fileModified(File, String) - Static method in class org.apache.lucene.store.FSDirectory
  Returns the time the named file was last modified.
fileModified(String) - Method in class org.apache.lucene.store.RAMDirectory
  Returns the time the named file was last modified.
filter - Variable in class org.apache.lucene.search.CachingSpanFilter
filter - Variable in class org.apache.lucene.search.CachingWrapperFilter
filter - Variable in class org.apache.lucene.search.ConstantScoreQuery
Filter - Class in org.apache.lucene.search
  Abstract base class providing a mechanism to use a subset of an index for restriction or permission of index search results.
Filter() - Constructor for class org.apache.lucene.search.Filter
filter - Variable in class org.apache.lucene.search.FilterManager.FilterItem
filter - Variable in class org.apache.lucene.search.RemoteCachingWrapperFilter
filterCleaner - Variable in class org.apache.lucene.search.FilterManager
  Cache cleaner that runs in a separate thread
FilteredQuery - Class in org.apache.lucene.search
  A query that applies a filter to the results of another query.
FilteredQuery(Query, Filter) - Constructor for class org.apache.lucene.search.FilteredQuery
  Constructs a new query which applies a filter to the results of the original query.
FilteredTermEnum - Class in org.apache.lucene.search
  Abstract class for enumerating a subset of all terms.
FilteredTermEnum() - Constructor for class org.apache.lucene.search.FilteredTermEnum
FilterIndexReader - Class in org.apache.lucene.index
  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(IndexReader) - Constructor for class org.apache.lucene.index.FilterIndexReader
  Construct a FilterIndexReader based on the specified base reader.
FilterIndexReader.FilterTermDocs - Class in org.apache.lucene.index
  Base class for filtering `TermDocs` implementations.
FilterIndexReader.FilterTermDocs(TermDocs) - Constructor for class org.apache.lucene.index.FilterIndexReader.FilterTermDocs
FilterIndexReader.FilterTermEnum - Class in org.apache.lucene.index
  Base class for filtering `TermEnum` implementations.
FilterIndexReader.FilterTermEnum(TermEnum) - Constructor for class org.apache.lucene.index.FilterIndexReader.FilterTermEnum
FilterIndexReader.FilterTermPositions - Class in org.apache.lucene.index
  Base class for filtering `TermPositions` implementations.
FilterIndexReader.FilterTermPositions(TermPositions) - Constructor for class org.apache.lucene.index.FilterIndexReader.FilterTermPositions
FilterManager - Class in org.apache.lucene.search
  Filter caching singleton.
FilterManager() - Constructor for class org.apache.lucene.search.FilterManager
  Sets up the FilterManager singleton.
FilterManager.FilterCleaner - Class in org.apache.lucene.search
  Keeps the cache from getting too big.
FilterManager.FilterCleaner() - Constructor for class org.apache.lucene.search.FilterManager.FilterCleaner
FilterManager.FilterItem - Class in org.apache.lucene.search
  Holds the filter and the last time the filter was used, to make LRU-based cache cleaning possible.
FilterManager.FilterItem(Filter) - Constructor for class org.apache.lucene.search.FilterManager.FilterItem
finalize() - Method in class org.apache.lucene.index.IndexWriter
  Release the write lock, if needed.
finalize() - Method in class org.apache.lucene.store.FSDirectory.FSIndexInput.Descriptor
findMerges(SegmentInfos, IndexWriter) - Method in class org.apache.lucene.index.LogMergePolicy
  Checks if any merges are now necessary and returns a `MergePolicy.MergeSpecification` if so.
findMergesForOptimize(SegmentInfos, IndexWriter, int, Set) - Method in class org.apache.lucene.index.LogMergePolicy
  Returns the merges necessary to optimize the index.
findMergesToExpungeDeletes(SegmentInfos, IndexWriter) - Method in class org.apache.lucene.index.LogMergePolicy
  Finds merges necessary to expunge all deletes from the index.
finishCommit() - Method in class org.apache.lucene.store.ChecksumIndexOutput
  See `ChecksumIndexOutput.prepareCommit()`
firstTime - Variable in class org.apache.lucene.search.spans.SpanScorer
fixIndex(CheckIndex.Status) - Method in class org.apache.lucene.index.CheckIndex
  Repairs the index using previously returned result from `CheckIndex.checkIndex()`.
flip(long) - Method in class org.apache.lucene.util.OpenBitSet
  flips a bit, expanding the set size if necessary
flip(long, long) - Method in class org.apache.lucene.util.OpenBitSet
  Flips a range of bits, expanding the set size if necessary
flipAndGet(int) - Method in class org.apache.lucene.util.OpenBitSet
  flips a bit and returns the resulting bit value.
flipAndGet(long) - Method in class org.apache.lucene.util.OpenBitSet
  flips a bit and returns the resulting bit value.
FLOAT - Static variable in class org.apache.lucene.search.function.FieldScoreQuery.Type
  field values are interpreted as numeric float values.
FLOAT - Static variable in class org.apache.lucene.search.SortField
  Sort using term values as encoded Floats.
FloatFieldSource - Class in org.apache.lucene.search.function
  Expert: obtains float field values from the `FieldCache` using `getFloats()` and makes those values available as other numeric types, casting as needed.
FloatFieldSource(String) - Constructor for class org.apache.lucene.search.function.FloatFieldSource
  Create a cached float field source with default string-to-float parser.
FloatFieldSource(String, FieldCache.FloatParser) - Constructor for class org.apache.lucene.search.function.FloatFieldSource
  Create a cached float field source with a specific string-to-float parser.
floatToByte(float, int, int) - Static method in class org.apache.lucene.util.SmallFloat
  Converts a 32 bit float to an 8 bit float.
floatToByte315(float) - Static method in class org.apache.lucene.util.SmallFloat
  floatToByte(b, mantissaBits=3, zeroExponent=15)
  smallest non-zero value = 5.820766E-10
  largest value = 7.5161928E9
  epsilon = 0.125
floatToByte52(float) - Static method in class org.apache.lucene.util.SmallFloat
  floatToByte(b, mantissaBits=5, zeroExponent=2)
  smallest nonzero value = 0.033203125
  largest value = 1984.0
  epsilon = 0.03125
floatVal(int) - Method in class org.apache.lucene.search.function.DocValues
  Return doc value as a float.
flush() - Method in class org.apache.lucene.index.IndexModifier
  Deprecated. Make sure all changes are written to disk.
flush() - Method in class org.apache.lucene.index.IndexReader
flush() - Method in class org.apache.lucene.index.IndexWriter
  Deprecated. please call `IndexWriter.commit()`) instead
flush(boolean, boolean, boolean) - Method in class org.apache.lucene.index.IndexWriter
  Flush all in-memory buffered udpates (adds and deletes) to the Directory.
flush() - Method in class org.apache.lucene.store.BufferedIndexOutput
  Forces any buffered output to be written.
flush() - Method in class org.apache.lucene.store.ChecksumIndexOutput
flush() - Method in class org.apache.lucene.store.IndexOutput
  Forces any buffered output to be written.
flush() - Method in class org.apache.lucene.store.RAMOutputStream
flushBuffer(byte[], int, int) - Method in class org.apache.lucene.store.BufferedIndexOutput
  Expert: implements buffer write.
flushBuffer(byte[], int, int) - Method in class org.apache.lucene.store.FSDirectory.FSIndexOutput
  output methods:
freq() - Method in class org.apache.lucene.index.FilterIndexReader.FilterTermDocs
freq() - Method in class org.apache.lucene.index.MultipleTermPositions
freq() - Method in interface org.apache.lucene.index.TermDocs
  Returns the frequency of the term within the current document.
freq - Variable in class org.apache.lucene.search.spans.SpanScorer
freq - Variable in class org.apache.lucene.search.spans.TermSpans
FSDirectory - Class in org.apache.lucene.store
  Straightforward implementation of `Directory` as a directory of files.
FSDirectory() - Constructor for class org.apache.lucene.store.FSDirectory
FSDirectory.FSIndexInput - Class in org.apache.lucene.store
FSDirectory.FSIndexInput(File) - Constructor for class org.apache.lucene.store.FSDirectory.FSIndexInput
FSDirectory.FSIndexInput(File, int) - Constructor for class org.apache.lucene.store.FSDirectory.FSIndexInput
FSDirectory.FSIndexInput.Descriptor - Class in org.apache.lucene.store
FSDirectory.FSIndexInput.Descriptor(File, String) - Constructor for class org.apache.lucene.store.FSDirectory.FSIndexInput.Descriptor
FSDirectory.FSIndexOutput - Class in org.apache.lucene.store
FSDirectory.FSIndexOutput(File) - Constructor for class org.apache.lucene.store.FSDirectory.FSIndexOutput
FUZZY_SLOP - Static variable in interface org.apache.lucene.queryParser.QueryParserConstants
  RegularExpression Id.
FuzzyQuery - Class in org.apache.lucene.search
  Implements the fuzzy search query.
FuzzyQuery(Term, float, int) - Constructor for class org.apache.lucene.search.FuzzyQuery
  Create a new FuzzyQuery that will match terms with a similarity of at least `minimumSimilarity` to `term`.
FuzzyQuery(Term, float) - Constructor for class org.apache.lucene.search.FuzzyQuery
  Calls `FuzzyQuery(term, minimumSimilarity, 0)`.
FuzzyQuery(Term) - Constructor for class org.apache.lucene.search.FuzzyQuery
  Calls `FuzzyQuery(term, 0.5f, 0)`.
FuzzyQuery.ScoreTerm - Class in org.apache.lucene.search
FuzzyQuery.ScoreTerm(Term, float) - Constructor for class org.apache.lucene.search.FuzzyQuery.ScoreTerm
FuzzyQuery.ScoreTermQueue - Class in org.apache.lucene.search
FuzzyQuery.ScoreTermQueue(int) - Constructor for class org.apache.lucene.search.FuzzyQuery.ScoreTermQueue
FuzzyTermEnum - Class in org.apache.lucene.search
  Subclass of FilteredTermEnum for enumerating all terms that are similiar to the specified filter term.
FuzzyTermEnum(IndexReader, Term) - Constructor for class org.apache.lucene.search.FuzzyTermEnum
  Creates a FuzzyTermEnum with an empty prefix and a minSimilarity of 0.5f.
FuzzyTermEnum(IndexReader, Term, float) - Constructor for class org.apache.lucene.search.FuzzyTermEnum
  Creates a FuzzyTermEnum with an empty prefix.
FuzzyTermEnum(IndexReader, Term, float, int) - Constructor for class org.apache.lucene.search.FuzzyTermEnum
  Constructor for enumeration of all terms from specified `reader` which share a prefix of length `prefixLength` with `term` and which have a fuzzy similarity > `minSimilarity`.

## G

generateParseException() - Method in class org.apache.lucene.queryParser.QueryParser
  Generate ParseException.
get(String) - Method in class org.apache.lucene.document.Document
  Returns the string value of the field with the given name if any exist in this document, or null.
get() - Static method in class org.apache.lucene.LucenePackage
  Return Lucene's package, including version information.
get(String) - Method in class org.apache.lucene.search.Hit
  Deprecated. Returns the string value of the field with the given name if any exist in this document, or null.
get(int) - Method in class org.apache.lucene.util.BitVector
  Returns `true` if `bit` is one and `false` if it is zero.
get(Object) - Method in class org.apache.lucene.util.cache.Cache
  Returns the value for the given key.
get(Object) - Method in class org.apache.lucene.util.cache.SimpleMapCache
get() - Method in class org.apache.lucene.util.CloseableThreadLocal
get(int) - Method in class org.apache.lucene.util.OpenBitSet
  Returns true or false for the specified bit index.
get(long) - Method in class org.apache.lucene.util.OpenBitSet
  Returns true or false for the specified bit index
getAllowDocsOutOfOrder() - Static method in class org.apache.lucene.search.BooleanQuery
  Whether hit docs may be collected out of docid order.
getAllowLeadingWildcard() - Method in class org.apache.lucene.queryParser.QueryParser
getAnalyzer() - Method in class org.apache.lucene.index.IndexWriter
  Returns the analyzer used by this index.
getAnalyzer() - Method in class org.apache.lucene.queryParser.QueryParser
getAndSet(int) - Method in class org.apache.lucene.util.BitVector
  Sets the value of `bit` to true, and returns true if bit was already set
getAndSet(int) - Method in class org.apache.lucene.util.OpenBitSet
  Sets a bit and returns the previous value.
getAndSet(long) - Method in class org.apache.lucene.util.OpenBitSet
  Sets a bit and returns the previous value.
getAuto(IndexReader, String) - Method in interface org.apache.lucene.search.FieldCache
  Checks the internal cache for an appropriate entry, and if none is found reads `field` to see if it contains integers, floats or strings, and then calls one of the other methods in this class to get the values.
getAverageValue() - Method in class org.apache.lucene.search.function.DocValues
  Returns the average of all values.
getBeginColumn() - Method in interface org.apache.lucene.queryParser.CharStream
  Returns the column number of the first character for current token (being matched after the last call to BeginTOken).
getBeginColumn() - Method in class org.apache.lucene.queryParser.FastCharStream
getBeginLine() - Method in interface org.apache.lucene.queryParser.CharStream
  Returns the line number of the first character for current token (being matched after the last call to BeginTOken).
getBeginLine() - Method in class org.apache.lucene.queryParser.FastCharStream
getBinaryLength() - Method in class org.apache.lucene.document.AbstractField
  Returns length of byte[] segment that is used as value, if Field is not binary returned value is undefined
getBinaryLength() - Method in interface org.apache.lucene.document.Fieldable
  Returns length of byte[] segment that is used as value, if Field is not binary returned value is undefined
getBinaryOffset() - Method in class org.apache.lucene.document.AbstractField
  Returns offset into byte[] segment that is used as value, if Field is not binary returned value is undefined
getBinaryOffset() - Method in interface org.apache.lucene.document.Fieldable
  Returns offset into byte[] segment that is used as value, if Field is not binary returned value is undefined
getBinaryValue() - Method in class org.apache.lucene.document.AbstractField
  Return the raw byte[] for the binary field.
getBinaryValue(byte[]) - Method in class org.apache.lucene.document.AbstractField
getBinaryValue(String) - Method in class org.apache.lucene.document.Document
  Returns an array of bytes for the first (or only) field that has the name specified as the method parameter.
getBinaryValue() - Method in interface org.apache.lucene.document.Fieldable
  Return the raw byte[] for the binary field.
getBinaryValue(byte[]) - Method in interface org.apache.lucene.document.Fieldable
  Return the raw byte[] for the binary field.
getBinaryValues(String) - Method in class org.apache.lucene.document.Document
  Returns an array of byte arrays for of the fields that have the name specified as the method parameter.
getBit(int) - Method in class org.apache.lucene.util.OpenBitSet
  returns 1 if the bit is set, 0 if not.
getBits() - Method in class org.apache.lucene.search.SpanFilterResult
  Deprecated. Use `SpanFilterResult.getDocIdSet()`
getBits() - Method in class org.apache.lucene.util.OpenBitSet
  Expert: returns the long[] storing the bits
getBitSet() - Method in class org.apache.lucene.util.DocIdBitSet
  Returns the underlying BitSet.
getBooleanQuery(Vector) - Method in class org.apache.lucene.queryParser.QueryParser
  Deprecated. use `QueryParser.getBooleanQuery(List)` instead
getBooleanQuery(List) - Method in class org.apache.lucene.queryParser.QueryParser
  Factory method for generating query, given a set of clauses.
getBooleanQuery(Vector, boolean) - Method in class org.apache.lucene.queryParser.QueryParser
  Deprecated. use `QueryParser.getBooleanQuery(List, boolean)` instead
getBooleanQuery(List, boolean) - Method in class org.apache.lucene.queryParser.QueryParser
  Factory method for generating query, given a set of clauses.
getBoost() - Method in class org.apache.lucene.document.AbstractField
  Returns the boost factor for hits for this field.
getBoost() - Method in class org.apache.lucene.document.Document
  Returns, at indexing time, the boost factor as set by `Document.setBoost(float)`.
getBoost() - Method in interface org.apache.lucene.document.Fieldable
  Returns the boost factor for hits for this field.
getBoost() - Method in class org.apache.lucene.search.Hit
  Deprecated. Returns the boost factor for this hit on any field of the underlying document.
getBoost() - Method in class org.apache.lucene.search.Query
  Gets the boost for this clause.
getBufferSize() - Method in class org.apache.lucene.store.BufferedIndexInput
  Returns buffer size.
getBytes(IndexReader, String) - Method in interface org.apache.lucene.search.FieldCache
  Checks the internal cache for an appropriate entry, and if none is found, reads the terms in `field` as a single byte and returns an array of size `reader.maxDoc()` of the value each document has in the given field.
getBytes(IndexReader, String, FieldCache.ByteParser) - Method in interface org.apache.lucene.search.FieldCache
  Checks the internal cache for an appropriate entry, and if none is found, reads the terms in `field` as bytes and returns an array of size `reader.maxDoc()` of the value each document has in the given field.
getByteSize() - Method in class org.apache.lucene.util.SortedVIntList
getCachedFieldValues(FieldCache, String, IndexReader) - Method in class org.apache.lucene.search.function.ByteFieldSource
getCachedFieldValues(FieldCache, String, IndexReader) - Method in class org.apache.lucene.search.function.FieldCacheSource
  Return cached DocValues for input field and reader.
getCachedFieldValues(FieldCache, String, IndexReader) - Method in class org.apache.lucene.search.function.FloatFieldSource
getCachedFieldValues(FieldCache, String, IndexReader) - Method in class org.apache.lucene.search.function.IntFieldSource
getCachedFieldValues(FieldCache, String, IndexReader) - Method in class org.apache.lucene.search.function.ShortFieldSource
getChecksum() - Method in class org.apache.lucene.store.ChecksumIndexInput
getChecksum() - Method in class org.apache.lucene.store.ChecksumIndexOutput
getClauses() - Method in class org.apache.lucene.search.BooleanQuery
  Returns the set of clauses in this query.
getClauses() - Method in class org.apache.lucene.search.spans.SpanNearQuery
  Return the clauses whose spans are matched.
getClauses() - Method in class org.apache.lucene.search.spans.SpanOrQuery
  Return the clauses whose spans are matched.
getCollator() - Method in class org.apache.lucene.search.RangeQuery
  Returns the collator used to determine range inclusion, if any.
getColumn() - Method in interface org.apache.lucene.queryParser.CharStream
  Deprecated.
getColumn() - Method in class org.apache.lucene.queryParser.FastCharStream
getComparable(String) - Method in class org.apache.lucene.search.SortComparator
  Returns an object which, when sorted according to natural order, will order the Term values in the correct order.
getComparator() - Method in class org.apache.lucene.index.FieldSortedTermVectorMapper
getCurrentVersion(String) - Static method in class org.apache.lucene.index.IndexReader
  Reads version number from segments files.
getCurrentVersion(File) - Static method in class org.apache.lucene.index.IndexReader
  Reads version number from segments files.
getCurrentVersion(Directory) - Static method in class org.apache.lucene.index.IndexReader
  Reads version number from segments files.
getCustom(IndexReader, String, SortComparator) - Method in interface org.apache.lucene.search.FieldCache
  Checks the internal cache for an appropriate entry, and if none is found reads the terms out of `field` and calls the given SortComparator to get the sort values.
getData() - Method in class org.apache.lucene.index.Payload
  Returns a reference to the underlying byte array that holds this payloads data.
getDateResolution(String) - Method in class org.apache.lucene.queryParser.QueryParser
  Returns the date resolution that is used by RangeQueries for the given field.
getDefault() - Static method in class org.apache.lucene.search.Similarity
  Return the default Similarity implementation used by indexing and search code.
getDefaultInfoStream() - Static method in class org.apache.lucene.index.IndexWriter
  Returns the current default infoStream for newly instantiated IndexWriters.
getDefaultOperator() - Method in class org.apache.lucene.queryParser.QueryParser
  Gets implicit operator setting, which will be either AND_OPERATOR or OR_OPERATOR.
getDefaultReplaceInvalidAcronym() - Static method in class org.apache.lucene.analysis.standard.StandardAnalyzer
  Deprecated. This will be removed (hardwired to true) in 3.0
getDefaultWriteLockTimeout() - Static method in class org.apache.lucene.index.IndexWriter
  Returns default write lock timeout for newly instantiated IndexWriters.
getDescription() - Method in class org.apache.lucene.search.Explanation
  A description of this explanation node.
getDetails() - Method in class org.apache.lucene.search.Explanation
  The sub-nodes of this explanation node.
getDirectory() - Method in class org.apache.lucene.index.IndexCommit
  Returns the `Directory` for the index.
getDirectory() - Method in class org.apache.lucene.index.IndexWriter
  Returns the Directory used by this index.
getDirectory() - Method in exception org.apache.lucene.index.MergePolicy.MergeException
  Returns the `Directory` of the index that hit the exception.
getDirectory(String) - Static method in class org.apache.lucene.store.FSDirectory
  Returns the directory instance for the named location.
getDirectory(String, LockFactory) - Static method in class org.apache.lucene.store.FSDirectory
  Returns the directory instance for the named location.
getDirectory(File) - Static method in class org.apache.lucene.store.FSDirectory
  Returns the directory instance for the named location.
getDirectory(File, LockFactory) - Static method in class org.apache.lucene.store.FSDirectory
  Returns the directory instance for the named location.
getDirectory(String, boolean) - Static method in class org.apache.lucene.store.FSDirectory
  Deprecated. Use IndexWriter's create flag, instead, to create a new index.
getDirectory(File, boolean) - Static method in class org.apache.lucene.store.FSDirectory
  Deprecated. Use IndexWriter's create flag, instead, to create a new index.
getDisableLocks() - Static method in class org.apache.lucene.store.FSDirectory
  Returns whether Lucene's use of lock files is disabled.
getDoc() - Method in class org.apache.lucene.search.SpanFilterResult.PositionInfo
getDocIdSet(IndexReader) - Method in class org.apache.lucene.search.CachingSpanFilter
getDocIdSet(IndexReader) - Method in class org.apache.lucene.search.CachingWrapperFilter
getDocIdSet(IndexReader) - Method in class org.apache.lucene.search.Filter
getDocIdSet(IndexReader) - Method in class org.apache.lucene.search.PrefixFilter
getDocIdSet(IndexReader) - Method in class org.apache.lucene.search.QueryWrapperFilter
getDocIdSet(IndexReader) - Method in class org.apache.lucene.search.RangeFilter
  Returns a DocIdSet with documents that should be permitted in search results.
getDocIdSet(IndexReader) - Method in class org.apache.lucene.search.RemoteCachingWrapperFilter
  Uses the `FilterManager` to keep the cache for a filter on the searcher side of a remote connection.
getDocIdSet() - Method in class org.apache.lucene.search.SpanFilterResult
  Returns the docIdSet
getDocIdSet(IndexReader) - Method in class org.apache.lucene.search.SpanQueryFilter
getDocument() - Method in class org.apache.lucene.search.Hit
  Deprecated. Returns document for this hit.
getDoubles(IndexReader, String) - Method in interface org.apache.lucene.search.ExtendedFieldCache
  Checks the internal cache for an appropriate entry, and if none is found, reads the terms in `field` as integers and returns an array of size `reader.maxDoc()` of the value each document has in the given field.
getDoubles(IndexReader, String, ExtendedFieldCache.DoubleParser) - Method in interface org.apache.lucene.search.ExtendedFieldCache
  Checks the internal cache for an appropriate entry, and if none is found, reads the terms in `field` as doubles and returns an array of size `reader.maxDoc()` of the value each document has in the given field.
getEnablePositionIncrements() - Method in class org.apache.lucene.analysis.StopFilter
getEnablePositionIncrements() - Method in class org.apache.lucene.queryParser.QueryParser
getEnablePositionIncrementsDefault() - Static method in class org.apache.lucene.analysis.StopFilter
getEnd() - Method in class org.apache.lucene.search.SpanFilterResult.StartEnd
getEnd() - Method in class org.apache.lucene.search.spans.SpanFirstQuery
  Return the maximum end position permitted in a match.
getEndColumn() - Method in interface org.apache.lucene.queryParser.CharStream
  Returns the column number of the last character for current token (being matched after the last call to BeginTOken).
getEndColumn() - Method in class org.apache.lucene.queryParser.FastCharStream
getEndLine() - Method in interface org.apache.lucene.queryParser.CharStream
  Returns the line number of the last character for current token (being matched after the last call to BeginTOken).
getEndLine() - Method in class org.apache.lucene.queryParser.FastCharStream
getEndOffset() - Method in class org.apache.lucene.index.TermVectorOffsetInfo
  The accessor for the ending offset for the term
getEnum(IndexReader) - Method in class org.apache.lucene.search.FuzzyQuery
getEnum(IndexReader) - Method in class org.apache.lucene.search.MultiTermQuery
  Construct the enumeration to be used, expanding the pattern term.
getEnum(IndexReader) - Method in class org.apache.lucene.search.WildcardQuery
getExclude() - Method in class org.apache.lucene.search.spans.SpanNotQuery
  Return the SpanQuery whose matches must not overlap those returned.
getFactory() - Method in class org.apache.lucene.search.SortField
getField(String) - Method in class org.apache.lucene.document.Document
  Returns a field with the given name if any exist in this document, or null.
getField() - Method in interface org.apache.lucene.index.TermFreqVector
  The `Fieldable` name.
getField() - Method in class org.apache.lucene.index.TermVectorEntry
getField() - Method in class org.apache.lucene.queryParser.QueryParser
getField() - Method in class org.apache.lucene.search.ConstantScoreRangeQuery
  Returns the field name for this query
getField() - Method in class org.apache.lucene.search.QueryTermVector
getField() - Method in class org.apache.lucene.search.RangeQuery
  Returns the field name for this query
getField() - Method in class org.apache.lucene.search.SortField
  Returns the name of the field.
getField() - Method in class org.apache.lucene.search.spans.SpanFirstQuery
getField() - Method in class org.apache.lucene.search.spans.SpanNearQuery
getField() - Method in class org.apache.lucene.search.spans.SpanNotQuery
getField() - Method in class org.apache.lucene.search.spans.SpanOrQuery
getField() - Method in class org.apache.lucene.search.spans.SpanQuery
  Returns the name of the field matched by this query.
getField() - Method in class org.apache.lucene.search.spans.SpanTermQuery
getFieldable(String) - Method in class org.apache.lucene.document.Document
  Returns a field with the given name if any exist in this document, or null.
getFieldables(String) - Method in class org.apache.lucene.document.Document
  Returns an array of `Fieldable`s with the given name.
getFieldNames(IndexReader.FieldOption) - Method in class org.apache.lucene.index.FilterIndexReader
getFieldNames(IndexReader.FieldOption) - Method in class org.apache.lucene.index.IndexReader
  Get a list of unique field names that exist in this index and have the specified field option information.
getFieldNames(IndexReader.FieldOption) - Method in class org.apache.lucene.index.MultiReader
getFieldNames(IndexReader.FieldOption) - Method in class org.apache.lucene.index.ParallelReader
getFieldQuery(String, String, int) - Method in class org.apache.lucene.queryParser.MultiFieldQueryParser
getFieldQuery(String, String) - Method in class org.apache.lucene.queryParser.MultiFieldQueryParser
getFieldQuery(String, String) - Method in class org.apache.lucene.queryParser.QueryParser
getFieldQuery(String, String, int) - Method in class org.apache.lucene.queryParser.QueryParser
  Base implementation delegates to `QueryParser.getFieldQuery(String,String)`.
getFields() - Method in class org.apache.lucene.document.Document
  Returns a List of all the fields in a document.
getFields(String) - Method in class org.apache.lucene.document.Document
  Returns an array of `Field`s with the given name.
getFieldToTerms() - Method in class org.apache.lucene.index.FieldSortedTermVectorMapper
  Get the mapping between fields and terms, sorted by the comparator
getFieldToTerms() - Method in class org.apache.lucene.index.PositionBasedTermVectorMapper
  Get the mapping between fields and terms, sorted by the comparator
getFile() - Method in class org.apache.lucene.store.FSDirectory
getFileNames() - Method in class org.apache.lucene.index.IndexCommit
  Returns all index files referenced by this commit point.
getFileNames() - Method in interface org.apache.lucene.index.IndexCommitPoint
  Deprecated. Returns all index files referenced by this commit point.
getFilePointer() - Method in class org.apache.lucene.store.BufferedIndexInput
getFilePointer() - Method in class org.apache.lucene.store.BufferedIndexOutput
  Returns the current position in this file, where the next write will occur.
getFilePointer() - Method in class org.apache.lucene.store.ChecksumIndexInput
getFilePointer() - Method in class org.apache.lucene.store.ChecksumIndexOutput
getFilePointer() - Method in class org.apache.lucene.store.IndexInput
  Returns the current position in this file, where the next read will occur.
getFilePointer() - Method in class org.apache.lucene.store.IndexOutput
  Returns the current position in this file, where the next write will occur.
getFilePointer() - Method in class org.apache.lucene.store.RAMOutputStream
getFilter() - Static method in class org.apache.lucene.index.IndexFileNameFilter
getFilter() - Method in class org.apache.lucene.search.ConstantScoreQuery
  Returns the encapsulated filter
getFilter() - Method in class org.apache.lucene.search.FilteredQuery
getFilter(Filter) - Method in class org.apache.lucene.search.FilterManager
  Returns the cached version of the filter.
getFlags() - Method in class org.apache.lucene.analysis.Token
  EXPERIMENTAL: While we think this is here to stay, we may want to change it to be a long.
getFloats(IndexReader, String) - Method in interface org.apache.lucene.search.FieldCache
  Checks the internal cache for an appropriate entry, and if none is found, reads the terms in `field` as floats and returns an array of size `reader.maxDoc()` of the value each document has in the given field.
getFloats(IndexReader, String, FieldCache.FloatParser) - Method in interface org.apache.lucene.search.FieldCache
  Checks the internal cache for an appropriate entry, and if none is found, reads the terms in `field` as floats and returns an array of size `reader.maxDoc()` of the value each document has in the given field.
getFrequency() - Method in class org.apache.lucene.index.TermVectorEntry
getFuzzyMinSim() - Method in class org.apache.lucene.queryParser.QueryParser
  Get the minimal similarity for fuzzy queries.
getFuzzyPrefixLength() - Method in class org.apache.lucene.queryParser.QueryParser
  Get the prefix length for fuzzy queries.
getFuzzyQuery(String, String, float) - Method in class org.apache.lucene.queryParser.MultiFieldQueryParser
getFuzzyQuery(String, String, float) - Method in class org.apache.lucene.queryParser.QueryParser
  Factory method for generating a query (similar to `QueryParser.getWildcardQuery(java.lang.String, java.lang.String)`).
getGeneration() - Method in class org.apache.lucene.index.IndexCommit
  Returns the generation (the _N in segments_N) for this IndexCommit
getId() - Method in class org.apache.lucene.search.Hit
  Deprecated. Returns id for this hit.
GetImage() - Method in interface org.apache.lucene.queryParser.CharStream
  Returns a string made up of characters from the marked token beginning to the current buffer position.
GetImage() - Method in class org.apache.lucene.queryParser.FastCharStream
getInclude() - Method in class org.apache.lucene.search.spans.SpanNotQuery
  Return the SpanQuery whose matches are filtered.
getIndexCommit() - Method in class org.apache.lucene.index.IndexReader
  Expert: return the IndexCommit that this reader has opened.
getIndexReader() - Method in class org.apache.lucene.search.IndexSearcher
  Return the `IndexReader` this searches.
getInfoStream() - Method in class org.apache.lucene.index.IndexModifier
  Deprecated.
getInfoStream() - Method in class org.apache.lucene.index.IndexWriter
  Returns the current infoStream in use by this writer.
getInstance() - Static method in class org.apache.lucene.search.FilterManager
getInts(IndexReader, String) - Method in interface org.apache.lucene.search.FieldCache
  Checks the internal cache for an appropriate entry, and if none is found, reads the terms in `field` as integers and returns an array of size `reader.maxDoc()` of the value each document has in the given field.
getInts(IndexReader, String, FieldCache.IntParser) - Method in interface org.apache.lucene.search.FieldCache
  Checks the internal cache for an appropriate entry, and if none is found, reads the terms in `field` as integers and returns an array of size `reader.maxDoc()` of the value each document has in the given field.
getLastDocCollected() - Method in exception org.apache.lucene.search.TimeLimitedCollector.TimeExceededException
  Returns last doc that was collected when the search time exceeded.
getLimit() - Method in class org.apache.lucene.index.IndexWriter.MaxFieldLength
getLine() - Method in interface org.apache.lucene.queryParser.CharStream
  Deprecated.
getLine() - Method in class org.apache.lucene.queryParser.FastCharStream
getLocale() - Method in class org.apache.lucene.queryParser.QueryParser
  Returns current locale, allowing access by subclasses.
getLocale() - Method in class org.apache.lucene.search.SortField
  Returns the Locale by which term values are interpreted.
getLockFactory() - Method in class org.apache.lucene.store.Directory
  Get the LockFactory that this Directory instance is using for its locking implementation.
getLockID() - Method in class org.apache.lucene.store.Directory
  Return a string identifier that uniquely differentiates this Directory instance from other Directory instances.
getLockID() - Method in class org.apache.lucene.store.FSDirectory
getLockPrefix() - Method in class org.apache.lucene.store.LockFactory
  Get the prefix in use for all locks created in this LockFactory.
getLongs(IndexReader, String) - Method in interface org.apache.lucene.search.ExtendedFieldCache
  Checks the internal cache for an appropriate entry, and if none is found, reads the terms in `field` as longs and returns an array of size `reader.maxDoc()` of the value each document has in the given field.
getLongs(IndexReader, String, ExtendedFieldCache.LongParser) - Method in interface org.apache.lucene.search.ExtendedFieldCache
  Checks the internal cache for an appropriate entry, and if none is found, reads the terms in `field` as longs and returns an array of size `reader.maxDoc()` of the value each document has in the given field.
getLowercaseExpandedTerms() - Method in class org.apache.lucene.queryParser.QueryParser
getLowerTerm() - Method in class org.apache.lucene.search.RangeQuery
  Returns the lower term of this range query
getLowerVal() - Method in class org.apache.lucene.search.ConstantScoreRangeQuery
  Returns the value of the lower endpoint of this range query, null if open ended
getMatch() - Method in class org.apache.lucene.search.ComplexExplanation
  The match status of this explanation node.
getMatch() - Method in class org.apache.lucene.search.spans.SpanFirstQuery
  Return the SpanQuery whose matches are filtered.
getMaxBufferedDeleteTerms() - Method in class org.apache.lucene.index.IndexWriter
  Returns the number of buffered deleted terms that will trigger a flush if enabled.
getMaxBufferedDocs() - Method in class org.apache.lucene.index.IndexModifier
  Deprecated.
getMaxBufferedDocs() - Method in class org.apache.lucene.index.IndexWriter
  Returns the number of buffered added documents that will trigger a flush if enabled.
getMaxClauseCount() - Static method in class org.apache.lucene.search.BooleanQuery
  Return the maximum number of clauses permitted, 1024 by default.
getMaxFieldLength() - Method in class org.apache.lucene.index.IndexModifier
  Deprecated.
getMaxFieldLength() - Method in class org.apache.lucene.index.IndexWriter
  Returns the maximum number of terms that will be indexed for a single field in a document.
getMaxMergeDocs() - Method in class org.apache.lucene.index.IndexWriter
  Returns the largest segment (measured by document count) that may be merged with other segments.
getMaxMergeDocs() - Method in class org.apache.lucene.index.LogMergePolicy
  Returns the largest segment (measured by document count) that may be merged with other segments.
getMaxMergeMB() - Method in class org.apache.lucene.index.LogByteSizeMergePolicy
  Returns the largest segment (meaured by total byte size of the segment's files, in MB) that may be merged with other segments.
getMaxScore() - Method in class org.apache.lucene.search.FieldSortedHitQueue
  returns the maximum score encountered by elements inserted via insert()
getMaxScore() - Method in class org.apache.lucene.search.TopDocs
  Expert: Returns the maximum score value encountered.
getMaxSyncPauseSeconds() - Method in class org.apache.lucene.index.IndexWriter
  Deprecated. This will be removed in 3.0, when autoCommit=true is removed from IndexWriter.
getMaxThreadCount() - Method in class org.apache.lucene.index.ConcurrentMergeScheduler
  Get the max # simultaneous threads that may be running.
getMaxTokenLength() - Method in class org.apache.lucene.analysis.standard.StandardAnalyzer
getMaxTokenLength() - Method in class org.apache.lucene.analysis.standard.StandardTokenizer
getMaxValue() - Method in class org.apache.lucene.search.function.DocValues
  Optional op.
getMergeFactor() - Method in class org.apache.lucene.index.IndexModifier
  Deprecated.
getMergeFactor() - Method in class org.apache.lucene.index.IndexWriter
  Returns the number of segments that are merged at once and also controls the total number of segments allowed to accumulate in the index.
getMergeFactor() - Method in class org.apache.lucene.index.LogMergePolicy
  Returns the number of segments that are merged at once and also controls the total number of segments allowed to accumulate in the index.
getMergePolicy() - Method in class org.apache.lucene.index.IndexWriter
  Expert: returns the current MergePolicy in use by this writer.
getMergeScheduler() - Method in class org.apache.lucene.index.IndexWriter
  Expert: returns the current MergePolicy in use by this writer.
getMergeThread(IndexWriter, MergePolicy.OneMerge) - Method in class org.apache.lucene.index.ConcurrentMergeScheduler
  Create and return a new MergeThread
getMergeThreadPriority() - Method in class org.apache.lucene.index.ConcurrentMergeScheduler
  Return the priority that merge threads run at.
getMessage() - Method in exception org.apache.lucene.queryParser.ParseException
  This method has the standard behavior when this object has been created using the standard constructors.
getMessage() - Method in error org.apache.lucene.queryParser.TokenMgrError
  You can also modify the body of this method to customize your error messages.
getMessage() - Method in exception org.apache.lucene.search.BooleanQuery.TooManyClauses
getMinimumNumberShouldMatch() - Method in class org.apache.lucene.search.BooleanQuery
  Gets the minimum number of the optional BooleanClauses which must be satisifed.
getMinMergeDocs() - Method in class org.apache.lucene.index.LogDocMergePolicy
  Get the minimum size for a segment to remain un-merged.
getMinMergeMB() - Method in class org.apache.lucene.index.LogByteSizeMergePolicy
  Get the minimum size for a segment to remain un-merged.
getMinSimilarity() - Method in class org.apache.lucene.search.FuzzyQuery
  Returns the minimum similarity that is required for this query to match.
getMinValue() - Method in class org.apache.lucene.search.function.DocValues
  Optional op.
getNextSize(int) - Static method in class org.apache.lucene.util.ArrayUtil
getNextToken() - Method in class org.apache.lucene.queryParser.QueryParser
  Get the next Token.
getNextToken() - Method in class org.apache.lucene.queryParser.QueryParserTokenManager
  Get the next Token.
getNoLockFactory() - Static method in class org.apache.lucene.store.NoLockFactory
getNormDecoder() - Static method in class org.apache.lucene.search.Similarity
  Returns a table for decoding normalization bytes.
getNumWords() - Method in class org.apache.lucene.util.OpenBitSet
  Expert: gets the number of longs in the array that are in use
getOccur() - Method in class org.apache.lucene.search.BooleanClause
getOffset() - Method in class org.apache.lucene.index.Payload
  Returns the offset in the underlying byte array
getOffsets() - Method in class org.apache.lucene.index.PositionBasedTermVectorMapper.TVPositionInfo
  Parallel list (to `PositionBasedTermVectorMapper.TVPositionInfo.getTerms()`) of TermVectorOffsetInfo objects.
getOffsets(int) - Method in interface org.apache.lucene.index.TermPositionVector
  Returns an array of TermVectorOffsetInfo in which the term is found.
getOffsets() - Method in class org.apache.lucene.index.TermVectorEntry
getOmitNorms() - Method in class org.apache.lucene.document.AbstractField
  True if norms are omitted for this indexed field
getOmitNorms() - Method in interface org.apache.lucene.document.Fieldable
  True if norms are omitted for this indexed field
getOmitTf() - Method in class org.apache.lucene.document.AbstractField
  True if tf is omitted for this indexed field
getOmitTf() - Method in interface org.apache.lucene.document.Fieldable
  True if tf is omitted for this indexed field
getPayload() - Method in class org.apache.lucene.analysis.Token
  Returns this Token's payload.
getPayload(byte[], int) - Method in class org.apache.lucene.index.FilterIndexReader.FilterTermPositions
getPayload(byte[], int) - Method in class org.apache.lucene.index.MultipleTermPositions
  Not implemented.
getPayload(byte[], int) - Method in interface org.apache.lucene.index.TermPositions
  Returns the payload data at the current term position.
getPayload() - Method in interface org.apache.lucene.search.spans.PayloadSpans
  Returns the payload data for the current span.
getPayload() - Method in class org.apache.lucene.search.spans.TermSpans
getPayloadLength() - Method in class org.apache.lucene.index.FilterIndexReader.FilterTermPositions
getPayloadLength() - Method in class org.apache.lucene.index.MultipleTermPositions
  Not implemented.
getPayloadLength() - Method in interface org.apache.lucene.index.TermPositions
  Returns the length of the payload at the current term position.
getPayloadsForQuery(Query) - Method in class org.apache.lucene.search.payloads.PayloadSpanUtil
  Query should be rewritten for wild/fuzzy support.
getPayloadSpans(IndexReader) - Method in class org.apache.lucene.search.spans.SpanFirstQuery
getPayloadSpans(IndexReader) - Method in class org.apache.lucene.search.spans.SpanNearQuery
getPayloadSpans(IndexReader) - Method in class org.apache.lucene.search.spans.SpanNotQuery
getPayloadSpans(IndexReader) - Method in class org.apache.lucene.search.spans.SpanOrQuery
getPayloadSpans(IndexReader) - Method in class org.apache.lucene.search.spans.SpanQuery
  Returns the matches for this query in an index, including access to any `Payload`s at those positions.
getPayloadSpans(IndexReader) - Method in class org.apache.lucene.search.spans.SpanTermQuery
getPhraseSlop() - Method in class org.apache.lucene.queryParser.QueryParser
  Gets the default slop for phrases.
getPosition() - Method in class org.apache.lucene.index.PositionBasedTermVectorMapper.TVPositionInfo
getPositionIncrement() - Method in class org.apache.lucene.analysis.Token
  Returns the position increment of this Token.
getPositionIncrementGap(String) - Method in class org.apache.lucene.analysis.Analyzer
  Invoked before indexing a Fieldable instance if terms have already been added to that field.
getPositionIncrementGap(String) - Method in class org.apache.lucene.analysis.PerFieldAnalyzerWrapper
  Return the positionIncrementGap from the analyzer assigned to fieldName
getPositions() - Method in class org.apache.lucene.index.TermVectorEntry
getPositions() - Method in class org.apache.lucene.search.MultiPhraseQuery
  Returns the relative positions of terms in this phrase.
getPositions() - Method in class org.apache.lucene.search.PhraseQuery
  Returns the relative positions of terms in this phrase.
getPositions() - Method in class org.apache.lucene.search.SpanFilterResult
  The first entry in the array corresponds to the first "on" bit.
getPositions() - Method in class org.apache.lucene.search.SpanFilterResult.PositionInfo
getPositions() - Method in class org.apache.lucene.search.spans.TermSpans
getPrefix() - Method in class org.apache.lucene.search.PrefixFilter
getPrefix() - Method in class org.apache.lucene.search.PrefixQuery
  Returns the prefix of this query.
getPrefixLength() - Method in class org.apache.lucene.search.FuzzyQuery
  Returns the non-fuzzy prefix length.
getPrefixQuery(String, String) - Method in class org.apache.lucene.queryParser.MultiFieldQueryParser
getPrefixQuery(String, String) - Method in class org.apache.lucene.queryParser.QueryParser
  Factory method for generating a query (similar to `QueryParser.getWildcardQuery(java.lang.String, java.lang.String)`).
getPreviousTokenStream() - Method in class org.apache.lucene.analysis.Analyzer
  Used by Analyzers that implement reusableTokenStream to retrieve previously saved TokenStreams for re-use by the same thread.
getQuery() - Method in class org.apache.lucene.search.BooleanClause
getQuery() - Method in class org.apache.lucene.search.ConstantScoreQuery.ConstantWeight
getQuery() - Method in class org.apache.lucene.search.FilteredQuery
getQuery() - Method in class org.apache.lucene.search.SpanQueryFilter
getQuery() - Method in class org.apache.lucene.search.spans.SpanWeight
getQuery() - Method in interface org.apache.lucene.search.Weight
  The query that this concerns.
getRAMBufferSizeMB() - Method in class org.apache.lucene.index.IndexWriter
  Returns the value set by `IndexWriter.setRAMBufferSizeMB(double)` if enabled.
getRangeCollator() - Method in class org.apache.lucene.queryParser.QueryParser
getRangeQuery(String, String, String, boolean) - Method in class org.apache.lucene.queryParser.MultiFieldQueryParser
getRangeQuery(String, String, String, boolean) - Method in class org.apache.lucene.queryParser.QueryParser
getResolution() - Static method in class org.apache.lucene.search.TimeLimitedCollector
  Return the timer resolution.
getReverse() - Method in class org.apache.lucene.search.SortField
  Returns whether the sort should be reversed.
getRunningMerge() - Method in class org.apache.lucene.index.ConcurrentMergeScheduler.MergeThread
getScore() - Method in class org.apache.lucene.search.Hit
  Deprecated. Returns score for this hit.
getSearchables() - Method in class org.apache.lucene.search.MultiSearcher
  Return the array of `Searchable`s this searches.
getSegmentsFileName() - Method in class org.apache.lucene.index.IndexCommit
  Get the segments file (`segments_N`) associated with this commit point.
getSegmentsFileName() - Method in interface org.apache.lucene.index.IndexCommitPoint
  Deprecated. Get the segments file (`segments_N`) associated with this commit point.
getShorts(IndexReader, String) - Method in interface org.apache.lucene.search.FieldCache
  Checks the internal cache for an appropriate entry, and if none is found, reads the terms in `field` as shorts and returns an array of size `reader.maxDoc()` of the value each document has in the given field.
getShorts(IndexReader, String, FieldCache.ShortParser) - Method in interface org.apache.lucene.search.FieldCache
  Checks the internal cache for an appropriate entry, and if none is found, reads the terms in `field` as shorts and returns an array of size `reader.maxDoc()` of the value each document has in the given field.
getShrinkSize(int, int) - Static method in class org.apache.lucene.util.ArrayUtil
getSimilarity() - Method in class org.apache.lucene.index.IndexWriter
  Expert: Return the Similarity implementation used by this IndexWriter.
getSimilarity(Searcher) - Method in class org.apache.lucene.search.BooleanQuery
getSimilarity(Searcher) - Method in class org.apache.lucene.search.Query
  Expert: Returns the Similarity implementation to be used for this query.
getSimilarity() - Method in class org.apache.lucene.search.Scorer
  Returns the Similarity implementation used by this scorer.
getSimilarity() - Method in class org.apache.lucene.search.Searcher
  Expert: Return the Similarity implementation used by this Searcher.
getSlop() - Method in class org.apache.lucene.search.MultiPhraseQuery
  Sets the phrase slop for this query.
getSlop() - Method in class org.apache.lucene.search.PhraseQuery
  Returns the slop.
getSlop() - Method in class org.apache.lucene.search.spans.SpanNearQuery
  Return the maximum number of intervening unmatched positions permitted.
getSort() - Method in class org.apache.lucene.search.Sort
  Representation of the sort criteria.
getSpans(IndexReader) - Method in class org.apache.lucene.search.spans.SpanFirstQuery
getSpans(IndexReader) - Method in class org.apache.lucene.search.spans.SpanNearQuery
getSpans(IndexReader) - Method in class org.apache.lucene.search.spans.SpanNotQuery
getSpans(IndexReader) - Method in class org.apache.lucene.search.spans.SpanOrQuery
getSpans(IndexReader) - Method in class org.apache.lucene.search.spans.SpanQuery
  Expert: Returns the matches for this query in an index.
getSpans(IndexReader) - Method in class org.apache.lucene.search.spans.SpanTermQuery
getStart() - Method in class org.apache.lucene.search.SpanFilterResult.StartEnd
  The Start position
getStartOffset() - Method in class org.apache.lucene.index.TermVectorOffsetInfo
  The accessor for the starting offset of the term.
getStarts() - Method in class org.apache.lucene.search.MultiSearcher
getStemDict(File) - Static method in class org.apache.lucene.analysis.WordlistLoader
  Reads a stem dictionary.
getStringIndex(IndexReader, String) - Method in interface org.apache.lucene.search.FieldCache
  Checks the internal cache for an appropriate entry, and if none is found reads the term values in `field` and returns an array of them in natural order, along with an array telling which element in the term array each document uses.
getStrings(IndexReader, String) - Method in interface org.apache.lucene.search.FieldCache
  Checks the internal cache for an appropriate entry, and if none is found, reads the term values in `field` and returns an array of size `reader.maxDoc()` containing the value each document has in the given field.
GetSuffix(int) - Method in interface org.apache.lucene.queryParser.CharStream
  Returns an array of characters that make up the suffix of length 'len' for the currently matched token.
GetSuffix(int) - Method in class org.apache.lucene.queryParser.FastCharStream
getSummary() - Method in class org.apache.lucene.search.ComplexExplanation
getSummary() - Method in class org.apache.lucene.search.Explanation
  A short one line summary which should contain all high level information about this Explanation, without the "Details"
getTerm() - Method in class org.apache.lucene.index.TermVectorEntry
getTerm() - Method in class org.apache.lucene.search.MultiTermQuery
  Returns the pattern term.
getTerm() - Method in class org.apache.lucene.search.spans.SpanTermQuery
  Return the term whose spans are matched.
getTerm() - Method in class org.apache.lucene.search.TermQuery
  Returns the term of this query.
getTermArrays() - Method in class org.apache.lucene.search.MultiPhraseQuery
  Returns a List of the terms in the multiphrase.
getTermFrequencies() - Method in interface org.apache.lucene.index.TermFreqVector
  Array of term frequencies.
getTermFrequencies() - Method in class org.apache.lucene.search.QueryTermVector
getTermFreqVector(int, String) - Method in class org.apache.lucene.index.FilterIndexReader
getTermFreqVector(int, String, TermVectorMapper) - Method in class org.apache.lucene.index.FilterIndexReader
getTermFreqVector(int, TermVectorMapper) - Method in class org.apache.lucene.index.FilterIndexReader
getTermFreqVector(int, String) - Method in class org.apache.lucene.index.IndexReader
  Return a term frequency vector for the specified document and field.
getTermFreqVector(int, String, TermVectorMapper) - Method in class org.apache.lucene.index.IndexReader
  Load the Term Vector into a user-defined data structure instead of relying on the parallel arrays of the `TermFreqVector`.
getTermFreqVector(int, TermVectorMapper) - Method in class org.apache.lucene.index.IndexReader
  Map all the term vectors for all fields in a Document
getTermFreqVector(int, String) - Method in class org.apache.lucene.index.MultiReader
getTermFreqVector(int, String, TermVectorMapper) - Method in class org.apache.lucene.index.MultiReader
getTermFreqVector(int, TermVectorMapper) - Method in class org.apache.lucene.index.MultiReader
getTermFreqVector(int, String) - Method in class org.apache.lucene.index.ParallelReader
getTermFreqVector(int, String, TermVectorMapper) - Method in class org.apache.lucene.index.ParallelReader
getTermFreqVector(int, TermVectorMapper) - Method in class org.apache.lucene.index.ParallelReader
getTermFreqVectors(int) - Method in class org.apache.lucene.index.FilterIndexReader
getTermFreqVectors(int) - Method in class org.apache.lucene.index.IndexReader
  Return an array of term frequency vectors for the specified document.
getTermFreqVectors(int) - Method in class org.apache.lucene.index.MultiReader
getTermFreqVectors(int) - Method in class org.apache.lucene.index.ParallelReader
getTermIndexInterval() - Method in class org.apache.lucene.index.IndexWriter
  Expert: Return the interval between indexed terms.
getTermInfosIndexDivisor() - Method in class org.apache.lucene.index.IndexReader
  For IndexReader implementations that use TermInfosReader to read terms, this returns the current indexDivisor.
getTermPositions(int) - Method in interface org.apache.lucene.index.TermPositionVector
  Returns an array of positions in which the term is found.
getTerms() - Method in class org.apache.lucene.index.PositionBasedTermVectorMapper.TVPositionInfo
  Note, there may be multiple terms at the same position
getTerms() - Method in interface org.apache.lucene.index.TermFreqVector
getTerms() - Method in class org.apache.lucene.search.PhraseQuery
  Returns the set of terms in this phrase.
getTerms() - Method in class org.apache.lucene.search.QueryTermVector
getTerms() - Method in class org.apache.lucene.search.spans.SpanFirstQuery
  Deprecated. use extractTerms instead
getTerms() - Method in class org.apache.lucene.search.spans.SpanNearQuery
  Deprecated. use extractTerms instead
getTerms() - Method in class org.apache.lucene.search.spans.SpanNotQuery
  Deprecated. use extractTerms instead
getTerms() - Method in class org.apache.lucene.search.spans.SpanOrQuery
  Deprecated. use extractTerms instead
getTerms() - Method in class org.apache.lucene.search.spans.SpanQuery
  Deprecated. use extractTerms instead
getTerms() - Method in class org.apache.lucene.search.spans.SpanTermQuery
  Deprecated. use extractTerms instead
getTermVectorEntrySet() - Method in class org.apache.lucene.index.SortedTermVectorMapper
  The TermVectorEntrySet.
getTimeAllowed() - Method in exception org.apache.lucene.search.TimeLimitedCollector.TimeExceededException
  Returns allowed time (milliseconds).
getTimeElapsed() - Method in exception org.apache.lucene.search.TimeLimitedCollector.TimeExceededException
  Returns elapsed time (milliseconds).
getTimestamp() - Method in class org.apache.lucene.index.IndexCommit
  Convenience method that returns the last modified time of the segments_N file corresponding to this index commit, equivalent to getDirectory().fileModified(getSegmentsFileName()).
getToken(int) - Method in class org.apache.lucene.queryParser.QueryParser
  Get the specific Token.
getTokens() - Method in class org.apache.lucene.analysis.SinkTokenizer
  Get the tokens in the internal List.
getTotalHits() - Method in class org.apache.lucene.search.TopDocCollector
  The total number of documents that matched this query.
getType() - Method in class org.apache.lucene.search.SortField
  Returns the type of contents in the field.
getUpperTerm() - Method in class org.apache.lucene.search.RangeQuery
  Returns the upper term of this range query
getUpperVal() - Method in class org.apache.lucene.search.ConstantScoreRangeQuery
  Returns the value of the upper endpoint of this range query, null if open ended
getUseCompoundDocStore() - Method in class org.apache.lucene.index.LogMergePolicy
  Returns true if newly flushed and newly merge doc store segment files (term vectors and stored fields) are written in compound file format.
getUseCompoundFile() - Method in class org.apache.lucene.index.IndexModifier
  Deprecated.
getUseCompoundFile() - Method in class org.apache.lucene.index.IndexWriter
  Get the current setting of whether newly flushed segments will use the compound file format.
getUseCompoundFile() - Method in class org.apache.lucene.index.LogMergePolicy
  Returns true if newly flushed and newly merge segments are written in compound file format.
getUseOldRangeQuery() - Method in class org.apache.lucene.queryParser.QueryParser
getUseScorer14() - Static method in class org.apache.lucene.search.BooleanQuery
  Deprecated. Use `BooleanQuery.getAllowDocsOutOfOrder()` instead.
getValue() - Method in class org.apache.lucene.queryParser.Token
  An optional attribute value of the Token.
getValue() - Method in class org.apache.lucene.search.ConstantScoreQuery.ConstantWeight
getValue() - Method in class org.apache.lucene.search.Explanation
  The value assigned to this explanation node.
getValue() - Method in class org.apache.lucene.search.spans.SpanWeight
getValue() - Method in interface org.apache.lucene.search.Weight
  The weight for this query.
getValues(String) - Method in class org.apache.lucene.document.Document
  Returns an array of values of the field specified as the method parameter.
getValues(IndexReader) - Method in class org.apache.lucene.search.function.FieldCacheSource
getValues(IndexReader) - Method in class org.apache.lucene.search.function.OrdFieldSource
getValues(IndexReader) - Method in class org.apache.lucene.search.function.ReverseOrdFieldSource
getValues(IndexReader) - Method in class org.apache.lucene.search.function.ValueSource
  Return the DocValues used by the function query.
getVersion() - Method in class org.apache.lucene.index.FilterIndexReader
getVersion() - Method in class org.apache.lucene.index.IndexCommit
  Returns the version for this IndexCommit.
getVersion() - Method in class org.apache.lucene.index.IndexReader
  Version number when this IndexReader was opened.
getVersion() - Method in class org.apache.lucene.index.MultiReader
  Not implemented.
getVersion() - Method in class org.apache.lucene.index.ParallelReader
  Not implemented.
getWildcardQuery(String, String) - Method in class org.apache.lucene.queryParser.MultiFieldQueryParser
getWildcardQuery(String, String) - Method in class org.apache.lucene.queryParser.QueryParser
  Factory method for generating a query.
getWordSet(File) - Static method in class org.apache.lucene.analysis.WordlistLoader
  Loads a text file and adds every line as an entry to a HashSet (omitting leading and trailing whitespace).
getWordSet(Reader) - Static method in class org.apache.lucene.analysis.WordlistLoader
  Reads lines from a Reader and adds every line as an entry to a HashSet (omitting leading and trailing whitespace).
getWriteLockTimeout() - Method in class org.apache.lucene.index.IndexWriter
  Returns allowed timeout when acquiring the write lock.
grow(int[], int) - Static method in class org.apache.lucene.util.ArrayUtil
grow(int[]) - Static method in class org.apache.lucene.util.ArrayUtil
grow(long[], int) - Static method in class org.apache.lucene.util.ArrayUtil
grow(long[]) - Static method in class org.apache.lucene.util.ArrayUtil
grow(byte[], int) - Static method in class org.apache.lucene.util.ArrayUtil
grow(byte[]) - Static method in class org.apache.lucene.util.ArrayUtil

## H

handleMergeException(Throwable) - Method in class org.apache.lucene.index.ConcurrentMergeScheduler
  Called when an exception is hit in a background merge thread
hasChanges - Variable in class org.apache.lucene.index.IndexReader
hasDeletions - Variable in class org.apache.lucene.index.CheckIndex.Status.SegmentInfoStatus
  True if this segment has pending deletions.
hasDeletions() - Method in class org.apache.lucene.index.FilterIndexReader
hasDeletions() - Method in class org.apache.lucene.index.IndexReader
  Returns true if any documents have been deleted
hasDeletions() - Method in class org.apache.lucene.index.IndexWriter
hasDeletions() - Method in class org.apache.lucene.index.MultiReader
hasDeletions() - Method in class org.apache.lucene.index.ParallelReader
hashCode() - Method in class org.apache.lucene.analysis.Token
hashCode() - Method in class org.apache.lucene.document.FieldSelectorResult
hashCode() - Method in class org.apache.lucene.index.IndexCommit
hashCode() - Method in class org.apache.lucene.index.Payload
hashCode() - Method in class org.apache.lucene.index.Term
  Combines the hashCode() of the field and the text.
hashCode() - Method in class org.apache.lucene.index.TermVectorEntry
hashCode() - Method in class org.apache.lucene.index.TermVectorOffsetInfo
hashCode() - Method in class org.apache.lucene.search.BooleanClause
  Returns a hash code value for this object.
hashCode() - Method in class org.apache.lucene.search.BooleanQuery
  Returns a hash code value for this object.
hashCode() - Method in class org.apache.lucene.search.CachingSpanFilter
hashCode() - Method in class org.apache.lucene.search.CachingWrapperFilter
hashCode() - Method in class org.apache.lucene.search.ConstantScoreQuery
  Returns a hash code value for this object.
hashCode() - Method in class org.apache.lucene.search.ConstantScoreRangeQuery
  Returns a hash code value for this object.
hashCode() - Method in class org.apache.lucene.search.DisjunctionMaxQuery
  Compute a hash code for hashing us
hashCode() - Method in class org.apache.lucene.search.FilteredQuery
  Returns a hash code value for this object.
hashCode() - Method in class org.apache.lucene.search.function.CustomScoreQuery
  Returns a hash code value for this object.
hashCode() - Method in class org.apache.lucene.search.function.FieldCacheSource
hashCode() - Method in class org.apache.lucene.search.function.OrdFieldSource
hashCode() - Method in class org.apache.lucene.search.function.ReverseOrdFieldSource
hashCode() - Method in class org.apache.lucene.search.function.ValueSource
  Needed for possible caching of query results - used by `ValueSourceQuery.hashCode()`.
hashCode() - Method in class org.apache.lucene.search.function.ValueSourceQuery
  Returns a hash code value for this object.
hashCode() - Method in class org.apache.lucene.search.FuzzyQuery
hashCode() - Method in class org.apache.lucene.search.MatchAllDocsQuery
hashCode() - Method in class org.apache.lucene.search.MultiPhraseQuery
  Returns a hash code value for this object.
hashCode() - Method in class org.apache.lucene.search.MultiTermQuery
hashCode() - Method in class org.apache.lucene.search.PhraseQuery
  Returns a hash code value for this object.
hashCode() - Method in class org.apache.lucene.search.PrefixQuery
  Returns a hash code value for this object.
hashCode() - Method in class org.apache.lucene.search.QueryFilter
  Deprecated.
hashCode() - Method in class org.apache.lucene.search.QueryWrapperFilter
hashCode() - Method in class org.apache.lucene.search.RangeFilter
  Returns a hash code value for this object.
hashCode() - Method in class org.apache.lucene.search.RangeQuery
  Returns a hash code value for this object.
hashCode() - Method in class org.apache.lucene.search.SpanQueryFilter
hashCode() - Method in class org.apache.lucene.search.spans.SpanFirstQuery
hashCode() - Method in class org.apache.lucene.search.spans.SpanNearQuery
hashCode() - Method in class org.apache.lucene.search.spans.SpanNotQuery
hashCode() - Method in class org.apache.lucene.search.spans.SpanOrQuery
hashCode() - Method in class org.apache.lucene.search.spans.SpanTermQuery
  Returns a hash code value for this object.
hashCode() - Method in class org.apache.lucene.search.TermQuery
  Returns a hash code value for this object.
hashCode(char[], int, int) - Static method in class org.apache.lucene.util.ArrayUtil
  Returns hash of chars in range start (inclusive) to end (inclusive)
hashCode(byte[], int, int) - Static method in class org.apache.lucene.util.ArrayUtil
  Returns hash of chars in range start (inclusive) to end (inclusive)
hashCode() - Method in class org.apache.lucene.util.OpenBitSet
hasNext() - Method in class org.apache.lucene.analysis.CharArraySet.CharArraySetIterator
hasNext() - Method in class org.apache.lucene.search.HitIterator
  Deprecated.
hasNorms(String) - Method in class org.apache.lucene.index.FilterIndexReader
hasNorms(String) - Method in class org.apache.lucene.index.IndexReader
  Returns true if there are norms stored for this field.
hasNorms(String) - Method in class org.apache.lucene.index.MultiReader
hasNorms(String) - Method in class org.apache.lucene.index.ParallelReader
hasProx - Variable in class org.apache.lucene.index.CheckIndex.Status.SegmentInfoStatus
  True if at least one of the fields in this segment does not omitTf.
heap - Variable in class org.apache.lucene.util.PriorityQueue
Hit - Class in org.apache.lucene.search
  Deprecated. Hits will be removed in Lucene 3.0. Use `TopDocCollector` and `TopDocs` instead.
HitCollector - Class in org.apache.lucene.search
  Lower-level search API.
HitCollector() - Constructor for class org.apache.lucene.search.HitCollector
HitIterator - Class in org.apache.lucene.search
  Deprecated. Hits will be removed in Lucene 3.0. Use `TopDocCollector` and `TopDocs` instead.
Hits - Class in org.apache.lucene.search
  Deprecated. Hits will be removed in Lucene 3.0.

  Instead e. g. `TopDocCollector` and `TopDocs` can be used:

         TopDocCollector collector = new TopDocCollector(hitsPerPage);
         searcher.search(query, collector);
         ScoreDoc[] hits = collector.topDocs().scoreDocs;
         for (int i = 0; i < hits.length; i++) {
           int docId = hits[i].doc;
           Document d = searcher.doc(docId);
           // do something with current hit
           ...

HOST - Static variable in class org.apache.lucene.analysis.standard.StandardTokenizer
HOUR - Static variable in class org.apache.lucene.document.DateTools.Resolution
hq - Variable in class org.apache.lucene.search.TopDocCollector
  The priority queue which holds the top-scoring documents.

## I

id(int) - Method in class org.apache.lucene.search.Hits
  Deprecated. Returns the id for the nth document in this set.
idf(int, int) - Method in class org.apache.lucene.search.DefaultSimilarity
  Implemented as `log(numDocs/(docFreq+1)) + 1`.
idf(Term, Searcher) - Method in class org.apache.lucene.search.Similarity
  Computes a score factor for a simple term.
idf(Collection, Searcher) - Method in class org.apache.lucene.search.Similarity
  Computes a score factor for a phrase.
idf(int, int) - Method in class org.apache.lucene.search.Similarity
  Computes a score factor based on a term's document frequency (the number of documents which contain the term).
idf(int, int) - Method in class org.apache.lucene.search.SimilarityDelegator
idf - Variable in class org.apache.lucene.search.spans.SpanWeight
image - Variable in class org.apache.lucene.queryParser.Token
  The string image of the token.
in - Variable in class org.apache.lucene.index.FilterIndexReader.FilterTermDocs
in - Variable in class org.apache.lucene.index.FilterIndexReader.FilterTermEnum
in - Variable in class org.apache.lucene.index.FilterIndexReader
includesLower() - Method in class org.apache.lucene.search.ConstantScoreRangeQuery
  Returns `true` if the lower endpoint is inclusive
includesUpper() - Method in class org.apache.lucene.search.ConstantScoreRangeQuery
  Returns `true` if the upper endpoint is inclusive
incRef() - Method in class org.apache.lucene.index.IndexReader
  Expert: increments the refCount of this IndexReader instance.
IndexCommit - Class in org.apache.lucene.index
  Expert: represents a single commit into an index as seen by the `IndexDeletionPolicy` or `IndexReader`.
IndexCommit() - Constructor for class org.apache.lucene.index.IndexCommit
IndexCommitPoint - Interface in org.apache.lucene.index
  Deprecated. Please subclass IndexCommit class instead
IndexDeletionPolicy - Interface in org.apache.lucene.index
  Expert: policy for deletion of stale `index commits`.
INDEXED - Static variable in class org.apache.lucene.index.IndexReader.FieldOption
  All indexed fields
INDEXED_NO_TERMVECTOR - Static variable in class org.apache.lucene.index.IndexReader.FieldOption
  All fields which are indexed but don't have termvectors enabled
INDEXED_WITH_TERMVECTOR - Static variable in class org.apache.lucene.index.IndexReader.FieldOption
  All fields which are indexed with termvectors enabled
indexesOf(String[], int, int) - Method in interface org.apache.lucene.index.TermFreqVector
  Just like `indexOf(int)` but searches for a number of terms at the same time.
indexesOf(String[], int, int) - Method in class org.apache.lucene.search.QueryTermVector
indexExists(String) - Static method in class org.apache.lucene.index.IndexReader
  Returns `true` if an index exists at the specified directory.
indexExists(File) - Static method in class org.apache.lucene.index.IndexReader
  Returns `true` if an index exists at the specified directory.
indexExists(Directory) - Static method in class org.apache.lucene.index.IndexReader
  Returns `true` if an index exists at the specified directory.
IndexFileNameFilter - Class in org.apache.lucene.index
  Filename filter that accept filenames and extensions only created by Lucene.
IndexFileNameFilter() - Constructor for class org.apache.lucene.index.IndexFileNameFilter
IndexInput - Class in org.apache.lucene.store
  Abstract base class for input from a file in a `Directory`.
IndexInput() - Constructor for class org.apache.lucene.store.IndexInput
IndexModifier - Class in org.apache.lucene.index
  Deprecated. Please use `IndexWriter` instead.
IndexModifier(Directory, Analyzer, boolean) - Constructor for class org.apache.lucene.index.IndexModifier
  Deprecated. Open an index with write access.
IndexModifier(String, Analyzer, boolean) - Constructor for class org.apache.lucene.index.IndexModifier
  Deprecated. Open an index with write access.
IndexModifier(File, Analyzer, boolean) - Constructor for class org.apache.lucene.index.IndexModifier
  Deprecated. Open an index with write access.
indexOf(String) - Method in interface org.apache.lucene.index.TermFreqVector
  Return an index in the term numbers array returned from `getTerms` at which the term with the specified `term` appears.
indexOf(String) - Method in class org.apache.lucene.search.QueryTermVector
INDEXORDER - Static variable in interface org.apache.lucene.search.ScoreDocComparator
  Special comparator for sorting hits according to index order (document number).
INDEXORDER - Static variable in class org.apache.lucene.search.Sort
  Represents sorting by index order.
IndexOutput - Class in org.apache.lucene.store
  Abstract base class for output to a file in a Directory.
IndexOutput() - Constructor for class org.apache.lucene.store.IndexOutput
indexReader - Variable in class org.apache.lucene.index.IndexModifier
  Deprecated.
IndexReader - Class in org.apache.lucene.index
  IndexReader is an abstract class, providing an interface for accessing an index.
IndexReader(Directory) - Constructor for class org.apache.lucene.index.IndexReader
  Deprecated. - use IndexReader()
IndexReader() - Constructor for class org.apache.lucene.index.IndexReader
IndexReader.FieldOption - Class in org.apache.lucene.index
  Constants describing field properties, for example used for `IndexReader.getFieldNames(FieldOption)`.
IndexSearcher - Class in org.apache.lucene.search
  Implements search over a single IndexReader.
IndexSearcher(String) - Constructor for class org.apache.lucene.search.IndexSearcher
  Creates a searcher searching the index in the named directory.
IndexSearcher(Directory) - Constructor for class org.apache.lucene.search.IndexSearcher
  Creates a searcher searching the index in the provided directory.
IndexSearcher(IndexReader) - Constructor for class org.apache.lucene.search.IndexSearcher
  Creates a searcher searching the provided index.
indexWriter - Variable in class org.apache.lucene.index.IndexModifier
  Deprecated.
IndexWriter - Class in org.apache.lucene.index
  An `IndexWriter` creates and maintains an index.
IndexWriter(String, Analyzer, boolean, IndexWriter.MaxFieldLength) - Constructor for class org.apache.lucene.index.IndexWriter
  Constructs an IndexWriter for the index in `path`.
IndexWriter(String, Analyzer, boolean) - Constructor for class org.apache.lucene.index.IndexWriter
  Deprecated. This constructor will be removed in the 3.0 release. Use `IndexWriter.IndexWriter(String,Analyzer,boolean,MaxFieldLength)` instead, and call `IndexWriter.commit()` when needed.
IndexWriter(File, Analyzer, boolean, IndexWriter.MaxFieldLength) - Constructor for class org.apache.lucene.index.IndexWriter
  Constructs an IndexWriter for the index in `path`.
IndexWriter(File, Analyzer, boolean) - Constructor for class org.apache.lucene.index.IndexWriter
  Deprecated. This constructor will be removed in the 3.0 release. Use `IndexWriter.IndexWriter(File,Analyzer,boolean,MaxFieldLength)` instead, and call `IndexWriter.commit()` when needed.
IndexWriter(Directory, Analyzer, boolean, IndexWriter.MaxFieldLength) - Constructor for class org.apache.lucene.index.IndexWriter
  Constructs an IndexWriter for the index in `d`.
IndexWriter(Directory, Analyzer, boolean) - Constructor for class org.apache.lucene.index.IndexWriter
  Deprecated. This constructor will be removed in the 3.0 release, and call `IndexWriter.commit()` when needed. Use `IndexWriter.IndexWriter(Directory,Analyzer,boolean,MaxFieldLength)` instead.
IndexWriter(String, Analyzer, IndexWriter.MaxFieldLength) - Constructor for class org.apache.lucene.index.IndexWriter
  Constructs an IndexWriter for the index in `path`, first creating it if it does not already exist.
IndexWriter(String, Analyzer) - Constructor for class org.apache.lucene.index.IndexWriter
  Deprecated. This constructor will be removed in the 3.0 release, and call `IndexWriter.commit()` when needed. Use `IndexWriter.IndexWriter(String,Analyzer,MaxFieldLength)` instead.
IndexWriter(File, Analyzer, IndexWriter.MaxFieldLength) - Constructor for class org.apache.lucene.index.IndexWriter
  Constructs an IndexWriter for the index in `path`, first creating it if it does not already exist.
IndexWriter(File, Analyzer) - Constructor for class org.apache.lucene.index.IndexWriter
  Deprecated. This constructor will be removed in the 3.0 release. Use `IndexWriter.IndexWriter(File,Analyzer,MaxFieldLength)` instead, and call `IndexWriter.commit()` when needed.
IndexWriter(Directory, Analyzer, IndexWriter.MaxFieldLength) - Constructor for class org.apache.lucene.index.IndexWriter
  Constructs an IndexWriter for the index in `d`, first creating it if it does not already exist.
IndexWriter(Directory, Analyzer) - Constructor for class org.apache.lucene.index.IndexWriter
  Deprecated. This constructor will be removed in the 3.0 release. Use `IndexWriter.IndexWriter(Directory,Analyzer,MaxFieldLength)` instead, and call `IndexWriter.commit()` when needed.
IndexWriter(Directory, boolean, Analyzer) - Constructor for class org.apache.lucene.index.IndexWriter
  Deprecated. This constructor will be removed in the 3.0 release. Use `IndexWriter.IndexWriter(Directory,Analyzer,MaxFieldLength)` instead, and call `IndexWriter.commit()` when needed.
IndexWriter(Directory, boolean, Analyzer, boolean) - Constructor for class org.apache.lucene.index.IndexWriter
  Deprecated. This constructor will be removed in the 3.0 release. Use `IndexWriter.IndexWriter(Directory,Analyzer,boolean,MaxFieldLength)` instead, and call `IndexWriter.commit()` when needed.
IndexWriter(Directory, Analyzer, IndexDeletionPolicy, IndexWriter.MaxFieldLength) - Constructor for class org.apache.lucene.index.IndexWriter
  Expert: constructs an IndexWriter with a custom `IndexDeletionPolicy`, for the index in `d`, first creating it if it does not already exist.
IndexWriter(Directory, boolean, Analyzer, IndexDeletionPolicy) - Constructor for class org.apache.lucene.index.IndexWriter
  Deprecated. This constructor will be removed in the 3.0 release. Use `IndexWriter.IndexWriter(Directory,Analyzer,IndexDeletionPolicy,MaxFieldLength)` instead, and call `IndexWriter.commit()` when needed.
IndexWriter(Directory, Analyzer, boolean, IndexDeletionPolicy, IndexWriter.MaxFieldLength) - Constructor for class org.apache.lucene.index.IndexWriter
  Expert: constructs an IndexWriter with a custom `IndexDeletionPolicy`, for the index in `d`.
IndexWriter(Directory, boolean, Analyzer, boolean, IndexDeletionPolicy) - Constructor for class org.apache.lucene.index.IndexWriter
  Deprecated. This constructor will be removed in the 3.0 release. Use `IndexWriter.IndexWriter(Directory,Analyzer,boolean,IndexDeletionPolicy,MaxFieldLength)` instead, and call `IndexWriter.commit()` when needed.
IndexWriter.MaxFieldLength - Class in org.apache.lucene.index
  Specifies maximum field length in `IndexWriter` constructors.
IndexWriter.MaxFieldLength(int) - Constructor for class org.apache.lucene.index.IndexWriter.MaxFieldLength
  Public constructor to allow users to specify the maximum field size limit.
infoStream - Variable in class org.apache.lucene.index.IndexModifier
  Deprecated.
init(Directory, Analyzer, boolean) - Method in class org.apache.lucene.index.IndexModifier
  Deprecated. Initialize an IndexWriter.
initialize(int) - Method in class org.apache.lucene.util.PriorityQueue
  Subclass constructors must call this.
initialValue() - Method in class org.apache.lucene.util.CloseableThreadLocal
inPlaceAnd(DocIdSetIterator) - Method in class org.apache.lucene.util.OpenBitSetDISI
  Perform an inplace AND with the doc ids from a given DocIdSetIterator, leaving only the bits set for which the doc ids are in common.
inPlaceNot(DocIdSetIterator) - Method in class org.apache.lucene.util.OpenBitSetDISI
  Perform an inplace NOT with the doc ids from a given DocIdSetIterator, clearing all the bits for each such doc id.
inPlaceOr(DocIdSetIterator) - Method in class org.apache.lucene.util.OpenBitSetDISI
  Perform an inplace OR with the doc ids from a given DocIdSetIterator, setting the bit for each such doc id.
inPlaceXor(DocIdSetIterator) - Method in class org.apache.lucene.util.OpenBitSetDISI
  Perform an inplace XOR with the doc ids from a given DocIdSetIterator, flipping all the bits for each such doc id.
input - Variable in class org.apache.lucene.analysis.TokenFilter
  The source of tokens for this filter.
input - Variable in class org.apache.lucene.analysis.Tokenizer
  The text source for this Tokenizer.
input_stream - Variable in class org.apache.lucene.queryParser.QueryParserTokenManager
insert(FieldDoc) - Method in class org.apache.lucene.search.FieldSortedHitQueue
insert(Object) - Method in class org.apache.lucene.search.FieldSortedHitQueue
insert(Object) - Method in class org.apache.lucene.util.PriorityQueue
  Adds element to the PriorityQueue in log(size) time if either the PriorityQueue is not full, or not lessThan(element, top()).
insert(Scorer) - Method in class org.apache.lucene.util.ScorerDocQueue
  Adds a Scorer to the ScorerDocQueue in log(size) time if either the ScorerDocQueue is not full, or not lessThan(scorer, top()).
insertWithOverflow(Object) - Method in class org.apache.lucene.search.FieldSortedHitQueue
insertWithOverflow(Object) - Method in class org.apache.lucene.util.PriorityQueue
  insertWithOverflow() is the same as insert() except its return value: it returns the object (if any) that was dropped off the heap because it was full.
INT - Static variable in class org.apache.lucene.search.function.FieldScoreQuery.Type
  field values are interpreted as numeric int values.
INT - Static variable in class org.apache.lucene.search.SortField
  Sort using term values as encoded Integers.
intersect(OpenBitSet) - Method in class org.apache.lucene.util.OpenBitSet
  this = this AND other
intersectionCount(OpenBitSet, OpenBitSet) - Static method in class org.apache.lucene.util.OpenBitSet
  Returns the popcount or cardinality of the intersection of the two sets.
intersects(OpenBitSet) - Method in class org.apache.lucene.util.OpenBitSet
  returns true if the sets have any elements in common
IntFieldSource - Class in org.apache.lucene.search.function
  Expert: obtains int field values from the `FieldCache` using `getInts()` and makes those values available as other numeric types, casting as needed.
IntFieldSource(String) - Constructor for class org.apache.lucene.search.function.IntFieldSource
  Create a cached int field source with default string-to-int parser.
IntFieldSource(String, FieldCache.IntParser) - Constructor for class org.apache.lucene.search.function.IntFieldSource
  Create a cached int field source with a specific string-to-int parser.
intVal(int) - Method in class org.apache.lucene.search.function.DocValues
  Return doc value as an int.
isBinary - Variable in class org.apache.lucene.document.AbstractField
isBinary() - Method in class org.apache.lucene.document.AbstractField
  True iff the value of the filed is stored as binary
isBinary() - Method in interface org.apache.lucene.document.Fieldable
  True iff the value of the filed is stored as binary
isCFSFile(String) - Method in class org.apache.lucene.index.IndexFileNameFilter
  Returns true if this is a file that would be contained in a CFS file.
isCompressed - Variable in class org.apache.lucene.document.AbstractField
isCompressed() - Method in class org.apache.lucene.document.AbstractField
  True if the value of the field is stored and compressed within the index
isCompressed() - Method in interface org.apache.lucene.document.Fieldable
  True if the value of the field is stored and compressed within the index
isCoordDisabled() - Method in class org.apache.lucene.search.BooleanQuery
  Returns true iff `Similarity.coord(int,int)` is disabled in scoring for this query instance.
isCurrent() - Method in class org.apache.lucene.index.FilterIndexReader
isCurrent() - Method in class org.apache.lucene.index.IndexReader
  Check whether this IndexReader is still using the current (i.e., most recently committed) version of the index.
isCurrent() - Method in class org.apache.lucene.index.MultiReader
  Checks recursively if all subreaders are up to date.
isCurrent() - Method in class org.apache.lucene.index.ParallelReader
  Checks recursively if all subreaders are up to date.
isDeleted(int) - Method in class org.apache.lucene.index.FilterIndexReader
isDeleted() - Method in class org.apache.lucene.index.IndexCommit
isDeleted(int) - Method in class org.apache.lucene.index.IndexReader
  Returns true if document n has been deleted
isDeleted(int) - Method in class org.apache.lucene.index.MultiReader
isDeleted(int) - Method in class org.apache.lucene.index.ParallelReader
isEmpty() - Method in class org.apache.lucene.analysis.CharArraySet
isEmpty() - Method in class org.apache.lucene.util.OpenBitSet
  Returns true if there are no set bits
isGreedy() - Method in class org.apache.lucene.search.TimeLimitedCollector
  Checks if this time limited collector is greedy in collecting the last hit.
isIgnoringOffsets() - Method in class org.apache.lucene.index.TermVectorMapper
isIgnoringPositions() - Method in class org.apache.lucene.index.PositionBasedTermVectorMapper
  Never ignores positions.
isIgnoringPositions() - Method in class org.apache.lucene.index.TermVectorMapper
  Indicate to Lucene that even if there are positions stored, this mapper is not interested in them and they can be skipped over.
isInclusive() - Method in class org.apache.lucene.search.RangeQuery
  Returns `true` if the range query is inclusive
isIndexed - Variable in class org.apache.lucene.document.AbstractField
isIndexed() - Method in class org.apache.lucene.document.AbstractField
  True iff the value of the field is to be indexed, so that it may be searched on.
isIndexed() - Method in interface org.apache.lucene.document.Fieldable
  True iff the value of the field is to be indexed, so that it may be searched on.
isInOrder() - Method in class org.apache.lucene.search.spans.SpanNearQuery
  Return true if matches are required to be in-order.
isLazy() - Method in class org.apache.lucene.document.AbstractField
isLazy() - Method in interface org.apache.lucene.document.Fieldable
  Indicates whether a Field is Lazy or not.
isLocked(Directory) - Static method in class org.apache.lucene.index.IndexReader
  Deprecated. Please use `IndexWriter.isLocked(Directory)` instead
isLocked(String) - Static method in class org.apache.lucene.index.IndexReader
  Deprecated. Please use `IndexWriter.isLocked(String)` instead
isLocked(Directory) - Static method in class org.apache.lucene.index.IndexWriter
  Returns `true` iff the index in the named directory is currently locked.
isLocked(String) - Static method in class org.apache.lucene.index.IndexWriter
  Returns `true` iff the index in the named directory is currently locked.
isLocked() - Method in class org.apache.lucene.store.Lock
  Returns true if the resource is currently locked.
isMatch() - Method in class org.apache.lucene.search.ComplexExplanation
  Indicates whether or not this Explanation models a good match.
isMatch() - Method in class org.apache.lucene.search.Explanation
  Indicates whether or not this Explanation models a good match.
ISOLatin1AccentFilter - Class in org.apache.lucene.analysis
  A filter that replaces accented characters in the ISO Latin 1 character set (ISO-8859-1) by their unaccented equivalent.
ISOLatin1AccentFilter(TokenStream) - Constructor for class org.apache.lucene.analysis.ISOLatin1AccentFilter
isOpen - Variable in class org.apache.lucene.store.FSDirectory.FSIndexInput.Descriptor
isOptimized() - Method in class org.apache.lucene.index.FilterIndexReader
isOptimized() - Method in class org.apache.lucene.index.IndexCommit
  Returns true if this commit is an optimized index.
isOptimized() - Method in class org.apache.lucene.index.IndexReader
  Checks is the index is optimized (if it has a single segment and no deletions).
isOptimized() - Method in class org.apache.lucene.index.MultiReader
isOptimized() - Method in class org.apache.lucene.index.ParallelReader
  Checks recursively if all subindexes are optimized
isPayloadAvailable() - Method in class org.apache.lucene.index.FilterIndexReader.FilterTermPositions
isPayloadAvailable() - Method in class org.apache.lucene.index.MultipleTermPositions
isPayloadAvailable() - Method in interface org.apache.lucene.index.TermPositions
  Checks if a payload can be loaded at this position.
isPayloadAvailable() - Method in interface org.apache.lucene.search.spans.PayloadSpans
  Checks if a payload can be loaded at this position.
isPayloadAvailable() - Method in class org.apache.lucene.search.spans.TermSpans
isPowerOfTwo(int) - Static method in class org.apache.lucene.util.BitUtil
  returns true if v is a power of two or zero
isPowerOfTwo(long) - Static method in class org.apache.lucene.util.BitUtil
  returns true if v is a power of two or zero
isProhibited() - Method in class org.apache.lucene.search.BooleanClause
isReplaceInvalidAcronym() - Method in class org.apache.lucene.analysis.standard.StandardAnalyzer
  Deprecated. This will be removed (hardwired to true) in 3.0
isReplaceInvalidAcronym() - Method in class org.apache.lucene.analysis.standard.StandardTokenizer
  Deprecated. Remove in 3.X and make true the only valid value
isRequired() - Method in class org.apache.lucene.search.BooleanClause
isStored - Variable in class org.apache.lucene.document.AbstractField
isStored() - Method in class org.apache.lucene.document.AbstractField
  True iff the value of the field is to be stored in the index for return with search hits.
isStored() - Method in interface org.apache.lucene.document.Fieldable
  True iff the value of the field is to be stored in the index for return with search hits.
isStoreOffsetWithTermVector() - Method in class org.apache.lucene.document.AbstractField
  True iff terms are stored as term vector together with their offsets (start and end positon in source text).
isStoreOffsetWithTermVector() - Method in interface org.apache.lucene.document.Fieldable
  True iff terms are stored as term vector together with their offsets (start and end positon in source text).
isStorePositionWithTermVector() - Method in class org.apache.lucene.document.AbstractField
  True iff terms are stored as term vector together with their token positions.
isStorePositionWithTermVector() - Method in interface org.apache.lucene.document.Fieldable
  True iff terms are stored as term vector together with their token positions.
isStrict() - Method in class org.apache.lucene.search.function.CustomScoreQuery
  Checks if this is strict custom scoring.
isTermVectorStored() - Method in class org.apache.lucene.document.AbstractField
  True iff the term or terms used to index this field are stored as a term vector, available from `IndexReader.getTermFreqVector(int,String)`.
isTermVectorStored() - Method in interface org.apache.lucene.document.Fieldable
  True iff the term or terms used to index this field are stored as a term vector, available from `IndexReader.getTermFreqVector(int,String)`.
isTokenChar(char) - Method in class org.apache.lucene.analysis.CharTokenizer
  Returns true iff a character should be included in a token.
isTokenChar(char) - Method in class org.apache.lucene.analysis.LetterTokenizer
  Collects only characters which satisfy `Character.isLetter(char)`.
isTokenChar(char) - Method in class org.apache.lucene.analysis.WhitespaceTokenizer
  Collects only characters which do not satisfy `Character.isWhitespace(char)`.
isTokenized - Variable in class org.apache.lucene.document.AbstractField
isTokenized() - Method in class org.apache.lucene.document.AbstractField
  True iff the value of the field should be tokenized as text prior to indexing.
isTokenized() - Method in interface org.apache.lucene.document.Fieldable
  True iff the value of the field should be tokenized as text prior to indexing.
iter - Variable in class org.apache.lucene.analysis.SinkTokenizer
iterator() - Method in class org.apache.lucene.analysis.CharArraySet
iterator() - Method in class org.apache.lucene.search.DisjunctionMaxQuery
  An Iterator over the disjuncts
iterator() - Method in class org.apache.lucene.search.DocIdSet
iterator() - Method in class org.apache.lucene.search.Hits
  Deprecated. Returns a `HitIterator` to navigate the Hits.
iterator() - Method in class org.apache.lucene.util.DocIdBitSet
iterator() - Method in class org.apache.lucene.util.OpenBitSet
iterator() - Method in class org.apache.lucene.util.SortedVIntList

## J

JAVA_1_1 - Static variable in class org.apache.lucene.util.Constants
  True iff this is Java version 1.1.
JAVA_1_2 - Static variable in class org.apache.lucene.util.Constants
  True iff this is Java version 1.2.
JAVA_1_3 - Static variable in class org.apache.lucene.util.Constants
  True iff this is Java version 1.3.
JAVA_VERSION - Static variable in class org.apache.lucene.util.Constants
  The value of `System.getProperty("java.version")`.``
jj_nt - Variable in class org.apache.lucene.queryParser.QueryParser
  Next token.
jjFillToken() - Method in class org.apache.lucene.queryParser.QueryParserTokenManager
jjnewLexState - Static variable in class org.apache.lucene.queryParser.QueryParserTokenManager
  Lex State array.
jjstrLiteralImages - Static variable in class org.apache.lucene.queryParser.QueryParserTokenManager
  Token literal values.

## K

KeepOnlyLastCommitDeletionPolicy - Class in org.apache.lucene.index
  This `IndexDeletionPolicy` implementation that keeps only the most recent commit and immediately removes all prior commits after a new commit is done.
KeepOnlyLastCommitDeletionPolicy() - Constructor for class org.apache.lucene.index.KeepOnlyLastCommitDeletionPolicy
keySet() - Method in class org.apache.lucene.util.cache.SimpleMapCache
  Returns a Set containing all keys in this cache.
KeywordAnalyzer - Class in org.apache.lucene.analysis
  "Tokenizes" the entire stream as a single token.
KeywordAnalyzer() - Constructor for class org.apache.lucene.analysis.KeywordAnalyzer
KeywordTokenizer - Class in org.apache.lucene.analysis
  Emits the entire input as a single token.
KeywordTokenizer(Reader) - Constructor for class org.apache.lucene.analysis.KeywordTokenizer
KeywordTokenizer(Reader, int) - Constructor for class org.apache.lucene.analysis.KeywordTokenizer
kind - Variable in class org.apache.lucene.queryParser.Token
  An integer that describes the kind of this token.

## L

lastModified(String) - Static method in class org.apache.lucene.index.IndexReader
  Returns the time the index in the named directory was last modified.
lastModified(File) - Static method in class org.apache.lucene.index.IndexReader
  Returns the time the index in the named directory was last modified.
lastModified(Directory) - Static method in class org.apache.lucene.index.IndexReader
  Returns the time the index in the named directory was last modified.
lazy - Variable in class org.apache.lucene.document.AbstractField
LAZY_LOAD - Static variable in class org.apache.lucene.document.FieldSelectorResult
  Lazily load this `Field`.
length - Variable in class org.apache.lucene.index.Payload
  the length of the payload data
length() - Method in class org.apache.lucene.index.Payload
  Returns the length of the payload data.
length() - Method in class org.apache.lucene.search.HitIterator
  Deprecated. Returns the total number of hits.
length() - Method in class org.apache.lucene.search.Hits
  Deprecated. Returns the total number of hits available in this set.
length() - Method in class org.apache.lucene.store.BufferedIndexOutput
  The number of bytes in the file.
length() - Method in class org.apache.lucene.store.ChecksumIndexInput
length() - Method in class org.apache.lucene.store.ChecksumIndexOutput
length() - Method in class org.apache.lucene.store.FSDirectory.FSIndexInput
length() - Method in class org.apache.lucene.store.FSDirectory.FSIndexOutput
length() - Method in class org.apache.lucene.store.IndexInput
  The number of bytes in the file.
length() - Method in class org.apache.lucene.store.IndexOutput
  The number of bytes in the file.
length() - Method in class org.apache.lucene.store.RAMOutputStream
length - Variable in class org.apache.lucene.util.UnicodeUtil.UTF16Result
length - Variable in class org.apache.lucene.util.UnicodeUtil.UTF8Result
LengthFilter - Class in org.apache.lucene.analysis
  Removes words that are too long and too short from the stream.
LengthFilter(TokenStream, int, int) - Constructor for class org.apache.lucene.analysis.LengthFilter
  Build a filter that removes words that are too long or too short from the text.
lengthNorm(String, int) - Method in class org.apache.lucene.search.DefaultSimilarity
  Implemented as `1/sqrt(numTerms)`.
lengthNorm(String, int) - Method in class org.apache.lucene.search.Similarity
  Computes the normalization value for a field given the total number of terms contained in a field.
lengthNorm(String, int) - Method in class org.apache.lucene.search.SimilarityDelegator
Less(String, String) - Static method in class org.apache.lucene.search.RangeFilter
  Constructs a filter for field `fieldName` matching less than or equal to `upperTerm`.
lessThan(Object, Object) - Method in class org.apache.lucene.search.FieldSortedHitQueue
  Returns whether `a` is less relevant than `b`.
lessThan(Object, Object) - Method in class org.apache.lucene.search.FuzzyQuery.ScoreTermQueue
lessThan(Object, Object) - Method in class org.apache.lucene.util.PriorityQueue
  Determines the ordering of objects in this priority queue.
LetterTokenizer - Class in org.apache.lucene.analysis
  A LetterTokenizer is a tokenizer that divides text at non-letters.
LetterTokenizer(Reader) - Constructor for class org.apache.lucene.analysis.LetterTokenizer
  Construct a new LetterTokenizer.
LEVEL_LOG_SPAN - Static variable in class org.apache.lucene.index.LogMergePolicy
  Defines the allowed range of log(size) for each level.
LexicalError(boolean, int, int, int, String, char) - Static method in error org.apache.lucene.queryParser.TokenMgrError
  Returns a detailed message for the Error when it is thrown by the token manager to indicate a lexical error.
lexStateNames - Static variable in class org.apache.lucene.queryParser.QueryParserTokenManager
  Lexer state names.
LIMITED - Static variable in class org.apache.lucene.index.IndexWriter.MaxFieldLength
  Sets the maximum field length to `IndexWriter.DEFAULT_MAX_FIELD_LENGTH`
LINUX - Static variable in class org.apache.lucene.util.Constants
  True iff running on Linux.
list() - Method in class org.apache.lucene.store.Directory
  Returns an array of strings, one for each file in the directory.
list() - Method in class org.apache.lucene.store.FSDirectory
  Returns an array of strings, one for each Lucene index file in the directory.
list() - Method in class org.apache.lucene.store.RAMDirectory
  Returns an array of strings, one for each file in the directory.
listCommits(Directory) - Static method in class org.apache.lucene.index.IndexReader
  Returns all commit points that exist in the Directory.
LOAD - Static variable in class org.apache.lucene.document.FieldSelectorResult
  Load this `Field` every time the `Document` is loaded, reading in the data as it is encounterd.
LOAD_AND_BREAK - Static variable in class org.apache.lucene.document.FieldSelectorResult
  Load this field as in the `FieldSelectorResult.LOAD` case, but immediately return from `Field` loading for the `Document`.
LOAD_FOR_MERGE - Static variable in class org.apache.lucene.document.FieldSelectorResult
  Behaves much like `FieldSelectorResult.LOAD` but does not uncompress any compressed data.
LoadFirstFieldSelector - Class in org.apache.lucene.document
  Load the First field and break.
LoadFirstFieldSelector() - Constructor for class org.apache.lucene.document.LoadFirstFieldSelector
Lock - Class in org.apache.lucene.store
  An interprocess mutex lock.
Lock() - Constructor for class org.apache.lucene.store.Lock
Lock.With - Class in org.apache.lucene.store
  Utility class for executing code with exclusive access.
Lock.With(Lock, long) - Constructor for class org.apache.lucene.store.Lock.With
  Constructs an executor that will grab the named lock.
LOCK_DIR - Static variable in class org.apache.lucene.store.FSDirectory
  Deprecated. As of 2.1, `LOCK_DIR` is unused because the write.lock is now stored by default in the index directory. If you really want to store locks elsewhere you can create your own `SimpleFSLockFactory` (or `NativeFSLockFactory`, etc.) passing in your preferred lock directory. Then, pass this `LockFactory` instance to one of the `getDirectory` methods that take a `lockFactory` (for example, `FSDirectory.getDirectory(String, LockFactory)`).
LOCK_OBTAIN_WAIT_FOREVER - Static variable in class org.apache.lucene.store.Lock
  Pass this value to `Lock.obtain(long)` to try forever to obtain the lock.
LOCK_POLL_INTERVAL - Static variable in class org.apache.lucene.store.Lock
  How long `Lock.obtain(long)` waits, in milliseconds, in between attempts to acquire the lock.
lockFactory - Variable in class org.apache.lucene.store.Directory
  Holds the LockFactory instance (implements locking for this Directory instance).
LockFactory - Class in org.apache.lucene.store
  Base class for Locking implementation.
LockFactory() - Constructor for class org.apache.lucene.store.LockFactory
LockObtainFailedException - Exception in org.apache.lucene.store
  This exception is thrown when the `write.lock` could not be acquired.
LockObtainFailedException(String) - Constructor for exception org.apache.lucene.store.LockObtainFailedException
lockPrefix - Variable in class org.apache.lucene.store.LockFactory
LockReleaseFailedException - Exception in org.apache.lucene.store
  This exception is thrown when the `write.lock` could not be released.
LockReleaseFailedException(String) - Constructor for exception org.apache.lucene.store.LockReleaseFailedException
LockStressTest - Class in org.apache.lucene.store
  Simple standalone tool that forever acquires & releases a lock using a specific LockFactory.
LockStressTest() - Constructor for class org.apache.lucene.store.LockStressTest
LockVerifyServer - Class in org.apache.lucene.store
  Simple standalone server that must be running when you use `VerifyingLockFactory`.
LockVerifyServer() - Constructor for class org.apache.lucene.store.LockVerifyServer
LogByteSizeMergePolicy - Class in org.apache.lucene.index
  This is a `LogMergePolicy` that measures size of a segment as the total byte size of the segment's files.
LogByteSizeMergePolicy() - Constructor for class org.apache.lucene.index.LogByteSizeMergePolicy
LogDocMergePolicy - Class in org.apache.lucene.index
  This is a `LogMergePolicy` that measures size of a segment as the number of documents (not taking deletions into account).
LogDocMergePolicy() - Constructor for class org.apache.lucene.index.LogDocMergePolicy
LogMergePolicy - Class in org.apache.lucene.index
  This class implements a `MergePolicy` that tries to merge segments into levels of exponentially increasing size, where each level has < mergeFactor segments in it.
LogMergePolicy() - Constructor for class org.apache.lucene.index.LogMergePolicy
LONG - Static variable in class org.apache.lucene.search.SortField
  Sort using term values as encoded Longs.
longToString(long) - Static method in class org.apache.lucene.document.NumberTools
  Converts a long to a String suitable for indexing.
longVal(int) - Method in class org.apache.lucene.search.function.DocValues
  Return doc value as a long.
lookup - Variable in class org.apache.lucene.search.FieldCache.StringIndex
  All the term values, in natural order.
LowerCaseFilter - Class in org.apache.lucene.analysis
  Normalizes token text to lower case.
LowerCaseFilter(TokenStream) - Constructor for class org.apache.lucene.analysis.LowerCaseFilter
LowerCaseTokenizer - Class in org.apache.lucene.analysis
  LowerCaseTokenizer performs the function of LetterTokenizer and LowerCaseFilter together.
LowerCaseTokenizer(Reader) - Constructor for class org.apache.lucene.analysis.LowerCaseTokenizer
  Construct a new LowerCaseTokenizer.
LPAREN - Static variable in interface org.apache.lucene.queryParser.QueryParserConstants
  RegularExpression Id.
lst - Variable in class org.apache.lucene.analysis.SinkTokenizer
LucenePackage - Class in org.apache.lucene
  Lucene's package information, including version.

## M

main(String[]) - Static method in class org.apache.lucene.index.CheckIndex
  Command-line interface to check and fix an index.
main(String[]) - Static method in class org.apache.lucene.index.IndexReader
  Prints the filename and size of each file within a given compound file.
main(String[]) - Static method in class org.apache.lucene.queryParser.QueryParser
  Command line tool to test QueryParser, using `SimpleAnalyzer`.
main(String[]) - Static method in class org.apache.lucene.search.RemoteSearchable
  Exports a searcher for the index in args[0] named "//localhost/Searchable".
main(String[]) - Static method in class org.apache.lucene.store.LockStressTest
main(String[]) - Static method in class org.apache.lucene.store.LockVerifyServer
makeLock(String) - Method in class org.apache.lucene.store.Directory
  Construct a `Lock`.
makeLock(String) - Method in class org.apache.lucene.store.LockFactory
  Return a new Lock instance identified by lockName.
makeLock(String) - Method in class org.apache.lucene.store.NativeFSLockFactory
makeLock(String) - Method in class org.apache.lucene.store.NoLockFactory
makeLock(String) - Method in class org.apache.lucene.store.SimpleFSLockFactory
makeLock(String) - Method in class org.apache.lucene.store.SingleInstanceLockFactory
makeLock(String) - Method in class org.apache.lucene.store.VerifyingLockFactory
makeStopSet(String[]) - Static method in class org.apache.lucene.analysis.StopFilter
  Builds a Set from an array of stop words, appropriate for passing into the StopFilter constructor.
makeStopSet(String[], boolean) - Static method in class org.apache.lucene.analysis.StopFilter
manager - Static variable in class org.apache.lucene.search.FilterManager
map(String, int, TermVectorOffsetInfo[], int[]) - Method in class org.apache.lucene.index.FieldSortedTermVectorMapper
map(String, int, TermVectorOffsetInfo[], int[]) - Method in class org.apache.lucene.index.PositionBasedTermVectorMapper
  Callback for the TermVectorReader.
map(String, int, TermVectorOffsetInfo[], int[]) - Method in class org.apache.lucene.index.SortedTermVectorMapper
map(String, int, TermVectorOffsetInfo[], int[]) - Method in class org.apache.lucene.index.TermVectorMapper
  Map the Term Vector information into your own structure
MapFieldSelector - Class in org.apache.lucene.document
  A FieldSelector based on a Map of field names to FieldSelectorResults
MapFieldSelector(Map) - Constructor for class org.apache.lucene.document.MapFieldSelector
  Create a a MapFieldSelector
MapFieldSelector(List) - Constructor for class org.apache.lucene.document.MapFieldSelector
  Create a a MapFieldSelector
MapFieldSelector(String[]) - Constructor for class org.apache.lucene.document.MapFieldSelector
  Create a a MapFieldSelector
MatchAllDocsQuery - Class in org.apache.lucene.search
  A query that matches all documents.
MatchAllDocsQuery() - Constructor for class org.apache.lucene.search.MatchAllDocsQuery
MAX_DATE_STRING() - Static method in class org.apache.lucene.document.DateField
  Deprecated.
MAX_STRING_VALUE - Static variable in class org.apache.lucene.document.NumberTools
  Equivalent to longToString(Long.MAX_VALUE)
MAX_TERM_LENGTH - Static variable in class org.apache.lucene.index.IndexWriter
  Absolute hard maximum length for a term.
maxBufferedDocs - Variable in class org.apache.lucene.index.IndexModifier
  Deprecated.
maxDoc() - Method in class org.apache.lucene.index.FilterIndexReader
maxDoc() - Method in class org.apache.lucene.index.IndexReader
  Returns one greater than the largest possible document number.
maxDoc() - Method in class org.apache.lucene.index.IndexWriter
  Returns total number of docs in this index, including docs not yet flushed (still in the RAM buffer), not counting deletions.
maxDoc() - Method in class org.apache.lucene.index.MultiReader
maxDoc() - Method in class org.apache.lucene.index.ParallelReader
maxDoc() - Method in class org.apache.lucene.search.IndexSearcher
maxDoc() - Method in class org.apache.lucene.search.MultiSearcher
maxDoc() - Method in class org.apache.lucene.search.RemoteSearchable
maxDoc() - Method in interface org.apache.lucene.search.Searchable
  Expert: Returns one greater than the largest possible document number.
maxDoc() - Method in class org.apache.lucene.search.Searcher
maxFieldLength - Variable in class org.apache.lucene.index.IndexModifier
  Deprecated.
maxscore - Variable in class org.apache.lucene.search.FieldSortedHitQueue
  Stores the maximum score value encountered, needed for normalizing.
maybeMerge() - Method in class org.apache.lucene.index.IndexWriter
  Expert: asks the mergePolicy whether any merges are necessary now and if so, runs the requested merges and then iterate (test again if merges are needed) until no more merges are returned by the mergePolicy.
merge(IndexWriter) - Method in class org.apache.lucene.index.ConcurrentMergeScheduler
merge(IndexWriter) - Method in class org.apache.lucene.index.SerialMergeScheduler
  Just do the merges in sequence.
mergeBooleanQueries(Query[]) - Static method in class org.apache.lucene.search.Query
  Expert: merges the clauses of a set of BooleanQuery's into a single BooleanQuery.
mergeFactor - Variable in class org.apache.lucene.index.IndexModifier
  Deprecated.
MergePolicy - Class in org.apache.lucene.index
  Expert: a MergePolicy determines the sequence of primitive merge operations to be used for overall merge and optimize operations.
MergePolicy() - Constructor for class org.apache.lucene.index.MergePolicy
MergePolicy.MergeAbortedException - Exception in org.apache.lucene.index
MergePolicy.MergeAbortedException() - Constructor for exception org.apache.lucene.index.MergePolicy.MergeAbortedException
MergePolicy.MergeAbortedException(String) - Constructor for exception org.apache.lucene.index.MergePolicy.MergeAbortedException
MergePolicy.MergeException - Exception in org.apache.lucene.index
  Exception thrown if there are any problems while executing a merge.
MergePolicy.MergeException(String) - Constructor for exception org.apache.lucene.index.MergePolicy.MergeException
  Deprecated. Use `MergePolicy.MergeException.MergePolicy.MergeException(String,Directory)` instead
MergePolicy.MergeException(String, Directory) - Constructor for exception org.apache.lucene.index.MergePolicy.MergeException
MergePolicy.MergeException(Throwable) - Constructor for exception org.apache.lucene.index.MergePolicy.MergeException
  Deprecated. Use `MergePolicy.MergeException.MergePolicy.MergeException(Throwable,Directory)` instead
MergePolicy.MergeException(Throwable, Directory) - Constructor for exception org.apache.lucene.index.MergePolicy.MergeException
MergePolicy.MergeSpecification - Class in org.apache.lucene.index
  A MergeSpecification instance provides the information necessary to perform multiple merges.
MergePolicy.MergeSpecification() - Constructor for class org.apache.lucene.index.MergePolicy.MergeSpecification
MergePolicy.OneMerge - Class in org.apache.lucene.index
  OneMerge provides the information necessary to perform an individual primitive merge operation, resulting in a single new segment.
MergePolicy.OneMerge(SegmentInfos, boolean) - Constructor for class org.apache.lucene.index.MergePolicy.OneMerge
merges - Variable in class org.apache.lucene.index.MergePolicy.MergeSpecification
  The subset of segments to be included in the primitive merge.
MergeScheduler - Class in org.apache.lucene.index
  Expert: `IndexWriter` uses an instance implementing this interface to execute the merges selected by a `MergePolicy`.
MergeScheduler() - Constructor for class org.apache.lucene.index.MergeScheduler
mergeThreadCount - Variable in class org.apache.lucene.index.ConcurrentMergeScheduler
mergeThreads - Variable in class org.apache.lucene.index.ConcurrentMergeScheduler
message(String) - Method in class org.apache.lucene.index.IndexWriter
  Prints a message to the infoStream (if non-null), prefixed with the identifying information for this writer and the thread that's calling it.
MILLISECOND - Static variable in class org.apache.lucene.document.DateTools.Resolution
MIN_DATE_STRING() - Static method in class org.apache.lucene.document.DateField
  Deprecated.
MIN_STRING_VALUE - Static variable in class org.apache.lucene.document.NumberTools
  Equivalent to longToString(Long.MIN_VALUE)
minNrShouldMatch - Variable in class org.apache.lucene.search.BooleanQuery
MINUS - Static variable in interface org.apache.lucene.queryParser.QueryParserConstants
  RegularExpression Id.
MINUTE - Static variable in class org.apache.lucene.document.DateTools.Resolution
missingSegments - Variable in class org.apache.lucene.index.CheckIndex.Status
  True if we were unable to locate and load the segments_N file.
missingSegmentVersion - Variable in class org.apache.lucene.index.CheckIndex.Status
  True if we were unable to read the version number from segments_N file.
MMapDirectory - Class in org.apache.lucene.store
  File-based `Directory` implementation that uses mmap for input.
MMapDirectory() - Constructor for class org.apache.lucene.store.MMapDirectory
Modifiers() - Method in class org.apache.lucene.queryParser.QueryParser
MONTH - Static variable in class org.apache.lucene.document.DateTools.Resolution
More(String, String) - Static method in class org.apache.lucene.search.RangeFilter
  Constructs a filter for field `fieldName` matching greater than or equal to `lowerTerm`.
more - Variable in class org.apache.lucene.search.spans.SpanScorer
MultiFieldQueryParser - Class in org.apache.lucene.queryParser
  A QueryParser which constructs queries to search multiple fields.
MultiFieldQueryParser(String[], Analyzer, Map) - Constructor for class org.apache.lucene.queryParser.MultiFieldQueryParser
  Creates a MultiFieldQueryParser.
MultiFieldQueryParser(String[], Analyzer) - Constructor for class org.apache.lucene.queryParser.MultiFieldQueryParser
  Creates a MultiFieldQueryParser.
MultiPhraseQuery - Class in org.apache.lucene.search
  MultiPhraseQuery is a generalized version of PhraseQuery, with an added method `MultiPhraseQuery.add(Term[])`.
MultiPhraseQuery() - Constructor for class org.apache.lucene.search.MultiPhraseQuery
MultipleTermPositions - Class in org.apache.lucene.index
  Describe class `MultipleTermPositions` here.
MultipleTermPositions(IndexReader, Term[]) - Constructor for class org.apache.lucene.index.MultipleTermPositions
  Creates a new `MultipleTermPositions` instance.
MultiReader - Class in org.apache.lucene.index
  An IndexReader which reads multiple indexes, appending their content.
MultiReader(IndexReader[]) - Constructor for class org.apache.lucene.index.MultiReader
  Construct a MultiReader aggregating the named set of (sub)readers.
MultiReader(IndexReader[], boolean) - Constructor for class org.apache.lucene.index.MultiReader
  Construct a MultiReader aggregating the named set of (sub)readers.
MultiSearcher - Class in org.apache.lucene.search
  Implements search over a set of `Searchables`.
MultiSearcher(Searchable[]) - Constructor for class org.apache.lucene.search.MultiSearcher
  Creates a searcher which searches searchables.
MultiTermQuery - Class in org.apache.lucene.search
  A `Query` that matches documents containing a subset of terms provided by a `FilteredTermEnum` enumeration.
MultiTermQuery(Term) - Constructor for class org.apache.lucene.search.MultiTermQuery
  Constructs a query for terms matching `term`.
MUST - Static variable in class org.apache.lucene.search.BooleanClause.Occur
  Use this operator for clauses that must appear in the matching documents.
MUST_NOT - Static variable in class org.apache.lucene.search.BooleanClause.Occur
  Use this operator for clauses that must not appear in the matching documents.

## N

name - Variable in class org.apache.lucene.document.AbstractField
name() - Method in class org.apache.lucene.document.AbstractField
  Returns the name of the field as an interned string.
name() - Method in interface org.apache.lucene.document.Fieldable
  Returns the name of the field as an interned string.
name - Variable in class org.apache.lucene.index.CheckIndex.Status.SegmentInfoStatus
  Name of the segment.
name() - Method in class org.apache.lucene.search.function.CustomScoreQuery
  A short name of this query, used in `CustomScoreQuery.toString(String)`.
NativeFSLockFactory - Class in org.apache.lucene.store
  Implements `LockFactory` using native OS file locks.
NativeFSLockFactory(String) - Constructor for class org.apache.lucene.store.NativeFSLockFactory
  Create a NativeFSLockFactory instance, storing lock files into the specified lockDirName:
NativeFSLockFactory(File) - Constructor for class org.apache.lucene.store.NativeFSLockFactory
  Create a NativeFSLockFactory instance, storing lock files into the specified lockDir:
newBooleanClause(Query, BooleanClause.Occur) - Method in class org.apache.lucene.queryParser.QueryParser
  Builds a new BooleanClause instance
newBooleanQuery(boolean) - Method in class org.apache.lucene.queryParser.QueryParser
  Builds a new BooleanQuery instance
newBuffer(byte[]) - Method in class org.apache.lucene.store.BufferedIndexInput
newComparator(IndexReader, String) - Method in class org.apache.lucene.search.SortComparator
newComparator(IndexReader, String) - Method in interface org.apache.lucene.search.SortComparatorSource
  Creates a comparator for the field in the given index.
newFuzzyQuery(Term, float, int) - Method in class org.apache.lucene.queryParser.QueryParser
  Builds a new FuzzyQuery instance
newMatchAllDocsQuery() - Method in class org.apache.lucene.queryParser.QueryParser
  Builds a new MatchAllDocsQuery instance
newMultiPhraseQuery() - Method in class org.apache.lucene.queryParser.QueryParser
  Builds a new MultiPhraseQuery instance
newPhraseQuery() - Method in class org.apache.lucene.queryParser.QueryParser
  Builds a new PhraseQuery instance
newPrefixQuery(Term) - Method in class org.apache.lucene.queryParser.QueryParser
  Builds a new PrefixQuery instance
newRangeQuery(String, String, String, boolean) - Method in class org.apache.lucene.queryParser.QueryParser
  Builds a new RangeQuery instance
newTermQuery(Term) - Method in class org.apache.lucene.queryParser.QueryParser
  Builds a new TermQuery instance
newToken(int, String) - Static method in class org.apache.lucene.queryParser.Token
  Returns a new Token object, by default.
newToken(int) - Static method in class org.apache.lucene.queryParser.Token
newWildcardQuery(Term) - Method in class org.apache.lucene.queryParser.QueryParser
  Builds a new WildcardQuery instance
next(Token) - Method in class org.apache.lucene.analysis.CachingTokenFilter
next() - Method in class org.apache.lucene.analysis.CharArraySet.CharArraySetIterator
  Returns the next String, as a Set would...
next(Token) - Method in class org.apache.lucene.analysis.CharTokenizer
next(Token) - Method in class org.apache.lucene.analysis.ISOLatin1AccentFilter
next(Token) - Method in class org.apache.lucene.analysis.KeywordTokenizer
next(Token) - Method in class org.apache.lucene.analysis.LengthFilter
  Returns the next input Token whose term() is the right len
next(Token) - Method in class org.apache.lucene.analysis.LowerCaseFilter
next(Token) - Method in class org.apache.lucene.analysis.PorterStemFilter
next(Token) - Method in class org.apache.lucene.analysis.SinkTokenizer
  Returns the next token out of the list of cached tokens
next(Token) - Method in class org.apache.lucene.analysis.standard.StandardFilter
  Returns the next token in the stream, or null at EOS.
next(Token) - Method in class org.apache.lucene.analysis.standard.StandardTokenizer
next(Token) - Method in class org.apache.lucene.analysis.StopFilter
  Returns the next input Token whose term() is not a stop word.
next(Token) - Method in class org.apache.lucene.analysis.TeeTokenFilter
next() - Method in class org.apache.lucene.analysis.TokenStream
  Deprecated. The returned Token is a "full private copy" (not re-used across calls to next()) but will be slower than calling `TokenStream.next(Token)` instead..
next(Token) - Method in class org.apache.lucene.analysis.TokenStream
  Returns the next token in the stream, or null at EOS.
next() - Method in class org.apache.lucene.index.FilterIndexReader.FilterTermDocs
next() - Method in class org.apache.lucene.index.FilterIndexReader.FilterTermEnum
next() - Method in class org.apache.lucene.index.MultipleTermPositions
next() - Method in interface org.apache.lucene.index.TermDocs
  Moves to the next pair in the enumeration.
next() - Method in class org.apache.lucene.index.TermEnum
  Increments the enumeration to the next element.
next - Variable in class org.apache.lucene.queryParser.Token
  A reference to the next regular (non-special) token from the input stream.
next() - Method in class org.apache.lucene.search.ConstantScoreQuery.ConstantScorer
next() - Method in class org.apache.lucene.search.DocIdSetIterator
  Moves to the next docId in the set.
next() - Method in class org.apache.lucene.search.FilteredTermEnum
  Increments the enumeration to the next element.
next() - Method in class org.apache.lucene.search.HitIterator
  Deprecated. Returns a `Hit` instance representing the next hit in `Hits`.
next() - Method in class org.apache.lucene.search.ReqExclScorer
next() - Method in class org.apache.lucene.search.ReqOptSumScorer
next() - Method in interface org.apache.lucene.search.spans.Spans
  Move to the next match, returning true iff any such exists.
next() - Method in class org.apache.lucene.search.spans.SpanScorer
next() - Method in class org.apache.lucene.search.spans.TermSpans
next() - Method in class org.apache.lucene.util.OpenBitSetIterator
  alternate shift implementations // 32 bit shifts, but a long shift needed at the end private void shift2() { int y = (int)word; if (y==0) {wordShift +=32; y = (int)(word >>>32); } if ((y & 0x0000FFFF) == 0) { wordShift +=16; y>>>=16; } if ((y & 0x000000FF) == 0) { wordShift +=8; y>>>=8; } indexArray = bitlist[y & 0xff]; word >>>= (wordShift +1); } private void shift3() { int lower = (int)word; int lowByte = lower & 0xff; if (lowByte != 0) { indexArray=bitlist[lowByte]; return; } shift(); }
nextCharArray() - Method in class org.apache.lucene.analysis.CharArraySet.CharArraySetIterator
  do not modify the returned char[]
nextHighestPowerOfTwo(int) - Static method in class org.apache.lucene.util.BitUtil
  returns the next highest power of two, or the current value if it's already a power of two or zero
nextHighestPowerOfTwo(long) - Static method in class org.apache.lucene.util.BitUtil
  returns the next highest power of two, or the current value if it's already a power of two or zero
nextPosition() - Method in class org.apache.lucene.index.FilterIndexReader.FilterTermPositions
nextPosition() - Method in class org.apache.lucene.index.MultipleTermPositions
nextPosition() - Method in interface org.apache.lucene.index.TermPositions
  Returns next position in the current document.
nextSetBit(int) - Method in class org.apache.lucene.util.OpenBitSet
  Returns the index of the first set bit starting at the index specified.
nextSetBit(long) - Method in class org.apache.lucene.util.OpenBitSet
  Returns the index of the first set bit starting at the index specified.
NIOFSDirectory - Class in org.apache.lucene.store
  NIO version of FSDirectory.
NIOFSDirectory() - Constructor for class org.apache.lucene.store.NIOFSDirectory
NO - Static variable in class org.apache.lucene.document.Field.Index
  Do not index the field value.
NO - Static variable in class org.apache.lucene.document.Field.Store
  Do not store the field value in the index.
NO - Static variable in class org.apache.lucene.document.Field.TermVector
  Do not store term vectors.
NO_LOAD - Static variable in class org.apache.lucene.document.FieldSelectorResult
  Do not load the `Field`.
NO_NORMS - Static variable in class org.apache.lucene.document.Field.Index
  Deprecated. This has been renamed to `Field.Index.NOT_ANALYZED_NO_NORMS`
NoLockFactory - Class in org.apache.lucene.store
  Use this `LockFactory` to disable locking entirely.
NoLockFactory() - Constructor for class org.apache.lucene.store.NoLockFactory
normalize(char) - Method in class org.apache.lucene.analysis.CharTokenizer
  Called on each token character to normalize it before it is added to the token.
normalize(char) - Method in class org.apache.lucene.analysis.LowerCaseTokenizer
  Collects only characters which satisfy `Character.isLetter(char)`.
normalize(float) - Method in class org.apache.lucene.search.ConstantScoreQuery.ConstantWeight
normalize(float) - Method in class org.apache.lucene.search.spans.SpanWeight
normalize(float) - Method in interface org.apache.lucene.search.Weight
  Assigns the query normalization factor to this.
norms(String) - Method in class org.apache.lucene.index.FilterIndexReader
norms(String, byte[], int) - Method in class org.apache.lucene.index.FilterIndexReader
norms(String) - Method in class org.apache.lucene.index.IndexReader
  Returns the byte-encoded normalization factor for the named field of every document.
norms(String, byte[], int) - Method in class org.apache.lucene.index.IndexReader
  Reads the byte-encoded normalization factor for the named field of every document.
norms(String) - Method in class org.apache.lucene.index.MultiReader
norms(String, byte[], int) - Method in class org.apache.lucene.index.MultiReader
norms(String) - Method in class org.apache.lucene.index.ParallelReader
norms(String, byte[], int) - Method in class org.apache.lucene.index.ParallelReader
norms - Variable in class org.apache.lucene.search.spans.SpanScorer
NOT - Static variable in interface org.apache.lucene.queryParser.QueryParserConstants
  RegularExpression Id.
NOT_ANALYZED - Static variable in class org.apache.lucene.document.Field.Index
  Index the field's value without using an Analyzer, so it can be searched.
NOT_ANALYZED_NO_NORMS - Static variable in class org.apache.lucene.document.Field.Index
  Expert: Index the field's value without an Analyzer, and also disable the storing of norms.
ntz(long) - Static method in class org.apache.lucene.util.BitUtil
  Returns number of trailing zeros in the 64 bit long value.
ntz2(long) - Static method in class org.apache.lucene.util.BitUtil
  returns 0 based index of first set bit (only works for x!=0)
  This is an alternate implementation of ntz()
ntz3(long) - Static method in class org.apache.lucene.util.BitUtil
  returns 0 based index of first set bit
  This is an alternate implementation of ntz()
ntzTable - Static variable in class org.apache.lucene.util.BitUtil
  table of number of trailing zeros in a byte
NUM - Static variable in class org.apache.lucene.analysis.standard.StandardTokenizer
numBadSegments - Variable in class org.apache.lucene.index.CheckIndex.Status
  How many bad segments were found.
NUMBER - Static variable in interface org.apache.lucene.queryParser.QueryParserConstants
  RegularExpression Id.
NumberTools - Class in org.apache.lucene.document
  Provides support for converting longs to Strings, and back again.
NumberTools() - Constructor for class org.apache.lucene.document.NumberTools
numDeleted - Variable in class org.apache.lucene.index.CheckIndex.Status.SegmentInfoStatus
  Number of deleted documents.
numDeletedDocs() - Method in class org.apache.lucene.index.IndexReader
  Returns the number of deleted documents.
numDocs() - Method in class org.apache.lucene.index.FilterIndexReader
numDocs() - Method in class org.apache.lucene.index.IndexReader
  Returns the number of documents in this index.
numDocs() - Method in class org.apache.lucene.index.IndexWriter
  Returns total number of docs in this index, including docs not yet flushed (still in the RAM buffer), and including deletions.
numDocs() - Method in class org.apache.lucene.index.MultiReader
numDocs() - Method in class org.apache.lucene.index.ParallelReader
numFiles - Variable in class org.apache.lucene.index.CheckIndex.Status.SegmentInfoStatus
  Number of files referenced by this segment.
numRamDocs() - Method in class org.apache.lucene.index.IndexWriter
  Expert: Return the number of documents currently buffered in RAM.
numSegments - Variable in class org.apache.lucene.index.CheckIndex.Status
  Number of segments in the index.

## O

obtain() - Method in class org.apache.lucene.store.Lock
  Attempts to obtain exclusive access and immediately return upon success or failure.
obtain(long) - Method in class org.apache.lucene.store.Lock
  Attempts to obtain an exclusive lock within amount of time given.
offset - Variable in class org.apache.lucene.index.Payload
  the offset within the byte array
offsets - Variable in class org.apache.lucene.util.UnicodeUtil.UTF16Result
OMIT_TF - Static variable in class org.apache.lucene.index.IndexReader.FieldOption
  All fields that omit tf
omitNorms - Variable in class org.apache.lucene.document.AbstractField
omitTf - Variable in class org.apache.lucene.document.AbstractField
onCommit(List) - Method in interface org.apache.lucene.index.IndexDeletionPolicy
  This is called each time the writer completed a commit.
onCommit(List) - Method in class org.apache.lucene.index.KeepOnlyLastCommitDeletionPolicy
  Deletes all commits except the most recent one.
onCommit(List) - Method in class org.apache.lucene.index.SnapshotDeletionPolicy
onInit(List) - Method in interface org.apache.lucene.index.IndexDeletionPolicy
  This is called once when a writer is first instantiated to give the policy a chance to remove old commit points.
onInit(List) - Method in class org.apache.lucene.index.KeepOnlyLastCommitDeletionPolicy
  Deletes all commits except the most recent one.
onInit(List) - Method in class org.apache.lucene.index.SnapshotDeletionPolicy
open - Variable in class org.apache.lucene.index.IndexModifier
  Deprecated.
open(String) - Static method in class org.apache.lucene.index.IndexReader
  Returns a read/write IndexReader reading the index in an FSDirectory in the named path.
open(File) - Static method in class org.apache.lucene.index.IndexReader
  Returns a read/write IndexReader reading the index in an FSDirectory in the named path.
open(Directory) - Static method in class org.apache.lucene.index.IndexReader
  Returns a read/write IndexReader reading the index in the given Directory.
open(Directory, boolean) - Static method in class org.apache.lucene.index.IndexReader
  Returns a read/write or read only IndexReader reading the index in the given Directory.
open(IndexCommit) - Static method in class org.apache.lucene.index.IndexReader
  Expert: returns a read/write IndexReader reading the index in the given `IndexCommit`.
open(Directory, IndexDeletionPolicy) - Static method in class org.apache.lucene.index.IndexReader
  Expert: returns a read/write IndexReader reading the index in the given Directory, with a custom `IndexDeletionPolicy`.
open(Directory, IndexDeletionPolicy, boolean) - Static method in class org.apache.lucene.index.IndexReader
  Expert: returns a read/write or read only IndexReader reading the index in the given Directory, with a custom `IndexDeletionPolicy`.
open(IndexCommit, IndexDeletionPolicy) - Static method in class org.apache.lucene.index.IndexReader
  Expert: returns a read/write IndexReader reading the index in the given Directory, using a specific commit and with a custom `IndexDeletionPolicy`.
open(IndexCommit, IndexDeletionPolicy, boolean) - Static method in class org.apache.lucene.index.IndexReader
  Expert: returns a read/write or read only IndexReader reading the index in the given Directory, using a specific commit and with a custom `IndexDeletionPolicy`.
OpenBitSet - Class in org.apache.lucene.util
  An "open" BitSet implementation that allows direct access to the array of words storing the bits.
OpenBitSet(long) - Constructor for class org.apache.lucene.util.OpenBitSet
  Constructs an OpenBitSet large enough to hold numBits.
OpenBitSet() - Constructor for class org.apache.lucene.util.OpenBitSet
OpenBitSet(long[], int) - Constructor for class org.apache.lucene.util.OpenBitSet
  Constructs an OpenBitSet from an existing long[].
OpenBitSetDISI - Class in org.apache.lucene.util
OpenBitSetDISI(DocIdSetIterator, int) - Constructor for class org.apache.lucene.util.OpenBitSetDISI
  Construct an OpenBitSetDISI with its bits set from the doc ids of the given DocIdSetIterator.
OpenBitSetDISI(int) - Constructor for class org.apache.lucene.util.OpenBitSetDISI
  Construct an OpenBitSetDISI with no bits set, and a given maximum size one larger than the largest doc id for which a bit may ever be set on this OpenBitSetDISI.
OpenBitSetIterator - Class in org.apache.lucene.util
  An iterator to iterate over set bits in an OpenBitSet.
OpenBitSetIterator(OpenBitSet) - Constructor for class org.apache.lucene.util.OpenBitSetIterator
OpenBitSetIterator(long[], int) - Constructor for class org.apache.lucene.util.OpenBitSetIterator
openInput(String) - Method in class org.apache.lucene.store.Directory
  Returns a stream reading an existing file.
openInput(String, int) - Method in class org.apache.lucene.store.Directory
  Returns a stream reading an existing file, with the specified read buffer size.
openInput(String) - Method in class org.apache.lucene.store.FSDirectory
openInput(String, int) - Method in class org.apache.lucene.store.FSDirectory
openInput(String) - Method in class org.apache.lucene.store.MMapDirectory
openInput(String, int) - Method in class org.apache.lucene.store.MMapDirectory
openInput(String, int) - Method in class org.apache.lucene.store.NIOFSDirectory
openInput(String) - Method in class org.apache.lucene.store.RAMDirectory
  Returns a stream reading an existing file.
openReaderPassed - Variable in class org.apache.lucene.index.CheckIndex.Status.SegmentInfoStatus
  True if we were able to open a SegmentReader on this segment.
optimize() - Method in class org.apache.lucene.index.IndexModifier
  Deprecated. Merges all segments together into a single segment, optimizing an index for search.
optimize() - Method in class org.apache.lucene.index.IndexWriter
  Requests an "optimize" operation on an index, priming the index for the fastest available search.
optimize(int) - Method in class org.apache.lucene.index.IndexWriter
  Optimize the index down to <= maxNumSegments.
optimize(boolean) - Method in class org.apache.lucene.index.IndexWriter
  Just like `IndexWriter.optimize()`, except you can specify whether the call should block until the optimize completes.
optimize(int, boolean) - Method in class org.apache.lucene.index.IndexWriter
  Just like `IndexWriter.optimize(int)`, except you can specify whether the call should block until the optimize completes.
OR - Static variable in class org.apache.lucene.queryParser.QueryParser.Operator
OR - Static variable in interface org.apache.lucene.queryParser.QueryParserConstants
  RegularExpression Id.
or(OpenBitSet) - Method in class org.apache.lucene.util.OpenBitSet
OR_OPERATOR - Static variable in class org.apache.lucene.queryParser.QueryParser
  Alternative form of QueryParser.Operator.OR
order - Variable in class org.apache.lucene.search.FieldCache.StringIndex
  For each document, an index into the lookup array.
OrdFieldSource - Class in org.apache.lucene.search.function
  Expert: obtains the ordinal of the field value from the default Lucene `Fieldcache` using getStringIndex().
OrdFieldSource(String) - Constructor for class org.apache.lucene.search.function.OrdFieldSource
  Contructor for a certain field.
org.apache.lucene - package org.apache.lucene
  Top-level package.
org.apache.lucene.analysis - package org.apache.lucene.analysis
  API and code to convert text into indexable/searchable tokens.
org.apache.lucene.analysis.standard - package org.apache.lucene.analysis.standard
  A fast grammar-based tokenizer constructed with JFlex.
org.apache.lucene.document - package org.apache.lucene.document
  The logical representation of a `Document` for indexing and searching.
org.apache.lucene.index - package org.apache.lucene.index
  Code to maintain and access indices.
org.apache.lucene.queryParser - package org.apache.lucene.queryParser
  A simple query parser implemented with JavaCC.
org.apache.lucene.search - package org.apache.lucene.search
  Code to search indices.
org.apache.lucene.search.function - package org.apache.lucene.search.function
  Programmatic control over documents scores.
org.apache.lucene.search.payloads - package org.apache.lucene.search.payloads
  The payloads package provides Query mechanisms for finding and using payloads.
org.apache.lucene.search.spans - package org.apache.lucene.search.spans
  The calculus of spans.
org.apache.lucene.store - package org.apache.lucene.store
  Binary i/o API, used for all index data.
org.apache.lucene.util - package org.apache.lucene.util
  Some utility classes.
org.apache.lucene.util.cache - package org.apache.lucene.util.cache
OS_NAME - Static variable in class org.apache.lucene.util.Constants
  The value of `System.getProperty("os.name")`.``
out - Static variable in class org.apache.lucene.index.CheckIndex
  Deprecated. Use `CheckIndex.setInfoStream(java.io.PrintStream)` per instance, instead.

## P

ParallelMultiSearcher - Class in org.apache.lucene.search
  Implements parallel search over a set of `Searchables`.
ParallelMultiSearcher(Searchable[]) - Constructor for class org.apache.lucene.search.ParallelMultiSearcher
  Creates a searcher which searches searchables.
ParallelReader - Class in org.apache.lucene.index
  An IndexReader which reads multiple, parallel indexes.
ParallelReader() - Constructor for class org.apache.lucene.index.ParallelReader
  Construct a ParallelReader.
ParallelReader(boolean) - Constructor for class org.apache.lucene.index.ParallelReader
  Construct a ParallelReader.
Parameter - Class in org.apache.lucene.util
  A serializable Enum class.
Parameter(String) - Constructor for class org.apache.lucene.util.Parameter
parse(String[], String[], Analyzer) - Static method in class org.apache.lucene.queryParser.MultiFieldQueryParser
  Parses a query which searches on the fields specified.
parse(String, String[], BooleanClause.Occur[], Analyzer) - Static method in class org.apache.lucene.queryParser.MultiFieldQueryParser
  Parses a query, searching on the fields specified.
parse(String[], String[], BooleanClause.Occur[], Analyzer) - Static method in class org.apache.lucene.queryParser.MultiFieldQueryParser
  Parses a query, searching on the fields specified.
parse(String) - Method in class org.apache.lucene.queryParser.QueryParser
  Parses a query string, returning a `Query`.
parseByte(String) - Method in interface org.apache.lucene.search.FieldCache.ByteParser
  Return a single Byte representation of this field's value.
parseDouble(String) - Method in interface org.apache.lucene.search.ExtendedFieldCache.DoubleParser
  Return an long representation of this field's value.
ParseException - Exception in org.apache.lucene.queryParser
  This exception is thrown when parse errors are encountered.
ParseException(Token, int[][], String[]) - Constructor for exception org.apache.lucene.queryParser.ParseException
  This constructor is used by the method "generateParseException" in the generated parser.
ParseException() - Constructor for exception org.apache.lucene.queryParser.ParseException
  The following constructors are for use by you for whatever purpose you can think of.
ParseException(String) - Constructor for exception org.apache.lucene.queryParser.ParseException
  Constructor with message.
parseFloat(String) - Method in interface org.apache.lucene.search.FieldCache.FloatParser
  Return an float representation of this field's value.
parseInt(String) - Method in interface org.apache.lucene.search.FieldCache.IntParser
  Return an integer representation of this field's value.
parseLong(String) - Method in interface org.apache.lucene.search.ExtendedFieldCache.LongParser
  Return an long representation of this field's value.
parseShort(String) - Method in interface org.apache.lucene.search.FieldCache.ShortParser
  Return a short representation of this field's value.
partial - Variable in class org.apache.lucene.index.CheckIndex.Status
  True if we checked only specific segments (`CheckIndex.checkIndex(List)`) was called with non-null argument).
Payload - Class in org.apache.lucene.index
  A Payload is metadata that can be stored together with each occurrence of a term.
Payload() - Constructor for class org.apache.lucene.index.Payload
  Creates an empty payload and does not allocate a byte array.
Payload(byte[]) - Constructor for class org.apache.lucene.index.Payload
  Creates a new payload with the the given array as data.
Payload(byte[], int, int) - Constructor for class org.apache.lucene.index.Payload
  Creates a new payload with the the given array as data.
payloadScore - Variable in class org.apache.lucene.search.payloads.BoostingTermQuery.BoostingTermWeight.BoostingSpanScorer
PayloadSpans - Interface in org.apache.lucene.search.spans
  WARNING: The status of the Payloads feature is experimental.
PayloadSpanUtil - Class in org.apache.lucene.search.payloads
  Experimental class to get set of payloads for most standard Lucene queries.
PayloadSpanUtil(IndexReader) - Constructor for class org.apache.lucene.search.payloads.PayloadSpanUtil
PerFieldAnalyzerWrapper - Class in org.apache.lucene.analysis
  This analyzer is used to facilitate scenarios where different fields require different analysis techniques.
PerFieldAnalyzerWrapper(Analyzer) - Constructor for class org.apache.lucene.analysis.PerFieldAnalyzerWrapper
  Constructs with default analyzer.
PhraseQuery - Class in org.apache.lucene.search
  A Query that matches documents containing a particular sequence of terms.
PhraseQuery() - Constructor for class org.apache.lucene.search.PhraseQuery
  Constructs an empty phrase query.
PLUS - Static variable in interface org.apache.lucene.queryParser.QueryParserConstants
  RegularExpression Id.
pop(long) - Static method in class org.apache.lucene.util.BitUtil
  Returns the number of bits set in the long
pop() - Method in class org.apache.lucene.util.PriorityQueue
  Removes and returns the least element of the PriorityQueue in log(size) time.
pop() - Method in class org.apache.lucene.util.ScorerDocQueue
  Removes and returns the least scorer of the ScorerDocQueue in log(size) time.
pop_andnot(long[], long[], int, int) - Static method in class org.apache.lucene.util.BitUtil
  Returns the popcount or cardinality of A & ~B Neither array is modified.
pop_array(long[], int, int) - Static method in class org.apache.lucene.util.BitUtil
  Returns the number of set bits in an array of longs.
pop_intersect(long[], long[], int, int) - Static method in class org.apache.lucene.util.BitUtil
  Returns the popcount or cardinality of the two sets after an intersection.
pop_union(long[], long[], int, int) - Static method in class org.apache.lucene.util.BitUtil
  Returns the popcount or cardinality of the union of two sets.
pop_xor(long[], long[], int, int) - Static method in class org.apache.lucene.util.BitUtil
PorterStemFilter - Class in org.apache.lucene.analysis
  Transforms the token stream as per the Porter stemming algorithm.
PorterStemFilter(TokenStream) - Constructor for class org.apache.lucene.analysis.PorterStemFilter
position - Variable in class org.apache.lucene.search.spans.TermSpans
PositionBasedTermVectorMapper - Class in org.apache.lucene.index
  For each Field, store position by position information.
PositionBasedTermVectorMapper() - Constructor for class org.apache.lucene.index.PositionBasedTermVectorMapper
PositionBasedTermVectorMapper(boolean) - Constructor for class org.apache.lucene.index.PositionBasedTermVectorMapper
PositionBasedTermVectorMapper.TVPositionInfo - Class in org.apache.lucene.index
  Container for a term at a position
PositionBasedTermVectorMapper.TVPositionInfo(int, boolean) - Constructor for class org.apache.lucene.index.PositionBasedTermVectorMapper.TVPositionInfo
positions - Variable in class org.apache.lucene.search.spans.TermSpans
prefix - Variable in class org.apache.lucene.search.PrefixFilter
PrefixFilter - Class in org.apache.lucene.search
PrefixFilter(Term) - Constructor for class org.apache.lucene.search.PrefixFilter
PrefixQuery - Class in org.apache.lucene.search
  A Query that matches documents containing terms with a specified prefix.
PrefixQuery(Term) - Constructor for class org.apache.lucene.search.PrefixQuery
  Constructs a query for terms starting with `prefix`.
PREFIXTERM - Static variable in interface org.apache.lucene.queryParser.QueryParserConstants
  RegularExpression Id.
prepareCommit() - Method in class org.apache.lucene.index.IndexWriter
  Expert: prepare for commit.
prepareCommit() - Method in class org.apache.lucene.store.ChecksumIndexOutput
  Starts but does not complete the commit of this file (= writing of the final checksum at the end).
PriorityQueue - Class in org.apache.lucene.util
  A PriorityQueue maintains a partial ordering of its elements such that the least element can always be found in constant time.
PriorityQueue() - Constructor for class org.apache.lucene.util.PriorityQueue
processPayload(Similarity) - Method in class org.apache.lucene.search.payloads.BoostingTermQuery.BoostingTermWeight.BoostingSpanScorer
put(Object, Object) - Method in class org.apache.lucene.util.cache.Cache
  Puts a (key, value)-pair into the cache.
put(Object, Object) - Method in class org.apache.lucene.util.cache.SimpleMapCache
put(Object) - Method in class org.apache.lucene.util.PriorityQueue
  Adds an Object to a PriorityQueue in log(size) time.
put(Scorer) - Method in class org.apache.lucene.util.ScorerDocQueue
  Adds a Scorer to a ScorerDocQueue in log(size) time.

## Q

Query(String) - Method in class org.apache.lucene.queryParser.QueryParser
Query - Class in org.apache.lucene.search
  The abstract base class for queries.
Query() - Constructor for class org.apache.lucene.search.Query
query - Variable in class org.apache.lucene.search.SpanQueryFilter
query - Variable in class org.apache.lucene.search.spans.SpanWeight
QueryFilter - Class in org.apache.lucene.search
  Deprecated. use a CachingWrapperFilter with QueryWrapperFilter
QueryFilter(Query) - Constructor for class org.apache.lucene.search.QueryFilter
  Deprecated. Constructs a filter which only matches documents matching `query`.
queryNorm(float) - Method in class org.apache.lucene.search.DefaultSimilarity
  Implemented as `1/sqrt(sumOfSquaredWeights)`.
queryNorm(float) - Method in class org.apache.lucene.search.Similarity
  Computes the normalization value for a query given the sum of the squared weights of each of the query terms.
queryNorm(float) - Method in class org.apache.lucene.search.SimilarityDelegator
queryNorm - Variable in class org.apache.lucene.search.spans.SpanWeight
QueryParser - Class in org.apache.lucene.queryParser
  This class is generated by JavaCC.
QueryParser(String, Analyzer) - Constructor for class org.apache.lucene.queryParser.QueryParser
  Constructs a query parser.
QueryParser(CharStream) - Constructor for class org.apache.lucene.queryParser.QueryParser
  Constructor with user supplied CharStream.
QueryParser(QueryParserTokenManager) - Constructor for class org.apache.lucene.queryParser.QueryParser
  Constructor with generated Token Manager.
QueryParser.Operator - Class in org.apache.lucene.queryParser
  The default operator for parsing queries.
QueryParserConstants - Interface in org.apache.lucene.queryParser
  Token literal values and constants.
QueryParserTokenManager - Class in org.apache.lucene.queryParser
  Token Manager.
QueryParserTokenManager(CharStream) - Constructor for class org.apache.lucene.queryParser.QueryParserTokenManager
  Constructor.
QueryParserTokenManager(CharStream, int) - Constructor for class org.apache.lucene.queryParser.QueryParserTokenManager
  Constructor.
QueryTermVector - Class in org.apache.lucene.search
QueryTermVector(String[]) - Constructor for class org.apache.lucene.search.QueryTermVector
QueryTermVector(String, Analyzer) - Constructor for class org.apache.lucene.search.QueryTermVector
queryWeight - Variable in class org.apache.lucene.search.spans.SpanWeight
QueryWrapperFilter - Class in org.apache.lucene.search
  Constrains search results to only match those which also match a provided query.
QueryWrapperFilter(Query) - Constructor for class org.apache.lucene.search.QueryWrapperFilter
  Constructs a filter which only matches documents matching `query`.
QUOTED - Static variable in interface org.apache.lucene.queryParser.QueryParserConstants
  RegularExpression Id.

## R

RAMDirectory - Class in org.apache.lucene.store
  A memory-resident `Directory` implementation.
RAMDirectory() - Constructor for class org.apache.lucene.store.RAMDirectory
  Constructs an empty `Directory`.
RAMDirectory(Directory) - Constructor for class org.apache.lucene.store.RAMDirectory
  Creates a new `RAMDirectory` instance from a different `Directory` implementation.
RAMDirectory(File) - Constructor for class org.apache.lucene.store.RAMDirectory
  Creates a new `RAMDirectory` instance from the `FSDirectory`.
RAMDirectory(String) - Constructor for class org.apache.lucene.store.RAMDirectory
  Creates a new `RAMDirectory` instance from the `FSDirectory`.
RAMOutputStream - Class in org.apache.lucene.store
  A memory-resident `IndexOutput` implementation.
RAMOutputStream() - Constructor for class org.apache.lucene.store.RAMOutputStream
  Construct an empty output buffer.
ramSizeInBytes() - Method in class org.apache.lucene.index.IndexWriter
  Expert: Return the total size of all index files currently cached in memory.
RangeEx - Static variable in interface org.apache.lucene.queryParser.QueryParserConstants
  Lexical state.
RANGEEX_END - Static variable in interface org.apache.lucene.queryParser.QueryParserConstants
  RegularExpression Id.
RANGEEX_GOOP - Static variable in interface org.apache.lucene.queryParser.QueryParserConstants
  RegularExpression Id.
RANGEEX_QUOTED - Static variable in interface org.apache.lucene.queryParser.QueryParserConstants
  RegularExpression Id.
RANGEEX_START - Static variable in interface org.apache.lucene.queryParser.QueryParserConstants
  RegularExpression Id.
RANGEEX_TO - Static variable in interface org.apache.lucene.queryParser.QueryParserConstants
  RegularExpression Id.
RangeFilter - Class in org.apache.lucene.search
  A Filter that restricts search results to a range of values in a given field.
RangeFilter(String, String, String, boolean, boolean) - Constructor for class org.apache.lucene.search.RangeFilter
RangeFilter(String, String, String, boolean, boolean, Collator) - Constructor for class org.apache.lucene.search.RangeFilter
  WARNING: Using this constructor and supplying a non-null value in the `collator` parameter will cause every single index Term in the Field referenced by lowerTerm and/or upperTerm to be examined.
RangeIn - Static variable in interface org.apache.lucene.queryParser.QueryParserConstants
  Lexical state.
RANGEIN_END - Static variable in interface org.apache.lucene.queryParser.QueryParserConstants
  RegularExpression Id.
RANGEIN_GOOP - Static variable in interface org.apache.lucene.queryParser.QueryParserConstants
  RegularExpression Id.
RANGEIN_QUOTED - Static variable in interface org.apache.lucene.queryParser.QueryParserConstants
  RegularExpression Id.
RANGEIN_START - Static variable in interface org.apache.lucene.queryParser.QueryParserConstants
  RegularExpression Id.
RANGEIN_TO - Static variable in interface org.apache.lucene.queryParser.QueryParserConstants
  RegularExpression Id.
RangeQuery - Class in org.apache.lucene.search
  A Query that matches documents within an exclusive range.
RangeQuery(Term, Term, boolean) - Constructor for class org.apache.lucene.search.RangeQuery
  Constructs a query selecting all terms greater than `lowerTerm` but less than `upperTerm`.
RangeQuery(Term, Term, boolean, Collator) - Constructor for class org.apache.lucene.search.RangeQuery
  Constructs a query selecting all terms greater than `lowerTerm` but less than `upperTerm`.
read(int[], int[]) - Method in class org.apache.lucene.index.FilterIndexReader.FilterTermDocs
read(int[], int[]) - Method in class org.apache.lucene.index.MultipleTermPositions
  Not implemented.
read(int[], int[]) - Method in interface org.apache.lucene.index.TermDocs
  Attempts to read multiple entries from the enumeration, up to length of docs.
readByte() - Method in class org.apache.lucene.store.BufferedIndexInput
readByte() - Method in class org.apache.lucene.store.ChecksumIndexInput
readByte() - Method in class org.apache.lucene.store.IndexInput
  Reads and returns a single byte.
readBytes(byte[], int, int) - Method in class org.apache.lucene.store.BufferedIndexInput
readBytes(byte[], int, int, boolean) - Method in class org.apache.lucene.store.BufferedIndexInput
readBytes(byte[], int, int) - Method in class org.apache.lucene.store.ChecksumIndexInput
readBytes(byte[], int, int) - Method in class org.apache.lucene.store.IndexInput
  Reads a specified number of bytes into an array at the specified offset.
readBytes(byte[], int, int, boolean) - Method in class org.apache.lucene.store.IndexInput
  Reads a specified number of bytes into an array at the specified offset with control over whether the read should be buffered (callers who have their own buffer should pass in "false" for useBuffer).
readChar() - Method in interface org.apache.lucene.queryParser.CharStream
  Returns the next character from the selected input.
readChar() - Method in class org.apache.lucene.queryParser.FastCharStream
readChars(char[], int, int) - Method in class org.apache.lucene.store.IndexInput
  Deprecated. -- please use readString or readBytes instead, and construct the string from those utf8 bytes
readerValue() - Method in class org.apache.lucene.document.Field
  The value of the field as a Reader, or null.
readerValue() - Method in interface org.apache.lucene.document.Fieldable
  The value of the field as a Reader, or null.
readInt() - Method in class org.apache.lucene.store.IndexInput
  Reads four bytes and returns an int.
readInternal(byte[], int, int) - Method in class org.apache.lucene.store.BufferedIndexInput
  Expert: implements buffer refill.
readInternal(byte[], int, int) - Method in class org.apache.lucene.store.FSDirectory.FSIndexInput
  IndexInput methods
readLong() - Method in class org.apache.lucene.store.IndexInput
  Reads eight bytes and returns a long.
readResolve() - Method in class org.apache.lucene.util.Parameter
  Resolves the deserialized instance to the local reference for accurate equals() and == comparisons.
readString() - Method in class org.apache.lucene.store.IndexInput
  Reads a string.
readVInt() - Method in class org.apache.lucene.store.IndexInput
  Reads an int stored in variable-length format.
readVLong() - Method in class org.apache.lucene.store.IndexInput
  Reads a long stored in variable-length format.
reinit(char[], int, int, int, int, String) - Method in class org.apache.lucene.analysis.Token
  Shorthand for calling `Token.clear()`, `Token.setTermBuffer(char[], int, int)`, `Token.setStartOffset(int)`, `Token.setEndOffset(int)`, `Token.setType(java.lang.String)`
reinit(char[], int, int, int, int) - Method in class org.apache.lucene.analysis.Token
  Shorthand for calling `Token.clear()`, `Token.setTermBuffer(char[], int, int)`, `Token.setStartOffset(int)`, `Token.setEndOffset(int)` `Token.setType(java.lang.String)` on Token.DEFAULT_TYPE
reinit(String, int, int, String) - Method in class org.apache.lucene.analysis.Token
  Shorthand for calling `Token.clear()`, `Token.setTermBuffer(String)`, `Token.setStartOffset(int)`, `Token.setEndOffset(int)` `Token.setType(java.lang.String)`
reinit(String, int, int, int, int, String) - Method in class org.apache.lucene.analysis.Token
  Shorthand for calling `Token.clear()`, `Token.setTermBuffer(String, int, int)`, `Token.setStartOffset(int)`, `Token.setEndOffset(int)` `Token.setType(java.lang.String)`
reinit(String, int, int) - Method in class org.apache.lucene.analysis.Token
  Shorthand for calling `Token.clear()`, `Token.setTermBuffer(String)`, `Token.setStartOffset(int)`, `Token.setEndOffset(int)` `Token.setType(java.lang.String)` on Token.DEFAULT_TYPE
reinit(String, int, int, int, int) - Method in class org.apache.lucene.analysis.Token
  Shorthand for calling `Token.clear()`, `Token.setTermBuffer(String, int, int)`, `Token.setStartOffset(int)`, `Token.setEndOffset(int)` `Token.setType(java.lang.String)` on Token.DEFAULT_TYPE
reinit(Token) - Method in class org.apache.lucene.analysis.Token
  Copy the prototype token's fields into this one.
reinit(Token, String) - Method in class org.apache.lucene.analysis.Token
  Copy the prototype token's fields into this one, with a different term.
reinit(Token, char[], int, int) - Method in class org.apache.lucene.analysis.Token
  Copy the prototype token's fields into this one, with a different term.
ReInit(CharStream) - Method in class org.apache.lucene.queryParser.QueryParser
  Reinitialise.
ReInit(QueryParserTokenManager) - Method in class org.apache.lucene.queryParser.QueryParser
  Reinitialise.
ReInit(CharStream) - Method in class org.apache.lucene.queryParser.QueryParserTokenManager
  Reinitialise parser.
ReInit(CharStream, int) - Method in class org.apache.lucene.queryParser.QueryParserTokenManager
  Reinitialise parser.
release() - Method in class org.apache.lucene.index.SnapshotDeletionPolicy
  Release the currently held snapshot.
release() - Method in class org.apache.lucene.store.Lock
  Releases exclusive access.
RELEVANCE - Static variable in interface org.apache.lucene.search.ScoreDocComparator
  Special comparator for sorting hits according to computed relevance (document score).
RELEVANCE - Static variable in class org.apache.lucene.search.Sort
  Represents sorting by computed relevance.
RemoteCachingWrapperFilter - Class in org.apache.lucene.search
  Provides caching of `Filter`s themselves on the remote end of an RMI connection.
RemoteCachingWrapperFilter(Filter) - Constructor for class org.apache.lucene.search.RemoteCachingWrapperFilter
RemoteSearchable - Class in org.apache.lucene.search
  A remote searchable implementation.
RemoteSearchable(Searchable) - Constructor for class org.apache.lucene.search.RemoteSearchable
  Constructs and exports a remote searcher.
remove() - Method in class org.apache.lucene.analysis.CharArraySet.CharArraySetIterator
remove() - Method in class org.apache.lucene.search.HitIterator
  Deprecated. Unsupported operation.
remove(OpenBitSet) - Method in class org.apache.lucene.util.OpenBitSet
  Remove all elements set in other.
removeAccents(char[], int) - Method in class org.apache.lucene.analysis.ISOLatin1AccentFilter
  To replace accented characters in a String by unaccented equivalents.
removeField(String) - Method in class org.apache.lucene.document.Document
  Removes field with the specified name from the document.
removeFields(String) - Method in class org.apache.lucene.document.Document
  Removes all fields with the given name from the document.
renameFile(String, String) - Method in class org.apache.lucene.store.Directory
  Deprecated.
renameFile(String, String) - Method in class org.apache.lucene.store.FSDirectory
  Deprecated.
renameFile(String, String) - Method in class org.apache.lucene.store.RAMDirectory
  Deprecated.
reopen() - Method in class org.apache.lucene.index.IndexReader
  Refreshes an IndexReader if the index has changed since this instance was (re)opened.
reopen() - Method in class org.apache.lucene.index.MultiReader
  Tries to reopen the subreaders.
reopen() - Method in class org.apache.lucene.index.ParallelReader
  Tries to reopen the subreaders.
ReqExclScorer - Class in org.apache.lucene.search
  A Scorer for queries with a required subscorer and an excluding (prohibited) subscorer.
ReqExclScorer(Scorer, Scorer) - Constructor for class org.apache.lucene.search.ReqExclScorer
  Construct a `ReqExclScorer`.
ReqOptSumScorer - Class in org.apache.lucene.search
  A Scorer for queries with a required part and an optional part.
ReqOptSumScorer(Scorer, Scorer) - Constructor for class org.apache.lucene.search.ReqOptSumScorer
  Construct a `ReqOptScorer`.
reset() - Method in class org.apache.lucene.analysis.CachingTokenFilter
reset(Reader) - Method in class org.apache.lucene.analysis.CharTokenizer
reset(Reader) - Method in class org.apache.lucene.analysis.KeywordTokenizer
reset() - Method in class org.apache.lucene.analysis.SinkTokenizer
  Reset the internal data structures to the start at the front of the list of tokens.
reset() - Method in class org.apache.lucene.analysis.standard.StandardTokenizer
reset(Reader) - Method in class org.apache.lucene.analysis.standard.StandardTokenizer
reset() - Method in class org.apache.lucene.analysis.TokenFilter
  Reset the filter as well as the input TokenStream.
reset(Reader) - Method in class org.apache.lucene.analysis.Tokenizer
  Expert: Reset the tokenizer to a new reader.
reset() - Method in class org.apache.lucene.analysis.TokenStream
  Resets this stream to the beginning.
reset() - Method in class org.apache.lucene.store.RAMOutputStream
  Resets this to an empty buffer.
resizeTermBuffer(int) - Method in class org.apache.lucene.analysis.Token
  Grows the termBuffer to at least size newSize, preserving the existing content.
result - Variable in class org.apache.lucene.util.UnicodeUtil.UTF16Result
result - Variable in class org.apache.lucene.util.UnicodeUtil.UTF8Result
reusableTokenStream(String, Reader) - Method in class org.apache.lucene.analysis.Analyzer
  Creates a TokenStream that is allowed to be re-used from the previous time that the same thread called this method.
reusableTokenStream(String, Reader) - Method in class org.apache.lucene.analysis.KeywordAnalyzer
reusableTokenStream(String, Reader) - Method in class org.apache.lucene.analysis.PerFieldAnalyzerWrapper
reusableTokenStream(String, Reader) - Method in class org.apache.lucene.analysis.SimpleAnalyzer
reusableTokenStream(String, Reader) - Method in class org.apache.lucene.analysis.standard.StandardAnalyzer
reusableTokenStream(String, Reader) - Method in class org.apache.lucene.analysis.StopAnalyzer
reusableTokenStream(String, Reader) - Method in class org.apache.lucene.analysis.WhitespaceAnalyzer
ReverseOrdFieldSource - Class in org.apache.lucene.search.function
  Expert: obtains the ordinal of the field value from the default Lucene `FieldCache` using getStringIndex() and reverses the order.
ReverseOrdFieldSource(String) - Constructor for class org.apache.lucene.search.function.ReverseOrdFieldSource
  Contructor for a certain field.
rewrite(IndexReader) - Method in class org.apache.lucene.search.BooleanQuery
rewrite(IndexReader) - Method in class org.apache.lucene.search.ConstantScoreQuery
rewrite(IndexReader) - Method in class org.apache.lucene.search.ConstantScoreRangeQuery
rewrite(IndexReader) - Method in class org.apache.lucene.search.DisjunctionMaxQuery
  Optimize our representation and our subqueries representations
rewrite(IndexReader) - Method in class org.apache.lucene.search.FilteredQuery
  Rewrites the wrapped query.
rewrite(IndexReader) - Method in class org.apache.lucene.search.function.CustomScoreQuery
rewrite(IndexReader) - Method in class org.apache.lucene.search.function.ValueSourceQuery
rewrite(IndexReader) - Method in class org.apache.lucene.search.FuzzyQuery
rewrite(Query) - Method in class org.apache.lucene.search.IndexSearcher
rewrite(IndexReader) - Method in class org.apache.lucene.search.MultiPhraseQuery
rewrite(Query) - Method in class org.apache.lucene.search.MultiSearcher
rewrite(IndexReader) - Method in class org.apache.lucene.search.MultiTermQuery
rewrite(Query) - Method in class org.apache.lucene.search.ParallelMultiSearcher
rewrite(IndexReader) - Method in class org.apache.lucene.search.PrefixQuery
rewrite(IndexReader) - Method in class org.apache.lucene.search.Query
  Expert: called to re-write queries into primitive queries.
rewrite(IndexReader) - Method in class org.apache.lucene.search.RangeQuery
rewrite(Query) - Method in class org.apache.lucene.search.RemoteSearchable
rewrite(Query) - Method in interface org.apache.lucene.search.Searchable
  Expert: called to re-write queries into primitive queries.
rewrite(Query) - Method in class org.apache.lucene.search.Searcher
rewrite(IndexReader) - Method in class org.apache.lucene.search.spans.SpanFirstQuery
rewrite(IndexReader) - Method in class org.apache.lucene.search.spans.SpanNearQuery
rewrite(IndexReader) - Method in class org.apache.lucene.search.spans.SpanNotQuery
rewrite(IndexReader) - Method in class org.apache.lucene.search.spans.SpanOrQuery
rewrite(IndexReader) - Method in class org.apache.lucene.search.WildcardQuery
rollback() - Method in class org.apache.lucene.index.IndexWriter
  Close the `IndexWriter` without committing any changes that have occurred since the last commit (or since it was opened, if commit hasn't been called).
round(Date, DateTools.Resolution) - Static method in class org.apache.lucene.document.DateTools
  Limit a date's resolution.
round(long, DateTools.Resolution) - Static method in class org.apache.lucene.document.DateTools
  Limit a date's resolution.
RPAREN - Static variable in interface org.apache.lucene.queryParser.QueryParserConstants
  RegularExpression Id.
run() - Method in class org.apache.lucene.index.ConcurrentMergeScheduler.MergeThread
run() - Method in class org.apache.lucene.search.FilterManager.FilterCleaner
run() - Method in class org.apache.lucene.store.Lock.With
  Calls `Lock.With.doBody()` while lock is obtained.

## S

score() - Method in class org.apache.lucene.search.ConstantScoreQuery.ConstantScorer
score - Variable in class org.apache.lucene.search.FuzzyQuery.ScoreTerm
score(int) - Method in class org.apache.lucene.search.Hits
  Deprecated. Returns the score for the nth document in this set.
score() - Method in class org.apache.lucene.search.payloads.BoostingTermQuery.BoostingTermWeight.BoostingSpanScorer
score() - Method in class org.apache.lucene.search.ReqExclScorer
  Returns the score of the current document matching the query.
score() - Method in class org.apache.lucene.search.ReqOptSumScorer
  Returns the score of the current document matching the query.
score - Variable in class org.apache.lucene.search.ScoreDoc
  Expert: The score of this document for the query.
score(HitCollector) - Method in class org.apache.lucene.search.Scorer
  Scores and collects all matching documents.
score(HitCollector, int) - Method in class org.apache.lucene.search.Scorer
  Expert: Collects matching documents in a range.
score() - Method in class org.apache.lucene.search.Scorer
  Returns the score of the current document matching the query.
SCORE - Static variable in class org.apache.lucene.search.SortField
  Sort by document score (relevancy).
score() - Method in class org.apache.lucene.search.spans.SpanScorer
ScoreDoc - Class in org.apache.lucene.search
  Expert: Returned by low-level search implementations.
ScoreDoc(int, float) - Constructor for class org.apache.lucene.search.ScoreDoc
  Expert: Constructs a ScoreDoc.
ScoreDocComparator - Interface in org.apache.lucene.search
  Expert: Compares two ScoreDoc objects for sorting.
scoreDocs - Variable in class org.apache.lucene.search.TopDocs
  Expert: The top hits for the query.
scorePayload(String, byte[], int, int) - Method in class org.apache.lucene.search.Similarity
  Calculate a scoring factor based on the data in the payload.
scorePayload(String, byte[], int, int) - Method in class org.apache.lucene.search.SimilarityDelegator
scorer(IndexReader) - Method in class org.apache.lucene.search.ConstantScoreQuery.ConstantWeight
scorer(IndexReader) - Method in class org.apache.lucene.search.payloads.BoostingTermQuery.BoostingTermWeight
Scorer - Class in org.apache.lucene.search
  Expert: Common scoring functionality for different types of queries.
Scorer(Similarity) - Constructor for class org.apache.lucene.search.Scorer
  Constructs a Scorer.
scorer(IndexReader) - Method in class org.apache.lucene.search.spans.SpanWeight
scorer(IndexReader) - Method in interface org.apache.lucene.search.Weight
  Constructs a scorer for this.
ScorerDocQueue - Class in org.apache.lucene.util
  A ScorerDocQueue maintains a partial ordering of its Scorers such that the least Scorer can always be found in constant time.
ScorerDocQueue(int) - Constructor for class org.apache.lucene.util.ScorerDocQueue
  Create a ScorerDocQueue with a maximum size.
search(Weight, Filter, int) - Method in class org.apache.lucene.search.IndexSearcher
search(Weight, Filter, int, Sort) - Method in class org.apache.lucene.search.IndexSearcher
search(Weight, Filter, HitCollector) - Method in class org.apache.lucene.search.IndexSearcher
search(Weight, Filter, int) - Method in class org.apache.lucene.search.MultiSearcher
search(Weight, Filter, int, Sort) - Method in class org.apache.lucene.search.MultiSearcher
search(Weight, Filter, HitCollector) - Method in class org.apache.lucene.search.MultiSearcher
search(Weight, Filter, int) - Method in class org.apache.lucene.search.ParallelMultiSearcher
  A search implementation which spans a new thread for each Searchable, waits for each search to complete and merge the results back together.
search(Weight, Filter, int, Sort) - Method in class org.apache.lucene.search.ParallelMultiSearcher
  A search implementation allowing sorting which spans a new thread for each Searchable, waits for each search to complete and merges the results back together.
search(Weight, Filter, HitCollector) - Method in class org.apache.lucene.search.ParallelMultiSearcher
  Lower-level search API.
search(Weight, Filter, HitCollector) - Method in class org.apache.lucene.search.RemoteSearchable
search(Weight, Filter, int) - Method in class org.apache.lucene.search.RemoteSearchable
search(Weight, Filter, int, Sort) - Method in class org.apache.lucene.search.RemoteSearchable
search(Weight, Filter, HitCollector) - Method in interface org.apache.lucene.search.Searchable
  Lower-level search API.
search(Weight, Filter, int) - Method in interface org.apache.lucene.search.Searchable
  Expert: Low-level search implementation.
search(Weight, Filter, int, Sort) - Method in interface org.apache.lucene.search.Searchable
  Expert: Low-level search implementation with arbitrary sorting.
search(Query) - Method in class org.apache.lucene.search.Searcher
  Deprecated. Hits will be removed in Lucene 3.0. Use `Searcher.search(Query, Filter, int)` instead.
search(Query, Filter) - Method in class org.apache.lucene.search.Searcher
  Deprecated. Hits will be removed in Lucene 3.0. Use `Searcher.search(Query, Filter, int)` instead.
search(Query, Sort) - Method in class org.apache.lucene.search.Searcher
  Deprecated. Hits will be removed in Lucene 3.0. Use `Searcher.search(Query, Filter, int, Sort)` instead.
search(Query, Filter, Sort) - Method in class org.apache.lucene.search.Searcher
  Deprecated. Hits will be removed in Lucene 3.0. Use `Searcher.search(Query, Filter, int, Sort)` instead.
search(Query, Filter, int, Sort) - Method in class org.apache.lucene.search.Searcher
  Search implementation with arbitrary sorting.
search(Query, HitCollector) - Method in class org.apache.lucene.search.Searcher
  Lower-level search API.
search(Query, Filter, HitCollector) - Method in class org.apache.lucene.search.Searcher
  Lower-level search API.
search(Query, Filter, int) - Method in class org.apache.lucene.search.Searcher
  Finds the top `n` hits for `query`, applying `filter` if non-null.
search(Query, int) - Method in class org.apache.lucene.search.Searcher
  Finds the top `n` hits for `query`.
search(Weight, Filter, HitCollector) - Method in class org.apache.lucene.search.Searcher
search(Weight, Filter, int) - Method in class org.apache.lucene.search.Searcher
search(Weight, Filter, int, Sort) - Method in class org.apache.lucene.search.Searcher
Searchable - Interface in org.apache.lucene.search
  The interface for search implementations.
Searcher - Class in org.apache.lucene.search
  An abstract base class for search implementations.
Searcher() - Constructor for class org.apache.lucene.search.Searcher
SECOND - Static variable in class org.apache.lucene.document.DateTools.Resolution
seek(Term) - Method in class org.apache.lucene.index.FilterIndexReader.FilterTermDocs
seek(TermEnum) - Method in class org.apache.lucene.index.FilterIndexReader.FilterTermDocs
seek(Term) - Method in class org.apache.lucene.index.MultipleTermPositions
  Not implemented.
seek(TermEnum) - Method in class org.apache.lucene.index.MultipleTermPositions
  Not implemented.
seek(Term) - Method in interface org.apache.lucene.index.TermDocs
  Sets this to the data for a term.
seek(TermEnum) - Method in interface org.apache.lucene.index.TermDocs
  Sets this to the data for the current term in a `TermEnum`.
seek(long) - Method in class org.apache.lucene.store.BufferedIndexInput
seek(long) - Method in class org.apache.lucene.store.BufferedIndexOutput
  Sets current position in this file, where the next write will occur.
seek(long) - Method in class org.apache.lucene.store.ChecksumIndexInput
seek(long) - Method in class org.apache.lucene.store.ChecksumIndexOutput
seek(long) - Method in class org.apache.lucene.store.FSDirectory.FSIndexOutput
  Random-access methods
seek(long) - Method in class org.apache.lucene.store.IndexInput
  Sets current position in this file, where the next read will occur.
seek(long) - Method in class org.apache.lucene.store.IndexOutput
  Sets current position in this file, where the next write will occur.
seek(long) - Method in class org.apache.lucene.store.RAMOutputStream
seekInternal(long) - Method in class org.apache.lucene.store.BufferedIndexInput
  Expert: implements seek.
seekInternal(long) - Method in class org.apache.lucene.store.FSDirectory.FSIndexInput
segmentFormat - Variable in class org.apache.lucene.index.CheckIndex.Status
  String description of the version of the index.
segmentInfos - Variable in class org.apache.lucene.index.CheckIndex.Status
  List of `CheckIndex.Status.SegmentInfoStatus` instances, detailing status of each segment.
segmentsChecked - Variable in class org.apache.lucene.index.CheckIndex.Status
  Empty unless you passed specific segments list to check as optional 3rd argument.
segmentsFileName - Variable in class org.apache.lucene.index.CheckIndex.Status
  Name of latest segments_N file in the index.
segString() - Method in class org.apache.lucene.index.IndexWriter
segString(Directory) - Method in class org.apache.lucene.index.MergePolicy.MergeSpecification
SerialMergeScheduler - Class in org.apache.lucene.index
  A `MergeScheduler` that simply does each merge sequentially, using the current thread.
SerialMergeScheduler() - Constructor for class org.apache.lucene.index.SerialMergeScheduler
set(int) - Method in class org.apache.lucene.util.BitVector
  Sets the value of `bit` to one.
set(Object) - Method in class org.apache.lucene.util.CloseableThreadLocal
set(long) - Method in class org.apache.lucene.util.OpenBitSet
  sets a bit, expanding the set size if necessary
set(long, long) - Method in class org.apache.lucene.util.OpenBitSet
  Sets a range of bits, expanding the set size if necessary
setAllowDocsOutOfOrder(boolean) - Static method in class org.apache.lucene.search.BooleanQuery
  Expert: Indicates whether hit docs may be collected out of docid order.
setAllowLeadingWildcard(boolean) - Method in class org.apache.lucene.queryParser.QueryParser
  Set to `true` to allow leading wildcard characters.
SetBasedFieldSelector - Class in org.apache.lucene.document
  Declare what fields to load normally and what fields to load lazily
SetBasedFieldSelector(Set, Set) - Constructor for class org.apache.lucene.document.SetBasedFieldSelector
  Pass in the Set of `Field` names to load and the Set of `Field` names to load lazily.
setBits(long[]) - Method in class org.apache.lucene.util.OpenBitSet
  Expert: sets a new long[] to use as the bit storage
setBoost(float) - Method in class org.apache.lucene.document.AbstractField
  Sets the boost factor hits on this field.
setBoost(float) - Method in class org.apache.lucene.document.Document
  Sets a boost factor for hits on any field of this document.
setBoost(float) - Method in interface org.apache.lucene.document.Fieldable
  Sets the boost factor hits on this field.
setBoost(float) - Method in class org.apache.lucene.search.Query
  Sets the boost for this query clause to `b`.
setBufferSize(int) - Method in class org.apache.lucene.store.BufferedIndexInput
  Change the buffer size used by this IndexInput
setCacheSize(int) - Method in class org.apache.lucene.search.FilterManager
  Sets the max size that cache should reach before it is cleaned up
setCleanThreadSleepTime(long) - Method in class org.apache.lucene.search.FilterManager
  Sets the cache cleaning frequency in milliseconds.
setData(byte[]) - Method in class org.apache.lucene.index.Payload
  Sets this payloads data.
setData(byte[], int, int) - Method in class org.apache.lucene.index.Payload
  Sets this payloads data.
setDateResolution(DateTools.Resolution) - Method in class org.apache.lucene.queryParser.QueryParser
  Sets the default date resolution used by RangeQueries for fields for which no specific date resolutions has been set.
setDateResolution(String, DateTools.Resolution) - Method in class org.apache.lucene.queryParser.QueryParser
  Sets the date resolution used by RangeQueries for a specific field.
setDebugStream(PrintStream) - Method in class org.apache.lucene.queryParser.QueryParserTokenManager
  Set debug output.
setDefault(Similarity) - Static method in class org.apache.lucene.search.Similarity
  Set the default Similarity implementation used by indexing and search code.
setDefaultInfoStream(PrintStream) - Static method in class org.apache.lucene.index.IndexWriter
  If non-null, this will be the default infoStream used by a newly instantiated IndexWriter.
setDefaultOperator(QueryParser.Operator) - Method in class org.apache.lucene.queryParser.QueryParser
  Sets the boolean operator of the QueryParser.
setDefaultReplaceInvalidAcronym(boolean) - Static method in class org.apache.lucene.analysis.standard.StandardAnalyzer
  Deprecated. This will be removed (hardwired to true) in 3.0
setDefaultWriteLockTimeout(long) - Static method in class org.apache.lucene.index.IndexWriter
  Sets the default (for any instance of IndexWriter) maximum time to wait for a write lock (in milliseconds).
setDescription(String) - Method in class org.apache.lucene.search.Explanation
  Sets the description of this explanation node.
setDisableLocks(boolean) - Static method in class org.apache.lucene.store.FSDirectory
  Set whether Lucene's use of lock files is disabled.
setDocumentNumber(int) - Method in class org.apache.lucene.index.TermVectorMapper
  Passes down the index of the document whose term vector is currently being mapped, once for each top level call to a term vector reader.
setEnablePositionIncrements(boolean) - Method in class org.apache.lucene.analysis.StopFilter
  Set to `true` to make this StopFilter enable position increments to result tokens.
setEnablePositionIncrements(boolean) - Method in class org.apache.lucene.queryParser.QueryParser
  Set to `true` to enable position increments in result query.
setEnablePositionIncrementsDefault(boolean) - Static method in class org.apache.lucene.analysis.StopFilter
  Set the default position increments behavior of every StopFilter created from now on.
setEndOffset(int) - Method in class org.apache.lucene.analysis.Token
  Set the ending offset.
setEndOffset(int) - Method in class org.apache.lucene.index.TermVectorOffsetInfo
setEnum(TermEnum) - Method in class org.apache.lucene.search.FilteredTermEnum
setExpectations(String, int, boolean, boolean) - Method in class org.apache.lucene.index.FieldSortedTermVectorMapper
setExpectations(String, int, boolean, boolean) - Method in class org.apache.lucene.index.PositionBasedTermVectorMapper
  Callback mechanism used by the TermVectorReader
setExpectations(String, int, boolean, boolean) - Method in class org.apache.lucene.index.SortedTermVectorMapper
setExpectations(String, int, boolean, boolean) - Method in class org.apache.lucene.index.TermVectorMapper
  Tell the mapper what to expect in regards to field, number of terms, offset and position storage.
setFlags(int) - Method in class org.apache.lucene.analysis.Token
setFreqCurrentDoc() - Method in class org.apache.lucene.search.payloads.BoostingTermQuery.BoostingTermWeight.BoostingSpanScorer
setFreqCurrentDoc() - Method in class org.apache.lucene.search.spans.SpanScorer
setFuzzyMinSim(float) - Method in class org.apache.lucene.queryParser.QueryParser
  Set the minimum similarity for fuzzy queries.
setFuzzyPrefixLength(int) - Method in class org.apache.lucene.queryParser.QueryParser
  Set the prefix length for fuzzy queries.
setGreedy(boolean) - Method in class org.apache.lucene.search.TimeLimitedCollector
  Sets whether this time limited collector is greedy.
setInfoStream(PrintStream) - Method in class org.apache.lucene.index.CheckIndex
  Set infoStream where messages should go.
setInfoStream(PrintStream) - Method in class org.apache.lucene.index.IndexModifier
  Deprecated. If non-null, information about merges and a message when `IndexModifier.getMaxFieldLength()` is reached will be printed to this.
setInfoStream(PrintStream) - Method in class org.apache.lucene.index.IndexWriter
  If non-null, information about merges, deletes and a message when maxFieldLength is reached will be printed to this.
setLength(long) - Method in class org.apache.lucene.store.FSDirectory.FSIndexOutput
setLength(long) - Method in class org.apache.lucene.store.IndexOutput
  Set the file length.
setLength(int) - Method in class org.apache.lucene.util.UnicodeUtil.UTF16Result
setLength(int) - Method in class org.apache.lucene.util.UnicodeUtil.UTF8Result
setLocale(Locale) - Method in class org.apache.lucene.queryParser.QueryParser
  Set locale used by date range parsing.
setLockFactory(LockFactory) - Method in class org.apache.lucene.store.Directory
  Set the LockFactory that this Directory instance should use for its locking implementation.
setLockPrefix(String) - Method in class org.apache.lucene.store.LockFactory
  Set the prefix in use for all locks created in this LockFactory.
setLowercaseExpandedTerms(boolean) - Method in class org.apache.lucene.queryParser.QueryParser
  Whether terms of wildcard, prefix, fuzzy and range queries are to be automatically lower-cased or not.
setMatch(Boolean) - Method in class org.apache.lucene.search.ComplexExplanation
  Sets the match status assigned to this explanation node.
setMaxBufferedDeleteTerms(int) - Method in class org.apache.lucene.index.IndexWriter
  Determines the minimal number of delete terms required before the buffered in-memory delete terms are applied and flushed.
setMaxBufferedDocs(int) - Method in class org.apache.lucene.index.IndexModifier
  Deprecated. Determines the minimal number of documents required before the buffered in-memory documents are merging and a new Segment is created.
setMaxBufferedDocs(int) - Method in class org.apache.lucene.index.IndexWriter
  Determines the minimal number of documents required before the buffered in-memory documents are flushed as a new Segment.
setMaxClauseCount(int) - Static method in class org.apache.lucene.search.BooleanQuery
  Set the maximum number of clauses permitted per BooleanQuery.
setMaxFieldLength(int) - Method in class org.apache.lucene.index.IndexModifier
  Deprecated. The maximum number of terms that will be indexed for a single field in a document.
setMaxFieldLength(int) - Method in class org.apache.lucene.index.IndexWriter
  The maximum number of terms that will be indexed for a single field in a document.
setMaxMergeDocs(int) - Method in class org.apache.lucene.index.IndexWriter
  Determines the largest segment (measured by document count) that may be merged with other segments.
setMaxMergeDocs(int) - Method in class org.apache.lucene.index.LogMergePolicy
  Determines the largest segment (measured by document count) that may be merged with other segments.
setMaxMergeMB(double) - Method in class org.apache.lucene.index.LogByteSizeMergePolicy
  Determines the largest segment (measured by total byte size of the segment's files, in MB) that may be merged with other segments.
setMaxScore(float) - Method in class org.apache.lucene.search.TopDocs
  Expert: Sets the maximum score value encountered.
setMaxSyncPauseSeconds(double) - Method in class org.apache.lucene.index.IndexWriter
  Deprecated. This will be removed in 3.0, when autoCommit=true is removed from IndexWriter.
setMaxThreadCount(int) - Method in class org.apache.lucene.index.ConcurrentMergeScheduler
  Sets the max # simultaneous threads that may be running.
setMaxTokenLength(int) - Method in class org.apache.lucene.analysis.standard.StandardAnalyzer
  Set maximum allowed token length.
setMaxTokenLength(int) - Method in class org.apache.lucene.analysis.standard.StandardTokenizer
  Set the max allowed token length.
setMergeFactor(int) - Method in class org.apache.lucene.index.IndexModifier
  Deprecated. Determines how often segment indices are merged by addDocument().
setMergeFactor(int) - Method in class org.apache.lucene.index.IndexWriter
  Determines how often segment indices are merged by addDocument().
setMergeFactor(int) - Method in class org.apache.lucene.index.LogMergePolicy
  Determines how often segment indices are merged by addDocument().
setMergePolicy(MergePolicy) - Method in class org.apache.lucene.index.IndexWriter
  Expert: set the merge policy used by this writer.
setMergeScheduler(MergeScheduler) - Method in class org.apache.lucene.index.IndexWriter
  Expert: set the merge scheduler used by this writer.
setMergeThreadPriority(int) - Method in class org.apache.lucene.index.ConcurrentMergeScheduler
  Return the priority that merge threads run at.
setMinimumNumberShouldMatch(int) - Method in class org.apache.lucene.search.BooleanQuery
  Specifies a minimum number of the optional BooleanClauses which must be satisfied.
setMinMergeDocs(int) - Method in class org.apache.lucene.index.LogDocMergePolicy
  Sets the minimum size for the lowest level segments.
setMinMergeMB(double) - Method in class org.apache.lucene.index.LogByteSizeMergePolicy
  Sets the minimum size for the lowest level segments.
setModifiedUTF8StringsMode() - Method in class org.apache.lucene.store.IndexInput
  Call this if readString should read characters stored in the old modified UTF8 format (length in java chars and java's modified UTF8 encoding).
setNorm(int, String, byte) - Method in class org.apache.lucene.index.IndexReader
  Expert: Resets the normalization factor for the named field of the named document.
setNorm(int, String, float) - Method in class org.apache.lucene.index.IndexReader
  Expert: Resets the normalization factor for the named field of the named document.
setNumWords(int) - Method in class org.apache.lucene.util.OpenBitSet
  Expert: sets the number of longs in the array that are in use
setOccur(BooleanClause.Occur) - Method in class org.apache.lucene.search.BooleanClause
setOmitNorms(boolean) - Method in class org.apache.lucene.document.AbstractField
  Expert: If set, omit normalization factors associated with this indexed field.
setOmitNorms(boolean) - Method in interface org.apache.lucene.document.Fieldable
  Expert: If set, omit normalization factors associated with this indexed field.
setOmitTf(boolean) - Method in class org.apache.lucene.document.AbstractField
  Expert: If set, omit tf from postings of this indexed field.
setOmitTf(boolean) - Method in interface org.apache.lucene.document.Fieldable
  Expert: If set, omit term freq, positions and payloads from postings for this field.
setPayload(Payload) - Method in class org.apache.lucene.analysis.Token
  Sets this Token's payload.
setPhraseSlop(int) - Method in class org.apache.lucene.queryParser.QueryParser
  Sets the default slop for phrases.
setPositionIncrement(int) - Method in class org.apache.lucene.analysis.Token
  Set the position increment.
setPreviousTokenStream(Object) - Method in class org.apache.lucene.analysis.Analyzer
  Used by Analyzers that implement reusableTokenStream to save a TokenStream for later re-use by the same thread.
setQuery(Query) - Method in class org.apache.lucene.search.BooleanClause
setRAMBufferSizeMB(double) - Method in class org.apache.lucene.index.IndexWriter
  Determines the amount of RAM that may be used for buffering added documents before they are flushed as a new Segment.
setRangeCollator(Collator) - Method in class org.apache.lucene.queryParser.QueryParser
  Sets the collator used to determine index term inclusion in ranges specified either for ConstantScoreRangeQuerys or RangeQuerys (if `QueryParser.setUseOldRangeQuery(boolean)` is called with a `true` value.)

  WARNING: Setting the rangeCollator to a non-null collator using this method will cause every single index Term in the Field referenced by lowerTerm and/or upperTerm to be examined.
setReplaceInvalidAcronym(boolean) - Method in class org.apache.lucene.analysis.standard.StandardAnalyzer
  Deprecated. This will be removed (hardwired to true) in 3.0
setReplaceInvalidAcronym(boolean) - Method in class org.apache.lucene.analysis.standard.StandardTokenizer
  Deprecated. Remove in 3.X and make true the only valid value See https://issues.apache.org/jira/browse/LUCENE-1068
setResolution(long) - Static method in class org.apache.lucene.search.TimeLimitedCollector
  Set the timer resolution.
setRunningMerge(MergePolicy.OneMerge) - Method in class org.apache.lucene.index.ConcurrentMergeScheduler.MergeThread
setSimilarity(Similarity) - Method in class org.apache.lucene.index.IndexWriter
  Expert: Set the Similarity implementation used by this IndexWriter.
setSimilarity(Similarity) - Method in class org.apache.lucene.search.Searcher
  Expert: Set the Similarity implementation used by this Searcher.
setSlop(int) - Method in class org.apache.lucene.search.MultiPhraseQuery
  Sets the phrase slop for this query.
setSlop(int) - Method in class org.apache.lucene.search.PhraseQuery
  Sets the number of other words permitted between words in query phrase.
setSort(String) - Method in class org.apache.lucene.search.Sort
  Sets the sort to the terms in `field` then by index order (document number).
setSort(String, boolean) - Method in class org.apache.lucene.search.Sort
  Sets the sort to the terms in `field` possibly in reverse, then by index order (document number).
setSort(String[]) - Method in class org.apache.lucene.search.Sort
  Sets the sort to the terms in each field in succession.
setSort(SortField) - Method in class org.apache.lucene.search.Sort
  Sets the sort to the given criteria.
setSort(SortField[]) - Method in class org.apache.lucene.search.Sort
  Sets the sort to the given criteria in succession.
setStartOffset(int) - Method in class org.apache.lucene.analysis.Token
  Set the starting offset.
setStartOffset(int) - Method in class org.apache.lucene.index.TermVectorOffsetInfo
setStoreTermVector(Field.TermVector) - Method in class org.apache.lucene.document.AbstractField
setStrict(boolean) - Method in class org.apache.lucene.search.function.CustomScoreQuery
  Set the strict mode of this query.
setTermBuffer(char[], int, int) - Method in class org.apache.lucene.analysis.Token
  Copies the contents of buffer, starting at offset for length characters, into the termBuffer array.
setTermBuffer(String) - Method in class org.apache.lucene.analysis.Token
  Copies the contents of buffer into the termBuffer array.
setTermBuffer(String, int, int) - Method in class org.apache.lucene.analysis.Token
  Copies the contents of buffer, starting at offset and continuing for length characters, into the termBuffer array.
setTermIndexInterval(int) - Method in class org.apache.lucene.index.IndexWriter
  Expert: Set the interval between indexed terms.
setTermInfosIndexDivisor(int) - Method in class org.apache.lucene.index.IndexReader
  For IndexReader implementations that use TermInfosReader to read terms, this sets the indexDivisor to subsample the number of indexed terms loaded into memory.
setTermLength(int) - Method in class org.apache.lucene.analysis.Token
  Set number of valid characters (length of the term) in the termBuffer array.
setTermText(String) - Method in class org.apache.lucene.analysis.Token
  Deprecated. use `Token.setTermBuffer(char[], int, int)` or `Token.setTermBuffer(String)` or `Token.setTermBuffer(String, int, int)`.
setTestMode() - Static method in class org.apache.lucene.index.ConcurrentMergeScheduler
setThreadPriority(int) - Method in class org.apache.lucene.index.ConcurrentMergeScheduler.MergeThread
setType(String) - Method in class org.apache.lucene.analysis.Token
  Set the lexical type.
setUseCompoundDocStore(boolean) - Method in class org.apache.lucene.index.LogMergePolicy
  Sets whether compound file format should be used for newly flushed and newly merged doc store segment files (term vectors and stored fields).
setUseCompoundFile(boolean) - Method in class org.apache.lucene.index.IndexModifier
  Deprecated. Setting to turn on usage of a compound file.
setUseCompoundFile(boolean) - Method in class org.apache.lucene.index.IndexWriter
  Setting to turn on usage of a compound file.
setUseCompoundFile(boolean) - Method in class org.apache.lucene.index.LogMergePolicy
  Sets whether compound file format should be used for newly flushed and newly merged segments.
setUseOldRangeQuery(boolean) - Method in class org.apache.lucene.queryParser.QueryParser
  By default QueryParser uses new ConstantScoreRangeQuery in preference to RangeQuery for range queries.
setUseScorer14(boolean) - Static method in class org.apache.lucene.search.BooleanQuery
  Deprecated. Use `BooleanQuery.setAllowDocsOutOfOrder(boolean)` instead.
setValue(String) - Method in class org.apache.lucene.document.Field
  Expert: change the value of this field.
setValue(Reader) - Method in class org.apache.lucene.document.Field
  Expert: change the value of this field.
setValue(byte[]) - Method in class org.apache.lucene.document.Field
  Expert: change the value of this field.
setValue(byte[], int, int) - Method in class org.apache.lucene.document.Field
  Expert: change the value of this field.
setValue(TokenStream) - Method in class org.apache.lucene.document.Field
  Expert: change the value of this field.
setValue(float) - Method in class org.apache.lucene.search.Explanation
  Sets the value assigned to this explanation node.
setWriteLockTimeout(long) - Method in class org.apache.lucene.index.IndexWriter
  Sets the maximum time to wait for a write lock (in milliseconds) for this instance of IndexWriter.
SHORT - Static variable in class org.apache.lucene.search.function.FieldScoreQuery.Type
  field values are interpreted as numeric short values.
SHORT - Static variable in class org.apache.lucene.search.SortField
  Sort using term values as encoded Shorts.
ShortFieldSource - Class in org.apache.lucene.search.function
  Expert: obtains short field values from the `FieldCache` using `getShorts()` and makes those values available as other numeric types, casting as needed.
ShortFieldSource(String) - Constructor for class org.apache.lucene.search.function.ShortFieldSource
  Create a cached short field source with default string-to-short parser.
ShortFieldSource(String, FieldCache.ShortParser) - Constructor for class org.apache.lucene.search.function.ShortFieldSource
  Create a cached short field source with a specific string-to-short parser.
SHOULD - Static variable in class org.apache.lucene.search.BooleanClause.Occur
  Use this operator for clauses that should appear in the matching documents.
shrink(int[], int) - Static method in class org.apache.lucene.util.ArrayUtil
shrink(long[], int) - Static method in class org.apache.lucene.util.ArrayUtil
shrink(byte[], int) - Static method in class org.apache.lucene.util.ArrayUtil
Similarity - Class in org.apache.lucene.search
  Expert: Scoring API.
Similarity() - Constructor for class org.apache.lucene.search.Similarity
similarity - Variable in class org.apache.lucene.search.spans.SpanWeight
SimilarityDelegator - Class in org.apache.lucene.search
  Expert: Delegating scoring implementation.
SimilarityDelegator(Similarity) - Constructor for class org.apache.lucene.search.SimilarityDelegator
  Construct a `Similarity` that delegates all methods to another.
SimpleAnalyzer - Class in org.apache.lucene.analysis
  An Analyzer that filters LetterTokenizer with LowerCaseFilter.
SimpleAnalyzer() - Constructor for class org.apache.lucene.analysis.SimpleAnalyzer
SimpleFSLockFactory - Class in org.apache.lucene.store
  Implements `LockFactory` using `File.createNewFile()`.
SimpleFSLockFactory(File) - Constructor for class org.apache.lucene.store.SimpleFSLockFactory
  Instantiate using the provided directory (as a File instance).
SimpleFSLockFactory(String) - Constructor for class org.apache.lucene.store.SimpleFSLockFactory
  Instantiate using the provided directory name (String).
SimpleLRUCache - Class in org.apache.lucene.util.cache
  Simple LRU cache implementation that uses a LinkedHashMap.
SimpleLRUCache(int) - Constructor for class org.apache.lucene.util.cache.SimpleLRUCache
  Creates a last-recently-used cache with the specified size.
SimpleMapCache - Class in org.apache.lucene.util.cache
  Simple cache implementation that uses a HashMap to store (key, value) pairs.
SimpleMapCache() - Constructor for class org.apache.lucene.util.cache.SimpleMapCache
SimpleMapCache(Map) - Constructor for class org.apache.lucene.util.cache.SimpleMapCache
SingleInstanceLockFactory - Class in org.apache.lucene.store
  Implements `LockFactory` for a single in-process instance, meaning all locking will take place through this one instance.
SingleInstanceLockFactory() - Constructor for class org.apache.lucene.store.SingleInstanceLockFactory
SinkTokenizer - Class in org.apache.lucene.analysis
  A SinkTokenizer can be used to cache Tokens for use in an Analyzer
SinkTokenizer(List) - Constructor for class org.apache.lucene.analysis.SinkTokenizer
SinkTokenizer() - Constructor for class org.apache.lucene.analysis.SinkTokenizer
SinkTokenizer(int) - Constructor for class org.apache.lucene.analysis.SinkTokenizer
size() - Method in class org.apache.lucene.analysis.CharArraySet
SIZE - Static variable in class org.apache.lucene.document.FieldSelectorResult
  Expert: Load the size of this `Field` rather than its value.
size(SegmentInfo) - Method in class org.apache.lucene.index.LogByteSizeMergePolicy
size(SegmentInfo) - Method in class org.apache.lucene.index.LogDocMergePolicy
size(SegmentInfo) - Method in class org.apache.lucene.index.LogMergePolicy
size() - Method in interface org.apache.lucene.index.TermFreqVector
size() - Method in class org.apache.lucene.search.QueryTermVector
size() - Method in class org.apache.lucene.util.BitVector
  Returns the number of bits in this vector.
size() - Method in class org.apache.lucene.util.OpenBitSet
  Returns the current capacity of this set.
size() - Method in class org.apache.lucene.util.PriorityQueue
  Returns the number of elements currently stored in the PriorityQueue.
size() - Method in class org.apache.lucene.util.ScorerDocQueue
  Returns the number of scorers currently stored in the ScorerDocQueue.
size() - Method in class org.apache.lucene.util.SortedVIntList
SIZE_AND_BREAK - Static variable in class org.apache.lucene.document.FieldSelectorResult
  Expert: Like `FieldSelectorResult.SIZE` but immediately break from the field loading loop, i.e., stop loading further fields, after the size is loaded
sizeInBytes() - Method in class org.apache.lucene.store.RAMDirectory
  Return total size in bytes of all files in this directory.
sizeInBytes() - Method in class org.apache.lucene.store.RAMOutputStream
  Returns byte usage of all buffers.
sizeMB - Variable in class org.apache.lucene.index.CheckIndex.Status.SegmentInfoStatus
  Net size (MB) of the files referenced by this segment.
skipChars(int) - Method in class org.apache.lucene.store.IndexInput
  Deprecated. this method operates on old "modified utf8" encoded strings
skipTo(int) - Method in class org.apache.lucene.index.FilterIndexReader.FilterTermDocs
skipTo(int) - Method in class org.apache.lucene.index.MultipleTermPositions
skipTo(int) - Method in interface org.apache.lucene.index.TermDocs
  Skips entries to the first beyond the current whose document number is greater than or equal to target.
skipTo(Term) - Method in class org.apache.lucene.index.TermEnum
  Skips terms to the first beyond the current whose value is greater or equal to target.
skipTo(int) - Method in class org.apache.lucene.search.ConstantScoreQuery.ConstantScorer
skipTo(int) - Method in class org.apache.lucene.search.DocIdSetIterator
  Skips entries to the first beyond the current whose document number is greater than or equal to target.
skipTo(int) - Method in class org.apache.lucene.search.ReqExclScorer
  Skips to the first match beyond the current whose document number is greater than or equal to a given target.
skipTo(int) - Method in class org.apache.lucene.search.ReqOptSumScorer
skipTo(int) - Method in interface org.apache.lucene.search.spans.Spans
  Skips to the first match beyond the current, whose document number is greater than or equal to target.
skipTo(int) - Method in class org.apache.lucene.search.spans.SpanScorer
skipTo(int) - Method in class org.apache.lucene.search.spans.TermSpans
skipTo(int) - Method in class org.apache.lucene.util.OpenBitSetIterator
sloppyFreq(int) - Method in class org.apache.lucene.search.DefaultSimilarity
  Implemented as `1 / (distance + 1)`.
sloppyFreq(int) - Method in class org.apache.lucene.search.Similarity
  Computes the amount of a sloppy phrase match, based on an edit distance.
sloppyFreq(int) - Method in class org.apache.lucene.search.SimilarityDelegator
SmallFloat - Class in org.apache.lucene.util
  Floating point numbers smaller than 32 bits.
SmallFloat() - Constructor for class org.apache.lucene.util.SmallFloat
snapshot() - Method in class org.apache.lucene.index.SnapshotDeletionPolicy
  Take a snapshot of the most recent commit to the index.
SnapshotDeletionPolicy - Class in org.apache.lucene.index
  A `IndexDeletionPolicy` that wraps around any other `IndexDeletionPolicy` and adds the ability to hold and later release a single "snapshot" of an index.
SnapshotDeletionPolicy(IndexDeletionPolicy) - Constructor for class org.apache.lucene.index.SnapshotDeletionPolicy
Sort - Class in org.apache.lucene.search
  Encapsulates sort criteria for returned hits.
Sort() - Constructor for class org.apache.lucene.search.Sort
  Sorts by computed relevance.
Sort(String) - Constructor for class org.apache.lucene.search.Sort
  Sorts by the terms in `field` then by index order (document number).
Sort(String, boolean) - Constructor for class org.apache.lucene.search.Sort
  Sorts possibly in reverse by the terms in `field` then by index order (document number).
Sort(String[]) - Constructor for class org.apache.lucene.search.Sort
  Sorts in succession by the terms in each field.
Sort(SortField) - Constructor for class org.apache.lucene.search.Sort
  Sorts by the criteria in the given SortField.
Sort(SortField[]) - Constructor for class org.apache.lucene.search.Sort
  Sorts in succession by the criteria in each SortField.
SortComparator - Class in org.apache.lucene.search
  Abstract base class for sorting hits returned by a Query.
SortComparator() - Constructor for class org.apache.lucene.search.SortComparator
SortComparatorSource - Interface in org.apache.lucene.search
  Expert: returns a comparator for sorting ScoreDocs.
SortedTermVectorMapper - Class in org.apache.lucene.index
  Store a sorted collection of `TermVectorEntry`s.
SortedTermVectorMapper(Comparator) - Constructor for class org.apache.lucene.index.SortedTermVectorMapper
SortedTermVectorMapper(boolean, boolean, Comparator) - Constructor for class org.apache.lucene.index.SortedTermVectorMapper
SortedVIntList - Class in org.apache.lucene.util
  Store and iterate sorted integers in compressed form in RAM.
SortedVIntList(int[]) - Constructor for class org.apache.lucene.util.SortedVIntList
  Create a SortedVIntList from all elements of an array of integers.
SortedVIntList(int[], int) - Constructor for class org.apache.lucene.util.SortedVIntList
  Create a SortedVIntList from an array of integers.
SortedVIntList(BitSet) - Constructor for class org.apache.lucene.util.SortedVIntList
  Create a SortedVIntList from a BitSet.
SortedVIntList(OpenBitSet) - Constructor for class org.apache.lucene.util.SortedVIntList
  Create a SortedVIntList from an OpenBitSet.
SortedVIntList(DocIdSetIterator) - Constructor for class org.apache.lucene.util.SortedVIntList
  Create a SortedVIntList.
SortField - Class in org.apache.lucene.search
  Stores information about how to sort documents by terms in an individual field.
SortField(String) - Constructor for class org.apache.lucene.search.SortField
  Creates a sort by terms in the given field where the type of term value is determined dynamically (`AUTO`).
SortField(String, boolean) - Constructor for class org.apache.lucene.search.SortField
  Creates a sort, possibly in reverse, by terms in the given field where the type of term value is determined dynamically (`AUTO`).
SortField(String, int) - Constructor for class org.apache.lucene.search.SortField
  Creates a sort by terms in the given field with the type of term values explicitly given.
SortField(String, int, boolean) - Constructor for class org.apache.lucene.search.SortField
  Creates a sort, possibly in reverse, by terms in the given field with the type of term values explicitly given.
SortField(String, Locale) - Constructor for class org.apache.lucene.search.SortField
  Creates a sort by terms in the given field sorted according to the given locale.
SortField(String, Locale, boolean) - Constructor for class org.apache.lucene.search.SortField
  Creates a sort, possibly in reverse, by terms in the given field sorted according to the given locale.
SortField(String, SortComparatorSource) - Constructor for class org.apache.lucene.search.SortField
  Creates a sort with a custom comparison function.
SortField(String, SortComparatorSource, boolean) - Constructor for class org.apache.lucene.search.SortField
  Creates a sort, possibly in reverse, with a custom comparison function.
sortType() - Method in interface org.apache.lucene.search.ScoreDocComparator
  Returns the type of sort.
sortValue(ScoreDoc) - Method in interface org.apache.lucene.search.ScoreDocComparator
  Returns the value used to sort the given document.
SpanFilter - Class in org.apache.lucene.search
  Abstract base class providing a mechanism to restrict searches to a subset of an index and also maintains and returns position information.
SpanFilter() - Constructor for class org.apache.lucene.search.SpanFilter
SpanFilterResult - Class in org.apache.lucene.search
  The results of a SpanQueryFilter.
SpanFilterResult(BitSet, List) - Constructor for class org.apache.lucene.search.SpanFilterResult
  Deprecated. Use `SpanFilterResult.SpanFilterResult(DocIdSet, List)` instead
SpanFilterResult(DocIdSet, List) - Constructor for class org.apache.lucene.search.SpanFilterResult
SpanFilterResult.PositionInfo - Class in org.apache.lucene.search
SpanFilterResult.PositionInfo(int) - Constructor for class org.apache.lucene.search.SpanFilterResult.PositionInfo
SpanFilterResult.StartEnd - Class in org.apache.lucene.search
SpanFilterResult.StartEnd(int, int) - Constructor for class org.apache.lucene.search.SpanFilterResult.StartEnd
SpanFirstQuery - Class in org.apache.lucene.search.spans
  Matches spans near the beginning of a field.
SpanFirstQuery(SpanQuery, int) - Constructor for class org.apache.lucene.search.spans.SpanFirstQuery
  Construct a SpanFirstQuery matching spans in `match` whose end position is less than or equal to `end`.
SpanNearQuery - Class in org.apache.lucene.search.spans
  Matches spans which are near one another.
SpanNearQuery(SpanQuery[], int, boolean) - Constructor for class org.apache.lucene.search.spans.SpanNearQuery
  Construct a SpanNearQuery.
SpanNotQuery - Class in org.apache.lucene.search.spans
  Removes matches which overlap with another SpanQuery.
SpanNotQuery(SpanQuery, SpanQuery) - Constructor for class org.apache.lucene.search.spans.SpanNotQuery
  Construct a SpanNotQuery matching spans from `include` which have no overlap with spans from `exclude`.
SpanOrQuery - Class in org.apache.lucene.search.spans
  Matches the union of its clauses.
SpanOrQuery(SpanQuery[]) - Constructor for class org.apache.lucene.search.spans.SpanOrQuery
  Construct a SpanOrQuery merging the provided clauses.
SpanQuery - Class in org.apache.lucene.search.spans
  Base class for span-based queries.
SpanQuery() - Constructor for class org.apache.lucene.search.spans.SpanQuery
SpanQueryFilter - Class in org.apache.lucene.search
  Constrains search results to only match those which also match a provided query.
SpanQueryFilter() - Constructor for class org.apache.lucene.search.SpanQueryFilter
SpanQueryFilter(SpanQuery) - Constructor for class org.apache.lucene.search.SpanQueryFilter
  Constructs a filter which only matches documents matching `query`.
Spans - Interface in org.apache.lucene.search.spans
  Expert: an enumeration of span matches.
spans - Variable in class org.apache.lucene.search.spans.SpanScorer
SpanScorer - Class in org.apache.lucene.search.spans
  Public for extension only.
SpanScorer(Spans, Weight, Similarity, byte[]) - Constructor for class org.apache.lucene.search.spans.SpanScorer
SpanTermQuery - Class in org.apache.lucene.search.spans
  Matches spans containing a term.
SpanTermQuery(Term) - Constructor for class org.apache.lucene.search.spans.SpanTermQuery
  Construct a SpanTermQuery matching the named term's spans.
SpanWeight - Class in org.apache.lucene.search.spans
  Expert-only.
SpanWeight(SpanQuery, Searcher) - Constructor for class org.apache.lucene.search.spans.SpanWeight
specialConstructor - Variable in exception org.apache.lucene.queryParser.ParseException
  This variable determines which constructor was used to create this object and thereby affects the semantics of the "getMessage" method (see below).
specialToken - Variable in class org.apache.lucene.queryParser.Token
  This field is used to access special tokens that occur prior to this token, but after the immediately preceding regular (non-special) token.
StaleReaderException - Exception in org.apache.lucene.index
  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.
StaleReaderException(String) - Constructor for exception org.apache.lucene.index.StaleReaderException
StandardAnalyzer - Class in org.apache.lucene.analysis.standard
  Filters `StandardTokenizer` with `StandardFilter`, `LowerCaseFilter` and `StopFilter`, using a list of English stop words.
StandardAnalyzer() - Constructor for class org.apache.lucene.analysis.standard.StandardAnalyzer
  Builds an analyzer with the default stop words (`StandardAnalyzer.STOP_WORDS`).
StandardAnalyzer(Set) - Constructor for class org.apache.lucene.analysis.standard.StandardAnalyzer
  Builds an analyzer with the given stop words.
StandardAnalyzer(String[]) - Constructor for class org.apache.lucene.analysis.standard.StandardAnalyzer
  Builds an analyzer with the given stop words.
StandardAnalyzer(File) - Constructor for class org.apache.lucene.analysis.standard.StandardAnalyzer
  Builds an analyzer with the stop words from the given file.
StandardAnalyzer(Reader) - Constructor for class org.apache.lucene.analysis.standard.StandardAnalyzer
  Builds an analyzer with the stop words from the given reader.
StandardAnalyzer(boolean) - Constructor for class org.apache.lucene.analysis.standard.StandardAnalyzer
  Deprecated. Remove in 3.X and make true the only valid value
StandardAnalyzer(Reader, boolean) - Constructor for class org.apache.lucene.analysis.standard.StandardAnalyzer
  Deprecated. Remove in 3.X and make true the only valid value
StandardAnalyzer(File, boolean) - Constructor for class org.apache.lucene.analysis.standard.StandardAnalyzer
  Deprecated. Remove in 3.X and make true the only valid value
StandardAnalyzer(String[], boolean) - Constructor for class org.apache.lucene.analysis.standard.StandardAnalyzer
  Deprecated. Remove in 3.X and make true the only valid value
StandardAnalyzer(Set, boolean) - Constructor for class org.apache.lucene.analysis.standard.StandardAnalyzer
  Deprecated. Remove in 3.X and make true the only valid value
StandardFilter - Class in org.apache.lucene.analysis.standard
  Normalizes tokens extracted with `StandardTokenizer`.
StandardFilter(TokenStream) - Constructor for class org.apache.lucene.analysis.standard.StandardFilter
  Construct filtering in.
StandardTokenizer - Class in org.apache.lucene.analysis.standard
  A grammar-based tokenizer constructed with JFlex
StandardTokenizer(Reader) - Constructor for class org.apache.lucene.analysis.standard.StandardTokenizer
  Creates a new instance of the `StandardTokenizer`.
StandardTokenizer(Reader, boolean) - Constructor for class org.apache.lucene.analysis.standard.StandardTokenizer
  Creates a new instance of the `StandardTokenizer`.
STAR - Static variable in interface org.apache.lucene.queryParser.QueryParserConstants
  RegularExpression Id.
start() - Method in interface org.apache.lucene.search.spans.Spans
  Returns the start position of the current match.
start() - Method in class org.apache.lucene.search.spans.TermSpans
startOffset() - Method in class org.apache.lucene.analysis.Token
  Returns this Token's starting offset, the position of the first character corresponding to this token in the source text.
STOP_WORDS - Static variable in class org.apache.lucene.analysis.standard.StandardAnalyzer
  An array containing some common English words that are usually not useful for searching.
StopAnalyzer - Class in org.apache.lucene.analysis
  Filters LetterTokenizer with LowerCaseFilter and StopFilter.
StopAnalyzer() - Constructor for class org.apache.lucene.analysis.StopAnalyzer
  Builds an analyzer which removes words in ENGLISH_STOP_WORDS.
StopAnalyzer(Set) - Constructor for class org.apache.lucene.analysis.StopAnalyzer
  Builds an analyzer with the stop words from the given set.
StopAnalyzer(String[]) - Constructor for class org.apache.lucene.analysis.StopAnalyzer
  Builds an analyzer which removes words in the provided array.
StopAnalyzer(File) - Constructor for class org.apache.lucene.analysis.StopAnalyzer
  Builds an analyzer with the stop words from the given file.
StopAnalyzer(Reader) - Constructor for class org.apache.lucene.analysis.StopAnalyzer
  Builds an analyzer with the stop words from the given reader.
StopFilter - Class in org.apache.lucene.analysis
  Removes stop words from a token stream.
StopFilter(TokenStream, String[]) - Constructor for class org.apache.lucene.analysis.StopFilter
  Construct a token stream filtering the given input.
StopFilter(TokenStream, String[], boolean) - Constructor for class org.apache.lucene.analysis.StopFilter
  Constructs a filter which removes words from the input TokenStream that are named in the array of words.
StopFilter(TokenStream, Set, boolean) - Constructor for class org.apache.lucene.analysis.StopFilter
  Construct a token stream filtering the given input.
StopFilter(TokenStream, Set) - Constructor for class org.apache.lucene.analysis.StopFilter
  Constructs a filter which removes words from the input TokenStream that are named in the Set.
storeOffsetWithTermVector - Variable in class org.apache.lucene.document.AbstractField
storePositionWithTermVector - Variable in class org.apache.lucene.document.AbstractField
STORES_PAYLOADS - Static variable in class org.apache.lucene.index.IndexReader.FieldOption
  All fields that store payloads
storeTermVector - Variable in class org.apache.lucene.document.AbstractField
STR_SIZE - Static variable in class org.apache.lucene.document.NumberTools
  The length of (all) strings returned by `NumberTools.longToString(long)`
STRING - Static variable in class org.apache.lucene.search.SortField
  Sort using term values as Strings.
STRING_INDEX - Static variable in interface org.apache.lucene.search.FieldCache
  Indicator for StringIndex values in the cache.
stringDifference(String, String) - Static method in class org.apache.lucene.util.StringHelper
  Compares two strings, character by character, and returns the first position where the two strings differ from one another.
StringHelper - Class in org.apache.lucene.util
  Methods for manipulating strings.
stringToDate(String) - Static method in class org.apache.lucene.document.DateField
  Deprecated. Converts a string-encoded date into a Date object.
stringToDate(String) - Static method in class org.apache.lucene.document.DateTools
  Converts a string produced by `timeToString` or `dateToString` back to a time, represented as a Date object.
stringToLong(String) - Static method in class org.apache.lucene.document.NumberTools
  Converts a String that was returned by `NumberTools.longToString(long)` back to a long.
stringToTime(String) - Static method in class org.apache.lucene.document.DateField
  Deprecated. Converts a string-encoded date into a millisecond time.
stringToTime(String) - Static method in class org.apache.lucene.document.DateTools
  Converts a string produced by `timeToString` or `dateToString` back to a time, represented as the number of milliseconds since January 1, 1970, 00:00:00 GMT.
stringValue() - Method in class org.apache.lucene.document.Field
  The value of the field as a String, or null.
stringValue() - Method in interface org.apache.lucene.document.Fieldable
  The value of the field as a String, or null.
strVal(int) - Method in class org.apache.lucene.search.function.DocValues
  Return doc value as a string.
subDoc(int) - Method in class org.apache.lucene.search.MultiSearcher
  Returns the document number of document `n` within its sub-index.
subReaders - Variable in class org.apache.lucene.index.MultiReader
subSearcher(int) - Method in class org.apache.lucene.search.MultiSearcher
  Returns index of the searcher for document `n` in the array used to construct this searcher.
sumOfSquaredWeights() - Method in class org.apache.lucene.search.ConstantScoreQuery.ConstantWeight
sumOfSquaredWeights() - Method in class org.apache.lucene.search.spans.SpanWeight
sumOfSquaredWeights() - Method in interface org.apache.lucene.search.Weight
  The sum of squared weights of contained query clauses.
SUN_OS - Static variable in class org.apache.lucene.util.Constants
  True iff running on SunOS.
SwitchTo(int) - Method in class org.apache.lucene.queryParser.QueryParserTokenManager
  Switch to specified lex state.
sync() - Method in class org.apache.lucene.index.ConcurrentMergeScheduler
sync(String) - Method in class org.apache.lucene.store.Directory
  Ensure that any writes to this file are moved to stable storage.
sync(String) - Method in class org.apache.lucene.store.FSDirectory
synchronizedCache(Cache) - Static method in class org.apache.lucene.util.cache.Cache
  Returns a thread-safe cache backed by the specified cache.

## T

TeeTokenFilter - Class in org.apache.lucene.analysis
  Works in conjunction with the SinkTokenizer to provide the ability to set aside tokens that have already been analyzed.
TeeTokenFilter(TokenStream, SinkTokenizer) - Constructor for class org.apache.lucene.analysis.TeeTokenFilter
term() - Method in class org.apache.lucene.analysis.Token
  Returns the Token's term text.
term() - Method in class org.apache.lucene.index.FilterIndexReader.FilterTermEnum
Term - Class in org.apache.lucene.index
  A Term represents a word from text.
Term(String, String) - Constructor for class org.apache.lucene.index.Term
  Constructs a Term with the given field and text.
Term(String) - Constructor for class org.apache.lucene.index.Term
  Constructs a Term with the given field and empty text.
term() - Method in class org.apache.lucene.index.TermEnum
  Returns the current Term in the enumeration.
Term(String) - Method in class org.apache.lucene.queryParser.QueryParser
TERM - Static variable in interface org.apache.lucene.queryParser.QueryParserConstants
  RegularExpression Id.
term() - Method in class org.apache.lucene.search.FilteredTermEnum
  Returns the current Term in the enumeration.
term - Variable in class org.apache.lucene.search.FuzzyQuery.ScoreTerm
term - Variable in class org.apache.lucene.search.spans.SpanTermQuery
term - Variable in class org.apache.lucene.search.spans.TermSpans
termBuffer() - Method in class org.apache.lucene.analysis.Token
  Returns the internal termBuffer character array which you can then directly alter.
termCompare(Term) - Method in class org.apache.lucene.search.FilteredTermEnum
  Equality compare on the term
termCompare(Term) - Method in class org.apache.lucene.search.FuzzyTermEnum
  The termCompare method in FuzzyTermEnum uses Levenshtein distance to calculate the distance between the given term and the comparing term.
termCompare(Term) - Method in class org.apache.lucene.search.WildcardTermEnum
termDocs() - Method in class org.apache.lucene.index.FilterIndexReader
termDocs(Term) - Method in class org.apache.lucene.index.IndexReader
  Returns an enumeration of all the documents which contain `term`.
termDocs() - Method in class org.apache.lucene.index.IndexReader
  Returns an unpositioned `TermDocs` enumerator.
termDocs() - Method in class org.apache.lucene.index.MultiReader
termDocs(Term) - Method in class org.apache.lucene.index.ParallelReader
termDocs() - Method in class org.apache.lucene.index.ParallelReader
TermDocs - Interface in org.apache.lucene.index
  TermDocs provides an interface for enumerating <document, frequency> pairs for a term.
TermEnum - Class in org.apache.lucene.index
  Abstract class for enumerating terms.
TermEnum() - Constructor for class org.apache.lucene.index.TermEnum
TermFreqVector - Interface in org.apache.lucene.index
  Provides access to stored term vector of a document field.
termLength() - Method in class org.apache.lucene.analysis.Token
  Return number of valid characters (length of the term) in the termBuffer array.
termPositions() - Method in class org.apache.lucene.index.FilterIndexReader
termPositions(Term) - Method in class org.apache.lucene.index.IndexReader
  Returns an enumeration of all the documents which contain `term`.
termPositions() - Method in class org.apache.lucene.index.IndexReader
  Returns an unpositioned `TermPositions` enumerator.
termPositions() - Method in class org.apache.lucene.index.MultiReader
termPositions(Term) - Method in class org.apache.lucene.index.ParallelReader
termPositions() - Method in class org.apache.lucene.index.ParallelReader
TermPositions - Interface in org.apache.lucene.index
  TermPositions provides an interface for enumerating the <document, frequency, <position>* > tuples for a term.
TermPositionVector - Interface in org.apache.lucene.index
  Extends `TermFreqVector` to provide additional information about positions in which each of the terms is found.
TermQuery - Class in org.apache.lucene.search
  A Query that matches documents containing a term.
TermQuery(Term) - Constructor for class org.apache.lucene.search.TermQuery
  Constructs a query for the term `t`.
terms() - Method in class org.apache.lucene.index.FilterIndexReader
terms(Term) - Method in class org.apache.lucene.index.FilterIndexReader
terms() - Method in class org.apache.lucene.index.IndexReader
  Returns an enumeration of all the terms in the index.
terms(Term) - Method in class org.apache.lucene.index.IndexReader
  Returns an enumeration of all terms starting at a given term.
terms() - Method in class org.apache.lucene.index.MultiReader
terms(Term) - Method in class org.apache.lucene.index.MultiReader
terms() - Method in class org.apache.lucene.index.ParallelReader
terms(Term) - Method in class org.apache.lucene.index.ParallelReader
terms - Variable in class org.apache.lucene.search.spans.SpanWeight
TermSpans - Class in org.apache.lucene.search.spans
  Expert: Public for extension only
TermSpans(TermPositions, Term) - Constructor for class org.apache.lucene.search.spans.TermSpans
termText() - Method in class org.apache.lucene.analysis.Token
  Deprecated. This method now has a performance penalty because the text is stored internally in a char[]. If possible, use `Token.termBuffer()` and `Token.termLength()` directly instead. If you really need a String, use `Token.term()`
TERMVECTOR - Static variable in class org.apache.lucene.index.IndexReader.FieldOption
  All fields with termvectors enabled.
TERMVECTOR_WITH_OFFSET - Static variable in class org.apache.lucene.index.IndexReader.FieldOption
  All fields with termvectors with offset values enabled
TERMVECTOR_WITH_POSITION - Static variable in class org.apache.lucene.index.IndexReader.FieldOption
  All fields with termvectors with position values enabled
TERMVECTOR_WITH_POSITION_OFFSET - Static variable in class org.apache.lucene.index.IndexReader.FieldOption
  All fields with termvectors with offset values and position values enabled
TermVectorEntry - Class in org.apache.lucene.index
  Convenience class for holding TermVector information.
TermVectorEntry() - Constructor for class org.apache.lucene.index.TermVectorEntry
TermVectorEntry(String, String, int, TermVectorOffsetInfo[], int[]) - Constructor for class org.apache.lucene.index.TermVectorEntry
TermVectorEntryFreqSortedComparator - Class in org.apache.lucene.index
  Compares `TermVectorEntry`s first by frequency and then by the term (case-sensitive)
TermVectorEntryFreqSortedComparator() - Constructor for class org.apache.lucene.index.TermVectorEntryFreqSortedComparator
TermVectorMapper - Class in org.apache.lucene.index
  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)`.
TermVectorMapper() - Constructor for class org.apache.lucene.index.TermVectorMapper
TermVectorMapper(boolean, boolean) - Constructor for class org.apache.lucene.index.TermVectorMapper
TermVectorOffsetInfo - Class in org.apache.lucene.index
  The TermVectorOffsetInfo class holds information pertaining to a Term in a `TermPositionVector`'s offset information.
TermVectorOffsetInfo() - Constructor for class org.apache.lucene.index.TermVectorOffsetInfo
TermVectorOffsetInfo(int, int) - Constructor for class org.apache.lucene.index.TermVectorOffsetInfo
text() - Method in class org.apache.lucene.index.Term
  Returns the text of this term.
tf(float) - Method in class org.apache.lucene.search.DefaultSimilarity
  Implemented as `sqrt(freq)`.
tf(int) - Method in class org.apache.lucene.search.Similarity
  Computes a score factor based on a term or phrase's frequency in a document.
tf(float) - Method in class org.apache.lucene.search.Similarity
  Computes a score factor based on a term or phrase's frequency in a document.
tf(float) - Method in class org.apache.lucene.search.SimilarityDelegator
TimeLimitedCollector - Class in org.apache.lucene.search
  The TimeLimitedCollector is used to timeout search requests that take longer than the maximum allowed search time limit.
TimeLimitedCollector(HitCollector, long) - Constructor for class org.apache.lucene.search.TimeLimitedCollector
  Create a TimeLimitedCollector wrapper over another HitCollector with a specified timeout.
TimeLimitedCollector.TimeExceededException - Exception in org.apache.lucene.search
  Thrown when elapsed search time exceeds allowed search time.
timestamp - Variable in class org.apache.lucene.search.FilterManager.FilterItem
timeToString(long) - Static method in class org.apache.lucene.document.DateField
  Deprecated. Converts a millisecond time to a string suitable for indexing.
timeToString(long, DateTools.Resolution) - Static method in class org.apache.lucene.document.DateTools
  Converts a millisecond time to a string suitable for indexing.
toByteArray() - Method in class org.apache.lucene.index.Payload
  Allocates a new byte array, copies the payload data into it and returns it.
toHtml() - Method in class org.apache.lucene.search.Explanation
  Render an explanation as HTML.
Token - Class in org.apache.lucene.analysis
  A Token is an occurrence of a term from the text of a field.
Token() - Constructor for class org.apache.lucene.analysis.Token
  Constructs a Token will null text.
Token(int, int) - Constructor for class org.apache.lucene.analysis.Token
  Constructs a Token with null text and start & end offsets.
Token(int, int, String) - Constructor for class org.apache.lucene.analysis.Token
  Constructs a Token with null text and start & end offsets plus the Token type.
Token(int, int, int) - Constructor for class org.apache.lucene.analysis.Token
  Constructs a Token with null text and start & end offsets plus flags.
Token(String, int, int) - Constructor for class org.apache.lucene.analysis.Token
  Deprecated.
Token(String, int, int, String) - Constructor for class org.apache.lucene.analysis.Token
  Deprecated.
Token(String, int, int, int) - Constructor for class org.apache.lucene.analysis.Token
  Deprecated.
Token(char[], int, int, int, int) - Constructor for class org.apache.lucene.analysis.Token
  Constructs a Token with the given term buffer (offset & length), start and end offsets
token - Variable in class org.apache.lucene.queryParser.QueryParser
  Current token.
Token - Class in org.apache.lucene.queryParser
  Describes the input token stream.
Token() - Constructor for class org.apache.lucene.queryParser.Token
  No-argument constructor
Token(int) - Constructor for class org.apache.lucene.queryParser.Token
  Constructs a new token for the specified Image.
Token(int, String) - Constructor for class org.apache.lucene.queryParser.Token
  Constructs a new token for the specified Image and Kind.
token_source - Variable in class org.apache.lucene.queryParser.QueryParser
  Generated Token Manager.
TOKEN_TYPES - Static variable in class org.apache.lucene.analysis.standard.StandardTokenizer
  String token types that correspond to token type int constants
TokenFilter - Class in org.apache.lucene.analysis
  A TokenFilter is a TokenStream whose input is another token stream.
TokenFilter(TokenStream) - Constructor for class org.apache.lucene.analysis.TokenFilter
  Construct a token stream filtering the given input.
tokenImage - Static variable in class org.apache.lucene.analysis.standard.StandardTokenizer
  Deprecated. Please use `StandardTokenizer.TOKEN_TYPES` instead
tokenImage - Variable in exception org.apache.lucene.queryParser.ParseException
  This is a reference to the "tokenImage" array of the generated parser within which the parse error occurred.
tokenImage - Static variable in interface org.apache.lucene.queryParser.QueryParserConstants
  Literal token values.
TOKENIZED - Static variable in class org.apache.lucene.document.Field.Index
  Deprecated. this has been renamed to `Field.Index.ANALYZED`
Tokenizer - Class in org.apache.lucene.analysis
  A Tokenizer is a TokenStream whose input is a Reader.
Tokenizer() - Constructor for class org.apache.lucene.analysis.Tokenizer
  Construct a tokenizer with null input.
Tokenizer(Reader) - Constructor for class org.apache.lucene.analysis.Tokenizer
  Construct a token stream processing the given input.
TokenMgrError - Error in org.apache.lucene.queryParser
  Token Manager Error.
TokenMgrError() - Constructor for error org.apache.lucene.queryParser.TokenMgrError
  No arg constructor.
TokenMgrError(String, int) - Constructor for error org.apache.lucene.queryParser.TokenMgrError
  Constructor with message and reason.
TokenMgrError(boolean, int, int, int, String, char, int) - Constructor for error org.apache.lucene.queryParser.TokenMgrError
  Full Constructor.
tokenStream(String, Reader) - Method in class org.apache.lucene.analysis.Analyzer
  Creates a TokenStream which tokenizes all the text in the provided Reader.
tokenStream(String, Reader) - Method in class org.apache.lucene.analysis.KeywordAnalyzer
tokenStream(String, Reader) - Method in class org.apache.lucene.analysis.PerFieldAnalyzerWrapper
tokenStream(String, Reader) - Method in class org.apache.lucene.analysis.SimpleAnalyzer
tokenStream(String, Reader) - Method in class org.apache.lucene.analysis.standard.StandardAnalyzer
  Constructs a `StandardTokenizer` filtered by a `StandardFilter`, a `LowerCaseFilter` and a `StopFilter`.
tokenStream(String, Reader) - Method in class org.apache.lucene.analysis.StopAnalyzer
  Filters LowerCaseTokenizer with StopFilter.
TokenStream - Class in org.apache.lucene.analysis
  A TokenStream enumerates the sequence of tokens, either from fields of a document or from query text.
TokenStream() - Constructor for class org.apache.lucene.analysis.TokenStream
tokenStream(String, Reader) - Method in class org.apache.lucene.analysis.WhitespaceAnalyzer
tokenStreamValue() - Method in class org.apache.lucene.document.Field
  The value of the field as a TokesStream, or null.
tokenStreamValue() - Method in interface org.apache.lucene.document.Fieldable
  The value of the field as a TokenStream, or null.
toolOutOfDate - Variable in class org.apache.lucene.index.CheckIndex.Status
  True if the index was created with a newer version of Lucene than the CheckIndex tool.
top() - Method in class org.apache.lucene.util.PriorityQueue
  Returns the least element of the PriorityQueue in constant time.
top() - Method in class org.apache.lucene.util.ScorerDocQueue
  Returns the least Scorer of the ScorerDocQueue in constant time.
topDoc() - Method in class org.apache.lucene.util.ScorerDocQueue
  Returns document number of the least Scorer of the ScorerDocQueue in constant time.
TopDocCollector - Class in org.apache.lucene.search
  A `HitCollector` implementation that collects the top-scoring documents, returning them as a `TopDocs`.
TopDocCollector(int) - Constructor for class org.apache.lucene.search.TopDocCollector
  Construct to collect a given number of hits.
TopDocCollector(PriorityQueue) - Constructor for class org.apache.lucene.search.TopDocCollector
  Constructor to collect the top-scoring documents by using the given PQ.
topDocs() - Method in class org.apache.lucene.search.TopDocCollector
  The top-scoring hits.
TopDocs - Class in org.apache.lucene.search
  Expert: Returned by low-level search implementations.
TopDocs(int, ScoreDoc[], float) - Constructor for class org.apache.lucene.search.TopDocs
  Expert: Constructs a TopDocs.
topDocs() - Method in class org.apache.lucene.search.TopFieldDocCollector
TopFieldDocCollector - Class in org.apache.lucene.search
  A `HitCollector` implementation that collects the top-sorting documents, returning them as a `TopFieldDocs`.
TopFieldDocCollector(IndexReader, Sort, int) - Constructor for class org.apache.lucene.search.TopFieldDocCollector
  Construct to collect a given number of hits.
TopFieldDocs - Class in org.apache.lucene.search
  Expert: Returned by low-level sorted search implementations.
TopFieldDocs(int, ScoreDoc[], SortField[], float) - Constructor for class org.apache.lucene.search.TopFieldDocs
  Creates one of these objects.
TopLevelQuery(String) - Method in class org.apache.lucene.queryParser.QueryParser
topNextAndAdjustElsePop() - Method in class org.apache.lucene.util.ScorerDocQueue
topScore() - Method in class org.apache.lucene.util.ScorerDocQueue
topSkipToAndAdjustElsePop(int) - Method in class org.apache.lucene.util.ScorerDocQueue
toString() - Method in class org.apache.lucene.analysis.PerFieldAnalyzerWrapper
toString() - Method in class org.apache.lucene.analysis.Token
toString() - Method in class org.apache.lucene.document.AbstractField
  Prints a Field for human consumption.
toString() - Method in class org.apache.lucene.document.DateTools.Resolution
toString() - Method in class org.apache.lucene.document.Document
  Prints the fields of a document for human consumption.
toString() - Method in class org.apache.lucene.index.ConcurrentMergeScheduler.MergeThread
toString() - Method in class org.apache.lucene.index.IndexModifier
  Deprecated.
toString() - Method in class org.apache.lucene.index.IndexReader.FieldOption
toString() - Method in class org.apache.lucene.index.IndexWriter.MaxFieldLength
toString() - Method in class org.apache.lucene.index.Term
toString() - Method in class org.apache.lucene.index.TermVectorEntry
toString() - Method in class org.apache.lucene.queryParser.Token
  Returns the image.
toString() - Method in class org.apache.lucene.search.BooleanClause.Occur
toString() - Method in class org.apache.lucene.search.BooleanClause
toString(String) - Method in class org.apache.lucene.search.BooleanQuery
  Prints a user-readable version of this query.
toString() - Method in class org.apache.lucene.search.CachingSpanFilter
toString() - Method in class org.apache.lucene.search.CachingWrapperFilter
toString(String) - Method in class org.apache.lucene.search.ConstantScoreQuery
  Prints a user-readable version of this query.
toString(String) - Method in class org.apache.lucene.search.ConstantScoreRangeQuery
  Prints a user-readable version of this query.
toString(String) - Method in class org.apache.lucene.search.DisjunctionMaxQuery
  Prettyprint us.
toString() - Method in class org.apache.lucene.search.Explanation
  Render an explanation as text.
toString(int) - Method in class org.apache.lucene.search.Explanation
toString(String) - Method in class org.apache.lucene.search.FilteredQuery
  Prints a user-readable version of this query.
toString(String) - Method in class org.apache.lucene.search.function.CustomScoreQuery
toString(int) - Method in class org.apache.lucene.search.function.DocValues
  Return a string representation of a doc value, as reuired for Explanations.
toString() - Method in class org.apache.lucene.search.function.FieldScoreQuery.Type
toString() - Method in class org.apache.lucene.search.function.ValueSource
toString(String) - Method in class org.apache.lucene.search.function.ValueSourceQuery
toString(String) - Method in class org.apache.lucene.search.FuzzyQuery
toString() - Method in class org.apache.lucene.search.Hit
  Deprecated. Prints the parameters to be used to discover the promised result.
toString(String) - Method in class org.apache.lucene.search.MatchAllDocsQuery
toString(String) - Method in class org.apache.lucene.search.MultiPhraseQuery
  Prints a user-readable version of this query.
toString(String) - Method in class org.apache.lucene.search.MultiTermQuery
  Prints a user-readable version of this query.
toString(String) - Method in class org.apache.lucene.search.PhraseQuery
  Prints a user-readable version of this query.
toString() - Method in class org.apache.lucene.search.PrefixFilter
  Prints a user-readable version of this query.
toString(String) - Method in class org.apache.lucene.search.PrefixQuery
  Prints a user-readable version of this query.
toString(String) - Method in class org.apache.lucene.search.Query
  Prints a query to a string, with `field` assumed to be the default field and omitted.
toString() - Method in class org.apache.lucene.search.Query
  Prints a query to a string.
toString() - Method in class org.apache.lucene.search.QueryTermVector
toString() - Method in class org.apache.lucene.search.QueryWrapperFilter
toString() - Method in class org.apache.lucene.search.RangeFilter
toString(String) - Method in class org.apache.lucene.search.RangeQuery
  Prints a user-readable version of this query.
toString() - Method in class org.apache.lucene.search.Sort
toString() - Method in class org.apache.lucene.search.SortField
toString() - Method in class org.apache.lucene.search.SpanQueryFilter
toString(String) - Method in class org.apache.lucene.search.spans.SpanFirstQuery
toString(String) - Method in class org.apache.lucene.search.spans.SpanNearQuery
toString(String) - Method in class org.apache.lucene.search.spans.SpanNotQuery
toString(String) - Method in class org.apache.lucene.search.spans.SpanOrQuery
toString(String) - Method in class org.apache.lucene.search.spans.SpanTermQuery
toString() - Method in class org.apache.lucene.search.spans.TermSpans
toString(String) - Method in class org.apache.lucene.search.TermQuery
  Prints a user-readable version of this query.
toString() - Method in class org.apache.lucene.store.FSDirectory
  For debug output.
toString() - Method in class org.apache.lucene.util.Parameter
ToStringUtils - Class in org.apache.lucene.util
  Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.
ToStringUtils() - Constructor for class org.apache.lucene.util.ToStringUtils
totalHits - Variable in class org.apache.lucene.search.TopDocCollector
  The total number of hits the collector encountered.
totalHits - Variable in class org.apache.lucene.search.TopDocs
  Expert: The total number of hits for the query.
totLoseDocCount - Variable in class org.apache.lucene.index.CheckIndex.Status
  How many documents will be lost to bad segments.
touchFile(String) - Method in class org.apache.lucene.store.Directory
  Set the modified time of an existing file to now.
touchFile(String) - Method in class org.apache.lucene.store.FSDirectory
  Set the modified time of an existing file to now.
touchFile(String) - Method in class org.apache.lucene.store.RAMDirectory
  Set the modified time of an existing file to now.
trimTrailingZeros() - Method in class org.apache.lucene.util.OpenBitSet
  Lowers numWords, the number of words in use, by checking for trailing zero words.
type() - Method in class org.apache.lucene.analysis.Token
  Returns this Token's lexical type.

## U

UN_TOKENIZED - Static variable in class org.apache.lucene.document.Field.Index
  Deprecated. This has been renamed to `Field.Index.NOT_ANALYZED`
undeleteAll() - Method in class org.apache.lucene.index.IndexReader
  Undeletes all documents currently marked as deleted in this index.
UNI_REPLACEMENT_CHAR - Static variable in class org.apache.lucene.util.UnicodeUtil
UNI_SUR_HIGH_END - Static variable in class org.apache.lucene.util.UnicodeUtil
UNI_SUR_HIGH_START - Static variable in class org.apache.lucene.util.UnicodeUtil
UNI_SUR_LOW_END - Static variable in class org.apache.lucene.util.UnicodeUtil
UNI_SUR_LOW_START - Static variable in class org.apache.lucene.util.UnicodeUtil
UnicodeUtil - Class in org.apache.lucene.util
  Class to encode java's UTF16 char[] into UTF8 byte[] without always allocating a new byte[] as String.getBytes("UTF-8") does.
UnicodeUtil() - Constructor for class org.apache.lucene.util.UnicodeUtil
UnicodeUtil.UTF16Result - Class in org.apache.lucene.util
UnicodeUtil.UTF16Result() - Constructor for class org.apache.lucene.util.UnicodeUtil.UTF16Result
UnicodeUtil.UTF8Result - Class in org.apache.lucene.util
UnicodeUtil.UTF8Result() - Constructor for class org.apache.lucene.util.UnicodeUtil.UTF8Result
UNINDEXED - Static variable in class org.apache.lucene.index.IndexReader.FieldOption
  All fields which are not indexed
union(OpenBitSet) - Method in class org.apache.lucene.util.OpenBitSet
  this = this OR other
unionCount(OpenBitSet, OpenBitSet) - Static method in class org.apache.lucene.util.OpenBitSet
  Returns the popcount or cardinality of the union of the two sets.
UNLIMITED - Static variable in class org.apache.lucene.index.IndexWriter.MaxFieldLength
  Sets the maximum field length to `Integer.MAX_VALUE`.
unlock(Directory) - Static method in class org.apache.lucene.index.IndexReader
  Deprecated. Please use `IndexWriter.unlock(Directory)` instead
unlock(Directory) - Static method in class org.apache.lucene.index.IndexWriter
  Forcibly unlocks the index in the named directory.
updateDocument(Term, Document) - Method in class org.apache.lucene.index.IndexWriter
  Updates a document by first deleting the document(s) containing `term` and then adding the new document.
updateDocument(Term, Document, Analyzer) - Method in class org.apache.lucene.index.IndexWriter
  Updates a document by first deleting the document(s) containing `term` and then adding the new document.
useCompoundDocStore(SegmentInfos) - Method in class org.apache.lucene.index.LogMergePolicy
useCompoundFile - Variable in class org.apache.lucene.index.IndexModifier
  Deprecated.
useCompoundFile(SegmentInfos, SegmentInfo) - Method in class org.apache.lucene.index.LogMergePolicy
UTF16toUTF8(char[], int, UnicodeUtil.UTF8Result) - Static method in class org.apache.lucene.util.UnicodeUtil
  Encode characters from a char[] source, starting at offset and stopping when the character 0xffff is seen.
UTF16toUTF8(char[], int, int, UnicodeUtil.UTF8Result) - Static method in class org.apache.lucene.util.UnicodeUtil
  Encode characters from a char[] source, starting at offset for length chars.
UTF16toUTF8(String, int, int, UnicodeUtil.UTF8Result) - Static method in class org.apache.lucene.util.UnicodeUtil
  Encode characters from this String, starting at offset for length characters.
UTF8toUTF16(byte[], int, int, UnicodeUtil.UTF16Result) - Static method in class org.apache.lucene.util.UnicodeUtil
  Convert UTF8 bytes into UTF16 characters.

## V

value - Variable in class org.apache.lucene.search.spans.SpanScorer
value - Variable in class org.apache.lucene.search.spans.SpanWeight
ValueSource - Class in org.apache.lucene.search.function
  Expert: source of values for basic function queries.
ValueSource() - Constructor for class org.apache.lucene.search.function.ValueSource
ValueSourceQuery - Class in org.apache.lucene.search.function
  Expert: A Query that sets the scores of document to the values obtained from a `ValueSource`.
ValueSourceQuery(ValueSource) - Constructor for class org.apache.lucene.search.function.ValueSourceQuery
  Create a value source query
VerifyingLockFactory - Class in org.apache.lucene.store
  A `LockFactory` that wraps another `LockFactory` and verifies that each lock obtain/release is "correct" (never results in two processes holding the lock at the same time).
VerifyingLockFactory(byte, LockFactory, String, int) - Constructor for class org.apache.lucene.store.VerifyingLockFactory

## W

weight(Searcher) - Method in class org.apache.lucene.search.Query
  Expert: Constructs and initializes a Weight for a top-level query.
weight - Variable in class org.apache.lucene.search.spans.SpanScorer
Weight - Interface in org.apache.lucene.search
  Expert: Calculate query weights and build query scorers.
WhitespaceAnalyzer - Class in org.apache.lucene.analysis
  An Analyzer that uses WhitespaceTokenizer.
WhitespaceAnalyzer() - Constructor for class org.apache.lucene.analysis.WhitespaceAnalyzer
WhitespaceTokenizer - Class in org.apache.lucene.analysis
  A WhitespaceTokenizer is a tokenizer that divides text at whitespace.
WhitespaceTokenizer(Reader) - Constructor for class org.apache.lucene.analysis.WhitespaceTokenizer
  Construct a new WhitespaceTokenizer.
WILDCARD_CHAR - Static variable in class org.apache.lucene.search.WildcardTermEnum
WILDCARD_STRING - Static variable in class org.apache.lucene.search.WildcardTermEnum
  String equality with support for wildcards
wildcardEquals(String, int, String, int) - Static method in class org.apache.lucene.search.WildcardTermEnum
  Determines if a word matches a wildcard pattern.
WildcardQuery - Class in org.apache.lucene.search
  Implements the wildcard search query.
WildcardQuery(Term) - Constructor for class org.apache.lucene.search.WildcardQuery
WildcardTermEnum - Class in org.apache.lucene.search
  Subclass of FilteredTermEnum for enumerating all terms that match the specified wildcard filter term.
WildcardTermEnum(IndexReader, Term) - Constructor for class org.apache.lucene.search.WildcardTermEnum
  Creates a new `WildcardTermEnum`.
WILDTERM - Static variable in interface org.apache.lucene.queryParser.QueryParserConstants
  RegularExpression Id.
WINDOWS - Static variable in class org.apache.lucene.util.Constants
  True iff running on Windows.
WITH_OFFSETS - Static variable in class org.apache.lucene.document.Field.TermVector
  Store the term vector + Token offset information
WITH_POSITIONS - Static variable in class org.apache.lucene.document.Field.TermVector
  Store the term vector + token position information
WITH_POSITIONS_OFFSETS - Static variable in class org.apache.lucene.document.Field.TermVector
  Store the term vector + Token position and offset information
wlen - Variable in class org.apache.lucene.util.OpenBitSet
WordlistLoader - Class in org.apache.lucene.analysis
  Loader for text files that represent a list of stopwords.
WordlistLoader() - Constructor for class org.apache.lucene.analysis.WordlistLoader
write(Directory, String) - Method in class org.apache.lucene.util.BitVector
  Writes this vector to the file `name` in Directory `d`, in a format that can be read by the constructor `BitVector.BitVector(Directory, String)`.
WRITE_LOCK_NAME - Static variable in class org.apache.lucene.index.IndexWriter
  Name of the write lock in the index.
WRITE_LOCK_TIMEOUT - Static variable in class org.apache.lucene.index.IndexWriter
  Default value for the write lock timeout (1,000).
writeByte(byte) - Method in class org.apache.lucene.store.BufferedIndexOutput
  Writes a single byte.
writeByte(byte) - Method in class org.apache.lucene.store.ChecksumIndexOutput
writeByte(byte) - Method in class org.apache.lucene.store.IndexOutput
  Writes a single byte.
writeByte(byte) - Method in class org.apache.lucene.store.RAMOutputStream
writeBytes(byte[], int, int) - Method in class org.apache.lucene.store.BufferedIndexOutput
  Writes an array of bytes.
writeBytes(byte[], int, int) - Method in class org.apache.lucene.store.ChecksumIndexOutput
writeBytes(byte[], int) - Method in class org.apache.lucene.store.IndexOutput
  Writes an array of bytes.
writeBytes(byte[], int, int) - Method in class org.apache.lucene.store.IndexOutput
  Writes an array of bytes.
writeBytes(byte[], int, int) - Method in class org.apache.lucene.store.RAMOutputStream
writeChars(String, int, int) - Method in class org.apache.lucene.store.IndexOutput
  Deprecated. -- please pre-convert to utf8 bytes instead or use `IndexOutput.writeString(java.lang.String)`
writeChars(char[], int, int) - Method in class org.apache.lucene.store.IndexOutput
  Deprecated. -- please pre-convert to utf8 bytes instead or use `IndexOutput.writeString(java.lang.String)`
writeInt(int) - Method in class org.apache.lucene.store.IndexOutput
  Writes an int as four bytes.
writeLong(long) - Method in class org.apache.lucene.store.IndexOutput
  Writes a long as eight bytes.
writer - Variable in class org.apache.lucene.index.ConcurrentMergeScheduler
writeString(String) - Method in class org.apache.lucene.store.IndexOutput
  Writes a string.
writeTo(IndexOutput) - Method in class org.apache.lucene.store.RAMOutputStream
  Copy the current contents of this buffer to the named output.
writeVInt(int) - Method in class org.apache.lucene.store.IndexOutput
  Writes an int in a variable-length format.
writeVLong(long) - Method in class org.apache.lucene.store.IndexOutput
  Writes an long in a variable-length format.

## X

xor(OpenBitSet) - Method in class org.apache.lucene.util.OpenBitSet
  this = this XOR other
xorCount(OpenBitSet, OpenBitSet) - Static method in class org.apache.lucene.util.OpenBitSet
  Returns the popcount or cardinality of the exclusive-or of the two sets.

## Y

YEAR - Static variable in class org.apache.lucene.document.DateTools.Resolution
YES - Static variable in class org.apache.lucene.document.Field.Store
  Store the original field value in the index.
YES - Static variable in class org.apache.lucene.document.Field.TermVector
  Store the term vectors of each document.

## _

_ESCAPED_CHAR - Static variable in interface org.apache.lucene.queryParser.QueryParserConstants
  RegularExpression Id.
_NUM_CHAR - Static variable in interface org.apache.lucene.queryParser.QueryParserConstants
  RegularExpression Id.
_QUOTED_CHAR - Static variable in interface org.apache.lucene.queryParser.QueryParserConstants
  RegularExpression Id.
_TERM_CHAR - Static variable in interface org.apache.lucene.queryParser.QueryParserConstants
  RegularExpression Id.
_TERM_START_CHAR - Static variable in interface org.apache.lucene.queryParser.QueryParserConstants
  RegularExpression Id.
_WHITESPACE - Static variable in interface org.apache.lucene.queryParser.QueryParserConstants
  RegularExpression Id.

A B C D E F G H I J K L M N O P Q R S T U V W X Y _

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV NEXT | FRAMES NO FRAMES

Copyright © 2000-2009 Apache Software Foundation. All Rights Reserved.