|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.lucene.search.suggest.DocumentDictionary
public class DocumentDictionary
Dictionary with terms, weights and optionally payload information taken from stored/indexed fields in a Lucene index.
NOTE:NumericDocValues
.
If the weight field is not defined, the value of the weight is 0
Nested Class Summary | |
---|---|
protected class |
DocumentDictionary.DocumentInputIterator
Implements InputIterator from stored fields. |
Field Summary | |
---|---|
protected String |
payloadField
Field to read payload from |
protected IndexReader |
reader
IndexReader to load documents from |
Constructor Summary | |
---|---|
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. |
Method Summary | |
---|---|
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 |
---|
protected final IndexReader reader
IndexReader
to load documents from
protected final String payloadField
Constructor Detail |
---|
public DocumentDictionary(IndexReader reader, String field, String weightField)
field
for the terms and weightField
for the weights that will be used for
the corresponding terms.
public DocumentDictionary(IndexReader reader, String field, String weightField, String payloadField)
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.
Method Detail |
---|
public InputIterator getEntryIterator() throws IOException
Dictionary
getEntryIterator
in interface Dictionary
IOException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |