org.elasticsearch.action.fieldstats

Class IndexConstraint

java.lang.Object

org.elasticsearch.action.fieldstats.IndexConstraint

public class IndexConstraint
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IndexConstraint.Comparison
static class	IndexConstraint.Property

Constructor Summary

Constructors

Constructor and Description
IndexConstraint(String field, IndexConstraint.Property property, IndexConstraint.Comparison comparison, String value)
IndexConstraint(String field, IndexConstraint.Property property, IndexConstraint.Comparison comparison, String value, String optionalFormat)

Method Summary

Methods

Modifier and Type	Method and Description
IndexConstraint.Comparison	getComparison()
String	getField()
String	getOptionalFormat()
IndexConstraint.Property	getProperty()
String	getValue()

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexConstraint

public IndexConstraint(String field,
               IndexConstraint.Property property,
               IndexConstraint.Comparison comparison,
               String value)

IndexConstraint

public IndexConstraint(String field,
               IndexConstraint.Property property,
               IndexConstraint.Comparison comparison,
               String value,
               String optionalFormat)

Method Detail

getField

public String getField()

Returns:

On what field the constraint is going to be applied on

getComparison

public IndexConstraint.Comparison getComparison()

Returns:

How to compare the specified value against the field property (lt, lte, gt and gte)

getProperty

public IndexConstraint.Property getProperty()

Returns:

On what property of a field the contraint is going to be applied on (min or max value)

getValue

public String getValue()

Returns:

The value to compare against

getOptionalFormat

public String getOptionalFormat()

Returns:

An optional format, that specifies how the value string is converted in the native value of the field. Not all field types support this and right now only date field supports this option.