org.apache.lucene.document
public final class Document extends Object implements Serializable
Note that fields which are not {@link Field#isStored() stored} are not available in documents retrieved from the index, e.g. with {@link Hits#doc(int)}, {@link Searcher#doc(int)} or {@link IndexReader#document(int)}.
Constructor Summary | |
---|---|
Document() Constructs a new document with no fields. |
Method Summary | |
---|---|
void | add(Field field) Adds a field to a document. |
Enumeration | fields() Returns an Enumeration of all the fields in 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. |
byte[] | getBinaryValue(String name)
Returns an array of bytes for the first (or only) field that has the name
specified as the method parameter. |
byte[][] | getBinaryValues(String name)
Returns an array of byte arrays for of the fields that have the name specified
as the method parameter. |
float | getBoost() Returns the boost factor for hits on any field of this document.
|
Field | getField(String name) Returns a field with the given name if any exist in this document, or
null. |
Field[] | getFields(String name)
Returns an array of {@link Field}s with the given name.
|
String[] | getValues(String name)
Returns an array of values of the field specified as the method parameter.
|
void | removeField(String name) Removes field with the specified name from the document. |
void | removeFields(String name) Removes all fields with the given name from the document. |
void | setBoost(float boost) Sets a boost factor for hits on any field of this document. |
String | toString() Prints the fields of a document for human consumption. |
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.
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 byte[]
containing the binary field value.
null
if no
binary fields with the specified name are available.
Parameters: name the name of the field
Returns: a byte[][]
of binary field values.
The default value is 1.0.
Note: This value is not stored directly with the document in the index. Documents returned from {@link IndexReader#document(int)} and {@link Hits#doc(int)} may thus not have the same value present as when this document was indexed.
See Also: Document
null
.
Parameters: name the name of the field
Returns: a Field[]
array
null
.
Parameters: name the name of the field
Returns: a String[]
of field values
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.
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.
Values are multiplied into the value of {@link Field#getBoost()} of each field in this document. Thus, this method in effect sets a default boost for the fields of this document.
See Also: Field