Package com.microstrategy.web.objects
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 Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description int
getAggregation()
Returns the current setting of the aggregation flag.int
getFiltering()
Returns the current filtering setting on this object.boolean
getGroupBy()
Returns the current setting of the groupBy property.int
getKey()
Returns the key of this dimty unit in its'WebDimty
collection.int
getRelativePosition()
Returns the current setting for relative position for the dimensionality unit.WebObjectInfo
getTarget()
Returns the target of the dimensionality unit, if one exists.int
getUnitType()
Returns the dimty unit type, which is a value fromEnumDSSXMLDimtyUnitType
.void
setAggregation(int aggregation)
Sets the aggregation of the current dimty unit.void
setFiltering(int filtering)
Sets the filtering setting for this dimensionality unit.void
setGroupBy(boolean groupBy)
Sets the groupBy property on this dimensionality unit.void
setRelativePosition(int relativePosition)
Sets the relative position property.void
setTarget(WebObjectInfo objectInfo)
Sets the target of the dimensionality unit.-
Methods inherited from interface com.microstrategy.utils.KeyedObject
_getObKey
-
Methods inherited from interface com.microstrategy.web.objects.WebDisplayUnit
addDetails, applyVisitor, canHighlight, getChildUnits, getDisplayName, getDisplayUnitType, getID, hasDetails, highlightUnit, highlightUnit, isHighlighted, isObjectInfo, isSelected, setDisplayName, setSelected
-
-
-
-
Method Detail
-
getKey
int getKey()
Returns the key of this dimty unit in its'WebDimty
collection.- Returns:
- The key of the current WebDimtyUnit object.
-
getUnitType
int getUnitType()
Returns the dimty unit type, which is a value fromEnumDSSXMLDimtyUnitType
. This is set upon creation of the dimty unit.- Returns:
- The dimty unit type, from
EnumDSSXMLDimtyUnitType
.
-
getAggregation
int getAggregation()
Returns the current setting of the aggregation flag. This value should be fromEnumDSSXMLAggregation
.- 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 fromEnumDSSXMLAggregation
, which will be set as the aggregation on this dimty unit.- See Also:
getAggregation()
-
getFiltering
int getFiltering()
Returns the current filtering setting on this object.- Returns:
- A value from
EnumDSSXMLFiltering
. - See Also:
setFiltering(int)
-
setFiltering
void setFiltering(int filtering)
Sets the filtering setting for this dimensionality unit.- Parameters:
filtering
- The new value for the filtering property, fromEnumDSSXMLFiltering
.- 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()
-
getTarget
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:
- A
WebObjectInfo
object, or null if the target is not set. - See Also:
setTarget(com.microstrategy.web.objects.WebObjectInfo)
-
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
- AWebObjectInfo
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()
-
-