| Method from org.apache.lucene.document.Document Detail: |
|---|
 public final void add(Fieldable field) {
fields.add(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.
|
public final String get(String name) {
for (Fieldable field : fields) {
if (field.name().equals(name) && (!field.isBinary()))
return field.stringValue();
}
return null;
} 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. |
public final byte[] getBinaryValue(String name) {
for (Fieldable field : fields) {
if (field.name().equals(name) && (field.isBinary()))
return field.getBinaryValue();
}
return null;
} 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. |
public final byte[][] getBinaryValues(String name) {
List< byte[] > result = new ArrayList< byte[] >();
for (Fieldable field : fields) {
if (field.name().equals(name) && (field.isBinary()))
result.add(field.getBinaryValue());
}
if (result.size() == 0)
return NO_BYTES;
return result.toArray(new byte[result.size()][]);
} 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. |
public float getBoost() {
return boost;
} Returns, at indexing time, the boost factor as set by #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
Similarity .) |
public final Field getField(String name) {
return (Field) getFieldable(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.
Do not use this method with lazy loaded fields. |
public Fieldable getFieldable(String name) {
for (Fieldable field : fields) {
if (field.name().equals(name))
return field;
}
return null;
} 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. |
public Fieldable[] getFieldables(String name) {
List< Fieldable > result = new ArrayList< Fieldable >();
for (Fieldable field : fields) {
if (field.name().equals(name)) {
result.add(field);
}
}
if (result.size() == 0)
return NO_FIELDABLES;
return result.toArray(new Fieldable[result.size()]);
} Returns an array of Fieldable s with the given name.
This method returns an empty array when there are no
matching fields. It never returns null. |
public final List<Fieldable> getFields() {
return fields;
} |
public final Field[] getFields(String name) {
List< Field > result = new ArrayList< Field >();
for (Fieldable field : fields) {
if (field.name().equals(name)) {
result.add((Field) field);
}
}
if (result.size() == 0)
return NO_FIELDS;
return result.toArray(new Field[result.size()]);
} Returns an array of Field s with the given name.
Do not use with lazy loaded fields.
This method returns an empty array when there are no
matching fields. It never returns null. |
public final String[] getValues(String name) {
List< String > result = new ArrayList< String >();
for (Fieldable field : fields) {
if (field.name().equals(name) && (!field.isBinary()))
result.add(field.stringValue());
}
if (result.size() == 0)
return NO_STRINGS;
return result.toArray(new String[result.size()]);
} 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. |
public final void removeField(String name) {
Iterator< Fieldable > it = fields.iterator();
while (it.hasNext()) {
Fieldable field = it.next();
if (field.name().equals(name)) {
it.remove();
return;
}
}
} 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.
|
public final void removeFields(String name) {
Iterator< Fieldable > it = fields.iterator();
while (it.hasNext()) {
Fieldable field = it.next();
if (field.name().equals(name)) {
it.remove();
}
}
} 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.
|
public void setBoost(float boost) {
this.boost = 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.
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. |
public final String toString() {
StringBuilder buffer = new StringBuilder();
buffer.append("Document< ");
for (int i = 0; i < fields.size(); i++) {
Fieldable field = fields.get(i);
buffer.append(field.toString());
if (i != fields.size()-1)
buffer.append(" ");
}
buffer.append(" >");
return buffer.toString();
} Prints the fields of a document for human consumption. |
org.apache.lucene.document.Document