public interface

WebDimension

implements WebObjectInfo
com.microstrategy.web.objects.WebDimension

Class Overview

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.

Summary

Public Methods
abstract Enumeration elements()
Returns a java.util.Enumeration containing the attributes within the collection.
abstract WebDimensionAttribute get(int index)
Returns the attribute within the collection with the given index.
abstract int getStyle()
Returns the XML style in which the dimension will be output in display XML.
abstract WebDisplayUnits getTopLevelAttributes()
abstract boolean isEmpty()
Returns whether the dimension has any attributes.
abstract WebDimensionAttribute itemByID(String attributeDSSID)
Searches for an attribute with the given DSSID in the WebDimension collection.
abstract void setStyle(int style)
Sets the XML style will be used when generating display XML for this dimension.
abstract int size()
Returns the number of attributes in the dimension collection.
[Expand]
Inherited Methods
From interface com.microstrategy.utils.KeyedObject
From interface com.microstrategy.web.objects.WebDisplayUnit
From interface com.microstrategy.web.objects.WebFeatures
From interface com.microstrategy.web.objects.WebObjectInfo
From interface com.microstrategy.web.objects.WebPromptSite

Public Methods

public abstract Enumeration elements ()

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

Returns
  • An Enumeration containing the objects within the dimension.

public abstract WebDimensionAttribute get (int index)

Returns the attribute within the collection with the given index.

Parameters
index The index of the object to find.
Returns
Throws
IndexOutOfBoundsException Thrown if the given index is invalid.

public abstract int getStyle ()

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

Returns
See Also

public abstract WebDisplayUnits getTopLevelAttributes ()

public abstract boolean isEmpty ()

Returns whether the dimension has any attributes.

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

public abstract WebDimensionAttribute itemByID (String attributeDSSID)

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
Throws
IllegalArgumentException Thrown if an attribute by the given DSS ID is not found in the dimension.

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

public abstract int size ()

Returns the number of attributes in the dimension collection.

Returns
  • The size of the dimension collection.