| Methods Summary |
|---|
| public final void | add(org.apache.lucene.document.Fieldable 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.add(field);
|
| public final java.util.Enumeration | fields()Returns an Enumeration of all the fields in a document.
return ((Vector)fields).elements();
|
| public final java.lang.String | get(java.lang.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. If only binary fields with this name
exist, returns null.
for (int i = 0; i < fields.size(); i++) {
Fieldable field = (Fieldable)fields.get(i);
if (field.name().equals(name) && (!field.isBinary()))
return field.stringValue();
}
return null;
|
| public final byte[] | getBinaryValue(java.lang.String name)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.
for (int i=0; i < fields.size(); i++) {
Fieldable field = (Fieldable)fields.get(i);
if (field.name().equals(name) && (field.isBinary()))
return field.binaryValue();
}
return null;
|
| public final byte[][] | getBinaryValues(java.lang.String name)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.
List result = new ArrayList();
for (int i = 0; i < fields.size(); i++) {
Fieldable field = (Fieldable)fields.get(i);
if (field.name().equals(name) && (field.isBinary()))
result.add(field.binaryValue());
}
if (result.size() == 0)
return null;
return (byte[][])result.toArray(new byte[result.size()][]);
|
| 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 {@link IndexReader#document(int)} and
{@link Hits#doc(int)} may thus not have the same value present as when
this document was indexed.
return boost;
|
| public final org.apache.lucene.document.Field | getField(java.lang.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.
Do not use this method with lazy loaded fields.
for (int i = 0; i < fields.size(); i++) {
Field field = (Field)fields.get(i);
if (field.name().equals(name))
return field;
}
return null;
|
| public org.apache.lucene.document.Fieldable | getFieldable(java.lang.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.
for (int i = 0; i < fields.size(); i++) {
Fieldable field = (Fieldable)fields.get(i);
if (field.name().equals(name))
return field;
}
return null;
|
| public org.apache.lucene.document.Fieldable[] | getFieldables(java.lang.String name)Returns an array of {@link Fieldable}s with the given name.
This method can return null.
List result = new ArrayList();
for (int i = 0; i < fields.size(); i++) {
Fieldable field = (Fieldable)fields.get(i);
if (field.name().equals(name)) {
result.add(field);
}
}
if (result.size() == 0)
return null;
return (Fieldable[])result.toArray(new Fieldable[result.size()]);
|
| public final java.util.List | getFields()Returns a List of all the fields in a document.
Note that fields which are not {@link Fieldable#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)}.
return fields;
|
| public final org.apache.lucene.document.Field[] | getFields(java.lang.String name)Returns an array of {@link Field}s with the given name.
This method can return null.
Do not use with lazy loaded fields.
List result = new ArrayList();
for (int i = 0; i < fields.size(); i++) {
Field field = (Field)fields.get(i);
if (field.name().equals(name)) {
result.add(field);
}
}
if (result.size() == 0)
return null;
return (Field[])result.toArray(new Field[result.size()]);
|
| public final java.lang.String[] | getValues(java.lang.String name)Returns an array of values of the field specified as the method parameter.
This method can return null.
List result = new ArrayList();
for (int i = 0; i < fields.size(); i++) {
Fieldable field = (Fieldable)fields.get(i);
if (field.name().equals(name) && (!field.isBinary()))
result.add(field.stringValue());
}
if (result.size() == 0)
return null;
return (String[])result.toArray(new String[result.size()]);
|
| public final void | removeField(java.lang.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.
Iterator it = fields.iterator();
while (it.hasNext()) {
Fieldable field = (Fieldable)it.next();
if (field.name().equals(name)) {
it.remove();
return;
}
}
|
| public final void | removeFields(java.lang.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.
Iterator it = fields.iterator();
while (it.hasNext()) {
Fieldable field = (Fieldable)it.next();
if (field.name().equals(name)) {
it.remove();
}
}
|
| 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 {@link Fieldable#getBoost()} of
each field in this document. Thus, this method in effect sets a default
boost for the fields of this document.
this.boost = boost;
|
| public final java.lang.String | toString()Prints the fields of a document for human consumption.
StringBuffer buffer = new StringBuffer();
buffer.append("Document<");
for (int i = 0; i < fields.size(); i++) {
Fieldable field = (Fieldable)fields.get(i);
buffer.append(field.toString());
if (i != fields.size()-1)
buffer.append(" ");
}
buffer.append(">");
return buffer.toString();
|
