Apache Lucene.Net 2.4.0 Class Library API

Fieldable Methods

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

Public Instance Methods

BinaryValueThe value of the field in Binary, or null. If null, the Reader value, String value, or TokenStream value is used. Exactly one of stringValue(), readerValue(), binaryValue(), and tokenStreamValue() must be set.
GetBinaryLength Returns the of byte][ segment that is used as value. If Fields is not binarythe returned value is undefined.
GetBinaryOffset Returns the offset into the byte[] segment that is used as value. If Fields is not binary returned value is undefined.
GetBinaryValueOverloaded. Return the raw byte[] for the vinary field. Note that you must also call GetBinaryLength() and GetBinaryOffset() to know which range of bytes in the returned array belong to this Field.
GetBoost 
GetOmitNormsTrue if norms are omitted for this indexed field
GetOmitTf True if tf is omitted for this indexed field.
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 Indicates whether a Field is Lazy or not. The semantics of Lazy loading are such that if a Field is lazily loaded, retrieving it's values via {@link #StringValue()} or {@link #BinaryValue()} is only valid as long as the {@link Lucene.Net.Index.IndexReader} that retrieved the {@link Document} is still open.
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", ...
ReaderValueThe value of the field as a Reader, or null. If null, the String value, binary value, or TokenStream value is used. Exactly one of stringValue(), readerValue(), binaryValue(), and tokenStreamValue() 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.
SetOmitTf Expert: If set, omit term freq, positions, and payloads from postings for this field for this field.
StringValueThe value of the field as a String, or null. If null, the Reader value, binary value, or TokenStream value is used. Exactly one of stringValue(), readerValue(), binaryValue(), and tokenStreamValue() must be set.
TokenStreamValueThe value of the field as a TokenStream, or null. If null, the Reader value, String value, or binary value is used. Exactly one of stringValue(), readerValue(), binaryValue(), and tokenStreamValue() must be set.

See Also

Fieldable Interface | Lucene.Net.Documents Namespace