Class Document

Documents are the unit of indexing and search.
A Document is a set of fields. Each field has a name and a textual value.
A field may be stored with the document, in which
case it is returned with search hits on the document. Thus each document
should typically contain one or more stored fields which uniquely identify
it.

Method Detail

iterator

add

Adds a field to a document. Several fields may be added with
the same name. In this case, if the fields are indexed, their text is
treated as though appended for the purposes of search.

Note that add like the removeField(s) methods only makes sense
prior to adding a document to an index. These methods 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.

removeField

Removes field with the specified name from the document.
If multiple fields exist with this name, this method removes the first field that has been added.
If there is no field with the specified name, the document remains unchanged.

Note that the removeField(s) methods like the add method only make sense
prior to adding a document to an index. These methods 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.

removeFields

Removes all fields with the given name from the document.
If there is no field with the specified name, the document remains unchanged.

Note that the removeField(s) methods like the add method only make sense
prior to adding a document to an index. These methods 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.

getBinaryValue

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.

getValues

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

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).