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 and (optionally) payload fields have 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
• if any of the term or (optionally) payload fields supplied do not have a value for a document, then the document is skipped by the dictionary

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and 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 contextsFeild for associated contexts.

Method Summary

Methods

Modifier and Type	Method and 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 Detail

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 Detail

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 contextsFeild for associated contexts.

Method Detail

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