|
Snapper 1.0 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A field is a section of a Document. Each field has two parts, a name and a value. Values may be free text, provided as a String or as a Reader, or they may be atomic keywords, which are not further processed. Such keywords may be used to represent dates, urls, etc. Fields are optionally stored in the index, so that they may be returned with hits on the document.
Method Summary | |
float |
getBoost()
Returns the boost factor for hits on any field of this document. |
boolean |
isIndexed()
True iff the value of the field is to be indexed, so that it may be searched on. |
boolean |
isStored()
True iff the value of the field is to be stored in the index for return with search hits. |
boolean |
isTermVectorStored()
True iff the term or terms used to index this field are stored as a term vector, available from IndexReader#getTermFreqVector(int,String) . |
boolean |
isTokenized()
True iff the value of the field should be tokenized as text prior to indexing. |
Field |
Keyword(java.lang.String name,
java.util.Date value)
Constructs a Date-valued Field that is not tokenized and is indexed, and stored in the index, for return with hits. |
Field |
Keyword(java.lang.String name,
java.lang.String value)
Constructs a String-valued Field that is not tokenized, but is indexed and stored. |
java.lang.String |
name()
The name of the field (e.g., "date", "subject", "title", or "body") as an interned string. |
java.io.Reader |
readerValue()
The value of the field as a Reader, or null. |
void |
setBoost(float boost)
Sets the boost factor hits on this field. |
java.lang.String |
stringValue()
The value of the field as a String, or null. |
Field |
Text(java.lang.String name,
java.io.Reader value)
Constructs a Reader-valued Field that is tokenized and indexed, but is not stored in the index verbatim. |
Field |
Text(java.lang.String name,
java.io.Reader value,
boolean storeTermVector)
Constructs a Reader-valued Field that is tokenized and indexed, but is not stored in the index verbatim. |
Field |
Text(java.lang.String name,
java.lang.String value)
Constructs a String-valued Field that is tokenized and indexed, and is stored in the index, for return with hits. |
Field |
Text(java.lang.String name,
java.lang.String value,
boolean storeTermVector)
Constructs a String-valued Field that is tokenized and indexed, and is stored in the index, for return with hits. |
Field |
UnIndexed(java.lang.String name,
java.lang.String value)
Constructs a String-valued Field that is not tokenized nor indexed, but is stored in the index, for return with hits. |
Field |
UnStored(java.lang.String name,
java.lang.String value)
Constructs a String-valued Field that is tokenized and indexed, but that is not stored in the index. |
Field |
UnStored(java.lang.String name,
java.lang.String value,
boolean storeTermVector)
Constructs a String-valued Field that is tokenized and indexed, but that is not stored in the index. |
Method Detail |
public void setBoost(float boost)
The boost is multiplied by Document.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 value Similarity#lengthNorm(String,int)
, and
rounded by Similarity#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.
Document.setBoost(float)
,
Similarity#lengthNorm(String, int)
,
Similarity#encodeNorm(float)
public float getBoost()
The default value is 1.0.
Note: this value is not stored directly with the document in the index.
Documents returned from IndexReader#document(int)
and Hits#doc(int)
may thus not have the same value present as when this field
was indexed.
setBoost(float)
public Field Keyword(java.lang.String name, java.lang.String value)
public Field UnIndexed(java.lang.String name, java.lang.String value)
public Field Text(java.lang.String name, java.lang.String value)
public Field Keyword(java.lang.String name, java.util.Date value)
public Field Text(java.lang.String name, java.lang.String value, boolean storeTermVector)
public Field UnStored(java.lang.String name, java.lang.String value)
public Field UnStored(java.lang.String name, java.lang.String value, boolean storeTermVector)
public Field Text(java.lang.String name, java.io.Reader value)
public Field Text(java.lang.String name, java.io.Reader value, boolean storeTermVector)
public java.lang.String name()
public java.lang.String stringValue()
public java.io.Reader readerValue()
public boolean isStored()
public boolean isIndexed()
public boolean isTokenized()
public boolean isTermVectorStored()
IndexReader#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 the stored
attribute instead.
IndexReader#getTermFreqVector(int, String)
|
Snapper 1.0 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |