A B C D F G H I L M N O P R S T U W

## A

accept(IndexReader, int, String, TermVectorMapper) - Method in class org.apache.lucene.index.TermVectorAccessor
  Visits the TermVectorMapper and populates it with terms available for a given document, either via a vector created at index time or by resolving them from the inverted index.
addDocument(Document, Analyzer) - Method in class org.apache.lucene.index.NRTManager
addDocument(Document) - Method in class org.apache.lucene.index.NRTManager
addDocuments(Collection<Document>, Analyzer) - Method in class org.apache.lucene.index.NRTManager
addDocuments(Collection<Document>) - Method in class org.apache.lucene.index.NRTManager
addWaitingListener(NRTManager.WaitingListener) - Method in class org.apache.lucene.index.NRTManager
  Adds a listener, to be notified when a caller is waiting for a specific generation searcher to be visible.
advise(FileDescriptor, long, long, int) - Static method in class org.apache.lucene.store.NativePosixUtil

## B

BalancedSegmentMergePolicy - Class in org.apache.lucene.index
  Merge policy that tries to balance not doing large segment merges with not accumulating too many segments in the index, to provide for better performance in near real-time setting.
BalancedSegmentMergePolicy() - Constructor for class org.apache.lucene.index.BalancedSegmentMergePolicy
BalancedSegmentMergePolicy.MergePolicyParams - Class in org.apache.lucene.index
BalancedSegmentMergePolicy.MergePolicyParams() - Constructor for class org.apache.lucene.index.BalancedSegmentMergePolicy.MergePolicyParams
baselineTf(float) - Method in class org.apache.lucene.misc.SweetSpotSimilarity
  Implemented as: `(x <= min) ? base : sqrt(x+(base**2)-min)` ...but with a special case check for 0.

## C

clearLock(String) - Method in class org.apache.lucene.store.NRTCachingDirectory
clone() - Method in class org.apache.lucene.store.WindowsDirectory.WindowsIndexInput
close() - Method in class org.apache.lucene.index.NRTManager
  NOTE: caller must separately close the writer.
close() - Method in class org.apache.lucene.index.NRTManagerReopenThread
close() - Method in class org.apache.lucene.store.NRTCachingDirectory
  Close thius directory, which flushes any cached files to the delegate and then closes the delegate.
close() - Method in class org.apache.lucene.store.WindowsDirectory.WindowsIndexInput
computeLengthNorm(String, int) - Method in class org.apache.lucene.misc.SweetSpotSimilarity
  Implemented as: `1/sqrt( steepness * (abs(x-min) + abs(x-max) - (max-min)) + 1 )` .
computeNorm(String, FieldInvertState) - Method in class org.apache.lucene.misc.SweetSpotSimilarity
  Implemented as `state.getBoost() * lengthNorm(fieldName, numTokens)` where numTokens does not count overlap tokens if discountOverlaps is true by default or true for this specific field.
createOutput(String) - Method in class org.apache.lucene.store.DirectIOLinuxDirectory
createOutput(String) - Method in class org.apache.lucene.store.NRTCachingDirectory

## D

DEFAULT_NUM_LARGE_SEGMENTS - Static variable in class org.apache.lucene.index.BalancedSegmentMergePolicy
DEFAULTnumTerms - Static variable in class org.apache.lucene.misc.HighFreqTerms
deleteDocuments(Term) - Method in class org.apache.lucene.index.NRTManager
deleteDocuments(Query) - Method in class org.apache.lucene.index.NRTManager
deleteFile(String) - Method in class org.apache.lucene.store.NRTCachingDirectory
DirectIOLinuxDirectory - Class in org.apache.lucene.store
  An `Directory` implementation that uses the Linux-specific O_DIRECT flag to bypass all OS level caching.
DirectIOLinuxDirectory(File, LockFactory, int) - Constructor for class org.apache.lucene.store.DirectIOLinuxDirectory
  Create a new NIOFSDirectory for the named location.
doCacheWrite(String) - Method in class org.apache.lucene.store.NRTCachingDirectory
  Subclass can override this to customize logic; return true if this file should be written to the RAMDirectory.
doDelete(int) - Method in class org.apache.lucene.index.MultiPassIndexSplitter.FakeDeleteIndexReader
DONTNEED - Static variable in class org.apache.lucene.store.NativePosixUtil
doUndeleteAll() - Method in class org.apache.lucene.index.MultiPassIndexSplitter.FakeDeleteIndexReader
  Just removes our overlaid deletions - does not undelete the original deletions.

## F

FieldNormModifier - Class in org.apache.lucene.index
  Given a directory and a list of fields, updates the fieldNorms in place for every document.
FieldNormModifier(Directory, Similarity) - Constructor for class org.apache.lucene.index.FieldNormModifier
  Constructor for code that wishes to use this class programmatically If Similarity is null, kill the field norms.
fileExists(String) - Method in class org.apache.lucene.store.NRTCachingDirectory
fileLength(String) - Method in class org.apache.lucene.store.NRTCachingDirectory
fileModified(String) - Method in class org.apache.lucene.store.NRTCachingDirectory
findMerges(SegmentInfos) - Method in class org.apache.lucene.index.BalancedSegmentMergePolicy
findMergesForOptimize(SegmentInfos, int, Map<SegmentInfo, Boolean>) - Method in class org.apache.lucene.index.BalancedSegmentMergePolicy
findMergesToExpungeDeletes(SegmentInfos) - Method in class org.apache.lucene.index.BalancedSegmentMergePolicy

## G

get() - Method in class org.apache.lucene.index.NRTManager
  Returns the most current searcher.
get(boolean) - Method in class org.apache.lucene.index.NRTManager
  Just like `NRTManager.get()`, but by passing `false` for requireDeletes, you can get faster reopen time, but the returned reader is allowed to not reflect all deletions.
get(long) - Method in class org.apache.lucene.index.NRTManager
  Call this if you require a searcher reflecting all changes as of the target generation.
get(long, boolean) - Method in class org.apache.lucene.index.NRTManager
  Call this if you require a searcher reflecting all changes as of the target generation, and you don't require deletions to be reflected.
getCurrentSearchingGen(boolean) - Method in class org.apache.lucene.index.NRTManager
  Returns generation of current searcher.
getHighFreqTerms(IndexReader, int, String) - Static method in class org.apache.lucene.misc.HighFreqTerms
getLockFactory() - Method in class org.apache.lucene.store.NRTCachingDirectory
getLockID() - Method in class org.apache.lucene.store.NRTCachingDirectory
getMaxMergeDocs() - Method in class org.apache.lucene.index.BalancedSegmentMergePolicy.MergePolicyParams
getMaxSmallSegments() - Method in class org.apache.lucene.index.BalancedSegmentMergePolicy
getMaxSmallSegments() - Method in class org.apache.lucene.index.BalancedSegmentMergePolicy.MergePolicyParams
getMergeFactor() - Method in class org.apache.lucene.index.BalancedSegmentMergePolicy.MergePolicyParams
getMergeScheduler() - Method in class org.apache.lucene.store.NRTCachingDirectory
getNumLargeSegments() - Method in class org.apache.lucene.index.BalancedSegmentMergePolicy
getNumLargeSegments() - Method in class org.apache.lucene.index.BalancedSegmentMergePolicy.MergePolicyParams
getPartialExpunge() - Method in class org.apache.lucene.index.BalancedSegmentMergePolicy
getPartialExpunge() - Method in class org.apache.lucene.index.BalancedSegmentMergePolicy.MergePolicyParams
getSequentialSubReaders() - Method in class org.apache.lucene.index.MultiPassIndexSplitter.FakeDeleteIndexReader
getSequentialSubReaders() - Method in class org.apache.lucene.index.PKIndexSplitter.DocumentFilteredIndexReader
GetTermInfo - Class in org.apache.lucene.misc
GetTermInfo() - Constructor for class org.apache.lucene.misc.GetTermInfo
getTermInfo(Directory, Term) - Static method in class org.apache.lucene.misc.GetTermInfo
getTotalTermFreq(IndexReader, Term) - Static method in class org.apache.lucene.misc.HighFreqTerms

## H

hasDeletions() - Method in class org.apache.lucene.index.MultiPassIndexSplitter.FakeDeleteIndexReader
hasDeletions() - Method in class org.apache.lucene.index.PKIndexSplitter.DocumentFilteredIndexReader
HighFreqTerms - Class in org.apache.lucene.misc
  `HighFreqTerms` class extracts the top n most frequent terms (by document frequency ) from an existing Lucene index and reports their document frequency.
HighFreqTerms() - Constructor for class org.apache.lucene.misc.HighFreqTerms
hyperbolicTf(float) - Method in class org.apache.lucene.misc.SweetSpotSimilarity
  Uses a hyperbolic tangent function that allows for a hard max...

## I

IndexMergeTool - Class in org.apache.lucene.misc
  Merges indices specified on the command line into the index specified as the first command line argument.
IndexMergeTool() - Constructor for class org.apache.lucene.misc.IndexMergeTool
IndexSorter - Class in org.apache.lucene.index
  Sort an index by document importance factor.
IndexSorter() - Constructor for class org.apache.lucene.index.IndexSorter
IndexSplitter - Class in org.apache.lucene.index
  Command-line tool that enables listing segments in an index, copying specific segments to another index, and deleting segments from an index.
IndexSplitter(File) - Constructor for class org.apache.lucene.index.IndexSplitter
infos - Variable in class org.apache.lucene.index.IndexSplitter
isDeleted(int) - Method in class org.apache.lucene.index.MultiPassIndexSplitter.FakeDeleteIndexReader
isDeleted(int) - Method in class org.apache.lucene.index.PKIndexSplitter.DocumentFilteredIndexReader
isUseCompoundFile() - Method in class org.apache.lucene.index.BalancedSegmentMergePolicy.MergePolicyParams

## L

length() - Method in class org.apache.lucene.store.WindowsDirectory.WindowsIndexInput
listAll() - Method in class org.apache.lucene.store.NRTCachingDirectory
listCachedFiles() - Method in class org.apache.lucene.store.NRTCachingDirectory
listSegments() - Method in class org.apache.lucene.index.IndexSplitter

## M

madvise(ByteBuffer, int) - Static method in class org.apache.lucene.store.NativePosixUtil
main(String[]) - Static method in class org.apache.lucene.index.FieldNormModifier
  Command Line Execution method.
main(String[]) - Static method in class org.apache.lucene.index.IndexSorter
main(String[]) - Static method in class org.apache.lucene.index.IndexSplitter
main(String[]) - Static method in class org.apache.lucene.index.MultiPassIndexSplitter
main(String[]) - Static method in class org.apache.lucene.misc.GetTermInfo
main(String[]) - Static method in class org.apache.lucene.misc.HighFreqTerms
main(String[]) - Static method in class org.apache.lucene.misc.IndexMergeTool
makeLock(String) - Method in class org.apache.lucene.store.NRTCachingDirectory
MultiPassIndexSplitter - Class in org.apache.lucene.index
  This tool splits input index into multiple equal parts.
MultiPassIndexSplitter() - Constructor for class org.apache.lucene.index.MultiPassIndexSplitter
MultiPassIndexSplitter.FakeDeleteIndexReader - Class in org.apache.lucene.index
  This class pretends that it can write deletions to the underlying index.
MultiPassIndexSplitter.FakeDeleteIndexReader(IndexReader) - Constructor for class org.apache.lucene.index.MultiPassIndexSplitter.FakeDeleteIndexReader

## N

NativePosixUtil - Class in org.apache.lucene.store
NativePosixUtil() - Constructor for class org.apache.lucene.store.NativePosixUtil
NOREUSE - Static variable in class org.apache.lucene.store.NativePosixUtil
NORMAL - Static variable in class org.apache.lucene.store.NativePosixUtil
NRTCachingDirectory - Class in org.apache.lucene.store
  Wraps a `RAMDirectory` around any provided delegate directory, to be used during NRT search.
NRTCachingDirectory(Directory, double, double) - Constructor for class org.apache.lucene.store.NRTCachingDirectory
  We will cache a newly created output if 1) it's a flush or a merge and the estimated size of the merged segment is <= maxMergeSizeMB, and 2) the total cached bytes is <= maxCachedMB
NRTManager - Class in org.apache.lucene.index
  Utility class to manage sharing near-real-time searchers across multiple searching threads.
NRTManager(IndexWriter) - Constructor for class org.apache.lucene.index.NRTManager
  Create new NRTManager.
NRTManager(IndexWriter, ExecutorService) - Constructor for class org.apache.lucene.index.NRTManager
  Create new NRTManager.
NRTManager.WaitingListener - Interface in org.apache.lucene.index
  NRTManager invokes this interface to notify it when a caller is waiting for a specific generation searcher to be visible.
NRTManagerReopenThread - Class in org.apache.lucene.index
  Utility class that runs a reopen thread to periodically reopen the NRT searchers in the provided `NRTManager`.
NRTManagerReopenThread(NRTManager, double, double) - Constructor for class org.apache.lucene.index.NRTManagerReopenThread
  Create NRTManagerReopenThread, to periodically reopen the NRT searcher.
numDocs() - Method in class org.apache.lucene.index.MultiPassIndexSplitter.FakeDeleteIndexReader
numDocs() - Method in class org.apache.lucene.index.PKIndexSplitter.DocumentFilteredIndexReader
numTerms - Static variable in class org.apache.lucene.misc.HighFreqTerms

## O

open_direct(String, boolean) - Static method in class org.apache.lucene.store.NativePosixUtil
openInput(String, int) - Method in class org.apache.lucene.store.DirectIOLinuxDirectory
openInput(String) - Method in class org.apache.lucene.store.NRTCachingDirectory
openInput(String, int) - Method in class org.apache.lucene.store.NRTCachingDirectory
openInput(String, int) - Method in class org.apache.lucene.store.WindowsDirectory
org.apache.lucene.index - package org.apache.lucene.index
org.apache.lucene.misc - package org.apache.lucene.misc
org.apache.lucene.store - package org.apache.lucene.store

## P

PKIndexSplitter - Class in org.apache.lucene.index
  Split an index based on a `Filter`.
PKIndexSplitter(Directory, Directory, Directory, Filter) - Constructor for class org.apache.lucene.index.PKIndexSplitter
  Deprecated. use `PKIndexSplitter.PKIndexSplitter(Version, Directory, Directory, Directory, Filter)` instead. This constructor will be removed in Lucene 4.0.
PKIndexSplitter(Directory, Directory, Directory, Term) - Constructor for class org.apache.lucene.index.PKIndexSplitter
  Deprecated. use `PKIndexSplitter.PKIndexSplitter(Version, Directory, Directory, Directory, Term)` instead. This constructor will be removed in Lucene 4.0.
PKIndexSplitter(Version, Directory, Directory, Directory, Filter) - Constructor for class org.apache.lucene.index.PKIndexSplitter
  Split an index based on a `Filter`.
PKIndexSplitter(Directory, Directory, Directory, Filter, IndexWriterConfig, IndexWriterConfig) - Constructor for class org.apache.lucene.index.PKIndexSplitter
PKIndexSplitter(Version, Directory, Directory, Directory, Term) - Constructor for class org.apache.lucene.index.PKIndexSplitter
  Split an index based on a given primary key term and a 'middle' term.
PKIndexSplitter(Directory, Directory, Directory, Term, IndexWriterConfig, IndexWriterConfig) - Constructor for class org.apache.lucene.index.PKIndexSplitter
PKIndexSplitter.DocumentFilteredIndexReader - Class in org.apache.lucene.index
PKIndexSplitter.DocumentFilteredIndexReader(IndexReader, Filter, boolean) - Constructor for class org.apache.lucene.index.PKIndexSplitter.DocumentFilteredIndexReader
posix_madvise(ByteBuffer, int) - Static method in class org.apache.lucene.store.NativePosixUtil
pread(FileDescriptor, long, ByteBuffer) - Static method in class org.apache.lucene.store.NativePosixUtil

## R

RANDOM - Static variable in class org.apache.lucene.store.NativePosixUtil
readInternal(byte[], int, int) - Method in class org.apache.lucene.store.WindowsDirectory.WindowsIndexInput
release(IndexSearcher) - Method in class org.apache.lucene.index.NRTManager
  Release the searcher obtained from `NRTManager.get()` or `NRTManager.get(long)`.
remove(String[]) - Method in class org.apache.lucene.index.IndexSplitter
removeWaitingListener(NRTManager.WaitingListener) - Method in class org.apache.lucene.index.NRTManager
  Remove a listener added with `NRTManager.addWaitingListener(org.apache.lucene.index.NRTManager.WaitingListener)`.
reopen(boolean) - Method in class org.apache.lucene.index.NRTManager
  Call this when you need the NRT reader to reopen.
reSetNorms(String) - Method in class org.apache.lucene.index.FieldNormModifier
  Resets the norms for the specified field.
run() - Method in class org.apache.lucene.index.NRTManagerReopenThread

## S

seekInternal(long) - Method in class org.apache.lucene.store.WindowsDirectory.WindowsIndexInput
SEQUENTIAL - Static variable in class org.apache.lucene.store.NativePosixUtil
setBaselineTfFactors(float, float) - Method in class org.apache.lucene.misc.SweetSpotSimilarity
  Sets the baseline and minimum function variables for baselineTf
setHyperbolicTfFactors(float, float, double, float) - Method in class org.apache.lucene.misc.SweetSpotSimilarity
  Sets the function variables for the hyperbolicTf functions
setLengthNormFactors(int, int, float) - Method in class org.apache.lucene.misc.SweetSpotSimilarity
  Sets the default function variables used by lengthNorm when no field specific variables have been set.
setLengthNormFactors(String, int, int, float, boolean) - Method in class org.apache.lucene.misc.SweetSpotSimilarity
  Sets the function variables used by lengthNorm for a specific named field.
setLockFactory(LockFactory) - Method in class org.apache.lucene.store.NRTCachingDirectory
setMaxMergeDocs(int) - Method in class org.apache.lucene.index.BalancedSegmentMergePolicy.MergePolicyParams
setMaxSmallSegments(int) - Method in class org.apache.lucene.index.BalancedSegmentMergePolicy.MergePolicyParams
setMaxSmallSegments(int) - Method in class org.apache.lucene.index.BalancedSegmentMergePolicy
setMergeFactor(int) - Method in class org.apache.lucene.index.BalancedSegmentMergePolicy.MergePolicyParams
setMergeFactor(int) - Method in class org.apache.lucene.index.BalancedSegmentMergePolicy
setMergePolicyParams(BalancedSegmentMergePolicy.MergePolicyParams) - Method in class org.apache.lucene.index.BalancedSegmentMergePolicy
setNumLargeSegments(int) - Method in class org.apache.lucene.index.BalancedSegmentMergePolicy.MergePolicyParams
setNumLargeSegments(int) - Method in class org.apache.lucene.index.BalancedSegmentMergePolicy
setPartialExpunge(boolean) - Method in class org.apache.lucene.index.BalancedSegmentMergePolicy.MergePolicyParams
setPartialExpunge(boolean) - Method in class org.apache.lucene.index.BalancedSegmentMergePolicy
setUseCompoundFile(boolean) - Method in class org.apache.lucene.index.BalancedSegmentMergePolicy.MergePolicyParams
size(SegmentInfo) - Method in class org.apache.lucene.index.BalancedSegmentMergePolicy
sizeInBytes() - Method in class org.apache.lucene.store.NRTCachingDirectory
  Returns how many bytes are being used by the RAMDirectory cache
sort(Directory, Directory, String) - Method in class org.apache.lucene.index.IndexSorter
sortByTotalTermFreq(IndexReader, TermStats[]) - Static method in class org.apache.lucene.misc.HighFreqTerms
  Takes array of TermStats.
split(File, String[]) - Method in class org.apache.lucene.index.IndexSplitter
split(IndexReader, Directory[], boolean) - Method in class org.apache.lucene.index.MultiPassIndexSplitter
  Deprecated. use `MultiPassIndexSplitter.split(Version, IndexReader, Directory[], boolean)` instead. This method will be removed in Lucene 4.0.
split(Version, IndexReader, Directory[], boolean) - Method in class org.apache.lucene.index.MultiPassIndexSplitter
  Split source index into multiple parts.
split() - Method in class org.apache.lucene.index.PKIndexSplitter
SweetSpotSimilarity - Class in org.apache.lucene.misc
  A similarity with a lengthNorm that provides for a "plateau" of equally good lengths, and tf helper functions.
SweetSpotSimilarity() - Constructor for class org.apache.lucene.misc.SweetSpotSimilarity
sync(Collection<String>) - Method in class org.apache.lucene.store.NRTCachingDirectory

## T

termPositions() - Method in class org.apache.lucene.index.MultiPassIndexSplitter.FakeDeleteIndexReader
termPositions() - Method in class org.apache.lucene.index.PKIndexSplitter.DocumentFilteredIndexReader
TermVectorAccessor - Class in org.apache.lucene.index
  Transparent access to the vector space model, either via TermFreqVector or by resolving it from the inverted index.
TermVectorAccessor() - Constructor for class org.apache.lucene.index.TermVectorAccessor
tf(int) - Method in class org.apache.lucene.misc.SweetSpotSimilarity
  Delegates to baselineTf
toString() - Method in class org.apache.lucene.store.NRTCachingDirectory
touchFile(String) - Method in class org.apache.lucene.store.NRTCachingDirectory
  Deprecated.

## U

updateDocument(Term, Document, Analyzer) - Method in class org.apache.lucene.index.NRTManager
updateDocument(Term, Document) - Method in class org.apache.lucene.index.NRTManager
updateDocuments(Term, Collection<Document>, Analyzer) - Method in class org.apache.lucene.index.NRTManager
updateDocuments(Term, Collection<Document>) - Method in class org.apache.lucene.index.NRTManager

## W

waiting(boolean, long) - Method in interface org.apache.lucene.index.NRTManager.WaitingListener
waiting(boolean, long) - Method in class org.apache.lucene.index.NRTManagerReopenThread
warm(IndexReader) - Method in class org.apache.lucene.index.NRTManager
  Override this to warm the newly opened reader before it's swapped in.
WILLNEED - Static variable in class org.apache.lucene.store.NativePosixUtil
WindowsDirectory - Class in org.apache.lucene.store
  Native `Directory` implementation for Microsoft Windows.
WindowsDirectory(File, LockFactory) - Constructor for class org.apache.lucene.store.WindowsDirectory
  Create a new WindowsDirectory for the named location.
WindowsDirectory(File) - Constructor for class org.apache.lucene.store.WindowsDirectory
  Create a new WindowsDirectory for the named location and `NativeFSLockFactory`.
WindowsDirectory.WindowsIndexInput - Class in org.apache.lucene.store
WindowsDirectory.WindowsIndexInput(File, int) - Constructor for class org.apache.lucene.store.WindowsDirectory.WindowsIndexInput

A B C D F G H I L M N O P R S T U W

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