org.elasticsearch.index.mapper
Interface FieldMapper<T>

All Known Implementing Classes:

AbstractFieldMapper, AllFieldMapper, BinaryFieldMapper, BooleanFieldMapper, BoostFieldMapper, ByteFieldMapper, DateFieldMapper, DoubleFieldMapper, FloatFieldMapper, GeoPointFieldMapper.GeoStringFieldMapper, GeoShapeFieldMapper, IdFieldMapper, IndexFieldMapper, IntegerFieldMapper, IpFieldMapper, LongFieldMapper, NumberFieldMapper, ParentFieldMapper, RoutingFieldMapper, ShortFieldMapper, SizeFieldMapper, SourceFieldMapper, StringFieldMapper, TimestampFieldMapper, TTLFieldMapper, TypeFieldMapper, UidFieldMapper

public interface FieldMapper<T>

Nested Class Summary

static class

FieldMapper.Names

Method Summary

boolean	analyzed()
float	boost()
FieldDataType	fieldDataType()
org.apache.lucene.search.Filter	fieldFilter(String value, QueryParseContext context)
org.apache.lucene.search.Query	fieldQuery(String value, QueryParseContext context) A field query for the specified value.
org.apache.lucene.search.Query	fuzzyQuery(String value, double minSim, int prefixLength, int maxExpansions)
org.apache.lucene.search.Query	fuzzyQuery(String value, String minSim, int prefixLength, int maxExpansions)
org.apache.lucene.document.Field.Index	index()
org.apache.lucene.analysis.Analyzer	indexAnalyzer() The analyzer that will be used to index the field.
boolean	indexed()
String	indexedValue(String value) Returns the indexed value.
org.apache.lucene.index.FieldInfo.IndexOptions	indexOptions()
FieldMapper.Names	names()
org.apache.lucene.search.Filter	nullValueFilter() Null value filter, returns null if there is no null value associated with the field.
boolean	omitNorms()
org.apache.lucene.search.Filter	prefixFilter(String value, QueryParseContext context)
org.apache.lucene.search.Query	prefixQuery(String value, org.apache.lucene.search.MultiTermQuery.RewriteMethod method, QueryParseContext context)
org.apache.lucene.search.Query	queryStringTermQuery(org.apache.lucene.index.Term term) A term query to use when parsing a query string.
org.apache.lucene.search.Filter	rangeFilter(String lowerTerm, String upperTerm, boolean includeLower, boolean includeUpper, QueryParseContext context) Constructs a range query filter based on the mapper.
org.apache.lucene.search.Query	rangeQuery(String lowerTerm, String upperTerm, boolean includeLower, boolean includeUpper, QueryParseContext context) Constructs a range query based on the mapper.
org.apache.lucene.analysis.Analyzer	searchAnalyzer() The analyzer that will be used to search the field.
org.apache.lucene.analysis.Analyzer	searchQuoteAnalyzer() The analyzer that will be used for quoted search on the field.
org.apache.lucene.document.Field.Store	store()
boolean	stored()
org.apache.lucene.document.Field.TermVector	termVector()
boolean	useFieldQueryWithQueryString() Should the field query fieldQuery(String, org.elasticsearch.index.query.QueryParseContext) be used when detecting this field in query string.
T	value(org.apache.lucene.document.Fieldable field) Returns the actual value of the field.
String	valueAsString(org.apache.lucene.document.Fieldable field) Returns the actual value of the field as string.
Object	valueForSearch(org.apache.lucene.document.Fieldable field) Returns the value that will be used as a result for search.
T	valueFromString(String value)

Method Detail

names

FieldMapper.Names names()

index

org.apache.lucene.document.Field.Index index()

indexed

boolean indexed()

analyzed

boolean analyzed()

store

org.apache.lucene.document.Field.Store store()

stored

boolean stored()

termVector

org.apache.lucene.document.Field.TermVector termVector()

boost

float boost()

omitNorms

boolean omitNorms()

indexOptions

org.apache.lucene.index.FieldInfo.IndexOptions indexOptions()

indexAnalyzer

org.apache.lucene.analysis.Analyzer indexAnalyzer()

The analyzer that will be used to index the field.

searchAnalyzer

org.apache.lucene.analysis.Analyzer searchAnalyzer()

The analyzer that will be used to search the field.

searchQuoteAnalyzer

org.apache.lucene.analysis.Analyzer searchQuoteAnalyzer()

The analyzer that will be used for quoted search on the field.

valueForSearch

Object valueForSearch(org.apache.lucene.document.Fieldable field)

Returns the value that will be used as a result for search. Can be only of specific types... .

value

T value(org.apache.lucene.document.Fieldable field)

Returns the actual value of the field.

valueFromString

T valueFromString(String value)

valueAsString

String valueAsString(org.apache.lucene.document.Fieldable field)

Returns the actual value of the field as string.

indexedValue

String indexedValue(String value)

Returns the indexed value.

useFieldQueryWithQueryString

boolean useFieldQueryWithQueryString()

Should the field query fieldQuery(String, org.elasticsearch.index.query.QueryParseContext) be used when detecting this field in query string.

fieldQuery

org.apache.lucene.search.Query fieldQuery(String value,
                                          @Nullable
                                          QueryParseContext context)

A field query for the specified value.

fuzzyQuery

org.apache.lucene.search.Query fuzzyQuery(String value,
                                          String minSim,
                                          int prefixLength,
                                          int maxExpansions)

fuzzyQuery

org.apache.lucene.search.Query fuzzyQuery(String value,
                                          double minSim,
                                          int prefixLength,
                                          int maxExpansions)

prefixQuery

org.apache.lucene.search.Query prefixQuery(String value,
                                           @Nullable
                                           org.apache.lucene.search.MultiTermQuery.RewriteMethod method,
                                           @Nullable
                                           QueryParseContext context)

prefixFilter

org.apache.lucene.search.Filter prefixFilter(String value,
                                             @Nullable
                                             QueryParseContext context)

queryStringTermQuery

org.apache.lucene.search.Query queryStringTermQuery(org.apache.lucene.index.Term term)

A term query to use when parsing a query string. Can return null.

fieldFilter

org.apache.lucene.search.Filter fieldFilter(String value,
                                            @Nullable
                                            QueryParseContext context)

rangeQuery

org.apache.lucene.search.Query rangeQuery(String lowerTerm,
                                          String upperTerm,
                                          boolean includeLower,
                                          boolean includeUpper,
                                          @Nullable
                                          QueryParseContext context)

Constructs a range query based on the mapper.

rangeFilter

org.apache.lucene.search.Filter rangeFilter(String lowerTerm,
                                            String upperTerm,
                                            boolean includeLower,
                                            boolean includeUpper,
                                            @Nullable
                                            QueryParseContext context)

Constructs a range query filter based on the mapper.

nullValueFilter

@Nullable
org.apache.lucene.search.Filter nullValueFilter()

Null value filter, returns null if there is no null value associated with the field.

fieldDataType

FieldDataType fieldDataType()