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

All Known Subinterfaces:

AllFieldMapper, BoostFieldMapper, IdFieldMapper, IndexFieldMapper, RoutingFieldMapper, SourceFieldMapper, TypeFieldMapper, UidFieldMapper

All Known Implementing Classes:

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

@ThreadSafe
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(java.lang.String value)
org.apache.lucene.search.Query	fieldQuery(java.lang.String value) A field query for the specified value.
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()
java.lang.String	indexedValue(java.lang.String value) Returns the indexed value.
FieldMapper.Names	names()
boolean	omitNorms()
boolean	omitTermFreqAndPositions()
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(java.lang.String lowerTerm, java.lang.String upperTerm, boolean includeLower, boolean includeUpper) Constructs a range query filter based on the mapper.
org.apache.lucene.search.Query	rangeQuery(java.lang.String lowerTerm, java.lang.String upperTerm, boolean includeLower, boolean includeUpper) 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.document.Field.Store	store()
boolean	stored()
org.apache.lucene.document.Field.TermVector	termVector()
boolean	useFieldQueryWithQueryString() Should the field query fieldQuery(String) be used when detecting this field in query string.
T	value(org.apache.lucene.document.Fieldable field) Returns the actual value of the field.
java.lang.String	valueAsString(org.apache.lucene.document.Fieldable field) Returns the actual value of the field as string.
java.lang.Object	valueForSearch(org.apache.lucene.document.Fieldable field) Returns the value that will be used as a result for search.
T	valueFromString(java.lang.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()

omitTermFreqAndPositions

boolean omitTermFreqAndPositions()

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.

valueForSearch

java.lang.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(java.lang.String value)

valueAsString

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

Returns the actual value of the field as string.

indexedValue

java.lang.String indexedValue(java.lang.String value)

Returns the indexed value.

useFieldQueryWithQueryString

boolean useFieldQueryWithQueryString()

Should the field query fieldQuery(String) be used when detecting this field in query string.

fieldQuery

org.apache.lucene.search.Query fieldQuery(java.lang.String value)

A field query for the specified value.

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(java.lang.String value)

rangeQuery

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

Constructs a range query based on the mapper.

rangeFilter

org.apache.lucene.search.Filter rangeFilter(java.lang.String lowerTerm,
                                            java.lang.String upperTerm,
                                            boolean includeLower,
                                            boolean includeUpper)

Constructs a range query filter based on the mapper.

fieldDataType

FieldDataType fieldDataType()