Uses of Class
org.apache.lucene.util.fst.FST

Packages that use FST

Package	Description
org.apache.lucene.analysis.charfilter	Normalization of text before the tokenizer.
org.apache.lucene.analysis.hunspell	A Java implementation of Hunspell stemming and spell-checking algorithms (Hunspell), and a stemming TokenFilter (HunspellStemFilter) based on it.
org.apache.lucene.analysis.ja.dict	Kuromoji dictionary implementation.
org.apache.lucene.analysis.ja.util	Kuromoji utility classes.
org.apache.lucene.analysis.ko.dict	Korean dictionary implementation.
org.apache.lucene.analysis.ko.util	Nori utility classes.
org.apache.lucene.analysis.miscellaneous	Miscellaneous Tokenstreams.
org.apache.lucene.analysis.synonym	Analysis components for Synonyms.
org.apache.lucene.backward_codecs.lucene40.blocktree	BlockTree terms dictionary.
org.apache.lucene.classification	Uses already seen data (the indexed documents) to classify an input ( can be simple text or a structured document).
org.apache.lucene.codecs.blockterms	Pluggable term index / block terms dictionary implementations.
org.apache.lucene.codecs.blocktreeords	Same postings format as Lucene50, except the terms dictionary also supports ords, i.e.
org.apache.lucene.codecs.lucene90.blocktree	BlockTree terms dictionary.
org.apache.lucene.codecs.memory	Term dictionary, DocValues or Postings formats that are read entirely into memory.
org.apache.lucene.codecs.simpletext	Simpletext Codec: writes human readable postings.
org.apache.lucene.codecs.uniformsplit	Pluggable term index / block terms dictionary implementations.
org.apache.lucene.sandbox.codecs.idversion	A primary-key postings format that associates a version (long) with each term and can provide fail-fast lookups by ID and version.
org.apache.lucene.search.suggest.analyzing	Analyzer based autosuggest.
org.apache.lucene.search.suggest.document	Support for document suggestion
org.apache.lucene.search.suggest.fst	Finite-state based autosuggest.
org.apache.lucene.util.fst	Finite state transducers

Uses of FST in org.apache.lucene.analysis.charfilter

Fields in org.apache.lucene.analysis.charfilter declared as FST

Modifier and Type	Field	Description
private final FST<CharsRef>	MappingCharFilter.map
(package private) final FST<CharsRef>	NormalizeCharMap.map

Constructors in org.apache.lucene.analysis.charfilter with parameters of type FST

Modifier	Constructor	Description
private	NormalizeCharMap(FST<CharsRef> map)

Uses of FST in org.apache.lucene.analysis.hunspell

Fields in org.apache.lucene.analysis.hunspell declared as FST

Modifier and Type	Field	Description
private final FST<CharsRef>	ConvTable.fst
(package private) FST<IntsRef>	Dictionary.prefixes
(package private) FST<IntsRef>	Dictionary.suffixes

Methods in org.apache.lucene.analysis.hunspell that return FST

Modifier and Type	Method	Description
private FST<IntsRef>	Dictionary.affixFST(TreeMap<String,IntArrayList> affixes)

Methods in org.apache.lucene.analysis.hunspell with parameters of type FST

Modifier and Type	Method	Description
private void	WordFormGenerator.fillAffixMap(FST<IntsRef> fst, AffixKind kind)
private IntsRef	Dictionary.lookup(FST<IntsRef> fst, char[] word)
(package private) static IntsRef	Dictionary.nextArc(FST<IntsRef> fst, FST.Arc<IntsRef> arc, FST.BytesReader reader, IntsRef output, int ch)

Uses of FST in org.apache.lucene.analysis.ja.dict

Fields in org.apache.lucene.analysis.ja.dict declared as FST

Modifier and Type	Field	Description
private final FST<Long>	TokenInfoFST.fst

Methods in org.apache.lucene.analysis.ja.dict that return FST

Modifier and Type	Method	Description
(package private) FST<Long>	TokenInfoFST.getInternalFST()

Constructors in org.apache.lucene.analysis.ja.dict with parameters of type FST

Modifier	Constructor	Description
	TokenInfoFST(FST<Long> fst, boolean fasterButMoreRam)

Uses of FST in org.apache.lucene.analysis.ja.util

Fields in org.apache.lucene.analysis.ja.util declared as FST

Modifier and Type	Field	Description
private FST<Long>	TokenInfoDictionaryWriter.fst

Methods in org.apache.lucene.analysis.ja.util with parameters of type FST

Modifier and Type	Method	Description
void	TokenInfoDictionaryWriter.setFST(FST<Long> fst)

Uses of FST in org.apache.lucene.analysis.ko.dict

Fields in org.apache.lucene.analysis.ko.dict declared as FST

Modifier and Type	Field	Description
private final FST<Long>	TokenInfoFST.fst

Methods in org.apache.lucene.analysis.ko.dict that return FST

Modifier and Type	Method	Description
(package private) FST<Long>	TokenInfoFST.getInternalFST()

Constructors in org.apache.lucene.analysis.ko.dict with parameters of type FST

Modifier	Constructor	Description
	TokenInfoFST(FST<Long> fst)

Uses of FST in org.apache.lucene.analysis.ko.util

Fields in org.apache.lucene.analysis.ko.util declared as FST

Modifier and Type	Field	Description
private FST<Long>	TokenInfoDictionaryWriter.fst

Methods in org.apache.lucene.analysis.ko.util with parameters of type FST

Modifier and Type	Method	Description
void	TokenInfoDictionaryWriter.setFST(FST<Long> fst)

Uses of FST in org.apache.lucene.analysis.miscellaneous

Fields in org.apache.lucene.analysis.miscellaneous declared as FST

Modifier and Type	Field	Description
private final FST<BytesRef>	StemmerOverrideFilter.StemmerOverrideMap.fst

Constructors in org.apache.lucene.analysis.miscellaneous with parameters of type FST

Modifier	Constructor	Description
	StemmerOverrideMap(FST<BytesRef> fst, boolean ignoreCase)	Creates a new StemmerOverrideFilter.StemmerOverrideMap

Uses of FST in org.apache.lucene.analysis.synonym

Fields in org.apache.lucene.analysis.synonym declared as FST

Modifier and Type	Field	Description
private final FST<BytesRef>	SynonymFilter.fst	Deprecated.
private final FST<BytesRef>	SynonymGraphFilter.fst
final FST<BytesRef>	SynonymMap.fst	map<input word, list<ord>>

Constructors in org.apache.lucene.analysis.synonym with parameters of type FST

Modifier	Constructor	Description
	SynonymMap(FST<BytesRef> fst, BytesRefHash words, int maxHorizontalContext)

Uses of FST in org.apache.lucene.backward_codecs.lucene40.blocktree

Fields in org.apache.lucene.backward_codecs.lucene40.blocktree declared as FST

Modifier and Type	Field	Description
(package private) final FST<BytesRef>	FieldReader.index

Uses of FST in org.apache.lucene.classification

Fields in org.apache.lucene.classification declared as FST

Modifier and Type	Field	Description
private FST<Long>	BooleanPerceptronClassifier.fst

Uses of FST in org.apache.lucene.codecs.blockterms

Fields in org.apache.lucene.codecs.blockterms declared as FST

Modifier and Type	Field	Description
private final FST<Long>	VariableGapTermsIndexReader.FieldIndexData.fst
(package private) FST<Long>	VariableGapTermsIndexWriter.FSTFieldWriter.fst

Constructors in org.apache.lucene.codecs.blockterms with parameters of type FST

Modifier	Constructor	Description
	IndexEnum(FST<Long> fst)

Uses of FST in org.apache.lucene.codecs.blocktreeords

Fields in org.apache.lucene.codecs.blocktreeords declared as FST

Modifier and Type	Field	Description
FST<FSTOrdsOutputs.Output>	OrdsBlockTreeTermsWriter.PendingBlock.index
final FST<FSTOrdsOutputs.Output>	OrdsBlockTreeTermsWriter.SubIndex.index
(package private) final FST<FSTOrdsOutputs.Output>	OrdsFieldReader.index

Methods in org.apache.lucene.codecs.blocktreeords with parameters of type FST

Modifier and Type	Method	Description
private void	OrdsBlockTreeTermsWriter.PendingBlock.append(FSTCompiler<FSTOrdsOutputs.Output> fstCompiler, FST<FSTOrdsOutputs.Output> subIndex, long termOrdOffset, IntsRefBuilder scratchIntsRef)

Constructors in org.apache.lucene.codecs.blocktreeords with parameters of type FST

Modifier	Constructor	Description
	SubIndex(FST<FSTOrdsOutputs.Output> index, long termOrdStart)

Uses of FST in org.apache.lucene.codecs.lucene90.blocktree

Fields in org.apache.lucene.codecs.lucene90.blocktree declared as FST

Modifier and Type	Field	Description
(package private) final FST<BytesRef>	FieldReader.index
FST<BytesRef>	Lucene90BlockTreeTermsWriter.PendingBlock.index

Fields in org.apache.lucene.codecs.lucene90.blocktree with type parameters of type FST

Modifier and Type	Field	Description
List<FST<BytesRef>>	Lucene90BlockTreeTermsWriter.PendingBlock.subIndices

Methods in org.apache.lucene.codecs.lucene90.blocktree with parameters of type FST

Modifier and Type	Method	Description
private void	Lucene90BlockTreeTermsWriter.PendingBlock.append(FSTCompiler<BytesRef> fstCompiler, FST<BytesRef> subIndex, IntsRefBuilder scratchIntsRef)

Constructor parameters in org.apache.lucene.codecs.lucene90.blocktree with type arguments of type FST

Modifier	Constructor	Description
	PendingBlock(BytesRef prefix, long fp, boolean hasTerms, boolean isFloor, int floorLeadByte, List<FST<BytesRef>> subIndices)

Uses of FST in org.apache.lucene.codecs.memory

Fields in org.apache.lucene.codecs.memory declared as FST

Modifier and Type	Field	Description
(package private) final FST<FSTTermOutputs.TermData>	FSTTermsReader.TermsReader.dict
final FST<FSTTermOutputs.TermData>	FSTTermsWriter.FieldMetaData.dict
(package private) final FST<FSTTermOutputs.TermData>	FSTTermsReader.TermsReader.IntersectTermsEnum.fst

Methods in org.apache.lucene.codecs.memory with parameters of type FST

Modifier and Type	Method	Description
(package private) static <T> void	FSTTermsReader.walk(FST<T> fst)

Constructors in org.apache.lucene.codecs.memory with parameters of type FST

Modifier	Constructor	Description
	FieldMetaData(FieldInfo fieldInfo, long numTerms, long sumTotalTermFreq, long sumDocFreq, int docCount, FST<FSTTermOutputs.TermData> fst)

Uses of FST in org.apache.lucene.codecs.simpletext

Fields in org.apache.lucene.codecs.simpletext declared as FST

Modifier and Type	Field	Description
private FST<PairOutputs.Pair<PairOutputs.Pair<Long,Long>,PairOutputs.Pair<Long,Long>>>	SimpleTextFieldsReader.SimpleTextTerms.fst

Constructors in org.apache.lucene.codecs.simpletext with parameters of type FST

Modifier	Constructor	Description
	SimpleTextTermsEnum(FST<PairOutputs.Pair<PairOutputs.Pair<Long,Long>,PairOutputs.Pair<Long,Long>>> fst, IndexOptions indexOptions)

Uses of FST in org.apache.lucene.codecs.uniformsplit

Fields in org.apache.lucene.codecs.uniformsplit declared as FST

Modifier and Type	Field	Description
protected final FST<Long>	FSTDictionary.fst

Constructors in org.apache.lucene.codecs.uniformsplit with parameters of type FST

Modifier	Constructor	Description
protected	FSTDictionary(FST<Long> fst)

Uses of FST in org.apache.lucene.sandbox.codecs.idversion

Fields in org.apache.lucene.sandbox.codecs.idversion declared as FST

Modifier and Type	Field	Description
FST<PairOutputs.Pair<BytesRef,Long>>	VersionBlockTreeTermsWriter.PendingBlock.index
(package private) final FST<PairOutputs.Pair<BytesRef,Long>>	VersionFieldReader.index

Fields in org.apache.lucene.sandbox.codecs.idversion with type parameters of type FST

Modifier and Type	Field	Description
List<FST<PairOutputs.Pair<BytesRef,Long>>>	VersionBlockTreeTermsWriter.PendingBlock.subIndices

Methods in org.apache.lucene.sandbox.codecs.idversion with parameters of type FST

Modifier and Type	Method	Description
private void	VersionBlockTreeTermsWriter.PendingBlock.append(FSTCompiler<PairOutputs.Pair<BytesRef,Long>> fstCompiler, FST<PairOutputs.Pair<BytesRef,Long>> subIndex, IntsRefBuilder scratchIntsRef)

Constructor parameters in org.apache.lucene.sandbox.codecs.idversion with type arguments of type FST

Modifier	Constructor	Description
	PendingBlock(BytesRef prefix, long maxVersion, long fp, boolean hasTerms, boolean isFloor, int floorLeadByte, List<FST<PairOutputs.Pair<BytesRef,Long>>> subIndices)

Uses of FST in org.apache.lucene.search.suggest.analyzing

Fields in org.apache.lucene.search.suggest.analyzing declared as FST

Modifier and Type	Field	Description
private FST<PairOutputs.Pair<Long,BytesRef>>	AnalyzingSuggester.fst	FST<Weight,Surface>: input is the analyzed form, with a null byte between terms weights are encoded as costs: (Integer.MAX_VALUE-weight) surface is the original, unanalyzed form.
private FST<Long>	FreeTextSuggester.fst	Holds 1gram, 2gram, 3gram models as a single FST.

Methods in org.apache.lucene.search.suggest.analyzing with parameters of type FST

Modifier and Type	Method	Description
protected List<FSTUtil.Path<PairOutputs.Pair<Long,BytesRef>>>	AnalyzingSuggester.getFullPrefixPaths(List<FSTUtil.Path<PairOutputs.Pair<Long,BytesRef>>> prefixPaths, Automaton lookupAutomaton, FST<PairOutputs.Pair<Long,BytesRef>> fst)	Returns all prefix paths to initialize the search.
protected List<FSTUtil.Path<PairOutputs.Pair<Long,BytesRef>>>	FuzzySuggester.getFullPrefixPaths(List<FSTUtil.Path<PairOutputs.Pair<Long,BytesRef>>> prefixPaths, Automaton lookupAutomaton, FST<PairOutputs.Pair<Long,BytesRef>> fst)
static <T> List<FSTUtil.Path<T>>	FSTUtil.intersectPrefixPaths(Automaton a, FST<T> fst)	Enumerates all minimal prefix paths in the automaton that also intersect the FST, accumulating the FST end node and output for each path.
private Long	FreeTextSuggester.lookupPrefix(FST<Long> fst, FST.BytesReader bytesReader, BytesRef scratch, FST.Arc<Long> arc)

Uses of FST in org.apache.lucene.search.suggest.document

Fields in org.apache.lucene.search.suggest.document declared as FST

Modifier and Type	Field	Description
private final FST<PairOutputs.Pair<Long,BytesRef>>	NRTSuggester.fst	FSTinvalid input: '<'Weight,Surface>: input is the analyzed form, with a null byte between terms and a NRTSuggesterBuilder.END_BYTE to denote the end of the input weight is a long surface is the original, unanalyzed form followed by the docID

Constructors in org.apache.lucene.search.suggest.document with parameters of type FST

Modifier	Constructor	Description
private	NRTSuggester(FST<PairOutputs.Pair<Long,BytesRef>> fst, int maxAnalyzedPathsPerOutput, int payloadSep)

Uses of FST in org.apache.lucene.search.suggest.fst

Fields in org.apache.lucene.search.suggest.fst declared as FST

Modifier and Type	Field	Description
private final FST<Object>	FSTCompletion.automaton	Finite state automaton encoding all the lookup terms.
(package private) FST<Object>	FSTCompletionBuilder.automaton	Finite state automaton encoding all the lookup terms.
private FST<Long>	WFSTCompletionLookup.fst	FST, weights are encoded as costs: (Integer.MAX_VALUE-weight)

Methods in org.apache.lucene.search.suggest.fst that return FST

Modifier and Type	Method	Description
private FST<Object>	FSTCompletionBuilder.buildAutomaton(BytesRefSorter sorter)	Builds the final automaton from a list of entries.
FST<Object>	FSTCompletion.getFST()	Returns the internal automaton.

Methods in org.apache.lucene.search.suggest.fst with parameters of type FST

Modifier and Type	Method	Description
private static FST.Arc<Object>[]	FSTCompletion.cacheRootArcs(FST<Object> automaton)	Cache the root node's output arcs starting with completions with the highest weights.

Constructors in org.apache.lucene.search.suggest.fst with parameters of type FST

Modifier	Constructor	Description
	FSTCompletion(FST<Object> automaton)	Defaults to higher weights first and exact first.
	FSTCompletion(FST<Object> automaton, boolean higherWeightsFirst, boolean exactFirst)	Constructs an FSTCompletion, specifying higherWeightsFirst and exactFirst.

Uses of FST in org.apache.lucene.util.fst

Fields in org.apache.lucene.util.fst declared as FST

Modifier and Type	Field	Description
(package private) final FST<T>	FSTCompiler.fst
protected final FST<T>	FSTEnum.fst
private final FST<T>	Util.TopNSearcher.fst

Methods in org.apache.lucene.util.fst that return FST

Modifier and Type	Method	Description
static <T> FST<T>	FST.fromFSTReader(FST.FSTMetadata<T> fstMetadata, FSTReader fstReader)	Create a FST from a FSTReader.
static <T> FST<T>	FST.read(Path path, Outputs<T> outputs)	Reads an automaton from a file.

Methods in org.apache.lucene.util.fst with parameters of type FST

Modifier and Type	Method	Description
(package private) static <T> int	Util.binarySearch(FST<T> fst, FST.Arc<T> arc, int targetLabel)	Perform a binary search of Arcs encoded as a packed array
static <T> T	Util.get(FST<T> fst, BytesRef input)	Looks up the output for this input, or null if the input is not accepted
static <T> T	Util.get(FST<T> fst, IntsRef input)	Looks up the output for this input, or null if the input is not accepted.
static <T> FST.Arc<T>	Util.readCeilArc(int label, FST<T> fst, FST.Arc<T> follow, FST.Arc<T> arc, FST.BytesReader in)	Reads the first arc greater or equal than the given label into the provided arc in place and returns it iff found, otherwise return null.
static <T> Util.TopResults<T>	Util.shortestPaths(FST<T> fst, FST.Arc<T> fromNode, T startOutput, Comparator<T> comparator, int topN, boolean allowEmptyString)	Starting from node, find the top N min cost completions to a final node.
static <T> void	Util.toDot(FST<T> fst, Writer out, boolean sameRank, boolean labelStates)	Dumps an FST to a GraphViz's dot language description for visualization.

Constructors in org.apache.lucene.util.fst with parameters of type FST

Modifier	Constructor	Description
	BytesRefFSTEnum(FST<T> fst)	doFloor controls the behavior of advance: if it's true doFloor is true, advance positions to the biggest term before target.
(package private)	FSTEnum(FST<T> fst)	doFloor controls the behavior of advance: if it's true doFloor is true, advance positions to the biggest term before target.
	IntsRefFSTEnum(FST<T> fst)	doFloor controls the behavior of advance: if it's true doFloor is true, advance positions to the biggest term before target.
	TopNSearcher(FST<T> fst, int topN, int maxQueueDepth, Comparator<T> comparator)	Creates an unbounded TopNSearcher
	TopNSearcher(FST<T> fst, int topN, int maxQueueDepth, Comparator<T> comparator, Comparator<Util.FSTPath<T>> pathComparator)