Index (Lucene 3.6.2 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 R S T U V W

## A

ABSOLUTE_MIN_SORT_BUFFER_SIZE - Static variable in class org.apache.lucene.search.suggest.fst.Sort
  Absolute minimum required buffer size for sorting.
add(BytesRef) - Method in interface org.apache.lucene.search.suggest.fst.BytesRefSorter
  Adds a single suggestion entry (possibly compound with its bucket).
add(BytesRef) - Method in class org.apache.lucene.search.suggest.fst.ExternalRefSorter
add(BytesRef, int) - Method in class org.apache.lucene.search.suggest.fst.FSTCompletionBuilder
  Appends a single suggestion and its weight to the internal buffers.
add(BytesRef) - Method in class org.apache.lucene.search.suggest.fst.InMemorySorter
add(CharSequence, Object) - Method in class org.apache.lucene.search.suggest.jaspell.JaspellLookup
add(CharSequence, Object) - Method in class org.apache.lucene.search.suggest.tst.TSTLookup
append(BytesRef) - Method in class org.apache.lucene.search.suggest.BytesRefList
  Appends a copy of the given `BytesRef` to this `BytesRefList`.
automatic() - Static method in class org.apache.lucene.search.suggest.fst.Sort.BufferSize
  Approximately half of the currently available free heap, but no less than `Sort.ABSOLUTE_MIN_SORT_BUFFER_SIZE`.

## B

balancedTree(Object[], Object[], int, int, TernaryTreeNode) - Method in class org.apache.lucene.search.suggest.tst.TSTAutocomplete
  Inserting keys in TST in the order middle,small,big (lexicographic measure) recursively creates a balanced tree which reduces insertion and search times significantly.
bucket - Variable in class org.apache.lucene.search.suggest.fst.FSTCompletion.Completion
BufferingTermFreqIteratorWrapper - Class in org.apache.lucene.search.suggest
  This wrapper buffers incoming elements.
BufferingTermFreqIteratorWrapper(TermFreqIterator) - Constructor for class org.apache.lucene.search.suggest.BufferingTermFreqIteratorWrapper
bufferSize - Variable in class org.apache.lucene.search.suggest.fst.Sort.SortInfo
build() - Method in class org.apache.lucene.search.suggest.fst.FSTCompletionBuilder
  Builds the final automaton from a list of added entries.
build(TermFreqIterator) - Method in class org.apache.lucene.search.suggest.fst.FSTCompletionLookup
  Builds up a new internal `Lookup` representation based on the given `TermFreqIterator`.
build(TermFreqIterator) - Method in class org.apache.lucene.search.suggest.fst.FSTLookup
  Deprecated.
build(TermFreqIterator) - Method in class org.apache.lucene.search.suggest.fst.WFSTCompletionLookup
build(TermFreqIterator) - Method in class org.apache.lucene.search.suggest.jaspell.JaspellLookup
build(Dictionary) - Method in class org.apache.lucene.search.suggest.Lookup
  Build lookup from a dictionary.
build(TermFreqIterator) - Method in class org.apache.lucene.search.suggest.Lookup
  Builds up a new internal `Lookup` representation based on the given `TermFreqIterator`.
build(TermFreqIterator) - Method in class org.apache.lucene.search.suggest.tst.TSTLookup
BytesRefList - Class in org.apache.lucene.search.suggest
  A simple append only random-access `BytesRef` array that stores full copies of the appended bytes in a `ByteBlockPool`.
BytesRefList() - Constructor for class org.apache.lucene.search.suggest.BytesRefList
  Creates a new `BytesRefList`
BytesRefSorter - Interface in org.apache.lucene.search.suggest.fst
  Collects `BytesRef` and then allows one to iterate over their sorted order.
bytesUsed() - Method in class org.apache.lucene.search.suggest.BytesRefList
  Returns the number internally used bytes to hold the appended bytes in memory

## C

CHARSEQUENCE_COMPARATOR - Static variable in class org.apache.lucene.search.suggest.Lookup
  A simple char-by-char comparator for `CharSequence`
clear() - Method in class org.apache.lucene.search.suggest.BytesRefList
  Clears this `BytesRefList`
clearIndex() - Method in class org.apache.lucene.search.spell.SpellChecker
  Removes all terms from the spell check index.
close() - Method in class org.apache.lucene.search.spell.SpellChecker
  Close the IndexSearcher used by this SpellChecker
close() - Method in class org.apache.lucene.search.suggest.fst.ExternalRefSorter
  Removes any written temporary files.
close() - Method in class org.apache.lucene.search.suggest.fst.Sort.ByteSequencesReader
  Closes the provided `DataInput` if it is `Closeable`.
close() - Method in class org.apache.lucene.search.suggest.fst.Sort.ByteSequencesWriter
  Closes the provided `DataOutput` if it is `Closeable`.
compare(SuggestWord, SuggestWord) - Method in class org.apache.lucene.search.spell.SuggestWordFrequencyComparator
compare(SuggestWord, SuggestWord) - Method in class org.apache.lucene.search.spell.SuggestWordScoreComparator
compareTo(FSTCompletion.Completion) - Method in class org.apache.lucene.search.suggest.fst.FSTCompletion.Completion
compareTo(Lookup.LookupResult) - Method in class org.apache.lucene.search.suggest.Lookup.LookupResult
  Compare alphabetically.
curPos - Variable in class org.apache.lucene.search.suggest.BufferingTermFreqIteratorWrapper

## D

data - Variable in class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie.TSTNode
  The key to the node.
decode(BytesRef, ByteArrayDataInput) - Method in class org.apache.lucene.search.suggest.SortedTermFreqIteratorWrapper
DEFAULT_ACCURACY - Static variable in class org.apache.lucene.search.spell.SpellChecker
  The default minimum score to use, if not specified by calling `SpellChecker.setAccuracy(float)` .
DEFAULT_BUCKETS - Static variable in class org.apache.lucene.search.suggest.fst.FSTCompletion
  Default number of buckets.
DEFAULT_BUCKETS - Static variable in class org.apache.lucene.search.suggest.fst.FSTCompletionBuilder
  Default number of buckets.
DEFAULT_COMPARATOR - Static variable in class org.apache.lucene.search.spell.SuggestWordQueue
DEFAULT_COMPARATOR - Static variable in class org.apache.lucene.search.suggest.fst.Sort
defaultTempDir() - Static method in class org.apache.lucene.search.suggest.fst.Sort
  Returns the default temporary directory.
Dictionary - Interface in org.apache.lucene.search.spell
  A simple interface representing a Dictionary.

## E

encode(Sort.ByteSequencesWriter, ByteArrayDataOutput, byte[], BytesRef, long) - Method in class org.apache.lucene.search.suggest.SortedTermFreqIteratorWrapper
entries - Variable in class org.apache.lucene.search.suggest.BufferingTermFreqIteratorWrapper
EQKID - Static variable in class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie.TSTNode
  Index values for accessing relatives array.
exist(String) - Method in class org.apache.lucene.search.spell.SpellChecker
  Check whether the word exists in the index.
ExternalRefSorter - Class in org.apache.lucene.search.suggest.fst
  Builds and iterates over sequences stored on disk.
ExternalRefSorter(Sort) - Constructor for class org.apache.lucene.search.suggest.fst.ExternalRefSorter
  Will buffer all sequences to a temporary file and then sort (all on-disk).

## F

F_WORD - Static variable in class org.apache.lucene.search.spell.SpellChecker
  Field name for each word in the ngram index.
FileDictionary - Class in org.apache.lucene.search.suggest
  Dictionary represented by a text file.
FileDictionary(InputStream) - Constructor for class org.apache.lucene.search.suggest.FileDictionary
FileDictionary(Reader) - Constructor for class org.apache.lucene.search.suggest.FileDictionary
  Creates a dictionary based on a reader.
FILENAME - Static variable in class org.apache.lucene.search.suggest.fst.FSTLookup
  Deprecated. Serialized automaton file name (storage).
freq - Variable in class org.apache.lucene.search.spell.SuggestWord
  The freq of the word
freqs - Variable in class org.apache.lucene.search.suggest.BufferingTermFreqIteratorWrapper
FSTCompletion - Class in org.apache.lucene.search.suggest.fst
  Finite state automata based implementation of "autocomplete" functionality.
FSTCompletion(FST<Object>, boolean, boolean) - Constructor for class org.apache.lucene.search.suggest.fst.FSTCompletion
FSTCompletion(FST<Object>) - Constructor for class org.apache.lucene.search.suggest.fst.FSTCompletion
  Defaults to higher weights first and exact first.
FSTCompletion.Completion - Class in org.apache.lucene.search.suggest.fst
  A single completion for a given key.
FSTCompletionBuilder - Class in org.apache.lucene.search.suggest.fst
  Finite state automata based implementation of "autocomplete" functionality.
FSTCompletionBuilder() - Constructor for class org.apache.lucene.search.suggest.fst.FSTCompletionBuilder
  Creates an `FSTCompletion` with default options: 10 buckets, exact match promoted to first position and `InMemorySorter` with a comparator obtained from `BytesRef.getUTF8SortedAsUnicodeComparator()`.
FSTCompletionBuilder(int, BytesRefSorter, int) - Constructor for class org.apache.lucene.search.suggest.fst.FSTCompletionBuilder
FSTCompletionLookup - Class in org.apache.lucene.search.suggest.fst
  An adapter from `Lookup` API to `FSTCompletion`.
FSTCompletionLookup() - Constructor for class org.apache.lucene.search.suggest.fst.FSTCompletionLookup
  This constructor prepares for creating a suggested FST using the `FSTCompletionLookup.build(TermFreqIterator)` method.
FSTCompletionLookup(int, boolean) - Constructor for class org.apache.lucene.search.suggest.fst.FSTCompletionLookup
  This constructor prepares for creating a suggested FST using the `FSTCompletionLookup.build(TermFreqIterator)` method.
FSTCompletionLookup(FSTCompletion, boolean) - Constructor for class org.apache.lucene.search.suggest.fst.FSTCompletionLookup
  This constructor takes a pre-built automaton.
FSTLookup - Class in org.apache.lucene.search.suggest.fst
  Deprecated. Use `FSTCompletionLookup` instead.
FSTLookup() - Constructor for class org.apache.lucene.search.suggest.fst.FSTLookup
  Deprecated.
FSTLookup(int, boolean) - Constructor for class org.apache.lucene.search.suggest.fst.FSTLookup
  Deprecated.

## G

GB - Static variable in class org.apache.lucene.search.suggest.fst.Sort
get(BytesRef, int) - Method in class org.apache.lucene.search.suggest.BytesRefList
  Returns the n'th element of this `BytesRefList`
get(CharSequence) - Method in class org.apache.lucene.search.suggest.fst.FSTCompletionLookup
get(CharSequence) - Method in class org.apache.lucene.search.suggest.fst.FSTLookup
  Deprecated. Get the (approximated) weight of a single key (if there is a perfect match for it in the automaton).
get(CharSequence) - Method in class org.apache.lucene.search.suggest.fst.WFSTCompletionLookup
  Returns the weight associated with an input string, or null if it does not exist.
get(CharSequence) - Method in class org.apache.lucene.search.suggest.jaspell.JaspellLookup
get(CharSequence) - Method in class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie
  Retrieve the object indexed by a key.
get(CharSequence) - Method in class org.apache.lucene.search.suggest.tst.TSTLookup
getAccuracy() - Method in class org.apache.lucene.search.spell.SpellChecker
  The accuracy (minimum score) to be used, unless overridden in `SpellChecker.suggestSimilar(String, int, org.apache.lucene.index.IndexReader, String, boolean, float)`, to decide whether a suggestion is included or not.
getAndIncrement(String) - Method in class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie
  Retrieve the `Float` indexed by key, increment it by one unit and store the new `Float`.
getBucket(CharSequence) - Method in class org.apache.lucene.search.suggest.fst.FSTCompletion
  Returns the bucket assigned to a given key (if found) or `-1` if no exact match exists.
getBucketCount() - Method in class org.apache.lucene.search.suggest.fst.FSTCompletion
  Returns the bucket count (discretization thresholds).
getComparator() - Method in class org.apache.lucene.search.spell.SpellChecker
getComparator() - Method in class org.apache.lucene.search.spell.TermFreqIterator.TermFreqIteratorWrapper
getComparator() - Method in class org.apache.lucene.search.suggest.BufferingTermFreqIteratorWrapper
getComparator() - Method in interface org.apache.lucene.search.suggest.fst.BytesRefSorter
getComparator() - Method in class org.apache.lucene.search.suggest.fst.ExternalRefSorter
getComparator() - Method in class org.apache.lucene.search.suggest.fst.InMemorySorter
getComparator() - Method in class org.apache.lucene.search.suggest.fst.Sort
getComparator() - Method in class org.apache.lucene.search.suggest.SortedTermFreqIteratorWrapper
getDistance(String, String) - Method in class org.apache.lucene.search.spell.JaroWinklerDistance
getDistance(String, String) - Method in class org.apache.lucene.search.spell.LevensteinDistance
getDistance(String, String) - Method in class org.apache.lucene.search.spell.NGramDistance
getDistance(String, String) - Method in interface org.apache.lucene.search.spell.StringDistance
  Returns a float between 0 and 1 based on how similar the specified strings are to one another.
getFST() - Method in class org.apache.lucene.search.suggest.fst.FSTCompletion
  Returns the internal automaton.
getKey(JaspellTernarySearchTrie.TSTNode) - Method in class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie
  Returns the key that indexes the node argument.
getNode(CharSequence) - Method in class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie
  Returns the node indexed by key, or `null` if that node doesn't exist.
getNode(CharSequence, JaspellTernarySearchTrie.TSTNode) - Method in class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie
  Returns the node indexed by key, or `null` if that node doesn't exist.
getOrCreateNode(CharSequence) - Method in class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie
  Returns the node indexed by key, creating that node if it doesn't exist, and creating any required intermediate nodes if they don't exist.
getResults() - Method in class org.apache.lucene.search.suggest.Lookup.LookupPriorityQueue
  Returns the top N results in descending order.
getStringDistance() - Method in class org.apache.lucene.search.spell.SpellChecker
  Returns the `StringDistance` instance used by this `SpellChecker` instance.
getThreshold() - Method in class org.apache.lucene.search.spell.JaroWinklerDistance
  Returns the current value of the threshold used for adding the Winkler bonus.
getWordsIterator() - Method in interface org.apache.lucene.search.spell.Dictionary
  Return all words present in the dictionary
getWordsIterator() - Method in class org.apache.lucene.search.spell.HighFrequencyDictionary
getWordsIterator() - Method in class org.apache.lucene.search.spell.LuceneDictionary
getWordsIterator() - Method in class org.apache.lucene.search.spell.PlainTextDictionary
getWordsIterator() - Method in class org.apache.lucene.search.suggest.FileDictionary

## H

HighFrequencyDictionary - Class in org.apache.lucene.search.spell
  HighFrequencyDictionary: terms taken from the given field of a Lucene index, which appear in a number of documents above a given threshold.
HighFrequencyDictionary(IndexReader, String, float) - Constructor for class org.apache.lucene.search.spell.HighFrequencyDictionary
HIKID - Static variable in class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie.TSTNode
  Index values for accessing relatives array.

## I

indexDictionary(Dictionary, IndexWriterConfig, boolean) - Method in class org.apache.lucene.search.spell.SpellChecker
  Indexes the data from the given `Dictionary`.
InMemorySorter - Class in org.apache.lucene.search.suggest.fst
  An `BytesRefSorter` that keeps all the entries in memory.
InMemorySorter(Comparator<BytesRef>) - Constructor for class org.apache.lucene.search.suggest.fst.InMemorySorter
insert(TernaryTreeNode, CharSequence, Object, int) - Method in class org.apache.lucene.search.suggest.tst.TSTAutocomplete
  Inserts a key in TST creating a series of Binary Search Trees at each node.
iterator() - Method in class org.apache.lucene.search.suggest.BytesRefList
  sugar for `BytesRefList.iterator(Comparator)` with a `null` comparator
iterator(Comparator<BytesRef>) - Method in class org.apache.lucene.search.suggest.BytesRefList
  Returns a `BytesRefIterator` with point in time semantics.
iterator() - Method in interface org.apache.lucene.search.suggest.fst.BytesRefSorter
  Sorts the entries added in `BytesRefSorter.add(BytesRef)` and returns an iterator over all sorted entries.
iterator() - Method in class org.apache.lucene.search.suggest.fst.ExternalRefSorter
iterator() - Method in class org.apache.lucene.search.suggest.fst.InMemorySorter

## J

JaroWinklerDistance - Class in org.apache.lucene.search.spell
  Similarity measure for short strings such as person names.
JaroWinklerDistance() - Constructor for class org.apache.lucene.search.spell.JaroWinklerDistance
JaspellLookup - Class in org.apache.lucene.search.suggest.jaspell
JaspellLookup() - Constructor for class org.apache.lucene.search.suggest.jaspell.JaspellLookup
JaspellTernarySearchTrie - Class in org.apache.lucene.search.suggest.jaspell
  Implementation of a Ternary Search Trie, a data structure for storing `String` objects that combines the compact size of a binary search tree with the speed of a digital search trie, and is therefore ideal for practical use in sorting and searching data.
JaspellTernarySearchTrie() - Constructor for class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie
  Constructs an empty Ternary Search Trie.
JaspellTernarySearchTrie(File) - Constructor for class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie
  Constructs a Ternary Search Trie and loads data from a `File` into the Trie.
JaspellTernarySearchTrie(File, boolean) - Constructor for class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie
  Constructs a Ternary Search Trie and loads data from a `File` into the Trie.
JaspellTernarySearchTrie.TSTNode - Class in org.apache.lucene.search.suggest.jaspell
  An inner class of Ternary Search Trie that represents a node in the trie.
JaspellTernarySearchTrie.TSTNode(char, JaspellTernarySearchTrie.TSTNode) - Constructor for class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie.TSTNode
  Constructor method.

## K

key - Variable in class org.apache.lucene.search.suggest.Lookup.LookupResult

## L

lessThan(SuggestWord, SuggestWord) - Method in class org.apache.lucene.search.spell.SuggestWordQueue
lessThan(Lookup.LookupResult, Lookup.LookupResult) - Method in class org.apache.lucene.search.suggest.Lookup.LookupPriorityQueue
LevensteinDistance - Class in org.apache.lucene.search.spell
  Levenstein edit distance class.
LevensteinDistance() - Constructor for class org.apache.lucene.search.spell.LevensteinDistance
  Optimized to run a bit faster than the static getDistance().
lines - Variable in class org.apache.lucene.search.suggest.fst.Sort.SortInfo
load(InputStream) - Method in class org.apache.lucene.search.suggest.fst.FSTCompletionLookup
load(InputStream) - Method in class org.apache.lucene.search.suggest.fst.FSTLookup
  Deprecated.
load(InputStream) - Method in class org.apache.lucene.search.suggest.fst.WFSTCompletionLookup
load(InputStream) - Method in class org.apache.lucene.search.suggest.jaspell.JaspellLookup
load(InputStream) - Method in class org.apache.lucene.search.suggest.Lookup
  Discard current lookup data and load it from a previously saved copy.
load(InputStream) - Method in class org.apache.lucene.search.suggest.tst.TSTLookup
LOKID - Static variable in class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie.TSTNode
  Index values for accessing relatives array.
lookup(CharSequence, int) - Method in class org.apache.lucene.search.suggest.fst.FSTCompletion
  Lookup suggestions to `key`.
lookup(CharSequence, boolean, int) - Method in class org.apache.lucene.search.suggest.fst.FSTCompletionLookup
lookup(CharSequence, boolean, int) - Method in class org.apache.lucene.search.suggest.fst.FSTLookup
  Deprecated. Lookup autocomplete suggestions to `key`.
lookup(CharSequence, boolean, int) - Method in class org.apache.lucene.search.suggest.fst.WFSTCompletionLookup
lookup(CharSequence, boolean, int) - Method in class org.apache.lucene.search.suggest.jaspell.JaspellLookup
Lookup - Class in org.apache.lucene.search.suggest
  Simple Lookup interface for `CharSequence` suggestions.
Lookup() - Constructor for class org.apache.lucene.search.suggest.Lookup
lookup(CharSequence, boolean, int) - Method in class org.apache.lucene.search.suggest.Lookup
  Look up a key and return possible completion for this key.
lookup(CharSequence, boolean, int) - Method in class org.apache.lucene.search.suggest.tst.TSTLookup
Lookup.LookupPriorityQueue - Class in org.apache.lucene.search.suggest
  A `PriorityQueue` collecting a fixed size of high priority `Lookup.LookupResult`
Lookup.LookupPriorityQueue(int) - Constructor for class org.apache.lucene.search.suggest.Lookup.LookupPriorityQueue
Lookup.LookupResult - Class in org.apache.lucene.search.suggest
  Result of a lookup.
Lookup.LookupResult(CharSequence, long) - Constructor for class org.apache.lucene.search.suggest.Lookup.LookupResult
LuceneDictionary - Class in org.apache.lucene.search.spell
  Lucene Dictionary: terms taken from the given field of a Lucene index.
LuceneDictionary(IndexReader, String) - Constructor for class org.apache.lucene.search.spell.LuceneDictionary

## M

matchAlmost(String) - Method in class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie
  Returns a `List` of keys that almost match the argument key.
matchAlmost(CharSequence, int) - Method in class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie
  Returns a `List` of keys that almost match the argument key.
matchPrefix(String) - Method in class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie
  Returns an alphabetical `List` of all keys in the trie that begin with a given prefix.
matchPrefix(CharSequence, int) - Method in class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie
  Returns an alphabetical `List` of all keys in the trie that begin with a given prefix.
MAX_TEMPFILES - Static variable in class org.apache.lucene.search.suggest.fst.Sort
  Maximum number of temporary files before doing an intermediate merge.
MB - Static variable in class org.apache.lucene.search.suggest.fst.Sort
megabytes(long) - Static method in class org.apache.lucene.search.suggest.fst.Sort.BufferSize
  Creates a `Sort.BufferSize` in MB.
mergeRounds - Variable in class org.apache.lucene.search.suggest.fst.Sort.SortInfo
mergeTime - Variable in class org.apache.lucene.search.suggest.fst.Sort.SortInfo
MIN_BUFFER_SIZE_MB - Static variable in class org.apache.lucene.search.suggest.fst.Sort
  Minimum recommended buffer size for sorting.

## N

next() - Method in class org.apache.lucene.search.spell.TermFreqIterator.TermFreqIteratorWrapper
next() - Method in class org.apache.lucene.search.suggest.BufferingTermFreqIteratorWrapper
next() - Method in class org.apache.lucene.search.suggest.SortedTermFreqIteratorWrapper
next() - Method in class org.apache.lucene.search.suggest.UnsortedTermFreqIteratorWrapper
NGramDistance - Class in org.apache.lucene.search.spell
  N-Gram version of edit distance based on paper by Grzegorz Kondrak, "N-gram similarity and distance".
NGramDistance(int) - Constructor for class org.apache.lucene.search.spell.NGramDistance
  Creates an N-Gram distance measure using n-grams of the specified size.
NGramDistance() - Constructor for class org.apache.lucene.search.spell.NGramDistance
  Creates an N-Gram distance measure using n-grams of size 2.
numDataNodes() - Method in class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie
  Returns the number of nodes in the trie that have non-null data.
numDataNodes(JaspellTernarySearchTrie.TSTNode) - Method in class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie
  Returns the number of nodes in the subtrie below and including the starting node.
numNodes() - Method in class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie
  Returns the total number of nodes in the trie.
numNodes(JaspellTernarySearchTrie.TSTNode) - Method in class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie
  Returns the total number of nodes in the subtrie below and including the starting Node.

## O

org.apache.lucene.search.spell - package org.apache.lucene.search.spell
  Suggest alternate spellings for words.
org.apache.lucene.search.suggest - package org.apache.lucene.search.suggest
  Support for Autocomplete/Autosuggest
org.apache.lucene.search.suggest.fst - package org.apache.lucene.search.suggest.fst
  Finite-state based autosuggest.
org.apache.lucene.search.suggest.jaspell - package org.apache.lucene.search.suggest.jaspell
  JaSpell-based autosuggest.
org.apache.lucene.search.suggest.tst - package org.apache.lucene.search.suggest.tst
  Ternary Search Tree based autosuggest.

## P

PARENT - Static variable in class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie.TSTNode
  Index values for accessing relatives array.
PlainTextDictionary - Class in org.apache.lucene.search.spell
  Dictionary represented by a text file.
PlainTextDictionary(File) - Constructor for class org.apache.lucene.search.spell.PlainTextDictionary
PlainTextDictionary(InputStream) - Constructor for class org.apache.lucene.search.spell.PlainTextDictionary
PlainTextDictionary(Reader) - Constructor for class org.apache.lucene.search.spell.PlainTextDictionary
  Creates a dictionary based on a reader.
prefixCompletion(TernaryTreeNode, CharSequence, int) - Method in class org.apache.lucene.search.suggest.tst.TSTAutocomplete
  Auto-completes a given prefix query using Depth-First Search with the end of prefix as source node each time finding a new leaf to get a complete key to be added in the suggest list.
put(CharSequence, Object) - Method in class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie
  Stores a value in the trie.

## R

read(BytesRef) - Method in class org.apache.lucene.search.suggest.fst.Sort.ByteSequencesReader
  Reads the next entry into the provided `BytesRef`.
read() - Method in class org.apache.lucene.search.suggest.fst.Sort.ByteSequencesReader
  Reads the next entry and returns it if successful.
readTime - Variable in class org.apache.lucene.search.suggest.fst.Sort.SortInfo
relatives - Variable in class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie.TSTNode
  The relative nodes.
remove(String) - Method in class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie
  Removes the value indexed by key.

## S

score - Variable in class org.apache.lucene.search.spell.SuggestWord
  the score of the word
setAccuracy(float) - Method in class org.apache.lucene.search.spell.SpellChecker
  Sets the accuracy 0 < minScore < 1; default `SpellChecker.DEFAULT_ACCURACY`
setComparator(Comparator<SuggestWord>) - Method in class org.apache.lucene.search.spell.SpellChecker
  Sets the `Comparator` for the `SuggestWordQueue`.
setMatchAlmostDiff(int) - Method in class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie
  Sets the number of characters by which words can differ from target word when calling the `matchAlmost` method.
setNumReturnValues(int) - Method in class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie
  Sets the default maximum number of values returned from the `matchPrefix` and `matchAlmost` methods.
setSpellIndex(Directory) - Method in class org.apache.lucene.search.spell.SpellChecker
  Use a different index as the spell checker index or re-open the existing index if `spellIndex` is the same value as given in the constructor.
setStringDistance(StringDistance) - Method in class org.apache.lucene.search.spell.SpellChecker
  Sets the `StringDistance` implementation for this `SpellChecker` instance.
setThreshold(float) - Method in class org.apache.lucene.search.spell.JaroWinklerDistance
  Sets the threshold used to determine when Winkler bonus should be used.
size() - Method in class org.apache.lucene.search.suggest.BytesRefList
  Returns the current size of this `BytesRefList`
Sort - Class in org.apache.lucene.search.suggest.fst
  On-disk sorting of byte arrays.
Sort() - Constructor for class org.apache.lucene.search.suggest.fst.Sort
  Defaults constructor.
Sort(Comparator<BytesRef>) - Constructor for class org.apache.lucene.search.suggest.fst.Sort
Sort(Comparator<BytesRef>, Sort.BufferSize, File, int) - Constructor for class org.apache.lucene.search.suggest.fst.Sort
  All-details constructor.
sort(File, File) - Method in class org.apache.lucene.search.suggest.fst.Sort
  Sort input to output, explicit hint for the buffer size.
Sort.BufferSize - Class in org.apache.lucene.search.suggest.fst
  A bit more descriptive unit for constructors.
Sort.ByteSequencesReader - Class in org.apache.lucene.search.suggest.fst
  Utility class to read length-prefixed byte[] entries from an input.
Sort.ByteSequencesReader(File) - Constructor for class org.apache.lucene.search.suggest.fst.Sort.ByteSequencesReader
Sort.ByteSequencesReader(DataInput) - Constructor for class org.apache.lucene.search.suggest.fst.Sort.ByteSequencesReader
Sort.ByteSequencesWriter - Class in org.apache.lucene.search.suggest.fst
  Utility class to emit length-prefixed byte[] entries to an output stream for sorting.
Sort.ByteSequencesWriter(File) - Constructor for class org.apache.lucene.search.suggest.fst.Sort.ByteSequencesWriter
Sort.ByteSequencesWriter(DataOutput) - Constructor for class org.apache.lucene.search.suggest.fst.Sort.ByteSequencesWriter
Sort.SortInfo - Class in org.apache.lucene.search.suggest.fst
  Sort info (debugging mostly).
Sort.SortInfo() - Constructor for class org.apache.lucene.search.suggest.fst.Sort.SortInfo
SortedTermFreqIteratorWrapper - Class in org.apache.lucene.search.suggest
  This wrapper buffers incoming elements and makes sure they are sorted based on given comparator.
SortedTermFreqIteratorWrapper(TermFreqIterator, Comparator<BytesRef>) - Constructor for class org.apache.lucene.search.suggest.SortedTermFreqIteratorWrapper
SortedTermFreqIteratorWrapper(TermFreqIterator, Comparator<BytesRef>, boolean) - Constructor for class org.apache.lucene.search.suggest.SortedTermFreqIteratorWrapper
sortKeys(JaspellTernarySearchTrie.TSTNode, int) - Method in class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie
  Returns keys sorted in alphabetical order.
sortPartition(int) - Method in class org.apache.lucene.search.suggest.fst.Sort
  Sort a single partition in-memory.
sortTime - Variable in class org.apache.lucene.search.suggest.fst.Sort.SortInfo
SpellChecker - Class in org.apache.lucene.search.spell
  Spell Checker class (Main class)
  (initially inspired by the David Spencer code).
SpellChecker(Directory, StringDistance) - Constructor for class org.apache.lucene.search.spell.SpellChecker
  Use the given directory as a spell checker index.
SpellChecker(Directory) - Constructor for class org.apache.lucene.search.spell.SpellChecker
  Use the given directory as a spell checker index with a `LevensteinDistance` as the default `StringDistance`.
SpellChecker(Directory, StringDistance, Comparator<SuggestWord>) - Constructor for class org.apache.lucene.search.spell.SpellChecker
  Use the given directory as a spell checker index with the given `StringDistance` measure and the given `Comparator` for sorting the results.
splitchar - Variable in class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie.TSTNode
  The char used in the split.
store(OutputStream) - Method in class org.apache.lucene.search.suggest.fst.FSTCompletionLookup
store(OutputStream) - Method in class org.apache.lucene.search.suggest.fst.FSTLookup
  Deprecated.
store(OutputStream) - Method in class org.apache.lucene.search.suggest.fst.WFSTCompletionLookup
store(OutputStream) - Method in class org.apache.lucene.search.suggest.jaspell.JaspellLookup
store(OutputStream) - Method in class org.apache.lucene.search.suggest.Lookup
  Persist the constructed lookup data to a directory.
store(OutputStream) - Method in class org.apache.lucene.search.suggest.tst.TSTLookup
string - Variable in class org.apache.lucene.search.spell.SuggestWord
  the suggested word
StringDistance - Interface in org.apache.lucene.search.spell
  Interface for string distances.
SuggestMode - Enum in org.apache.lucene.search.spell
  Set of strategies for suggesting related terms
suggestSimilar(String, int) - Method in class org.apache.lucene.search.spell.SpellChecker
  Suggest similar words.
suggestSimilar(String, int, float) - Method in class org.apache.lucene.search.spell.SpellChecker
  Suggest similar words.
suggestSimilar(String, int, IndexReader, String, boolean) - Method in class org.apache.lucene.search.spell.SpellChecker
  Deprecated. use suggestSimilar(String, int, IndexReader, String, SuggestMode)
  - SuggestMode.SUGGEST_WHEN_NOT_IN_INDEX instead of morePopular=false
  - SuggestMode.SuGGEST_MORE_POPULAR instead of morePopular=true
suggestSimilar(String, int, IndexReader, String, boolean, float) - Method in class org.apache.lucene.search.spell.SpellChecker
  Deprecated. use suggestSimilar(String, int, IndexReader, String, SuggestMode, float)
  - SuggestMode.SUGGEST_WHEN_NOT_IN_INDEX instead of morePopular=false
  - SuggestMode.SuGGEST_MORE_POPULAR instead of morePopular=true
suggestSimilar(String, int, IndexReader, String, SuggestMode) - Method in class org.apache.lucene.search.spell.SpellChecker
  Calls `suggestSimilar(word, numSug, ir, suggestMode, field, this.accuracy)`
suggestSimilar(String, int, IndexReader, String, SuggestMode, float) - Method in class org.apache.lucene.search.spell.SpellChecker
  Suggest similar words (optionally restricted to a field of an index).
SuggestWord - Class in org.apache.lucene.search.spell
  SuggestWord, used in suggestSimilar method in SpellChecker class.
SuggestWord() - Constructor for class org.apache.lucene.search.spell.SuggestWord
SuggestWordFrequencyComparator - Class in org.apache.lucene.search.spell
  Frequency first, then score.
SuggestWordFrequencyComparator() - Constructor for class org.apache.lucene.search.spell.SuggestWordFrequencyComparator
SuggestWordQueue - Class in org.apache.lucene.search.spell
  Sorts SuggestWord instances
SuggestWordQueue(int) - Constructor for class org.apache.lucene.search.spell.SuggestWordQueue
  Use the `SuggestWordQueue.DEFAULT_COMPARATOR`
SuggestWordQueue(int, Comparator<SuggestWord>) - Constructor for class org.apache.lucene.search.spell.SuggestWordQueue
  Specify the size of the queue and the comparator to use for sorting.
SuggestWordScoreComparator - Class in org.apache.lucene.search.spell
  Score first, then frequency
SuggestWordScoreComparator() - Constructor for class org.apache.lucene.search.spell.SuggestWordScoreComparator

## T

tempMergeFiles - Variable in class org.apache.lucene.search.suggest.fst.Sort.SortInfo
TermFreqIterator - Interface in org.apache.lucene.search.spell
  Interface for enumerating term,weight pairs.
TermFreqIterator.TermFreqIteratorWrapper - Class in org.apache.lucene.search.spell
  Wraps a BytesRefIterator as a TermFreqIterator, with all weights set to `1`
TermFreqIterator.TermFreqIteratorWrapper(BytesRefIterator) - Constructor for class org.apache.lucene.search.spell.TermFreqIterator.TermFreqIteratorWrapper
TernaryTreeNode - Class in org.apache.lucene.search.suggest.tst
  The class creates a TST node.
TernaryTreeNode() - Constructor for class org.apache.lucene.search.suggest.tst.TernaryTreeNode
toString() - Method in class org.apache.lucene.search.suggest.fst.FSTCompletion.Completion
toString() - Method in class org.apache.lucene.search.suggest.fst.Sort.SortInfo
toString() - Method in class org.apache.lucene.search.suggest.Lookup.LookupResult
totalTime - Variable in class org.apache.lucene.search.suggest.fst.Sort.SortInfo
TSTAutocomplete - Class in org.apache.lucene.search.suggest.tst
TSTAutocomplete() - Constructor for class org.apache.lucene.search.suggest.tst.TSTAutocomplete
TSTLookup - Class in org.apache.lucene.search.suggest.tst
TSTLookup() - Constructor for class org.apache.lucene.search.suggest.tst.TSTLookup

## U

UnsortedTermFreqIteratorWrapper - Class in org.apache.lucene.search.suggest
  This wrapper buffers the incoming elements and makes sure they are in random order.
UnsortedTermFreqIteratorWrapper(TermFreqIterator) - Constructor for class org.apache.lucene.search.suggest.UnsortedTermFreqIteratorWrapper
utf8 - Variable in class org.apache.lucene.search.suggest.fst.FSTCompletion.Completion

## V

value - Variable in class org.apache.lucene.search.suggest.Lookup.LookupResult
valueOf(String) - Static method in enum org.apache.lucene.search.spell.SuggestMode
  Returns the enum constant of this type with the specified name.
values() - Static method in enum org.apache.lucene.search.spell.SuggestMode
  Returns an array containing the constants of this enum type, in the order they're declared.

## W

weight() - Method in class org.apache.lucene.search.spell.TermFreqIterator.TermFreqIteratorWrapper
weight() - Method in interface org.apache.lucene.search.spell.TermFreqIterator
weight() - Method in class org.apache.lucene.search.suggest.BufferingTermFreqIteratorWrapper
weight() - Method in class org.apache.lucene.search.suggest.SortedTermFreqIteratorWrapper
weight() - Method in class org.apache.lucene.search.suggest.UnsortedTermFreqIteratorWrapper
WFSTCompletionLookup - Class in org.apache.lucene.search.suggest.fst
  Suggester based on a weighted FST: it first traverses the prefix, then walks the n shortest paths to retrieve top-ranked suggestions.
WFSTCompletionLookup() - Constructor for class org.apache.lucene.search.suggest.fst.WFSTCompletionLookup
  Calls `WFSTCompletionLookup(true)`
WFSTCompletionLookup(boolean) - Constructor for class org.apache.lucene.search.suggest.fst.WFSTCompletionLookup
  Creates a new suggester.
write(BytesRef) - Method in class org.apache.lucene.search.suggest.fst.Sort.ByteSequencesWriter
write(byte[]) - Method in class org.apache.lucene.search.suggest.fst.Sort.ByteSequencesWriter
write(byte[], int, int) - Method in class org.apache.lucene.search.suggest.fst.Sort.ByteSequencesWriter

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

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