File	Doc	Category	Size	Date	Package
Field.java	API Doc	Apache Lucene 1.4.3	9702	Fri Apr 16 11:48:26 BST 2004	org.apache.lucene.document

Field

• java.lang.Object

Fields Summary
private String	name
private String	stringValue
private boolean	storeTermVector
private Reader	readerValue
private boolean	isStored
private boolean	isIndexed
private boolean	isTokenized
private float	boost

Constructors Summary
public Field(String name, String string, boolean store, boolean index, boolean token) Create a field by specifying all parameters except for storeTermVector, which is set to false. this(name, string, store, index, token, false);
public Field(String name, String string, boolean store, boolean index, boolean token, boolean storeTermVector) param name The name of the field param string The string to process param store true if the field should store the string param index true if the field should be indexed param token true if the field should be tokenized param storeTermVector true if we should store the Term Vector info if (name == null) throw new IllegalArgumentException("name cannot be null"); if (string == null) throw new IllegalArgumentException("value cannot be null"); if (!index && storeTermVector) throw new IllegalArgumentException("cannot store a term vector for fields that are not indexed."); this.name = name.intern(); // field names are interned this.stringValue = string; this.isStored = store; this.isIndexed = index; this.isTokenized = token; this.storeTermVector = storeTermVector;
Field(String name, Reader reader) if (name == null) throw new IllegalArgumentException("name cannot be null"); if (reader == null) throw new IllegalArgumentException("value cannot be null"); this.name = name.intern(); // field names are interned this.readerValue = reader;

Methods Summary
public static final org.apache.lucene.document.Field	Keyword(java.lang.String name, java.lang.String value) Constructs a String-valued Field that is not tokenized, but is indexed and stored. Useful for non-text fields, e.g. date or url. return new Field(name, value, true, true, false);
public static final org.apache.lucene.document.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. return new Field(name, DateField.dateToString(value), true, true, false);
public static final org.apache.lucene.document.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. Useful for longer text fields, like "body". Term vector will not be stored for this field. return Text(name, value, false);
public static final org.apache.lucene.document.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. Useful for longer text fields, like "body". Field f = new Field(name, value); f.storeTermVector = storeTermVector; return f;
public static final org.apache.lucene.document.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. Useful for short text fields, like "title" or "subject". Term vector will not be stored for this field. return Text(name, value, false);
public static final org.apache.lucene.document.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. Useful for short text fields, like "title" or "subject". return new Field(name, value, true, true, true, storeTermVector);
public static final org.apache.lucene.document.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. return new Field(name, value, true, false, false);
public static final org.apache.lucene.document.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. Term vector will not be stored for this field. return UnStored(name, value, false);
public static final org.apache.lucene.document.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. return new Field(name, value, false, true, true, storeTermVector);
public float	getBoost() Returns the boost factor for hits on any field of this document. The default value is 1.0. Note: this value is not stored directly with the document in the index. Documents returned from {@link IndexReader#document(int)} and {@link Hits#doc(int)} may thus not have the same value present as when this field was indexed. see #setBoost(float) return boost;
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 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 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. see IndexReader#getTermFreqVector(int, String) 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() The name of the field (e.g., "date", "subject", "title", or "body") as an interned string. return name;
public java.io.Reader	readerValue() The value of the field as a Reader, or null. If null, the String value is used. Exactly one of stringValue() and readerValue() must be set. return readerValue;
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 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 Similarity#lengthNorm(String,int)}, and rounded by {@link 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. see Document#setBoost(float) see Similarity#lengthNorm(String, int) see Similarity#encodeNorm(float) this.boost = boost;
public java.lang.String	stringValue() The value of the field as a String, or null. If null, the Reader value is used. Exactly one of stringValue() and readerValue() must be set. return stringValue;
public final java.lang.String	toString() Prints a Field for human consumption. if (isStored && isIndexed && !isTokenized) return "Keyword<" + name + ":" + stringValue + ">"; else if (isStored && !isIndexed && !isTokenized) return "Unindexed<" + name + ":" + stringValue + ">"; else if (isStored && isIndexed && isTokenized && stringValue!=null) return "Text<" + name + ":" + stringValue + ">"; else if (!isStored && isIndexed && isTokenized && readerValue!=null) return "Text<" + name + ":" + readerValue + ">"; else if (!isStored && isIndexed && isTokenized) { return "UnStored<" + name + ">"; } else { return super.toString(); }