Class AbstractField

Inheritance

System.Object

AbstractField

Namespace:

Assembly: Lucene.Net.NetCore.dll

Syntax

public abstract class AbstractField : object, IFieldable

Constructors

Name	Description
AbstractField()
AbstractField(String, Field.Store, Field.Index, Field.TermVector)

Fields

Name	Description
fieldsData
internalBinaryLength
internalbinaryOffset
internalBoost
internalIsBinary
internalIsIndexed
internalIsStored
internalIsTokenized
internalName
internalOmitNorms
internalOmitTermFreqAndPositions
lazy
storeOffsetWithTermVector
storePositionWithTermVector
storeTermVector
tokenStream

Properties

Name	Description
BinaryLength	Returns length of byte[] segment that is used as value, if Field is not binary returned value is undefined
BinaryOffset	Returns offset into byte[] segment that is used as value, if Field is not binary returned value is undefined
Boost	Gets or sets the boost factor for hits for this field. The default value is 1.0. Note: this value is not stored directly with the document in the index. Documents returned from Document(Int32) and Doc(Int32) may thus not have the same value present as when this field was indexed.
IsBinary	True iff the value of the filed is stored as binary
IsIndexed	True iff the value of the field is to be indexed, so that it may be searched on.
IsLazy
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.
IsStoreOffsetWithTermVector	True iff terms are stored as term vector together with their offsets (start and end position in source text).
IsStorePositionWithTermVector	True iff terms are stored as term vector together with their token positions.
IsTermVectorStored	True iff the term or terms used to index this field are stored as a term vector, available from GetTermFreqVector(Int32, 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.
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.
Name	Returns the name of the field as an interned string. For example "date", "title", "body", ...
OmitNorms	True if norms are omitted for this indexed field
OmitTermFreqAndPositions	Expert: If set, omit term freq, positions and payloads from postings for this field. NOTE: While this option reduces storage space required in the index, it also means any query requiring positional information, such as PhraseQuery or Lucene.Net.Search.Spans.SpanQuery subclasses will silently fail to find results.
ReaderValue
StringValue
TokenStreamValue

Methods

Name	Description
GetBinaryValue()	Return the raw byte[] for the binary field. Note that you must also call BinaryLength and BinaryOffset to know which range of bytes in this returned array belong to the field.
GetBinaryValue(Byte[])
SetStoreTermVector(Field.TermVector)
ToString()	Prints a Field for human consumption.