org.elasticsearch.index.mapper

Class IpFieldMapper.IpFieldType

java.lang.Object

org.apache.lucene.document.FieldType

org.elasticsearch.index.mapper.MappedFieldType

org.elasticsearch.index.mapper.IpFieldMapper.IpFieldType

All Implemented Interfaces:

org.apache.lucene.index.IndexableFieldType

Enclosing class:

IpFieldMapper

public static final class IpFieldMapper.IpFieldType
extends MappedFieldType

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IpFieldMapper.IpFieldType.IpScriptDocValues

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

Method Summary

Modifier and Type	Method and Description
MappedFieldType	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.search.Query	rangeQuery(java.lang.Object lowerTerm, java.lang.Object upperTerm, boolean includeLower, boolean includeUpper, QueryShardContext context)
FieldStats.Ip	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.
org.apache.lucene.search.Query	termsQuery(java.util.List<?> values, QueryShardContext context) Build a constant-scoring query that matches all values.
java.lang.String	typeName() Returns the name of this type, as would be specified in mapping properties
java.lang.Object	valueForDisplay(java.lang.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, checkCompatibility, eagerGlobalOrdinals, equals, extractTerm, failIfNoDocValues, failIfNotIndexed, fuzzyQuery, hasDocValues, hashCode, indexAnalyzer, isAggregatable, isFieldWithinQuery, isSearchable, name, nullValue, 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

Method Detail

clone

public MappedFieldType clone()

Specified by:

clone in class MappedFieldType

typeName

public java.lang.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

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().

Specified by:

termQuery in class MappedFieldType

termsQuery

public org.apache.lucene.search.Query termsQuery(java.util.List<?> values,
                                                 QueryShardContext 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.QueryShardContext).

Overrides:

termsQuery in class MappedFieldType

rangeQuery

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

Overrides:

rangeQuery in class MappedFieldType

stats

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

Overrides:

stats in class MappedFieldType

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 MappedFieldType

valueForDisplay

public java.lang.Object valueForDisplay(java.lang.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(@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 MappedFieldType