|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.lucene.document.Field
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.
Nested Class Summary | |
static class |
Field.Index
Specifies whether and how a field should be indexed. |
static class |
Field.Store
Specifies whether and how a field should be stored. |
static class |
Field.TermVector
Specifies whether and how a field should have term vectors. |
Constructor Summary | |
Field(String name,
byte[] value,
Field.Store store)
Create a stored field with binary value. |
|
Field(String name,
Reader reader)
Create a tokenized and indexed field that is not stored. |
|
Field(String name,
Reader reader,
Field.TermVector termVector)
Create a tokenized and indexed field that is not stored, optionally with storing term vectors. |
|
Field(String name,
String string,
boolean store,
boolean index,
boolean token)
Deprecated. use Field(String, String, Field.Store, Field.Index) instead |
|
Field(String name,
String string,
boolean store,
boolean index,
boolean token,
boolean storeTermVector)
Deprecated. use Field(String, String, Field.Store, Field.Index, Field.TermVector) instead |
|
Field(String name,
String value,
Field.Store store,
Field.Index index)
Create a field by specifying its name, value and how it will be saved in the index. |
|
Field(String name,
String value,
Field.Store store,
Field.Index index,
Field.TermVector termVector)
Create a field by specifying its name, value and how it will be saved in the index. |
Method Summary | |
byte[] |
binaryValue()
The value of the field in Binary, or null. |
float |
getBoost()
Returns the boost factor for hits for this field. |
boolean |
getOmitNorms()
True if norms are omitted for this indexed field |
boolean |
isBinary()
True iff the value of the filed is stored as binary |
boolean |
isCompressed()
True if the value of the field is stored and compressed within the index |
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 |
isStoreOffsetWithTermVector()
True iff terms are stored as term vector together with their offsets (start and end positon in source text). |
boolean |
isStorePositionWithTermVector()
True iff terms are stored as term vector together with their token positions. |
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. |
static Field |
Keyword(String name,
Date value)
Deprecated. use Field(name, value, Field.Store.YES, Field.Index.UN_TOKENIZED) instead |
static Field |
Keyword(String name,
String value)
Deprecated. use Field(name, value, Field.Store.YES, Field.Index.UN_TOKENIZED) instead |
String |
name()
Returns the name of the field as an interned string. |
Reader |
readerValue()
The value of the field as a Reader, or null. |
void |
setBoost(float boost)
Sets the boost factor hits on this field. |
void |
setOmitNorms(boolean omitNorms)
Expert: If set, omit normalization factors associated with this indexed field. |
String |
stringValue()
The value of the field as a String, or null. |
static Field |
Text(String name,
Reader value)
Deprecated. use Field(name, value) instead |
static Field |
Text(String name,
Reader value,
boolean storeTermVector)
Deprecated. use Field(name, value, storeTermVector) instead |
static Field |
Text(String name,
String value)
Deprecated. use Field(name, value, Field.Store.YES, Field.Index.TOKENIZED) instead |
static Field |
Text(String name,
String value,
boolean storeTermVector)
Deprecated. use Field(name, value, Field.Store.YES, Field.Index.TOKENIZED, storeTermVector) instead |
String |
toString()
Prints a Field for human consumption. |
static Field |
UnIndexed(String name,
String value)
Deprecated. use Field(name, value, Field.Store.YES, Field.Index.NO) instead |
static Field |
UnStored(String name,
String value)
Deprecated. use Field(name, value, Field.Store.NO, Field.Index.TOKENIZED) instead |
static Field |
UnStored(String name,
String value,
boolean storeTermVector)
Deprecated. use Field(name, value, Field.Store.NO, Field.Index.TOKENIZED, storeTermVector) instead |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public Field(String name, String value, Field.Store store, Field.Index index)
name
- The name of the fieldvalue
- The string to processstore
- Whether value
should be stored in the indexindex
- Whether the field should be indexed, and if so, if it should
be tokenized before indexing
NullPointerException
- if name or value is null
IllegalArgumentException
- if the field is neither stored nor indexedpublic Field(String name, String value, Field.Store store, Field.Index index, Field.TermVector termVector)
name
- The name of the fieldvalue
- The string to processstore
- Whether value
should be stored in the indexindex
- Whether the field should be indexed, and if so, if it should
be tokenized before indexingtermVector
- Whether term vector should be stored
NullPointerException
- if name or value is null
IllegalArgumentException
- in any of the following situations:
TermVector.YES
public Field(String name, Reader reader)
name
- The name of the fieldreader
- The reader with the content
NullPointerException
- if name or reader is null
public Field(String name, Reader reader, Field.TermVector termVector)
name
- The name of the fieldreader
- The reader with the contenttermVector
- Whether term vector should be stored
NullPointerException
- if name or reader is null
public Field(String name, String string, boolean store, boolean index, boolean token)
Field(String, String, Field.Store, Field.Index)
instead
storeTermVector
,
which is set to false
.
public Field(String name, byte[] value, Field.Store store)
name
- The name of the fieldvalue
- The binary valuestore
- How value
should be stored (compressed or not)
IllegalArgumentException
- if store is Store.NO
public Field(String name, String string, boolean store, boolean index, boolean token, boolean storeTermVector)
Field(String, String, Field.Store, Field.Index, Field.TermVector)
instead
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 infoMethod 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 static final Field Keyword(String name, String value)
Field(name, value, Field.Store.YES, Field.Index.UN_TOKENIZED)
instead
public static final Field UnIndexed(String name, String value)
Field(name, value, Field.Store.YES, Field.Index.NO)
instead
public static final Field Text(String name, String value)
Field(name, value, Field.Store.YES, Field.Index.TOKENIZED)
instead
public static final Field Keyword(String name, Date value)
Field(name, value, Field.Store.YES, Field.Index.UN_TOKENIZED)
instead
public static final Field Text(String name, String value, boolean storeTermVector)
Field(name, value, Field.Store.YES, Field.Index.TOKENIZED, storeTermVector)
instead
public static final Field UnStored(String name, String value)
Field(name, value, Field.Store.NO, Field.Index.TOKENIZED)
instead
public static final Field UnStored(String name, String value, boolean storeTermVector)
Field(name, value, Field.Store.NO, Field.Index.TOKENIZED, storeTermVector)
instead
public static final Field Text(String name, Reader value)
Field(name, value)
instead
public static final Field Text(String name, Reader value, boolean storeTermVector)
Field(name, value, storeTermVector)
instead
public String name()
public String stringValue()
public Reader readerValue()
public byte[] binaryValue()
public final boolean isStored()
public final boolean isIndexed()
public final boolean isTokenized()
public final boolean isCompressed()
public final 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)
public boolean isStoreOffsetWithTermVector()
public boolean isStorePositionWithTermVector()
public final boolean isBinary()
public boolean getOmitNorms()
public void setOmitNorms(boolean omitNorms)
public final String toString()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |