| java.lang.Object
 org.apache.lucene.document.Document
| Document | | final public class Document implements java.io.Serializable(Code) | | 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
Fieldable.isStored 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
Fieldable.isStored stored are
not available in documents retrieved from the index, e.g. with
Hits.doc(int) ,
Searcher.doc(int) or
IndexReader.document(int) .
|
| Constructor Summary | |
| public | Document()
Constructs a new document with no fields. |
| Method Summary | |
| final public void | add(Fieldable field)
Adds a field to a document. | | final public Enumeration | fields()
Returns an Enumeration of all the fields in a document. | | final public String | get(String name)
Returns the string value of the field with the given name if any exist in
this document, or null. | | final public byte[] | getBinaryValue(String name)
Returns an array of bytes for the first (or only) field that has the name
specified as the method parameter. | | final public byte[][] | getBinaryValues(String name)
Returns an array of byte arrays for of the fields that have the name specified
as the method parameter. | | public float | getBoost()
Returns, at indexing time, the boost factor as set by
Document.setBoost(float) . | | final public Field | getField(String name)
Returns a field with the given name if any exist in this document, or
null. | | public Fieldable | getFieldable(String name)
Returns a field with the given name if any exist in this document, or
null. | | public Fieldable[] | getFieldables(String name)
Returns an array of
Fieldable s with the given name. | | final public List | getFields()
Returns a List of all the fields in a document.
Note that fields which are not
Fieldable.isStored stored are
not available in documents retrieved from the index, e.g. | | final public Field[] | getFields(String name)
Returns an array of
Field s with the given name. | | final public String[] | getValues(String name)
Returns an array of values of the field specified as the method parameter. | | final public void | removeField(String name)
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. | | final public void | removeFields(String name)
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. | | public void | setBoost(float boost)
Sets a boost factor for hits on any field of this document. | | final public String | toString()
Prints the fields of a document for human consumption. |
| Document | | public Document()(Code) | | Constructs a new document with no fields.
|
| add | | final public void add(Fieldable field)(Code) | | 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.
|
| get | | final public String get(String name)(Code) | | 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.
|
| getBinaryValue | | final public byte[] getBinaryValue(String name)(Code) | | 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. a byte[] containing the binary field value or null |
| getBinaryValues | | final public byte[][] getBinaryValues(String name)(Code) | | Returns an array of byte arrays for of the fields that have the name specified
as the method parameter. This method will return null if no
binary fields with the specified name are available.
Parameters:
name - the name of the field a byte[][] of binary field values or null |
| getBoost | | public float getBoost()(Code) | | Returns, at indexing time, the boost factor as set by
Document.setBoost(float) .
Note that once a document is indexed this value is no longer available
from the index. At search time, for retrieved documents, this method always
returns 1. This however does not mean that the boost value set at indexing
time was ignored - it was just combined with other indexing time factors and
stored elsewhere, for better indexing and search performance. (For more
information see the "norm(t,d)" part of the scoring formula in
org.apache.lucene.search.Similarity Similarity .)
See Also: Document.setBoost(float) |
| getField | | final public Field getField(String name)(Code) | | 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.
Do not use this method with lazy loaded fields.
|
| getFieldable | | public Fieldable getFieldable(String name)(Code) | | 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.
|
| getFieldables | | public Fieldable[] getFieldables(String name)(Code) | | Returns an array of
Fieldable s with the given name.
This method can return null.
Parameters:
name - the name of the field a Fieldable[] array or null |
| getFields | | final public Field[] getFields(String name)(Code) | | Returns an array of
Field s with the given name.
This method can return null.
Do not use with lazy loaded fields.
Parameters:
name - the name of the field a Field[] array |
| getValues | | final public String[] getValues(String name)(Code) | | Returns an array of values of the field specified as the method parameter.
This method can return null.
Parameters:
name - the name of the field a String[] of field values or null |
| removeField | | final public void removeField(String name)(Code) | | 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 | | final public void removeFields(String name)(Code) | | 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.
|
| setBoost | | public void setBoost(float boost)(Code) | | Sets a boost factor for hits on any field of this document. This value
will be multiplied into the score of all hits on this document.
The default value is 1.0.
Values are multiplied into the value of
Fieldable.getBoost of
each field in this document. Thus, this method in effect sets a default
boost for the fields of this document.
See Also: Fieldable.setBoost(float) |
| toString | | final public String toString()(Code) | | Prints the fields of a document for human consumption.
|
|
|