Package org.apache.lucene.search.suggest

Class DocumentDictionary

java.lang.Object

org.apache.lucene.search.suggest.DocumentDictionary

All Implemented Interfaces:

Dictionary

Direct Known Subclasses:

DocumentValueSourceDictionary

public class DocumentDictionary
extends Object
implements Dictionary

Dictionary with terms, weights, payload (optional) and contexts (optional) information taken from stored/indexed fields in a Lucene index. NOTE:

• The term field has to be stored; if it is missing, the document is skipped.
• The payload and contexts field are optional and are not required to be stored.
• The weight field can be stored or can be a NumericDocValues. If the weight field is not defined, the value of the weight is 0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	DocumentDictionary.DocumentInputIterator	Implements InputIterator from stored fields.

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	contextsField	Field to read contexts from
protected final String	payloadField	Field to read payload from
protected final IndexReader	reader	IndexReader to load documents from

Constructor Summary

Constructors

Constructor	Description
DocumentDictionary(IndexReader reader, String field, String weightField)	Creates a new dictionary with the contents of the fields named field for the terms and weightField for the weights that will be used for the corresponding terms.
DocumentDictionary(IndexReader reader, String field, String weightField, String payloadField)	Creates a new dictionary with the contents of the fields named field for the terms, weightField for the weights that will be used for the the corresponding terms and payloadField for the corresponding payloads for the entry.
DocumentDictionary(IndexReader reader, String field, String weightField, String payloadField, String contextsField)	Creates a new dictionary with the contents of the fields named field for the terms, weightField for the weights that will be used for the the corresponding terms, payloadField for the corresponding payloads for the entry and contextsField for associated contexts.

Method Summary

Modifier and Type	Method	Description
InputIterator	getEntryIterator()	Returns an iterator over all the entries

Methods inherited from class java.lang.Object

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

Field Details

reader

protected final IndexReader reader

IndexReader to load documents from

payloadField

protected final String payloadField

Field to read payload from

contextsField

protected final String contextsField

Field to read contexts from

Constructor Details

DocumentDictionary

public DocumentDictionary(IndexReader reader,
 String field,
 String weightField)

Creates a new dictionary with the contents of the fields named field for the terms and weightField for the weights that will be used for the corresponding terms.

DocumentDictionary

public DocumentDictionary(IndexReader reader,
 String field,
 String weightField,
 String payloadField)

Creates a new dictionary with the contents of the fields named field for the terms, weightField for the weights that will be used for the the corresponding terms and payloadField for the corresponding payloads for the entry.

DocumentDictionary

public DocumentDictionary(IndexReader reader,
 String field,
 String weightField,
 String payloadField,
 String contextsField)

Creates a new dictionary with the contents of the fields named field for the terms, weightField for the weights that will be used for the the corresponding terms, payloadField for the corresponding payloads for the entry and contextsField for associated contexts.

Method Details

getEntryIterator

public InputIterator getEntryIterator()
                               throws IOException

Description copied from interface: Dictionary

Returns an iterator over all the entries

Specified by:

getEntryIterator in interface Dictionary

Returns:

Iterator

Throws:

IOException