org.apache.lucene.index

Class StoredDocument

java.lang.Object

org.apache.lucene.index.StoredDocument

All Implemented Interfaces:

Iterable<StorableField>

public class StoredDocument
extends Object
implements Iterable<StorableField>

StoredDocument is retrieved from IndexReader containing only stored fields from indexed IndexDocument.

Constructor Summary

Constructors

Constructor and Description
StoredDocument() Sole constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(StorableField field) Adds a field to a document.
String	get(String name) Returns the string value of the field with the given name if any exist in this document, or null.
BytesRef	getBinaryValue(String name) Returns an array of bytes for the first (or only) field that has the name specified as the method parameter.
BytesRef[]	getBinaryValues(String name) Returns an array of byte arrays for of the fields that have the name specified as the method parameter.
StorableField	getField(String name) Returns a field with the given name if any exist in this document, or null.
List<StorableField>	getFields() Returns a List of all the fields in a document.
StorableField[]	getFields(String name) Returns an array of StorableFields with the given name.
String[]	getValues(String name) Returns an array of values of the field specified as the method parameter.
Iterator<StorableField>	iterator()
String	toString() Prints the fields of a document for human consumption.

Methods inherited from class java.lang.Object

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

Constructor Detail

StoredDocument

public StoredDocument()

Sole constructor.

Method Detail

add

public final void add(StorableField field)

Adds a field to a document.

This method supports construction of a StoredDocument from a StoredFieldVisitor. This method cannot be used to change the content of an existing index! In order to achieve this, a document has to be deleted from an index and a new changed version of that document has to be added.

getFields

public StorableField[] getFields(String name)

Returns an array of StorableFields with the given name. This method returns an empty array when there are no matching fields. It never returns null.

Parameters:

name - the name of the field

Returns:

a StorableField[] array

getField

public final StorableField getField(String name)

Returns a field with the given name if any exist in this document, or null. If multiple fields exists with this name, this method returns the first value added.

getFields

public final List<StorableField> getFields()

Returns a List of all the fields in a document.

Note that fields which are not stored are not available in documents retrieved from the index, e.g. IndexSearcher.doc(int) or IndexReader.document(int).

Returns:

an immutable List<StorableField>

iterator

public Iterator<StorableField> iterator()

Specified by:

iterator in interface Iterable<StorableField>

getBinaryValues

public final BytesRef[] getBinaryValues(String name)

Returns an array of byte arrays for of the fields that have the name specified as the method parameter. This method returns an empty array when there are no matching fields. It never returns null.

Parameters:

name - the name of the field

Returns:

a BytesRef[] of binary field values

getBinaryValue

public final BytesRef getBinaryValue(String name)

Returns an array of bytes for the first (or only) field that has the name specified as the method parameter. This method will return null if no binary fields with the specified name are available. There may be non-binary fields with the same name.

Parameters:

name - the name of the field.

Returns:

a BytesRef containing the binary field value or null

getValues

public final String[] getValues(String name)

Returns an array of values of the field specified as the method parameter. This method returns an empty array when there are no matching fields. It never returns null. For IntField, LongField, FloatField and DoubleField it returns the string value of the number. If you want the actual numeric field instances back, use getFields(java.lang.String).

Parameters:

name - the name of the field

Returns:

a String[] of field values

get

public final String get(String name)

Returns the string value of the field with the given name if any exist in this document, or null. If multiple fields exist with this name, this method returns the first value added. If only binary fields with this name exist, returns null. For IntField, LongField, FloatField and DoubleField it returns the string value of the number. If you want the actual numeric field instance back, use getField(java.lang.String).

toString

public final String toString()

Prints the fields of a document for human consumption.

Overrides:

toString in class Object