Lucene.Net 1.4.3 Class Library

Field Methods

The methods of the Field class are listed below. For a complete list of Field class members, see the Field Members topic.

Public Static Methods

KeywordOverloaded. Constructs a String-valued Field that is not tokenized, but is indexed and stored. Useful for non-text fields, e.g. date or url.
TextOverloaded. 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.
UnIndexedConstructs a String-valued Field that is not tokenized nor indexed, but is stored in the index, for return with hits.
UnStoredOverloaded. 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.

Public Instance Methods

Equals (inherited from Object) Determines whether the specified Object is equal to the current Object.
GetBoost 
GetHashCode (inherited from Object) Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetType (inherited from Object) Gets the Type of the current instance.
IsIndexedTrue iff the value of the Field is to be indexed, so that it may be searched on.
IsStoredTrue 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.
IsTermVectorStoredTrue 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.
IsTokenizedTrue 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.
NameThe name of the Field (e.g., "date", "subject", "title", or "body") as an interned string.
ReaderValueThe 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.
SetBoost 
StringValueThe 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.
ToStringPrints a Field for human consumption.

See Also

Field Class | Lucene.Net.Documents Namespace