A B C D F G H I L M N O P R S T 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.
advise(FileDescriptor, long, long, int) - Static method in class org.apache.lucene.store.NativePosixUtil

## B

BalancedSegmentMergePolicy - Class in org.apache.lucene.index
  Deprecated. This class is removed in 4.0; use `TieredMergePolicy` instead.
BalancedSegmentMergePolicy() - Constructor for class org.apache.lucene.index.BalancedSegmentMergePolicy
  Deprecated.
BalancedSegmentMergePolicy.MergePolicyParams - Class in org.apache.lucene.index
  Deprecated. Specifies configuration parameters for BalancedSegmentMergePolicy.
BalancedSegmentMergePolicy.MergePolicyParams() - Constructor for class org.apache.lucene.index.BalancedSegmentMergePolicy.MergePolicyParams
  Deprecated.
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

clone() - Method in class org.apache.lucene.store.WindowsDirectory.WindowsIndexInput
close() - Method in class org.apache.lucene.store.WindowsDirectory.WindowsIndexInput
CompoundFileExtractor - Class in org.apache.lucene.index
  Command-line tool for extracting sub-files out of a compound file.
CompoundFileExtractor() - Constructor for class org.apache.lucene.index.CompoundFileExtractor
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

## D

DEFAULT_NUM_LARGE_SEGMENTS - Static variable in class org.apache.lucene.index.BalancedSegmentMergePolicy
  Deprecated.
DEFAULTnumTerms - Static variable in class org.apache.lucene.misc.HighFreqTerms
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.
DONTNEED - Static variable in class org.apache.lucene.store.NativePosixUtil

## F

FieldNormModifier - Class in org.apache.lucene.index
  Deprecated. This class is broken, as it does not correctly take position overlaps into account.
FieldNormModifier(Directory, Similarity) - Constructor for class org.apache.lucene.index.FieldNormModifier
  Deprecated. Constructor for code that wishes to use this class programmatically If Similarity is null, kill the field norms.
findForcedDeletesMerges(SegmentInfos) - Method in class org.apache.lucene.index.BalancedSegmentMergePolicy
  Deprecated.
findForcedMerges(SegmentInfos, int, Map<SegmentInfo, Boolean>) - Method in class org.apache.lucene.index.BalancedSegmentMergePolicy
  Deprecated.
findMerges(SegmentInfos) - Method in class org.apache.lucene.index.BalancedSegmentMergePolicy
  Deprecated.

## G

getHighFreqTerms(IndexReader, int, String) - Static method in class org.apache.lucene.misc.HighFreqTerms
getMaxMergeDocs() - Method in class org.apache.lucene.index.BalancedSegmentMergePolicy.MergePolicyParams
  Deprecated.
getMaxSmallSegments() - Method in class org.apache.lucene.index.BalancedSegmentMergePolicy
  Deprecated.
getMaxSmallSegments() - Method in class org.apache.lucene.index.BalancedSegmentMergePolicy.MergePolicyParams
  Deprecated.
getMergeFactor() - Method in class org.apache.lucene.index.BalancedSegmentMergePolicy.MergePolicyParams
  Deprecated.
getNumLargeSegments() - Method in class org.apache.lucene.index.BalancedSegmentMergePolicy
  Deprecated.
getNumLargeSegments() - Method in class org.apache.lucene.index.BalancedSegmentMergePolicy.MergePolicyParams
  Deprecated.
getPartialExpunge() - Method in class org.apache.lucene.index.BalancedSegmentMergePolicy
  Deprecated.
getPartialExpunge() - Method in class org.apache.lucene.index.BalancedSegmentMergePolicy.MergePolicyParams
  Deprecated.
GetTermInfo - Class in org.apache.lucene.misc
  Utility to get document frequency and total number of occurrences (sum of the tf for each doc) of a term.
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

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
isUseCompoundFile() - Method in class org.apache.lucene.index.BalancedSegmentMergePolicy.MergePolicyParams
  Deprecated.

## L

length() - Method in class org.apache.lucene.store.WindowsDirectory.WindowsIndexInput
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.CompoundFileExtractor
main(String[]) - Static method in class org.apache.lucene.index.FieldNormModifier
  Deprecated. 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
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

## 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
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, 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
  Miscellaneous index tools.
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
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
remove(String[]) - Method in class org.apache.lucene.index.IndexSplitter
reSetNorms(String) - Method in class org.apache.lucene.index.FieldNormModifier
  Deprecated. Resets the norms for the specified field.

## 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.
setMaxMergeDocs(int) - Method in class org.apache.lucene.index.BalancedSegmentMergePolicy.MergePolicyParams
  Deprecated.
setMaxSmallSegments(int) - Method in class org.apache.lucene.index.BalancedSegmentMergePolicy.MergePolicyParams
  Deprecated.
setMaxSmallSegments(int) - Method in class org.apache.lucene.index.BalancedSegmentMergePolicy
  Deprecated.
setMergeFactor(int) - Method in class org.apache.lucene.index.BalancedSegmentMergePolicy.MergePolicyParams
  Deprecated.
setMergeFactor(int) - Method in class org.apache.lucene.index.BalancedSegmentMergePolicy
  Deprecated.
setMergePolicyParams(BalancedSegmentMergePolicy.MergePolicyParams) - Method in class org.apache.lucene.index.BalancedSegmentMergePolicy
  Deprecated.
setNumLargeSegments(int) - Method in class org.apache.lucene.index.BalancedSegmentMergePolicy.MergePolicyParams
  Deprecated.
setNumLargeSegments(int) - Method in class org.apache.lucene.index.BalancedSegmentMergePolicy
  Deprecated.
setPartialExpunge(boolean) - Method in class org.apache.lucene.index.BalancedSegmentMergePolicy.MergePolicyParams
  Deprecated.
setPartialExpunge(boolean) - Method in class org.apache.lucene.index.BalancedSegmentMergePolicy
  Deprecated.
setUseCompoundFile(boolean) - Method in class org.apache.lucene.index.BalancedSegmentMergePolicy.MergePolicyParams
  Deprecated.
size(SegmentInfo) - Method in class org.apache.lucene.index.BalancedSegmentMergePolicy
  Deprecated.
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

## T

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

## W

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 W