Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
org.apache.lucene.document.Field
public final class Field
extends java.lang.Object
implements java.io.Serializable
Constructor Summary | |
| |
|
Method Summary | |
static Field |
|
static Field |
|
static Field |
|
static Field |
|
static Field |
|
static Field |
|
static Field |
|
static Field |
|
static Field |
|
float |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
String |
|
Reader |
|
void |
|
String |
|
String |
|
public Field(String name, String string, boolean store, boolean index, boolean token)
Create a field by specifying all parameters except forstoreTermVector
, which is set tofalse
.
public Field(String name, String string, boolean store, boolean index, boolean token, boolean storeTermVector)
- Parameters:
name
- The name of the fieldstring
- The string to processstore
- true if the field should store the stringindex
- true if the field should be indexedtoken
- true if the field should be tokenizedstoreTermVector
- true if we should store the Term Vector info
public static final Field Keyword(String name, Date value)
Constructs a Date-valued Field that is not tokenized and is indexed, and stored in the index, for return with hits.
public static final Field Keyword(String name, String value)
Constructs a String-valued Field that is not tokenized, but is indexed and stored. Useful for non-text fields, e.g. date or url.
public static final Field Text(String name, Reader value)
Constructs a Reader-valued Field that is tokenized and indexed, but is not stored in the index verbatim. Useful for longer text fields, like "body". Term vector will not be stored for this field.
public static final Field Text(String name, Reader value, boolean storeTermVector)
Constructs a Reader-valued Field that is tokenized and indexed, but is not stored in the index verbatim. Useful for longer text fields, like "body".
public static final Field Text(String name, String value)
Constructs a String-valued Field that is tokenized and indexed, and is stored in the index, for return with hits. Useful for short text fields, like "title" or "subject". Term vector will not be stored for this field.
public static final Field Text(String name, String value, boolean storeTermVector)
Constructs a String-valued Field that is tokenized and indexed, and is stored in the index, for return with hits. Useful for short text fields, like "title" or "subject".
public static final Field UnIndexed(String name, String value)
Constructs a String-valued Field that is not tokenized nor indexed, but is stored in the index, for return with hits.
public static final Field UnStored(String name, String value)
Constructs a String-valued Field that is tokenized and indexed, but that is not stored in the index. Term vector will not be stored for this field.
public static final Field UnStored(String name, String value, boolean storeTermVector)
Constructs a String-valued Field that is tokenized and indexed, but that is not stored in the index.
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 fromIndexReader.document(int)
andHits.doc(int)
may thus not have the same value present as when this field was indexed.
- See Also:
setBoost(float)
public final boolean isIndexed()
True iff the value of the field is to be indexed, so that it may be searched on.
public final boolean isStored()
True iff the value of the field is to be stored in the index for return with search hits. It is an error for this to be true if a field is Reader-valued.
public final boolean isTermVectorStored()
True iff the term or terms used to index this field are stored as a term vector, available fromIndexReader.getTermFreqVector(int,String)
. These methods do not provide access to the original content of the field, only to terms used to index it. If the original content must be preserved, use thestored
attribute instead.
public final boolean isTokenized()
True iff the value of the field should be tokenized as text prior to indexing. Un-tokenized fields are indexed as a single word and may not be Reader-valued.
public String name()
The name of the field (e.g., "date", "subject", "title", or "body") as an interned string.
public Reader readerValue()
The value of the field as a Reader, or null. If null, the String value is used. Exactly one of stringValue() and readerValue() must be set.
public void setBoost(float boost)
Sets the boost factor hits on this field. This value will be multiplied into the score of all hits on this this field of this document. The boost is multiplied byDocument.getBoost()
of the document containing this field. If a document has multiple fields with the same name, all such values are multiplied together. This product is then multipled by the valueSimilarity.lengthNorm(String,int)
, and rounded bySimilarity.encodeNorm(float)
before it is stored in the index. One should attempt to ensure that this product does not overflow the range of that encoding.
public String stringValue()
The value of the field as a String, or null. If null, the Reader value is used. Exactly one of stringValue() and readerValue() must be set.
public final String toString()
Prints a Field for human consumption.