Package com.microstrategy.web.objects

Interface WebDimension

All Superinterfaces:

KeyedObject, WebDisplayUnit, WebFeatures, WebObjectInfo, WebPromptSite

public interface WebDimension
extends WebObjectInfo

This interface represents a dimension, which is a first class object. The WebDimension interface is primarily a collection of attributes, and most of its' methods which are not derived from WebObjectInfo reflect that fact.

Since:

MicroStrategy Web 7.3.1 or earlier

Method Summary

Modifier and Type	Method	Description
java.util.Enumeration	elements()	Returns a java.util.Enumeration containing the attributes within the collection.
WebDimensionAttribute	get(int index)	Returns the attribute within the collection with the given index.
int	getStyle()	Returns the XML style in which the dimension will be output in display XML.
WebDisplayUnits	getTopLevelAttributes()
boolean	isEmpty()	Returns whether the dimension has any attributes.
WebDimensionAttribute	itemByID(java.lang.String attributeDSSID)	Searches for an attribute with the given DSSID in the WebDimension collection.
void	setStyle(int style)	Sets the XML style will be used when generating display XML for this dimension.
int	size()	Returns the number of attributes in the dimension collection.

Methods inherited from interface com.microstrategy.utils.KeyedObject

_getObKey

Methods inherited from interface com.microstrategy.web.objects.WebDisplayUnit

addDetails, applyVisitor, canHighlight, getChildUnits, getDisplayName, getDisplayUnitType, hasDetails, highlightUnit, highlightUnit, isHighlighted, isObjectInfo, isSelected, setDisplayName, setSelected

Methods inherited from interface com.microstrategy.web.objects.WebFeatures

isFeatureAvailable, isFeatureAvailable

Methods inherited from interface com.microstrategy.web.objects.WebObjectInfo

buildShortObjectAttributes, buildShortXML, getAbbreviation, getAccessGranted, getAncestors, getCardStatus, getCertifiedInfo, getComments, getContainerDid, getContainerType, getCreationTime, getCreationTimeStamp, getDataSources, getDescription, getExtendedType, getFactory, getFlags, getIconPath, getID, getModificationTime, getModificationTimeStamp, getName, getNonSchedulable, getOtherNameTransCount, getOwner, getParent, getPreSaveAsFlags, getProjectId, getProjectName, getPropertyFlags, getPropertySetFilter, getPropertySets, getRecommendationInfo, getSecurity, getState, getSubType, getType, getVersionID, getViewMediaSettings, getVisualizationViewMode, getXML, getXML, hasOwner, isAncestorNamedFolder, isDirty, isEmbedded, isHidden, isNew, isPopulated, populate, populate, setAbbreviation, setComments, setDataSources, setDescription, setExtendedType, setFlags, setHidden, setIconPath, setName, setNonSchedulable, setPreSaveAsFlags, setPropertyFlags

Methods inherited from interface com.microstrategy.web.objects.WebPromptSite

getPromptInstances

Method Detail

get

WebDimensionAttribute get(int index)
                   throws java.lang.IndexOutOfBoundsException

Returns the attribute within the collection with the given index.

Parameters:

index - The index of the object to find.

Returns:

The WebDimensionAttribute object corresponding to the given index.

Throws:

java.lang.IndexOutOfBoundsException - Thrown if the given index is invalid.

itemByID

WebDimensionAttribute itemByID(java.lang.String attributeDSSID)
                        throws java.lang.IllegalArgumentException

Searches for an attribute with the given DSSID in the WebDimension collection.

Parameters:

attributeDSSID - The DSS ID of the attribute to search for in the dimension.

Returns:

The WebDimensionAttribute object with the given DSS ID.

Throws:

java.lang.IllegalArgumentException - Thrown if an attribute by the given DSS ID is not found in the dimension.

isEmpty

boolean isEmpty()

Returns whether the dimension has any attributes.

Returns:

True if the dimension has attributes, false if it does not.

size

int size()

Returns the number of attributes in the dimension collection.

Returns:

The size of the dimension collection.

elements

java.util.Enumeration elements()

Returns a java.util.Enumeration containing the attributes within the collection.

Returns:

An Enumeration containing the objects within the dimension.

getStyle

int getStyle()

Returns the XML style in which the dimension will be output in display XML.

Returns:

The current display style of the dimension, from EnumWebDimensionDisplayStyle.

See Also:

setStyle(int)

setStyle

void setStyle(int style)

Sets the XML style will be used when generating display XML for this dimension.

Parameters:

style - The display style to use for the dimension, which should be a value from EnumWebDimensionDisplayStyle.

See Also:

getStyle()

getTopLevelAttributes

WebDisplayUnits getTopLevelAttributes()

Since:

MicroStrategy Web 9.0.0