Class SuggestField
- java.lang.Object
-
- org.apache.lucene.document.Field
-
- org.apache.lucene.search.suggest.document.SuggestField
-
- All Implemented Interfaces:
IndexableField
- Direct Known Subclasses:
ContextSuggestField
public class SuggestField extends Field
Field that indexes a string value and a weight as a weighted completion against a named suggester. Field is tokenized, not stored and stores documents, frequencies and positions. Field can be used to provide near real time document suggestions.Besides the usual
Analyzers,CompletionAnalyzercan be used to tune suggest field only parameters (e.g. preserving token separators, preserving position increments when converting the token stream to an automaton)Example indexing usage:
document.add(new SuggestField(name, "suggestion", 4));
To perform document suggestions based on the field, useSuggestIndexSearcher.suggest(CompletionQuery, int, boolean)- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.lucene.document.Field
Field.Store
-
-
Field Summary
Fields Modifier and Type Field Description static FieldTypeFIELD_TYPEDefault field type for suggest field-
Fields inherited from class org.apache.lucene.document.Field
fieldsData, name, tokenStream, type
-
-
Constructor Summary
Constructors Constructor Description SuggestField(String name, String value, int weight)Creates aSuggestField
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description TokenStreamtokenStream(Analyzer analyzer, TokenStream reuse)protected bytetype()Returns a byte to denote the type of the fieldprotected CompletionTokenStreamwrapTokenStream(TokenStream stream)Wraps astreamwith a CompletionTokenStream.-
Methods inherited from class org.apache.lucene.document.Field
binaryValue, fieldType, getCharSequenceValue, invertableType, name, numericValue, readerValue, setBytesValue, setBytesValue, setByteValue, setDoubleValue, setFloatValue, setIntValue, setLongValue, setReaderValue, setShortValue, setStringValue, setTokenStream, storedValue, stringValue, tokenStreamValue, toString
-
-
-
-
Field Detail
-
FIELD_TYPE
public static final FieldType FIELD_TYPE
Default field type for suggest field
-
-
Constructor Detail
-
SuggestField
public SuggestField(String name, String value, int weight)
Creates aSuggestField- Parameters:
name- field namevalue- field value to get suggestions onweight- field weight- Throws:
IllegalArgumentException- if either the name or value is null, if value is an empty string, if the weight is negative, if value contains any reserved characters
-
-
Method Detail
-
tokenStream
public TokenStream tokenStream(Analyzer analyzer, TokenStream reuse)
- Specified by:
tokenStreamin interfaceIndexableField- Overrides:
tokenStreamin classField
-
wrapTokenStream
protected CompletionTokenStream wrapTokenStream(TokenStream stream)
Wraps astreamwith a CompletionTokenStream.Subclasses can override this method to change the indexing pipeline.
-
type
protected byte type()
Returns a byte to denote the type of the field
-
-