org.elasticsearch.index.mapper.ip

Class LegacyIpFieldMapper.IpFieldType

java.lang.Object

org.apache.lucene.document.FieldType

org.elasticsearch.index.mapper.MappedFieldType

org.elasticsearch.index.mapper.TermBasedFieldType

org.elasticsearch.index.mapper.core.LegacyNumberFieldMapper.NumberFieldType

org.elasticsearch.index.mapper.core.LegacyLongFieldMapper.LongFieldType

org.elasticsearch.index.mapper.ip.LegacyIpFieldMapper.IpFieldType

All Implemented Interfaces:

org.apache.lucene.index.IndexableFieldType

Enclosing class:

LegacyIpFieldMapper

public static final class LegacyIpFieldMapper.IpFieldType
extends LegacyLongFieldMapper.LongFieldType

Nested Class Summary

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

MappedFieldType.Relation

Nested classes/interfaces inherited from class org.apache.lucene.document.FieldType

org.apache.lucene.document.FieldType.LegacyNumericType

Constructor Summary

Constructors

Modifier	Constructor and Description
	IpFieldType()
protected	IpFieldType(LegacyIpFieldMapper.IpFieldType ref)

Method Summary

Modifier and Type	Method and Description
LegacyNumberFieldMapper.NumberFieldType	clone()
DocValueFormat	docValueFormat(java.lang.String format, org.joda.time.DateTimeZone timeZone) Return a DocValueFormat that can be used to display and parse values as returned by the fielddata API.
IndexFieldData.Builder	fielddataBuilder() Return a fielddata builder for this field
org.apache.lucene.util.BytesRef	indexedValueForSearch(java.lang.Object value) Returns the indexed value used to construct search "values".
org.apache.lucene.search.Query	rangeQuery(java.lang.Object lowerTerm, java.lang.Object upperTerm, boolean includeLower, boolean includeUpper)
FieldStats	stats(org.apache.lucene.index.IndexReader reader)
org.apache.lucene.search.Query	termQuery(java.lang.Object value, QueryShardContext context) Generates a query that will only match documents that contain the given value.
java.lang.String	typeName() Returns the name of this type, as would be specified in mapping properties
java.lang.Object	valueForSearch(java.lang.Object value) IPs should return as a string.

Methods inherited from class org.elasticsearch.index.mapper.core.LegacyLongFieldMapper.LongFieldType

nullValue

Methods inherited from class org.elasticsearch.index.mapper.core.LegacyNumberFieldMapper.NumberFieldType

checkCompatibility

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

termsQuery

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

boost, eagerGlobalOrdinals, equals, extractTerm, failIfNoDocValues, failIfNotIndexed, fuzzyQuery, hasDocValues, hashCode, indexAnalyzer, isAggregatable, isFieldWithinQuery, isSearchable, name, nullValueAsString, nullValueQuery, prefixQuery, queryStringTermQuery, regexpQuery, searchAnalyzer, searchQuoteAnalyzer, setBoost, setEagerGlobalOrdinals, setHasDocValues, setIndexAnalyzer, setName, setNullValue, setSearchAnalyzer, setSearchQuoteAnalyzer, setSimilarity, similarity

Methods inherited from class org.apache.lucene.document.FieldType

checkIfFrozen, docValuesType, freeze, indexOptions, numericPrecisionStep, numericType, omitNorms, pointDimensionCount, pointNumBytes, setDimensions, setDocValuesType, setIndexOptions, setNumericPrecisionStep, setNumericType, setOmitNorms, setStored, setStoreTermVectorOffsets, setStoreTermVectorPayloads, setStoreTermVectorPositions, setStoreTermVectors, setTokenized, stored, storeTermVectorOffsets, storeTermVectorPayloads, storeTermVectorPositions, storeTermVectors, tokenized, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

IpFieldType

public IpFieldType()

IpFieldType

protected IpFieldType(LegacyIpFieldMapper.IpFieldType ref)

Method Detail

clone

public LegacyNumberFieldMapper.NumberFieldType clone()

Overrides:

clone in class LegacyLongFieldMapper.LongFieldType

typeName

public java.lang.String typeName()

Description copied from class: MappedFieldType

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

Overrides:

typeName in class LegacyLongFieldMapper.LongFieldType

valueForSearch

public java.lang.Object valueForSearch(java.lang.Object value)

IPs should return as a string.

Overrides:

valueForSearch in class MappedFieldType

indexedValueForSearch

public org.apache.lucene.util.BytesRef indexedValueForSearch(java.lang.Object value)

Description copied from class: TermBasedFieldType

Returns the indexed value used to construct search "values". This method is used for the default implementations of most query factory methods such as TermBasedFieldType.termQuery(java.lang.Object, org.elasticsearch.index.query.QueryShardContext).

Overrides:

indexedValueForSearch in class LegacyLongFieldMapper.LongFieldType

termQuery

public org.apache.lucene.search.Query termQuery(java.lang.Object value,
                                                @Nullable
                                                QueryShardContext 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().

Overrides:

termQuery in class TermBasedFieldType

rangeQuery

public org.apache.lucene.search.Query rangeQuery(java.lang.Object lowerTerm,
                                                 java.lang.Object upperTerm,
                                                 boolean includeLower,
                                                 boolean includeUpper)

Overrides:

rangeQuery in class LegacyLongFieldMapper.LongFieldType

stats

public FieldStats stats(org.apache.lucene.index.IndexReader reader)
                 throws java.io.IOException

Overrides:

stats in class LegacyLongFieldMapper.LongFieldType

Returns:

a FieldStats instance that maps to the type of this field or null if the provided index has no stats about the current field

Throws:

java.io.IOException

fielddataBuilder

public IndexFieldData.Builder fielddataBuilder()

Description copied from class: MappedFieldType

Return a fielddata builder for this field

Overrides:

fielddataBuilder in class LegacyLongFieldMapper.LongFieldType

docValueFormat

public DocValueFormat docValueFormat(@Nullable
                                     java.lang.String format,
                                     org.joda.time.DateTimeZone timeZone)

Description copied from class: MappedFieldType

Return a DocValueFormat that can be used to display and parse values as returned by the fielddata API. The default implementation returns a DocValueFormat.RAW.

Overrides:

docValueFormat in class LegacyNumberFieldMapper.NumberFieldType