Module org.apache.lucene.suggest

Package org.apache.lucene.search.suggest.document

Class NRTSuggesterBuilder

java.lang.Object

org.apache.lucene.search.suggest.document.NRTSuggesterBuilder

final class NRTSuggesterBuilder
extends Object

Builder for NRTSuggester

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	NRTSuggesterBuilder.Entry

Field Summary

Fields

Modifier and Type	Field	Description
private final BytesRefBuilder	analyzed
static final int	END_BYTE	Marks end of the analyzed input and start of dedup byte.
private final int	endByte
private final PriorityQueue<NRTSuggesterBuilder.Entry>	entries
private final FSTCompiler<PairOutputs.Pair<Long,BytesRef>>	fstCompiler
private int	maxAnalyzedPathsPerOutput
private final PairOutputs<Long,BytesRef>	outputs
static final int	PAYLOAD_SEP	Label used to separate surface form and docID in the output
private final int	payloadSep
private final IntsRefBuilder	scratchInts

Constructor Summary

Constructors

Constructor	Description
NRTSuggesterBuilder()	Create a builder for NRTSuggester

Method Summary

Modifier and Type	Method	Description
void	addEntry(int docID, BytesRef surfaceForm, long weight)	Adds an entry for the latest input term, should be called after startTerm(org.apache.lucene.util.BytesRef) on the desired input
void	finishTerm()	Writes all the entries for the FST input term
private static int	maxNumArcsForDedupByte(int currentNumDedupBytes)	Num arcs for nth dedup byte: if n invalid input: '<'= 5: 1 + (2 * n) else: (1 + (2 * n)) * n
void	startTerm(BytesRef analyzed)	Initializes an FST input term to add entries against
boolean	store(DataOutput output)	Builds and stores a FST that can be loaded with NRTSuggester.load(IndexInput, CompletionPostingsFormat.FSTLoadMode))}

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

PAYLOAD_SEP

public static final int PAYLOAD_SEP

Label used to separate surface form and docID in the output

See Also:

• Constant Field Values

END_BYTE

public static final int END_BYTE

Marks end of the analyzed input and start of dedup byte.

See Also:

• Constant Field Values

outputs

private final PairOutputs<Long,BytesRef> outputs

fstCompiler

private final FSTCompiler<PairOutputs.Pair<Long,BytesRef>> fstCompiler

scratchInts

private final IntsRefBuilder scratchInts

analyzed

private final BytesRefBuilder analyzed

entries

private final PriorityQueue<NRTSuggesterBuilder.Entry> entries

payloadSep

private final int payloadSep

endByte

private final int endByte

maxAnalyzedPathsPerOutput

private int maxAnalyzedPathsPerOutput

Constructor Details

NRTSuggesterBuilder

public NRTSuggesterBuilder()
                    throws IOException

Create a builder for NRTSuggester

Throws:

IOException

Method Details

startTerm

public void startTerm(BytesRef analyzed)

Initializes an FST input term to add entries against

addEntry

public void addEntry(int docID,
 BytesRef surfaceForm,
 long weight)
              throws IOException

Adds an entry for the latest input term, should be called after startTerm(org.apache.lucene.util.BytesRef) on the desired input

Throws:

IOException

finishTerm

public void finishTerm()
                throws IOException

Writes all the entries for the FST input term

Throws:

IOException

store

public boolean store(DataOutput output)
              throws IOException

Builds and stores a FST that can be loaded with NRTSuggester.load(IndexInput, CompletionPostingsFormat.FSTLoadMode))}

Throws:

IOException

maxNumArcsForDedupByte

private static int maxNumArcsForDedupByte(int currentNumDedupBytes)

Num arcs for nth dedup byte: if n invalid input: '<'= 5: 1 + (2 * n) else: (1 + (2 * n)) * n

TODO: is there a better way to make the fst built to be more TopNSearcher friendly?