Package com.gooddata.sdk.model.executeafm.afm

Class SimpleMeasureDefinition

java.lang.Object
com.gooddata.sdk.model.executeafm.afm.SimpleMeasureDefinition
All Implemented Interfaces:
MeasureDefinition, java.io.Serializable
Direct Known Subclasses:
VOSimpleMeasureDefinition
public class SimpleMeasureDefinition
extends java.lang.Object
implements MeasureDefinition
Definition of simple measure
See Also:
Serialized Form

  • Constructor Details

    • SimpleMeasureDefinition

      public SimpleMeasureDefinition​(ObjQualifier item)

    • SimpleMeasureDefinition

      public SimpleMeasureDefinition​(ObjQualifier item, java.lang.String aggregation, java.lang.Boolean computeRatio, java.util.List<FilterItem> filters)
      Creates new definition
      Parameters:
      item - item which is measured, can be attribute, fact or another measure
      aggregation - additional aggregation applied
      computeRatio - whether should be shown as ratio
      filters - additional filters applied

    • SimpleMeasureDefinition

      public SimpleMeasureDefinition​(ObjQualifier item, Aggregation aggregation, java.lang.Boolean computeRatio, java.util.List<FilterItem> filters)
      Creates new definition
      Parameters:
      item - item which is measured, can be attribute, fact or another measure
      aggregation - additional aggregation applied
      computeRatio - whether should be shown as ratio
      filters - additional filters applied

    • SimpleMeasureDefinition

      public SimpleMeasureDefinition​(ObjQualifier item, Aggregation aggregation, java.lang.Boolean computeRatio, FilterItem... filters)
      Creates new definition
      Parameters:
      item - item which is measured, can be attribute, fact or another measure
      aggregation - additional aggregation applied
      computeRatio - whether should be shown as ratio
      filters - additional filters applied

  • Method Details

    • withObjUriQualifiers

      public MeasureDefinition withObjUriQualifiers​(ObjQualifierConverter objQualifierConverter)
      Description copied from interface: MeasureDefinition
      Copy itself using the given object qualifier converter in case when IdentifierObjQualifier instances are used in the object otherwise the original object is returned.

      The provided converter must be able to handle the conversion for the qualifiers that are of the IdentifierObjQualifier type that are used by this object or its encapsulated child objects.

      Specified by:
      withObjUriQualifiers in interface MeasureDefinition
      Parameters:
      objQualifierConverter - The function that converts identifier qualifiers to the matching URI qualifiers. In case when the object uses the identifier qualifiers, it will return a new copy of itself or its encapsulated objects that used URI qualifiers, otherwise the original object is returned. The parameter must not be null.
      Returns:
      copy of itself with replaced qualifiers in case when some IdentifierObjQualifier were used, otherwise original object is returned.

    • isAdHoc

      public boolean isAdHoc()
      Specified by:
      isAdHoc in interface MeasureDefinition
      Returns:
      true if this definition represents ad hoc specified measure, false otherwise

    • getUri

      public java.lang.String getUri()
      Description copied from interface: MeasureDefinition
      Returns the definition in the form of uri of Metric. Default implementation throws UnsupportedOperationException
      Specified by:
      getUri in interface MeasureDefinition
      Returns:
      uri of the measure

    • getObjQualifiers

      public java.util.Collection<ObjQualifier> getObjQualifiers()
      Description copied from interface: MeasureDefinition
      Returns all the qualifiers used by the measure definition and its encapsulated objects.

      This information comes handy if it is necessary, for example, to convert the measure definition to use just the URI object qualifiers instead of the identifier object qualifiers. It can be used to gather these for a conversion service.

      Specified by:
      getObjQualifiers in interface MeasureDefinition
      Returns:
      all the qualifiers the measure definition uses, even in its encapsulated objects (apart from the measure filters)

    • getItem

      public ObjQualifier getItem()
      Returns:
      measured item, can be attribute, fact or another measure

    • getAggregation

      public java.lang.String getAggregation()
      Returns:
      additional aggregation applied

    • setAggregation

      public void setAggregation​(java.lang.String aggregation)
      Set additional aggregation applied
      Parameters:
      aggregation - additional aggregation applied

    • setAggregation

      public void setAggregation​(Aggregation aggregation)
      Set additional aggregation applied
      Parameters:
      aggregation - additional aggregation applied

    • getComputeRatio

      public java.lang.Boolean getComputeRatio()
      Returns:
      true when should be shown as ratio, false otherwise

    • setComputeRatio

      public void setComputeRatio​(java.lang.Boolean computeRatio)
      Set whether should be shown as ratio
      Parameters:
      computeRatio - whether should be shown as ratio

    • getFilters

      public java.util.List<FilterItem> getFilters()
      Returns:
      additional filters applied

    • setFilters

      public void setFilters​(java.util.List<FilterItem> filters)
      Set additional filters applied
      Parameters:
      filters - additional filters applied

    • addFilter

      public void addFilter​(FilterItem filter)
      Apply additional filter
      Parameters:
      filter - filter to be applied

    • hasFilters

      public boolean hasFilters()
      Returns:
      true when filters are set, false otherwise

    • hasComputeRatio

      public boolean hasComputeRatio()
      Returns:
      true when computeRatio is set, false otherwise

    • hasAggregation

      public boolean hasAggregation()
      Returns:
      true when additional aggregation is set, false otherwise

    • equals

      public boolean equals​(java.lang.Object o)
      Overrides:
      equals in class java.lang.Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object