Module org.elasticsearch.server

Package org.elasticsearch.index.mapper

Interface DocumentDimensions

All Known Implementing Classes:

DocumentDimensions.OnlySingleValueAllowed, TimeSeriesIdFieldMapper.TimeSeriesIdBuilder

public interface DocumentDimensions

Collects dimensions from documents.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	DocumentDimensions.OnlySingleValueAllowed	Makes sure that each dimension only appears on time.

Method Summary

Modifier and Type	Method	Description
DocumentDimensions	addIp(String fieldName, InetAddress value)
DocumentDimensions	addLong(String fieldName, long value)
default DocumentDimensions	addString(String fieldName, String value)
DocumentDimensions	addString(String fieldName, org.apache.lucene.util.BytesRef utf8Value)	This overloaded method tries to take advantage of the fact that the UTF-8 value is already computed in some cases when we want to collect dimensions, so we can save re-computing the UTF-8 encoding.
DocumentDimensions	addUnsignedLong(String fieldName, long value)
static DocumentDimensions	fromIndexSettings(IndexSettings indexSettings)	Build an index's DocumentDimensions using its settings
DocumentDimensions	validate(IndexSettings settings)

Method Details

fromIndexSettings

static DocumentDimensions fromIndexSettings(IndexSettings indexSettings)

Build an index's DocumentDimensions using its settings

addString

DocumentDimensions addString(String fieldName,
 org.apache.lucene.util.BytesRef utf8Value)

This overloaded method tries to take advantage of the fact that the UTF-8 value is already computed in some cases when we want to collect dimensions, so we can save re-computing the UTF-8 encoding.

addString

default DocumentDimensions addString(String fieldName,
 String value)

addIp

DocumentDimensions addIp(String fieldName,
 InetAddress value)

addLong

DocumentDimensions addLong(String fieldName,
 long value)

addUnsignedLong

DocumentDimensions addUnsignedLong(String fieldName,
 long value)

validate

DocumentDimensions validate(IndexSettings settings)