Field (elastic-indexer 3.0.2 API)

java.lang.Object
- com.arakelian.elastic.model.Field

All Implemented Interfaces:: java.io.Serializable

@Value.Immutable(copy=false)
public abstract class Field
extends java.lang.Object
implements java.io.Serializable

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Field.IndexOptions`
`static class`	`Field.SubfieldSerializer`
`static class`	`Field.TermVector`
`static class`	`Field.Type`

Field Summary

Fields
Modifier and Type	Field and Description
`static java.util.Set<java.lang.String>`	`META_FIELDS` Elastic meta fields, see https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-fields.html

Constructor Summary

Constructors
Constructor and Description

Field()

Constructors
Constructor and Description
`Field()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object another)`
`java.util.List<java.lang.String>`	`getAdditionalTargets()` Returns a list of fields that should be targeted by `ElasticDocBuilder` whenever this field is targeted.
`java.util.Set<java.lang.String>`	`getAliases()` Returns a list of aliases for this field.
`java.lang.String`	`getAnalyzer()` Returns the analyzer used by this field.
`abstract java.lang.Double`	`getBoost()` Returns a query time boosting.
`abstract java.lang.Boolean`	`getCoerce()` Returns true if Elastic should try to convert strings to numbers and truncate fractions for integers.
`java.util.List<java.lang.String>`	`getCopyTo()` Returns a list of fields that this field value should be copied to.
`abstract java.lang.String`	`getDescription()`
`java.util.Set<java.lang.String>`	`getExcludePlugins()`
`java.util.Map<java.lang.String,Field>`	`getFields()`
`abstract java.lang.String`	`getFormat()` Returns the date format used by Elastic to parse date values.
`java.lang.Integer`	`getIgnoreAbove()` Returns the maximum length of strings that can be indexed or stored.
`java.util.Set<java.lang.String>`	`getIncludePlugins()`
`abstract Field.IndexOptions`	`getIndexOptions()` Returns setting that determines what information is added to the inverted index.
`abstract java.lang.String`	`getName()` Returns the name of the Elastic index field that should be created.
`abstract java.lang.String`	`getNormalizer()` Returns the normalizer used by this field.
`abstract java.lang.String`	`getNullValue()` Returns a value that will replace null values during indexed.
`abstract Orientation`	`getOrientation()` Returns how to interpret vertex order for polygons / multipolygons.
`abstract java.lang.Integer`	`getPositionIncrementGap()`
`abstract java.lang.String`	`getPrecision()`
`java.lang.Integer`	`getScalingFactor()`
`abstract java.lang.String`	`getSearchAnalyzer()`
`abstract SpatialStrategy`	`getStrategy()` Returns the approach for how to represent shapes at indexing and search time.
`abstract Field.TermVector`	`getTermVector()` Returns setting that determines what information is added to the inverted index.
`java.util.List<TokenFilter>`	`getTokenFilters()`
`abstract Tree`	`getTree()`
`abstract java.lang.String`	`getTreeLevels()` Returns maximum number of layers to be used by the PrefixTree.
`Field.Type`	`getType()`
`java.lang.Boolean`	`isDocValues()` Returns true if doc_values is enabled.
`abstract java.lang.Boolean`	`isEagerGlobalOrdinals()`
`abstract java.lang.Boolean`	`isEnabled()` Returns true if this field is enabled.
`abstract java.lang.Boolean`	`isFielddata()` Returns true if field data is enabled for field.
`abstract java.lang.Boolean`	`isIgnoreGlobalTokenFilters()`
`abstract java.lang.Boolean`	`isIgnoreMalformed()` Returns true if this field should ignore illegal values detected when building Elastic document.
`abstract java.lang.Boolean`	`isIgnoreZValue()` Returns true (default) if three dimension points will be accepted (stored in source) but only latitude and longitude values will be indexed; the third dimension is ignored.
`java.lang.Boolean`	`isIncludeInAll()` Returns true if this field should not be included in _all.
`java.lang.Boolean`	`isIndex()` Returns flag that indicates if field is indexed and therefore searchable.
`boolean`	`isMetaField()`
`abstract java.lang.Boolean`	`isNorms()`
`abstract java.lang.Boolean`	`isPointsOnly()`
`abstract java.lang.Boolean`	`isSortTokens()`
`java.lang.Boolean`	`isStore()` Returns true if the field value is stored.

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - META_FIELDS
```
public static final java.util.Set<java.lang.String> META_FIELDS
```
    Elastic meta fields, see https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-fields.html
- Constructor Detail
  - Field
```
public Field()
```
- Method Detail
  - equals
```
public boolean equals(@Nullable
                      java.lang.Object another)
```
    Overrides:
    
    equals in class java.lang.Object
  - getAdditionalTargets
```
@Value.Default
 @Value.Auxiliary
public java.util.List<java.lang.String> getAdditionalTargets()
```
    Returns a list of fields that should be targeted by ElasticDocBuilder whenever this field is targeted.
    
    Returns:
    
    list of fields that should be targeted by ElasticDocBuilder whenever this field is targeted.
  - getAliases
```
@Value.Default
 @Value.Auxiliary
public java.util.Set<java.lang.String> getAliases()
```
    Returns a list of aliases for this field.
    
    Returns:
    
    list of aliases for this field.
  - getAnalyzer
```
@Value.Default
 @Value.Auxiliary
public java.lang.String getAnalyzer()
```
    Returns the analyzer used by this field. For TOKEN_COUNT fields, the analyzer is required, and so therefore we default one below to make it easy to create new mappings by just specifyig a field type.
    
    Returns:
    
    the analyzer used by this field.
  - getBoost
```
@Value.Auxiliary
public abstract java.lang.Double getBoost()
```
    Returns a query time boosting. Accepts a floating point number, defaults to 1.0.
    
    Returns:
    
    a query time boosting
    
    See Also:
    
    boost
  - getCoerce
```
@Value.Auxiliary
public abstract java.lang.Boolean getCoerce()
```
    Returns true if Elastic should try to convert strings to numbers and truncate fractions for integers.
    
    Returns:
    
    true if Elastic should try to convert strings to numbers and truncate fractions for integers
    
    See Also:
    
    Range Datatypes
  - getCopyTo
```
@Value.Default
 @Value.Auxiliary
public java.util.List<java.lang.String> getCopyTo()
```
    Returns a list of fields that this field value should be copied to. The getCopyTo() allows you to create custom _all fields. The values of multiple fields can be copied into a group field, which can then be queried as a single field.
    
    Returns:
    
    list of fields that this field value should be copied to.
  - getDescription
```
@Value.Auxiliary
public abstract java.lang.String getDescription()
```
  - getExcludePlugins
```
@Value.Default
 @Value.Auxiliary
public java.util.Set<java.lang.String> getExcludePlugins()
```
  - getFields
```
@Value.Default
 @Value.Auxiliary
public java.util.Map<java.lang.String,Field> getFields()
```
  - getFormat
```
@Value.Auxiliary
public abstract java.lang.String getFormat()
```
    Returns the date format used by Elastic to parse date values. Note that Elastic internally stores dates as a long value representing milliseconds-since-the-epoch in UTC.
    
    Returns:
    
    date format used by Elastic to parse date values.
  - getIgnoreAbove
```
@Value.Default
 @Value.Auxiliary
public java.lang.Integer getIgnoreAbove()
```
    Returns the maximum length of strings that can be indexed or stored. Strings longer than the ignore_above setting will be ignored.
    
    Returns:
    
    maximum length of strings that can be indexed or stored
  - getIncludePlugins
```
@Value.Default
 @Value.Auxiliary
public java.util.Set<java.lang.String> getIncludePlugins()
```
  - getIndexOptions
```
@Value.Auxiliary
public abstract Field.IndexOptions getIndexOptions()
```
    Returns setting that determines what information is added to the inverted index. Analyzed string fields use Field.IndexOptions.POSITIONS as the default, and all other fields use Field.IndexOptions.DOCS as the default.
    
    Returns:
    
    setting that determines what information is added to the inverted index.
  - getName
```
public abstract java.lang.String getName()
```
    Returns the name of the Elastic index field that should be created.
    
    Returns:
    
    name of the Elastic index field that should be created.
  - getNormalizer
```
@Value.Auxiliary
public abstract java.lang.String getNormalizer()
```
    Returns the normalizer used by this field.
    
    Returns:
    
    the normalizer used by this field.
  - getNullValue
```
@Value.Auxiliary
public abstract java.lang.String getNullValue()
```
    Returns a value that will replace null values during indexed. Normally, null values cannot be indexed or searched. This parameter allows you to replace explicit null values with another value that can be indexed and searched instead.
    
    Returns:
    
    value that will replace null values during indexed
  - getOrientation
```
@Value.Auxiliary
public abstract Orientation getOrientation()
```
    Returns how to interpret vertex order for polygons / multipolygons.
    
    Returns:
    
    how to interpret vertex order for polygons / multipolygons.
  - getPositionIncrementGap
```
@Value.Auxiliary
public abstract java.lang.Integer getPositionIncrementGap()
```
  - getPrecision
```
@Value.Auxiliary
public abstract java.lang.String getPrecision()
```
  - getScalingFactor
```
@Value.Default
 @Value.Auxiliary
public java.lang.Integer getScalingFactor()
```
  - getSearchAnalyzer
```
@Value.Auxiliary
public abstract java.lang.String getSearchAnalyzer()
```
  - getStrategy
```
@Value.Auxiliary
public abstract SpatialStrategy getStrategy()
```
    Returns the approach for how to represent shapes at indexing and search time.
    
    Returns:
    
    the approach for how to represent shapes at indexing and search time.
  - getTermVector
```
@Value.Auxiliary
public abstract Field.TermVector getTermVector()
```
    Returns setting that determines what information is added to the inverted index. Analyzed string fields use Field.IndexOptions.POSITIONS as the default, and all other fields use Field.IndexOptions.DOCS as the default.
    
    Returns:
    
    setting that determines what information is added to the inverted index.
  - getTokenFilters
```
@Value.Default
 @Value.Auxiliary
public java.util.List<TokenFilter> getTokenFilters()
```
  - getTree
```
@Value.Auxiliary
public abstract Tree getTree()
```
  - getTreeLevels
```
@Value.Auxiliary
public abstract java.lang.String getTreeLevels()
```
    Returns maximum number of layers to be used by the PrefixTree. This can be used to control the precision of shape representations and therefore how many terms are indexed. Defaults to the default value of the chosen PrefixTree implementation
    
    Returns:
    
    maximum number of layers to be used by the PrefixTree
  - getType
```
@Value.Default
public Field.Type getType()
```
  - isDocValues
```
@Value.Default
 @Value.Auxiliary
public java.lang.Boolean isDocValues()
```
    Returns true if doc_values is enabled. Note that all fields which support doc values have them enabled by default.
    
    Returns:
    
    true if this field has doc_values enabled.
  - isEagerGlobalOrdinals
```
@Value.Auxiliary
public abstract java.lang.Boolean isEagerGlobalOrdinals()
```
  - isEnabled
```
@Value.Auxiliary
public abstract java.lang.Boolean isEnabled()
```
    Returns true if this field is enabled. The enabled setting can be applied only to the mapping type and to object fields, causes Elasticsearch to skip parsing of the contents of the field entirely. The JSON can still be retrieved from the _source field, but it is not searchable or stored in any other way.
    
    Returns:
    
    true if this field is enabled.
  - isFielddata
```
@Value.Auxiliary
public abstract java.lang.Boolean isFielddata()
```
    Returns true if field data is enabled for field. Fielddata can consume a lot of heap space, especially when loading high cardinality text fields. Once fielddata has been loaded into the heap, it remains there for the lifetime of the segment. Also, loading fielddata is an expensive process which can cause users to experience latency hits. This is why fielddata is disabled by default.
    
    Returns:
    
    true if field data is enabled for field.
  - isIgnoreGlobalTokenFilters
```
@Value.Auxiliary
public abstract java.lang.Boolean isIgnoreGlobalTokenFilters()
```
  - isIgnoreMalformed
```
@Value.Auxiliary
public abstract java.lang.Boolean isIgnoreMalformed()
```
    Returns true if this field should ignore illegal values detected when building Elastic document.
    
    Returns:
    
    true if this field should ignore illegal values detected when building Elastic document.
  - isIgnoreZValue
```
@Value.Auxiliary
public abstract java.lang.Boolean isIgnoreZValue()
```
    Returns true (default) if three dimension points will be accepted (stored in source) but only latitude and longitude values will be indexed; the third dimension is ignored. If false, geo-points containing any more than latitude and longitude (two dimensions) values throw an exception and reject the whole document.
    
    Returns:
    
    true if three dimension points will be accepted but only latitude and longitude values will be indexed
  - isIncludeInAll
```
@Value.Default
 @Value.Auxiliary
public java.lang.Boolean isIncludeInAll()
```
    Returns true if this field should not be included in _all.
    
    Returns:
    
    true if this field should not be included in _all.
    
    See Also:
    
    https://www.elastic.co/guide/en/elasticsearch/reference/current/include-in-all.html
  - isIndex
```
@Value.Default
 @Value.Auxiliary
public java.lang.Boolean isIndex()
```
    Returns flag that indicates if field is indexed and therefore searchable. Note that prior to ES 5, "analyzed" and "not_analyzed" were acceptable values for this field. Both values implied that index was "true", with "not_analyzed" also implying a field type of "keyword". A non-technical discussion of this on Elastic blog can be found here: https://www.elastic.co/blog/strings-are-dead-long-live-strings
    
    Returns:
    
    flag that indicates if field is indexed.
    
    See Also:
    
    https://github.com/elastic/elasticsearch/issues/21134
  - isMetaField
```
@Value.Default
 @Value.Auxiliary
public boolean isMetaField()
```
  - isNorms
```
@Value.Auxiliary
public abstract java.lang.Boolean isNorms()
```
  - isPointsOnly
```
@Value.Auxiliary
public abstract java.lang.Boolean isPointsOnly()
```
  - isSortTokens
```
@Value.Auxiliary
public abstract java.lang.Boolean isSortTokens()
```
  - isStore
```
@Value.Default
 @Value.Auxiliary
public java.lang.Boolean isStore()
```
    Returns true if the field value is stored. By default, field values are indexed to make them searchable, but they are not stored. This means that the field can be queried, but the original field value cannot be retrieved.
    
    Returns:
    
    true if this field value is stored.

Class Field

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

META_FIELDS

Constructor Detail

Field

Method Detail

equals

getAdditionalTargets

getAliases

getAnalyzer

getBoost

getCoerce

getCopyTo

getDescription

getExcludePlugins

getFields

getFormat

getIgnoreAbove

getIncludePlugins

getIndexOptions

getName

getNormalizer

getNullValue

getOrientation

getPositionIncrementGap

getPrecision

getScalingFactor

getSearchAnalyzer

getStrategy

getTermVector

getTokenFilters

getTree

getTreeLevels

getType

isDocValues

isEagerGlobalOrdinals

isEnabled

isFielddata

isIgnoreGlobalTokenFilters

isIgnoreMalformed

isIgnoreZValue

isIncludeInAll

isIndex

isMetaField

isNorms

isPointsOnly

isSortTokens

isStore