Module org.elasticsearch.server

Package org.elasticsearch.index.mapper

Class IpScriptFieldType

java.lang.Object

org.elasticsearch.index.mapper.MappedFieldType

org.elasticsearch.index.mapper.AbstractScriptFieldType<IpFieldScript.LeafFactory>

org.elasticsearch.index.mapper.IpScriptFieldType

public final class IpScriptFieldType
extends AbstractScriptFieldType<IpFieldScript.LeafFactory>

Nested Class Summary

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

AbstractScriptFieldType.Builder<Factory>

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

MappedFieldType.BlockLoaderContext, MappedFieldType.CollapseType, MappedFieldType.FielddataOperation, MappedFieldType.FieldExtractPreference, MappedFieldType.Relation

Field Summary

Fields

Modifier and Type	Field	Description
static final RuntimeField.Parser	PARSER

Fields inherited from class org.elasticsearch.index.mapper.AbstractScriptFieldType

DEFAULT_SCRIPT, script

Method Summary

Modifier and Type	Method	Description
BlockLoader	blockLoader(MappedFieldType.BlockLoaderContext blContext)	Returns a loader for ESQL or null if the field doesn't support ESQL.
DocValueFormat	docValueFormat(String format, ZoneId timeZone)	Pick a DocValueFormat that can be used to display and parse values of fields of this type.
org.apache.lucene.search.Query	existsQuery(SearchExecutionContext context)
IpScriptFieldData.Builder	fielddataBuilder(FieldDataContext fieldDataContext)	Return a fielddata builder for this field
org.apache.lucene.search.Query	rangeQuery(Object lowerTerm, Object upperTerm, boolean includeLower, boolean includeUpper, ZoneId timeZone, DateMathParser parser, SearchExecutionContext context)
org.apache.lucene.search.Query	termQuery(Object value, SearchExecutionContext context)	Generates a query that will only match documents that contain the given value.
org.apache.lucene.search.Query	termsQuery(Collection<?> values, SearchExecutionContext context)	Build a constant-scoring query that matches all values.
String	typeName()	Returns the name of this type, as would be specified in mapping properties
Object	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.AbstractScriptFieldType

applyScriptContext, fieldHasValue, fuzzyQuery, isAggregatable, isSearchable, leafFactory, leafFactory, multiPhraseQuery, phrasePrefixQuery, phraseQuery, prefixQuery, rangeQuery, regexpQuery, spanPrefixQuery, validateMatchedRoutingPath, valueFetcher, wildcardQuery

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

checkNoFormat, checkNoTimeZone, collapseType, dimensions, distanceFeatureQuery, eagerGlobalOrdinals, extractTerm, failIfNoDocValues, failIfNotIndexed, failIfNotIndexedNorDocValuesFallback, familyTypeName, fuzzyIntervals, fuzzyQuery, getMetricType, getTerms, getTextSearchInfo, hasDocValues, isDimension, isFieldWithinQuery, isIndexed, isStored, mayExistInIndex, meta, name, normalizedWildcardQuery, pointReaderIfPossible, prefixIntervals, prefixQuery, termIntervals, termQueryCaseInsensitive, wildcardIntervals, wildcardQuery

Methods inherited from class java.lang.Object

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

Field Details

PARSER

public static final RuntimeField.Parser PARSER

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

valueForDisplay

public Object 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

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

fielddataBuilder

public IpScriptFieldData.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

existsQuery

public org.apache.lucene.search.Query existsQuery(SearchExecutionContext context)

Overrides:

existsQuery in class MappedFieldType

rangeQuery

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

Specified by:

rangeQuery in class AbstractScriptFieldType<IpFieldScript.LeafFactory>

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

termsQuery

public org.apache.lucene.search.Query termsQuery(Collection<?> values,
 SearchExecutionContext context)

Description copied from class: MappedFieldType

Build a constant-scoring query that matches all values. The default implementation uses a ConstantScoreQuery around a BooleanQuery whose BooleanClause.Occur.SHOULD clauses are generated with MappedFieldType.termQuery(java.lang.Object, org.elasticsearch.index.query.SearchExecutionContext).

Overrides:

termsQuery in class MappedFieldType

blockLoader

public BlockLoader blockLoader(MappedFieldType.BlockLoaderContext blContext)

Description copied from class: MappedFieldType

Returns a loader for ESQL or null if the field doesn't support ESQL.

Overrides:

blockLoader in class MappedFieldType