protected AbstractField() 
{

}

 protected AbstractField(String name,
    Field.Store store,
    Field.Index index,
    Field.TermVector termVector) 
{
    if (name == null)
      throw new NullPointerException("name cannot be null");
    this.name = name.intern();        // field names are interned
    if (store == Field.Store.YES){
      this.isStored = true;
      this.isCompressed = false;
    }
    else if (store == Field.Store.COMPRESS) {
      this.isStored = true;
      this.isCompressed = true;
    }
    else if (store == Field.Store.NO){
      this.isStored = false;
      this.isCompressed = false;
    }
    else
      throw new IllegalArgumentException("unknown store parameter " + store);
    if (index == Field.Index.NO) {
      this.isIndexed = false;
      this.isTokenized = false;
    } else if (index == Field.Index.TOKENIZED) {
      this.isIndexed = true;
      this.isTokenized = true;
    } else if (index == Field.Index.UN_TOKENIZED) {
      this.isIndexed = true;
      this.isTokenized = false;
    } else if (index == Field.Index.NO_NORMS) {
      this.isIndexed = true;
      this.isTokenized = false;
      this.omitNorms = true;
    } else {
      throw new IllegalArgumentException("unknown index parameter " + index);
    }
    this.isBinary = false;
    setStoreTermVector(termVector);
}

 public float getBoost() 
{
    return boost;
}

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 org.apache.lucene.index.IndexReader#document(int) and org.apache.lucene.search.Hits#doc(int) may thus not have the same value present as when this field was indexed.

 public boolean getOmitNorms() 
{
 return omitNorms;
}

True if norms are omitted for this indexed field

 public final boolean isBinary() 
{
 return isBinary;
}

True iff the value of the filed is stored as binary

 public final boolean isCompressed() 
{
 return isCompressed;
}

True if the value of the field is stored and compressed within the index

 public final boolean isIndexed() 
{
 return isIndexed;
}

True iff the value of the field is to be indexed, so that it may be searched on.

 public boolean isLazy() 
{
    return lazy;
}

 public boolean isStoreOffsetWithTermVector() 
{
    return storeOffsetWithTermVector;
}

True iff terms are stored as term vector together with their offsets (start and end positon in source text).

 public boolean isStorePositionWithTermVector() 
{
    return storePositionWithTermVector;
}

True iff terms are stored as term vector together with their token positions.

 public final boolean isStored() 
{
 return 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() 
{
 return storeTermVector;
}

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 final boolean isTokenized() 
{
 return 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() 
{
 return name;
}

Returns the name of the field as an interned string. For example "date", "title", "body", ...

 public  void setBoost(float boost) 
{
    this.boost = 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 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 org.apache.lucene.search.Similarity#lengthNorm(String,int) , and rounded by 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.

 public  void setOmitNorms(boolean omitNorms) 
{
 this.omitNorms=omitNorms;
}

Expert: If set, omit normalization factors associated with this indexed field. This effectively disables indexing boosts and length normalization for this field.

 protected  void setStoreTermVector(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 String toString() 
{
    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();
}

Prints a Field for human consumption.