org.apache.lucene.index

Interface IndexableFieldType

All Known Implementing Classes:

FieldType

public interface IndexableFieldType

Describes the properties of a field.

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

Method Summary

Methods

Modifier and Type	Method and Description
DocValues.Type	docValueType() DocValues type; if non-null then the field's value will be indexed into docValues
boolean	indexed() True if this field should be indexed (inverted)
FieldInfo.IndexOptions	indexOptions() FieldInfo.IndexOptions, describing what should be recorded into the inverted index
boolean	omitNorms() True if norms should not be indexed
boolean	stored() True if the field's value should be stored
boolean	storeTermVectorOffsets() True if term vector offsets should be indexed
boolean	storeTermVectorPositions() True if term vector positions should be indexed
boolean	storeTermVectors() True if term vectors should be indexed
boolean	tokenized() True if this field's value should be analyzed

Method Detail

indexed

boolean indexed()

True if this field should be indexed (inverted)

stored

boolean stored()

True if the field's value should be stored

tokenized

boolean tokenized()

True if this field's value should be analyzed

storeTermVectors

boolean storeTermVectors()

True if term vectors should be indexed

storeTermVectorOffsets

boolean storeTermVectorOffsets()

True if term vector offsets should be indexed

storeTermVectorPositions

boolean storeTermVectorPositions()

True if term vector positions should be indexed

omitNorms

boolean omitNorms()

True if norms should not be indexed

indexOptions

FieldInfo.IndexOptions indexOptions()

FieldInfo.IndexOptions, describing what should be recorded into the inverted index

docValueType

DocValues.Type docValueType()

DocValues type; if non-null then the field's value will be indexed into docValues