Package de.elo.ix.client.esearch.query

Class AggregationQuery

java.lang.Object
de.elo.ix.client.esearch.query.AggregationQuery
All Implemented Interfaces:
Serializable
public class AggregationQuery extends Object implements Serializable
Since:
21.03.000.001
See Also:

  • Field Details

    • name

      protected String name

    • type

      protected AggregationTypeE type

    • searchField

      protected SearchFieldE searchField
      Provides the constant of the field to be aggregated.
      To aggregate an index field, set this to SearchFieldE.INDEXFIELD and provide its name in indexFieldKey.
      See Also:

    • fieldType

      protected FieldTypeE fieldType
      Defines the concrete ES field together with searchField.
      Options are tokenized, not tokenized, numeric, date.
      See Also:

    • indexFieldKey

      protected String indexFieldKey
      If searchfield equals to SearchFieldE.INDEXFIELD, provide the name of the index field here.
      If searchField != SearchFieldE.INDEXFIELD, this value is ignored. If the associated docmask is of type DocMaskC.DATA_ORGANISATION_OBJKEYS or DATA_ORGANISATION_TABLE the value of this field should be the line key of the docMaskLine. If the associated docMask is of type DocMaskC.DATA_ORGANISATION_ASPECT the value of this field should be the name of the aspectAssoc followed by "¶" followed by the line key of the aspectLine, e.g. CUSTOMERADDRESS¶STREET.

    • aggregationQueryParams

      protected AggregationQueryParams aggregationQueryParams
      Contains type specific parameters (e.g. for type=TERMS parameters size, sub-aggregations, ...)

  • Constructor Details

    • AggregationQuery

      public AggregationQuery()

    • AggregationQuery

      public AggregationQuery(String name)
      Constructor with only the name.

    • AggregationQuery

      public AggregationQuery(String name, AggregationTypeE type)
      Constructor with name and type.

    • AggregationQuery

      public AggregationQuery(String name, AggregationTypeE type, SearchFieldE searchField, FieldTypeE fieldType)
      Constructor with name, type and frequently used parameters searchField and fieldType.

  • Method Details

    • getName

      public String getName()

    • setName

      public void setName(String name)

    • getType

      public AggregationTypeE getType()

    • setType

      public void setType(AggregationTypeE type)

    • getSearchField

      public SearchFieldE getSearchField()

    • setSearchField

      public void setSearchField(SearchFieldE searchField)

    • getFieldType

      public FieldTypeE getFieldType()

    • setFieldType

      public void setFieldType(FieldTypeE fieldType)

    • getIndexFieldKey

      public String getIndexFieldKey()

    • setIndexFieldKey

      public void setIndexFieldKey(String indexFieldKey)

    • getAggregationQueryParams

      public AggregationQueryParams getAggregationQueryParams()

    • setAggregationQueryParams

      public void setAggregationQueryParams(AggregationQueryParams aggregationQueryParams)

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • toString

      public String toString(int depth)
      Produces a toString-Result with base parameters and type specific parameters.
      The type specific parameters are contained in aggregationQueryParams (type-specific) and can contain AggregationQueries for sub-aggregations of one level deeper.
      Parameters:
      depth - recursion depth of sub-aggregations
      Returns:

    • toShortString

      public String toShortString()
      Returns a shorter toString value.
      The aggregationQueryParams are type specific.