Class Document
- All Implemented Interfaces:
Iterable<IndexableField>
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.
Note that fields which are not stored
are not available in documents
retrieved from the index, e.g. with ScoreDoc.doc
or StoredFields.document(int)
.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal void
add
(IndexableField field) Adds a field to a document.void
clear()
Removes all the fields from document.final String
Returns the string value of the field with the given name if any exist in this document, or null.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.final BytesRef[]
getBinaryValues
(String name) Returns an array of byte arrays for of the fields that have the name specified as the method parameter.final IndexableField
Returns a field with the given name if any exist in this document, or null.final List
<IndexableField> Returns a List of all the fields in a document.Returns an array ofIndexableField
s with the given name.final String[]
Returns an array of values of the field specified as the method parameter.iterator()
final void
removeField
(String name) Removes field with the specified name from the document.final void
removeFields
(String name) Removes all fields with the given name from the document.final 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
Methods inherited from interface java.lang.Iterable
forEach, spliterator
-
Constructor Details
-
Document
public Document()Constructs a new document with no fields.
-
-
Method Details
-
iterator
- Specified by:
iterator
in interfaceIterable<IndexableField>
-
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.
-
getBinaryValues
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
Returns an array of bytes for the first (or only) field that has the name specified as the method parameter. This method will returnnull
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 ornull
-
getField
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
Returns an array ofIndexableField
s 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
Field[]
array
-
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.
StoredFields.document(int)
.- Returns:
- an immutable
List<Field>
-
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 a numericStoredField
it returns the string value of the number. If you want the actual numeric field instances back, usegetFields(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 a numericStoredField
it returns the string value of the number. If you want the actual numeric field instance back, usegetField(java.lang.String)
. -
toString
Prints the fields of a document for human consumption. -
clear
public void clear()Removes all the fields from document.
-