Apache Lucene.Net 2.4.0 Class Library API

AbstractField Methods

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

Public Instance Methods

BinaryValue 
Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
GetBinaryLength Returns the length of byte[] segment that is used as value. If Field is not binary returned value is undefined.
GetBinaryOffset Returns offset into byte[] segment that is used as value. If Field is not binary returned value is undefined.
GetBinaryValueOverloaded. Return the raw byte[] for the binary field. Note that you must also call {@link #GetBinaryLength} and {@link #GetBinaryOffset} to know which range of bytes in this returned array belong to the field.
GetBoost 
GetHashCode (inherited from Object)Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table.
GetOmitNormsTrue if norms are omitted for this indexed field
GetOmitTf Returns true if tf is 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.
IsLazy 
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 Lucene.Net.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.
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", ...
ReaderValue 
SetBoost 
SetOmitNormsExpert: If set, omit normalization factors associated with this indexed field. This effectively disables indexing boosts and length normalization for this field.
SetOmitTf Expert: If set, omit tf from postings of this indexed field.
StringValue 
TokenStreamValue 
ToStringPrints a Field for human consumption.

Protected Instance Methods

Finalize (inherited from Object)Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object)Creates a shallow copy of the current Object.

Protected Internal Instance Methods

SetStoreTermVector 

See Also

AbstractField Class | Lucene.Net.Documents Namespace