Module org.elasticsearch.server

Package org.elasticsearch.index.mapper

Class RangeFieldMapper.RangeFieldType

java.lang.Object

org.elasticsearch.index.mapper.MappedFieldType

org.elasticsearch.index.mapper.RangeFieldMapper.RangeFieldType

Enclosing class:

RangeFieldMapper

public static final class RangeFieldMapper.RangeFieldType
extends MappedFieldType

Nested Class Summary

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

MappedFieldType.CollapseType, MappedFieldType.Relation

Field Summary

Fields

Modifier and Type	Field	Description
protected final boolean	coerce
protected final DateMathParser	dateMathParser
protected final DateFormatter	dateTimeFormatter
protected final RangeType	rangeType

Constructor Summary

Constructors

Constructor	Description
RangeFieldType(String name, boolean indexed, boolean stored, boolean hasDocValues, DateFormatter formatter, boolean coerce, Map<String,String> meta)
RangeFieldType(String name, DateFormatter formatter)
RangeFieldType(String name, RangeType type)
RangeFieldType(String name, RangeType type, boolean indexed, boolean stored, boolean hasDocValues, boolean coerce, Map<String,String> meta)

Method Summary

Modifier and Type	Method	Description
protected DateMathParser	dateMathParser()
DateFormatter	dateTimeFormatter()
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(FieldDataContext fieldDataContext)	Return a fielddata builder for this field
boolean	mayExistInIndex(SearchExecutionContext context)
org.apache.lucene.search.Query	rangeQuery(Object lowerTerm, Object upperTerm, boolean includeLower, boolean includeUpper, ShapeRelation relation, ZoneId timeZone, DateMathParser parser, SearchExecutionContext context)	Factory method for range queries.
RangeType	rangeType()
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.

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

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

Methods inherited from class java.lang.Object

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

Field Details

rangeType

protected final RangeType rangeType

dateTimeFormatter

protected final DateFormatter dateTimeFormatter

dateMathParser

protected final DateMathParser dateMathParser

coerce

protected final boolean coerce

Constructor Details

RangeFieldType

public RangeFieldType(String name,
 RangeType type,
 boolean indexed,
 boolean stored,
 boolean hasDocValues,
 boolean coerce,
 Map<String,String> meta)

RangeFieldType

public RangeFieldType(String name,
 RangeType type)

RangeFieldType

public RangeFieldType(String name,
 boolean indexed,
 boolean stored,
 boolean hasDocValues,
 DateFormatter formatter,
 boolean coerce,
 Map<String,String> meta)

RangeFieldType

public RangeFieldType(String name,
 DateFormatter formatter)

Method Details

rangeType

public RangeType rangeType()

fielddataBuilder

public IndexFieldData.Builder fielddataBuilder(FieldDataContext fieldDataContext)

Description copied from class: MappedFieldType

Return a fielddata builder for this field

Overrides:

fielddataBuilder in class MappedFieldType

Parameters:

fieldDataContext - the context for the fielddata

mayExistInIndex

public boolean mayExistInIndex(SearchExecutionContext context)

Overrides:

mayExistInIndex in class MappedFieldType

Returns:

if the field may have values in the underlying index Note that this should only return false if it is not possible for it to match on a term query.

See Also:

• QueryParserHelper

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

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

dateTimeFormatter

public DateFormatter dateTimeFormatter()

dateMathParser

protected DateMathParser dateMathParser()

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

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

Specified by:

termQuery in class MappedFieldType

rangeQuery

public org.apache.lucene.search.Query rangeQuery(Object lowerTerm,
 Object upperTerm,
 boolean includeLower,
 boolean includeUpper,
 ShapeRelation relation,
 ZoneId timeZone,
 DateMathParser parser,
 SearchExecutionContext context)

Description copied from class: MappedFieldType

Factory method for range queries.

Overrides:

rangeQuery in class MappedFieldType

relation - the relation, nulls should be interpreted like INTERSECTS