Package org.elasticsearch.index.mapper

Class BinaryFieldMapper.BinaryFieldType

java.lang.Object

org.elasticsearch.index.mapper.MappedFieldType

org.elasticsearch.index.mapper.BinaryFieldMapper.BinaryFieldType

Enclosing class:

BinaryFieldMapper

public static final class BinaryFieldMapper.BinaryFieldType
extends MappedFieldType

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.index.mapper.MappedFieldType

MappedFieldType.CollapseType, MappedFieldType.Relation

Constructor Summary

Constructors

Constructor	Description
BinaryFieldType(String name)

Method Summary

Modifier and Type	Method	Description
DocValueFormat	docValueFormat(String format, ZoneId timeZone)	Pick a DocValueFormat that can be used to display and parse values of fields of this type.
IndexFieldData.Builder	fielddataBuilder(String fullyQualifiedIndexName, Supplier<SearchLookup> searchLookup)	Return a fielddata builder for this field
org.apache.lucene.search.Query	termQuery(Object value, SearchExecutionContext context)	Generates a query that will only match documents that contain the given value.
String	typeName()	Returns the name of this type, as would be specified in mapping properties
ValueFetcher	valueFetcher(SearchExecutionContext context, String format)	Create a helper class to fetch field values during the FetchFieldsPhase.
BytesReference	valueForDisplay(Object value)	Given a value that comes from the stored fields API, convert it to the expected type.

Methods inherited from class org.elasticsearch.index.mapper.MappedFieldType

boost, checkNoFormat, checkNoTimeZone, collapseType, distanceFeatureQuery, eagerGlobalOrdinals, existsQuery, extractTerm, failIfNoDocValues, failIfNotIndexed, familyTypeName, fuzzyIntervals, fuzzyQuery, getTerms, getTextSearchInfo, hasDocValues, isAggregatable, isDimension, isFieldWithinQuery, isSearchable, isStored, meta, multiPhraseQuery, name, normalizedWildcardQuery, phrasePrefixQuery, phraseQuery, pointReaderIfPossible, prefixIntervals, prefixQuery, prefixQuery, rangeQuery, regexpQuery, setBoost, spanPrefixQuery, termIntervals, termQueryCaseInsensitive, termsQuery, wildcardIntervals, wildcardQuery, wildcardQuery

Methods inherited from class java.lang.Object

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

Constructor Details

BinaryFieldType

public BinaryFieldType(String name)

Method Details

typeName

public String typeName()

Description copied from class: MappedFieldType

Returns the name of this type, as would be specified in mapping properties

Specified by:

typeName in class MappedFieldType

valueFetcher

public ValueFetcher valueFetcher(SearchExecutionContext context,
 String format)

Description copied from class: MappedFieldType

Create a helper class to fetch field values during the FetchFieldsPhase.

New field types must implement this method in order to support the search 'fields' option. Except for metadata fields, field types should not throw UnsupportedOperationException since this could cause a search retrieving multiple fields (like "fields": ["*"]) to fail.

Specified by:

valueFetcher in class MappedFieldType

docValueFormat

public DocValueFormat docValueFormat(String format,
 ZoneId timeZone)

Description copied from class: MappedFieldType

Pick a DocValueFormat that can be used to display and parse values of fields of this type.

Overrides:

docValueFormat in class MappedFieldType

valueForDisplay

public BytesReference valueForDisplay(Object value)

Description copied from class: MappedFieldType

Given a value that comes from the stored fields API, convert it to the expected type. For instance a date field would store dates as longs and format it back to a string in this method.

Overrides:

valueForDisplay in class MappedFieldType

fielddataBuilder

public IndexFieldData.Builder fielddataBuilder(String fullyQualifiedIndexName,
 Supplier<SearchLookup> searchLookup)

Description copied from class: MappedFieldType

Return a fielddata builder for this field

Overrides:

fielddataBuilder in class MappedFieldType

Parameters:

fullyQualifiedIndexName - the name of the index this field-data is build for

searchLookup - a SearchLookup supplier to allow for accessing other fields values in the context of runtime fields

termQuery

public org.apache.lucene.search.Query termQuery(Object value,
 SearchExecutionContext context)

Description copied from class: MappedFieldType

Generates a query that will only match documents that contain the given value. The default implementation returns a TermQuery over the value bytes, boosted by MappedFieldType.boost().

Specified by:

termQuery in class MappedFieldType