java.lang.Object

org.elasticsearch.index.mapper.KeywordFieldMapper.KeywordFieldType

Enclosing class:: KeywordFieldMapper

public static final class KeywordFieldMapper.KeywordFieldType
extends StringFieldType

Nested Class Summary

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

Constructor Summary

Constructors
Constructor	Description
`KeywordFieldType(java.lang.String name)`
`KeywordFieldType(java.lang.String name, boolean isSearchable, boolean hasDocValues, java.util.Map<java.lang.String,java.lang.String> meta)`
`KeywordFieldType(java.lang.String name, boolean hasDocValues, org.apache.lucene.document.FieldType fieldType, boolean eagerGlobalOrdinals, NamedAnalyzer normalizer, NamedAnalyzer searchAnalyzer, SimilarityProvider similarity, java.util.Map<java.lang.String,java.lang.String> meta, float boost)`
`KeywordFieldType(java.lang.String name, NamedAnalyzer analyzer)`

Method Summary

Modifier and Type	Method	Description
`org.apache.lucene.search.Query`	`existsQuery(QueryShardContext context)`
`IndexFieldData.Builder`	`fielddataBuilder(java.lang.String fullyQualifiedIndexName)`	Return a fielddata builder for this field
`protected org.apache.lucene.util.BytesRef`	`indexedValueForSearch(java.lang.Object value)`	Returns the indexed value used to construct search "values".
`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.StringFieldType

fuzzyQuery, normalizeWildcardPattern, prefixQuery, rangeQuery, regexpQuery, wildcardQuery

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

rangeQuery

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

boost, docValueFormat, eagerGlobalOrdinals, extractTerm, failIfNoDocValues, failIfNotIndexed, familyTypeName, getTextSearchInfo, hasDocValues, indexAnalyzer, intervals, isAggregatable, isFieldWithinQuery, isSearchable, meta, multiPhraseQuery, name, phrasePrefixQuery, phraseQuery, pointReaderIfPossible, setBoost, setEagerGlobalOrdinals, setIndexAnalyzer, spanPrefixQuery, updateMeta

Methods inherited from class java.lang.Object

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

Constructor Details
- KeywordFieldType
  
  public KeywordFieldType(java.lang.String name, boolean hasDocValues, org.apache.lucene.document.FieldType fieldType, boolean eagerGlobalOrdinals, NamedAnalyzer normalizer, NamedAnalyzer searchAnalyzer, SimilarityProvider similarity, java.util.Map<java.lang.String,java.lang.String> meta, float boost)
- KeywordFieldType
  
  public KeywordFieldType(java.lang.String name, boolean isSearchable, boolean hasDocValues, java.util.Map<java.lang.String,java.lang.String> meta)
- KeywordFieldType
  
  public KeywordFieldType(java.lang.String name)
- KeywordFieldType
  
  public KeywordFieldType(java.lang.String name, NamedAnalyzer analyzer)
Method Details
- 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
- existsQuery
  
  public org.apache.lucene.search.Query existsQuery(QueryShardContext context)
  
  Specified by:
  
  existsQuery in class MappedFieldType
- fielddataBuilder
  
  public IndexFieldData.Builder fielddataBuilder(java.lang.String fullyQualifiedIndexName)
  
  Description copied from class: MappedFieldType
  
  Return a fielddata builder for this field
  
  Overrides:
  
  fielddataBuilder in class MappedFieldType
  
  Parameters:
  
  fullyQualifiedIndexName - the name of the index this field-data is build for
- 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
- indexedValueForSearch
  
  protected org.apache.lucene.util.BytesRef indexedValueForSearch(java.lang.Object value)
  
  Returns the indexed value used to construct search "values". This method is used for the default implementations of most query factory methods such as MappedFieldType.termQuery(java.lang.Object, org.elasticsearch.index.query.QueryShardContext).
- termQuery
  
  public org.apache.lucene.search.Query termQuery(java.lang.Object value, 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

Class KeywordFieldMapper.KeywordFieldType

Nested Class Summary

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