Lucene.Net 1.9.1 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

BinaryValueThe value of the field in Binary, or null. If null, the Reader or String value is used. Exactly one of stringValue(), readerValue() and binaryValue() must be set.
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.
GetOmitNormsTrue if norms are omitted for this indexed field
GetType (inherited from Object) Gets the Type of the current instance.
IsBinaryTrue iff the value of the filed is stored as binary
IsCompressedTrue if the value of the field is stored and compressed within the index
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.
IsStoreOffsetWithTermVector True iff terms are stored as term vector together with their offsets (start and end positon in source text).
IsStorePositionWithTermVector True iff terms are stored as term vector together with their token positions.
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.
NameReturns the name of the field as an interned string. For example "date", "title", "body", ...
ReaderValueThe value of the field as a Reader, or null. If null, the String value or binary value is used. Exactly one of stringValue(), readerValue(), and binaryValue() must be set.
SetBoost 
SetOmitNormsExpert: If set, omit normalization factors associated with this indexed field. This effectively disables indexing boosts and length normalization for this field.
StringValueThe value of the field as a String, or null. If null, the Reader value or binary value is used. Exactly one of stringValue(), readerValue(), and binaryValue() must be set.
ToStringPrints a Field for human consumption.

See Also

Field Class | Lucene.Net.Documents Namespace