public interface

WebDimtyUnit

implements WebDisplayUnit
com.microstrategy.web.objects.WebDimtyUnit

Class Overview

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.

Summary

Public Methods
abstract int getAggregation()
Returns the current setting of the aggregation flag.
abstract int getFiltering()
Returns the current filtering setting on this object.
abstract boolean getGroupBy()
Returns the current setting of the groupBy property.
abstract int getKey()
Returns the key of this dimty unit in its' WebDimty collection.
abstract int getRelativePosition()
Returns the current setting for relative position for the dimensionality unit.
abstract WebObjectInfo getTarget()
Returns the target of the dimensionality unit, if one exists.
abstract int getUnitType()
Returns the dimty unit type, which is a value from EnumDSSXMLDimtyUnitType.
abstract void setAggregation(int aggregation)
Sets the aggregation of the current dimty unit.
abstract void setFiltering(int filtering)
Sets the filtering setting for this dimensionality unit.
abstract void setGroupBy(boolean groupBy)
Sets the groupBy property on this dimensionality unit.
abstract void setRelativePosition(int relativePosition)
Sets the relative position property.
abstract void setTarget(WebObjectInfo objectInfo)
Sets the target of the dimensionality unit.
[Expand]
Inherited Methods
From interface com.microstrategy.utils.KeyedObject
From interface com.microstrategy.web.objects.WebDisplayUnit

Public Methods

public abstract int getAggregation ()

Returns the current setting of the aggregation flag. This value should be from EnumDSSXMLAggregation.

Returns
  • The current aggregation setting.

public abstract int getFiltering ()

Returns the current filtering setting on this object.

Returns

public abstract boolean getGroupBy ()

Returns the current setting of the groupBy property.

Returns
  • The value of the groupBy property.

public abstract int getKey ()

Returns the key of this dimty unit in its' WebDimty collection.

Returns
  • The key of the current WebDimtyUnit object.

public abstract int getRelativePosition ()

Returns the current setting for relative position for the dimensionality unit.

Returns
  • the current relativePosition value(default is -1).

public abstract WebObjectInfo getTarget ()

Returns the target of the dimensionality unit, if one exists. If the dimensionality unit does not have a target set, or does not require one, this will return null.

Returns

public abstract int getUnitType ()

Returns the dimty unit type, which is a value from EnumDSSXMLDimtyUnitType. This is set upon creation of the dimty unit.

Returns

public abstract 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

public abstract 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

public abstract 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

public abstract void setRelativePosition (int relativePosition)

Sets the relative position property.

Parameters
relativePosition The value to use for relative position.

public abstract void setTarget (WebObjectInfo objectInfo)

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
UnsupportedOperationException If the dimensionality unit's type is one which cannot have a target, then this exception is thrown.
See Also