| Methods Summary |
|---|
| public float | getBoost()Returns the boost factor for hits for this field.
The default value is 1.0.
Note: this value is not stored directly with the document in the index.
Documents returned from {@link org.apache.lucene.index.IndexReader#document(int)} and
{@link org.apache.lucene.search.Hits#doc(int)} may thus not have the same value present as when
this field was indexed.
return boost;
|
| public boolean | getOmitNorms()True if norms are omitted for this indexed field return omitNorms;
|
| public final boolean | isBinary()True iff the value of the filed is stored as binary return isBinary;
|
| public final boolean | isCompressed()True if the value of the field is stored and compressed within the index return isCompressed;
|
| public final boolean | isIndexed()True iff the value of the field is to be indexed, so that it may be
searched on. return isIndexed;
|
| public boolean | isLazy()
return lazy;
|
| public boolean | isStoreOffsetWithTermVector()True iff terms are stored as term vector together with their offsets
(start and end positon in source text).
return storeOffsetWithTermVector;
|
| public boolean | isStorePositionWithTermVector()True iff terms are stored as term vector together with their token positions.
return storePositionWithTermVector;
|
| 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. return isStored;
|
| public final boolean | isTermVectorStored()True iff the term or terms used to index this field are stored as a term
vector, available from {@link org.apache.lucene.index.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. return storeTermVector;
|
| 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. return isTokenized;
|
| public java.lang.String | name()Returns the name of the field as an interned string.
For example "date", "title", "body", ... return name;
|
| 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 by {@link org.apache.lucene.document.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 {@link org.apache.lucene.search.Similarity#lengthNorm(String,int)}, and
rounded by {@link org.apache.lucene.search.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.
this.boost = boost;
|
| public void | setOmitNorms(boolean omitNorms)Expert:
If set, omit normalization factors associated with this indexed field.
This effectively disables indexing boosts and length normalization for this field. this.omitNorms=omitNorms;
|
| protected void | setStoreTermVector(org.apache.lucene.document.Field$TermVector termVector)
if (termVector == Field.TermVector.NO) {
this.storeTermVector = false;
this.storePositionWithTermVector = false;
this.storeOffsetWithTermVector = false;
}
else if (termVector == Field.TermVector.YES) {
this.storeTermVector = true;
this.storePositionWithTermVector = false;
this.storeOffsetWithTermVector = false;
}
else if (termVector == Field.TermVector.WITH_POSITIONS) {
this.storeTermVector = true;
this.storePositionWithTermVector = true;
this.storeOffsetWithTermVector = false;
}
else if (termVector == Field.TermVector.WITH_OFFSETS) {
this.storeTermVector = true;
this.storePositionWithTermVector = false;
this.storeOffsetWithTermVector = true;
}
else if (termVector == Field.TermVector.WITH_POSITIONS_OFFSETS) {
this.storeTermVector = true;
this.storePositionWithTermVector = true;
this.storeOffsetWithTermVector = true;
}
else {
throw new IllegalArgumentException("unknown termVector parameter " + termVector);
}
|
| public final java.lang.String | toString()Prints a Field for human consumption.
StringBuffer result = new StringBuffer();
if (isStored) {
result.append("stored");
if (isCompressed)
result.append("/compressed");
else
result.append("/uncompressed");
}
if (isIndexed) {
if (result.length() > 0)
result.append(",");
result.append("indexed");
}
if (isTokenized) {
if (result.length() > 0)
result.append(",");
result.append("tokenized");
}
if (storeTermVector) {
if (result.length() > 0)
result.append(",");
result.append("termVector");
}
if (storeOffsetWithTermVector) {
if (result.length() > 0)
result.append(",");
result.append("termVectorOffsets");
}
if (storePositionWithTermVector) {
if (result.length() > 0)
result.append(",");
result.append("termVectorPosition");
}
if (isBinary) {
if (result.length() > 0)
result.append(",");
result.append("binary");
}
if (omitNorms) {
result.append(",omitNorms");
}
if (lazy){
result.append(",lazy");
}
result.append('<");
result.append(name);
result.append(':");
if (fieldsData != null && lazy == false) {
result.append(fieldsData);
}
result.append('>");
return result.toString();
|
