org.apache.lucene.search.suggest.document

Class SuggestField

java.lang.Object

org.apache.lucene.document.Field

org.apache.lucene.search.suggest.document.SuggestField

All Implemented Interfaces:

IndexableField

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, CompletionAnalyzer can be used to tune suggest field only parameters (e.g. preserving token seperators, 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 this field, use SuggestIndexSearcher.suggest(String, CharSequence, int, org.apache.lucene.search.Filter)

Example query usage:

 SuggestIndexSearcher indexSearcher = ..
 indexSearcher.suggest(name, "su", 2)
 

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.Index, Field.Store, Field.TermVector

Field Summary

Fields inherited from class org.apache.lucene.document.Field

boost, fieldsData, name, tokenStream, type

Constructor Summary

Constructors

Constructor and Description
SuggestField(String name, String value, long weight) Creates a SuggestField

Method Summary

Methods

Modifier and Type	Method and Description
TokenStream	tokenStream(Analyzer analyzer, TokenStream reuse)

Methods inherited from class org.apache.lucene.document.Field

binaryValue, boost, fieldType, name, numericValue, readerValue, setBoost, setBytesValue, setBytesValue, setByteValue, setDoubleValue, setFloatValue, setIntValue, setLongValue, setReaderValue, setShortValue, setStringValue, setTokenStream, stringValue, tokenStreamValue, toString, translateFieldType

Methods inherited from class java.lang.Object

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

Constructor Detail

SuggestField

public SuggestField(String name,
            String value,
            long weight)

Creates a SuggestField

Parameters:

name - of the field

value - to get suggestions on

weight - weight of the suggestion

Method Detail

tokenStream

public TokenStream tokenStream(Analyzer analyzer,
                      TokenStream reuse)
                        throws IOException

Specified by:

tokenStream in interface IndexableField

Overrides:

tokenStream in class Field

Throws:

IOException