Interface WebDimtyUnit

  • All Superinterfaces:
    KeyedObject, WebDisplayUnit

    public interface WebDimtyUnit
    extends WebDisplayUnit
    This interface represents a dimensionality unit.

    The dimensionality of a metric is an expression that represents the level (i.e. list of attributes) at which the metric is calculated. It is fairly complex since in addition to describing a list of attributes we also need to describe how the level interacts with attributes in the filter and the template of the report that contains the metric.

    The dimensionality is described as a collection of units. Each unit is represented by an instance of WebDimtyUnit. Each dimensionality unit records information about how a particular attribute or dimension appears in the dimensionality.

    Since:
    MicroStrategy Web 7.3.1 or earlier
    • Method Detail

      • getKey

        int getKey()
        Returns the key of this dimty unit in its' WebDimty collection.
        Returns:
        The key of the current WebDimtyUnit object.
      • getAggregation

        int getAggregation()
        Returns the current setting of the aggregation flag. This value should be from EnumDSSXMLAggregation.
        Returns:
        The current aggregation setting.
        See Also:
        setAggregation(int)
      • setAggregation

        void setAggregation​(int aggregation)
        Sets the aggregation of the current dimty unit.
        Parameters:
        aggregation - A value from EnumDSSXMLAggregation, which will be set as the aggregation on this dimty unit.
        See Also:
        getAggregation()
      • setFiltering

        void setFiltering​(int filtering)
        Sets the filtering setting for this dimensionality unit.
        Parameters:
        filtering - The new value for the filtering property, from EnumDSSXMLFiltering.
        See Also:
        getFiltering()
      • getGroupBy

        boolean getGroupBy()
        Returns the current setting of the groupBy property.
        Returns:
        The value of the groupBy property.
        See Also:
        setGroupBy(boolean)
      • setGroupBy

        void setGroupBy​(boolean groupBy)
        Sets the groupBy property on this dimensionality unit.
        Parameters:
        groupBy - A boolean which tells whether groupBy should be on or off for this dimensionality unit.
        See Also:
        getGroupBy()
      • getRelativePosition

        int getRelativePosition()
        Returns the current setting for relative position for the dimensionality unit.
        Returns:
        the current relativePosition value(default is -1).
        See Also:
        setRelativePosition(int)
      • setRelativePosition

        void setRelativePosition​(int relativePosition)
        Sets the relative position property.
        Parameters:
        relativePosition - The value to use for relative position.
        See Also:
        getRelativePosition()
      • setTarget

        void setTarget​(WebObjectInfo objectInfo)
                throws java.lang.UnsupportedOperationException
        Sets the target of the dimensionality unit. Note that this is only valid for some of the different dimensionality unit types.
        Parameters:
        objectInfo - A WebObjectInfo object which is to be used as the target of this dimensionality unit.
        Throws:
        java.lang.UnsupportedOperationException - If the dimensionality unit's type is one which cannot have a target, then this exception is thrown.
        See Also:
        getTarget()