add
public final void add(
Field field
)
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.
fields
public final Enumeration fields(
)
Returns an Enumeration of all the fields in a document.
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.
getBoost
public float getBoost(
)
Returns the boost factor for hits on any field of this document.
The default value is 1.0.
Note: This value is not stored directly with the document in the index.
Documents returned from document(int) and
doc(int) may thus not have the same value present as when
this document was indexed.
getField
public final Field 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 Field[] getFields(
String name
)
Returns an array of Fields with the given name.
This method can return null.
getValues
public final String[] getValues(
String name
)
Returns an array of values of the field specified as the method parameter.
This method can return null.
removeField
public final 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. 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
public final 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. 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
)
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.
Values are multiplied into the value of getBoost() of
each field in this document. Thus, this method in effect sets a default
boost for the fields of this document.
toString
public final String toString(
)
Prints the fields of a document for human consumption.
|