Save This Page
Home » lucene-2.3.2-src » org.apache » lucene » document » [javadoc | source]
org.apache.lucene.document
public interface: Fieldable [javadoc | source]

All Implemented Interfaces:
    Serializable

All Known Implementing Classes:
    FieldForMerge, Field, AbstractField, LazyField

Synonymous with Field .
Method from org.apache.lucene.document.Fieldable Summary:
binaryValue,   getBoost,   getOmitNorms,   isBinary,   isCompressed,   isIndexed,   isLazy,   isStoreOffsetWithTermVector,   isStorePositionWithTermVector,   isStored,   isTermVectorStored,   isTokenized,   name,   readerValue,   setBoost,   setOmitNorms,   stringValue,   tokenStreamValue
Method from org.apache.lucene.document.Fieldable Detail:
 public byte[] binaryValue()
    The value of the field in Binary, or null. If null, the Reader value, String value, or TokenStream value is used. Exactly one of stringValue(), readerValue(), binaryValue(), and tokenStreamValue() must be set.
 public float getBoost()
 public boolean getOmitNorms()
    True if norms are omitted for this indexed field
 public boolean isBinary()
    True iff the value of the filed is stored as binary
 public boolean isCompressed()
    True if the value of the field is stored and compressed within the index
 public boolean isIndexed()
    True iff the value of the field is to be indexed, so that it may be searched on.
 public boolean isLazy()
 public boolean isStoreOffsetWithTermVector()
    True iff terms are stored as term vector together with their offsets (start and end positon in source text).
 public boolean isStorePositionWithTermVector()
    True iff terms are stored as term vector together with their token positions.
 public 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 boolean isTermVectorStored()
    True iff the term or terms used to index this field are stored as a term vector, available from 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.
 public 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()
    Returns the name of the field as an interned string. For example "date", "title", "body", ...
 public Reader readerValue()
    The value of the field as a Reader, or null. If null, the String value, binary value, or TokenStream value is used. Exactly one of stringValue(), readerValue(), binaryValue(), and tokenStreamValue() must be set.
 public  void setBoost(float 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.
 public String stringValue()
    The value of the field as a String, or null. If null, the Reader value, binary value, or TokenStream value is used. Exactly one of stringValue(), readerValue(), binaryValue(), and tokenStreamValue() must be set.
 public TokenStream tokenStreamValue()
    The value of the field as a TokenStream, or null. If null, the Reader value, String value, or binary value is used. Exactly one of stringValue(), readerValue(), binaryValue(), and tokenStreamValue() must be set.