public class FieldType extends Object implements IndexableFieldType
Modifier and Type | Class and Description |
---|---|
static class |
FieldType.NumericType
Data type of the numeric value
|
Constructor and Description |
---|
FieldType()
Create a new FieldType with default properties.
|
FieldType(FieldType ref)
Create a new mutable FieldType with all of the properties from
ref |
Modifier and Type | Method and Description |
---|---|
FieldInfo.DocValuesType |
docValueType()
DocValues
FieldInfo.DocValuesType : if non-null then the field's value
will be indexed into docValues. |
void |
freeze()
Prevents future changes.
|
boolean |
indexed()
True if this field should be indexed (inverted)
|
FieldInfo.IndexOptions |
indexOptions()
FieldInfo.IndexOptions , describing what should be
recorded into the inverted index |
int |
numericPrecisionStep()
Precision step for numeric field.
|
FieldType.NumericType |
numericType()
NumericType: if non-null then the field's value will be indexed
numerically so that
NumericRangeQuery can be used at
search time. |
boolean |
omitNorms()
True if normalization values should be omitted for the field.
|
void |
setDocValueType(FieldInfo.DocValuesType type)
Set's the field's DocValuesType
|
void |
setIndexed(boolean value)
Set to
true to index (invert) this field. |
void |
setIndexOptions(FieldInfo.IndexOptions value)
Sets the indexing options for the field:
|
void |
setNumericPrecisionStep(int precisionStep)
Sets the numeric precision step for the field.
|
void |
setNumericType(FieldType.NumericType type)
Specifies the field's numeric type.
|
void |
setOmitNorms(boolean value)
Set to
true to omit normalization values for the field. |
void |
setStored(boolean value)
Set to
true to store this field. |
void |
setStoreTermVectorOffsets(boolean value)
Set to
true to also store token character offsets into the term
vector for this field. |
void |
setStoreTermVectorPayloads(boolean value)
Set to
true to also store token payloads into the term
vector for this field. |
void |
setStoreTermVectorPositions(boolean value)
Set to
true to also store token positions into the term
vector for this field. |
void |
setStoreTermVectors(boolean value)
Set to
true if this field's indexed form should be also stored
into term vectors. |
void |
setTokenized(boolean value)
Set to
true to tokenize this field's contents via the
configured Analyzer . |
boolean |
stored()
True if the field's value should be stored
|
boolean |
storeTermVectorOffsets()
True if this field's token character offsets should also
be stored into term vectors.
|
boolean |
storeTermVectorPayloads()
True if this field's token payloads should also be stored
into the term vectors.
|
boolean |
storeTermVectorPositions()
True if this field's token positions should also be stored
into the term vectors.
|
boolean |
storeTermVectors()
True if this field's indexed form should be also stored
into term vectors.
|
boolean |
tokenized()
True if this field's value should be analyzed by the
Analyzer . |
String |
toString()
Prints a Field for human consumption.
|
public FieldType(FieldType ref)
ref
public FieldType()
public void freeze()
public boolean indexed()
The default is false
.
indexed
in interface IndexableFieldType
setIndexed(boolean)
public void setIndexed(boolean value)
true
to index (invert) this field.value
- true if this field should be indexed.IllegalStateException
- if this FieldType is frozen against
future modifications.indexed()
public boolean stored()
The default is false
.
stored
in interface IndexableFieldType
setStored(boolean)
public void setStored(boolean value)
true
to store this field.value
- true if this field should be stored.IllegalStateException
- if this FieldType is frozen against
future modifications.stored()
public boolean tokenized()
Analyzer
.
This has no effect if IndexableFieldType.indexed()
returns false.
The default is true
.
tokenized
in interface IndexableFieldType
setTokenized(boolean)
public void setTokenized(boolean value)
true
to tokenize this field's contents via the
configured Analyzer
.value
- true if this field should be tokenized.IllegalStateException
- if this FieldType is frozen against
future modifications.tokenized()
public boolean storeTermVectors()
This builds a miniature inverted-index for this field which
can be accessed in a document-oriented way from
IndexReader.getTermVector(int,String)
.
This option is illegal if IndexableFieldType.indexed()
returns false.
The default is false
.
storeTermVectors
in interface IndexableFieldType
setStoreTermVectors(boolean)
public void setStoreTermVectors(boolean value)
true
if this field's indexed form should be also stored
into term vectors.value
- true if this field should store term vectors.IllegalStateException
- if this FieldType is frozen against
future modifications.storeTermVectors()
public boolean storeTermVectorOffsets()
This option is illegal if term vectors are not enabled for the field
(IndexableFieldType.storeTermVectors()
is false)
The default is false
.
storeTermVectorOffsets
in interface IndexableFieldType
setStoreTermVectorOffsets(boolean)
public void setStoreTermVectorOffsets(boolean value)
true
to also store token character offsets into the term
vector for this field.value
- true if this field should store term vector offsets.IllegalStateException
- if this FieldType is frozen against
future modifications.storeTermVectorOffsets()
public boolean storeTermVectorPositions()
This option is illegal if term vectors are not enabled for the field
(IndexableFieldType.storeTermVectors()
is false).
The default is false
.
storeTermVectorPositions
in interface IndexableFieldType
setStoreTermVectorPositions(boolean)
public void setStoreTermVectorPositions(boolean value)
true
to also store token positions into the term
vector for this field.value
- true if this field should store term vector positions.IllegalStateException
- if this FieldType is frozen against
future modifications.storeTermVectorPositions()
public boolean storeTermVectorPayloads()
This option is illegal if term vector positions are not enabled
for the field (IndexableFieldType.storeTermVectors()
is false).
The default is false
.
storeTermVectorPayloads
in interface IndexableFieldType
setStoreTermVectorPayloads(boolean)
public void setStoreTermVectorPayloads(boolean value)
true
to also store token payloads into the term
vector for this field.value
- true if this field should store term vector payloads.IllegalStateException
- if this FieldType is frozen against
future modifications.storeTermVectorPayloads()
public boolean omitNorms()
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.
The default is false
.
omitNorms
in interface IndexableFieldType
setOmitNorms(boolean)
public void setOmitNorms(boolean value)
true
to omit normalization values for the field.value
- true if this field should omit norms.IllegalStateException
- if this FieldType is frozen against
future modifications.omitNorms()
public FieldInfo.IndexOptions indexOptions()
FieldInfo.IndexOptions
, describing what should be
recorded into the inverted index
The default is FieldInfo.IndexOptions.DOCS_AND_FREQS_AND_POSITIONS
.
indexOptions
in interface IndexableFieldType
setIndexOptions(org.apache.lucene.index.FieldInfo.IndexOptions)
public void setIndexOptions(FieldInfo.IndexOptions value)
value
- indexing optionsIllegalStateException
- if this FieldType is frozen against
future modifications.indexOptions()
public void setNumericType(FieldType.NumericType type)
type
- numeric type, or null if the field has no numeric type.IllegalStateException
- if this FieldType is frozen against
future modifications.numericType()
public FieldType.NumericType numericType()
NumericRangeQuery
can be used at
search time.
The default is null
(no numeric type)
setNumericType(NumericType)
public void setNumericPrecisionStep(int precisionStep)
precisionStep
- numeric precision step for the fieldIllegalArgumentException
- if precisionStep is less than 1.IllegalStateException
- if this FieldType is frozen against
future modifications.numericPrecisionStep()
public int numericPrecisionStep()
This has no effect if numericType()
returns null.
The default is NumericUtils.PRECISION_STEP_DEFAULT
setNumericPrecisionStep(int)
public final String toString()
public FieldInfo.DocValuesType docValueType()
FieldInfo.DocValuesType
: if non-null then the field's value
will be indexed into docValues.
The default is null
(no docValues)
docValueType
in interface IndexableFieldType
setDocValueType(org.apache.lucene.index.FieldInfo.DocValuesType)
public void setDocValueType(FieldInfo.DocValuesType type)
type
- DocValues type, or null if no DocValues should be stored.IllegalStateException
- if this FieldType is frozen against
future modifications.docValueType()
Copyright © 2000-2013 Apache Software Foundation. All Rights Reserved.