Package org.elasticsearch.index.mapper

Class CustomDocValuesField

java.lang.Object

org.elasticsearch.index.mapper.CustomDocValuesField

All Implemented Interfaces:

IndexableField

Direct Known Subclasses:

BinaryFieldMapper.CustomBinaryDocValuesField

public abstract class CustomDocValuesField
extends Object
implements IndexableField

Field Summary

Fields

Modifier and Type	Field	Description
static FieldType	TYPE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CustomDocValuesField(String name)

Method Summary

Modifier and Type	Method	Description
IndexableFieldType	fieldType()	IndexableFieldType describing the properties of this field.
String	name()	Field name
Number	numericValue()	Non-null if this field has a numeric value
Reader	readerValue()	Non-null if this field has a Reader value
String	stringValue()	Non-null if this field has a string value
TokenStream	tokenStream(Analyzer analyzer, TokenStream reuse)	Creates the TokenStream used for indexing this field.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.lucene.index.IndexableField

binaryValue, getCharSequenceValue

Field Detail

TYPE

public static final FieldType TYPE

Constructor Detail

CustomDocValuesField

protected CustomDocValuesField(String name)

Method Detail

name

public String name()

Description copied from interface: IndexableField

Field name

Specified by:

name in interface IndexableField

fieldType

public IndexableFieldType fieldType()

Description copied from interface: IndexableField

IndexableFieldType describing the properties of this field.

Specified by:

fieldType in interface IndexableField

stringValue

public String stringValue()

Description copied from interface: IndexableField

Non-null if this field has a string value

Specified by:

stringValue in interface IndexableField

readerValue

public Reader readerValue()

Description copied from interface: IndexableField

Non-null if this field has a Reader value

Specified by:

readerValue in interface IndexableField

numericValue

public Number numericValue()

Description copied from interface: IndexableField

Non-null if this field has a numeric value

Specified by:

numericValue in interface IndexableField

tokenStream

public TokenStream tokenStream(Analyzer analyzer,
                               TokenStream reuse)

Description copied from interface: IndexableField

Creates the TokenStream used for indexing this field. If appropriate, implementations should use the given Analyzer to create the TokenStreams.

Specified by:

tokenStream in interface IndexableField

Parameters:

analyzer - Analyzer that should be used to create the TokenStreams from

reuse - TokenStream for a previous instance of this field name. This allows custom field types (like StringField and NumericField) that do not use the analyzer to still have good performance. Note: the passed-in type may be inappropriate, for example if you mix up different types of Fields for the same field name. So it's the responsibility of the implementation to check.

Returns:

TokenStream value for indexing the document. Should always return a non-null value if the field is to be indexed