Package org.apache.lucene.index
Interface IndexableFieldType
-
- All Known Implementing Classes:
FieldType
public interface IndexableFieldTypeDescribes the properties of a field.- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description DocValuesTypedocValuesType()DocValuesDocValuesType: how the field's value will be indexed into docValues.Map<String,String>getAttributes()Attributes for the field type.IndexOptionsindexOptions()IndexOptions, describing what should be recorded into the inverted indexbooleanomitNorms()True if normalization values should be omitted for the field.intpointDimensionCount()If this is positive (representing the number of point dimensions), the field is indexed as a point.intpointIndexDimensionCount()The number of dimensions used for the index keyintpointNumBytes()The number of bytes in each dimension's values.booleanstored()True if the field's value should be storedbooleanstoreTermVectorOffsets()True if this field's token character offsets should also be stored into term vectors.booleanstoreTermVectorPayloads()True if this field's token payloads should also be stored into the term vectors.booleanstoreTermVectorPositions()True if this field's token positions should also be stored into the term vectors.booleanstoreTermVectors()True if this field's indexed form should be also stored into term vectors.booleantokenized()True if this field's value should be analyzed by theAnalyzer.intvectorDimension()The number of dimensions of the field's vector valueVectorEncodingvectorEncoding()TheVectorEncodingof the field's vector valueVectorSimilarityFunctionvectorSimilarityFunction()TheVectorSimilarityFunctionof the field's vector value
-
-
-
Method Detail
-
stored
boolean stored()
True if the field's value should be stored
-
tokenized
boolean tokenized()
True if this field's value should be analyzed by theAnalyzer.This has no effect if
indexOptions()returns IndexOptions.NONE.
-
storeTermVectors
boolean 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
TermVectors.get(int,String).This option is illegal if
indexOptions()returns IndexOptions.NONE.
-
storeTermVectorOffsets
boolean 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)
-
storeTermVectorPositions
boolean 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).
-
storeTermVectorPayloads
boolean 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).
-
omitNorms
boolean 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.
-
indexOptions
IndexOptions indexOptions()
IndexOptions, describing what should be recorded into the inverted index
-
docValuesType
DocValuesType docValuesType()
DocValuesDocValuesType: how the field's value will be indexed into docValues.
-
pointDimensionCount
int pointDimensionCount()
If this is positive (representing the number of point dimensions), the field is indexed as a point.
-
pointIndexDimensionCount
int pointIndexDimensionCount()
The number of dimensions used for the index key
-
pointNumBytes
int pointNumBytes()
The number of bytes in each dimension's values.
-
vectorDimension
int vectorDimension()
The number of dimensions of the field's vector value
-
vectorEncoding
VectorEncoding vectorEncoding()
TheVectorEncodingof the field's vector value
-
vectorSimilarityFunction
VectorSimilarityFunction vectorSimilarityFunction()
TheVectorSimilarityFunctionof the field's vector value
-
-