Interface IIndexableFieldType

Describes the properties of a field.

Note

This API is experimental and might change in incompatible ways in the next release.

Namespace: Lucene.Net.Index

Assembly: Lucene.Net.dll

Syntax

public interface IIndexableFieldType

Properties

DocValueType

DocValues DocValuesType: if not NONE then the field's value will be indexed into docValues.

Declaration

DocValuesType DocValueType { get; }

Property Value

Type	Description
DocValuesType

IndexOptions

IndexOptions, describing what should be recorded into the inverted index

Declaration

IndexOptions IndexOptions { get; }

Property Value

Type	Description
IndexOptions

IsIndexed

true if this field should be indexed (inverted)

Declaration

bool IsIndexed { get; }

Property Value

Type	Description
bool

IsStored

true if the field's value should be stored

Declaration

bool IsStored { get; }

Property Value

Type	Description
bool

IsTokenized

true if this field's value should be analyzed by the Analyzer.

This has no effect if IsIndexed returns false.

Declaration

bool IsTokenized { get; }

Property Value

Type	Description
bool

OmitNorms

true if normalization values should be omitted for the field.

This saves memory, but at the expense of scoring quality (length normalization will be disabled), and if you omit norms, you cannot use index-time boosts.

Declaration

bool OmitNorms { get; }

Property Value

Type	Description
bool

StoreTermVectorOffsets

true if this field's token character offsets should also be stored into term vectors.

This option is illegal if term vectors are not enabled for the field (StoreTermVectors is false)

Declaration

bool StoreTermVectorOffsets { get; }

Property Value

Type	Description
bool

StoreTermVectorPayloads

true if this field's token payloads should also be stored into the term vectors.

This option is illegal if term vector positions are not enabled for the field (StoreTermVectors is false).

Declaration

bool StoreTermVectorPayloads { get; }

Property Value

Type	Description
bool

StoreTermVectorPositions

true if this field's token positions should also be stored into the term vectors.

This option is illegal if term vectors are not enabled for the field (StoreTermVectors is false).

Declaration

bool StoreTermVectorPositions { get; }

Property Value

Type	Description
bool

StoreTermVectors

true if this field's indexed form should be also stored into term vectors.

this builds a miniature inverted-index for this field which can be accessed in a document-oriented way from GetTermVector(int, string).

This option is illegal if IsIndexed returns false.

Declaration

bool StoreTermVectors { get; }

Property Value

Type	Description
bool