public interface

WebDimty

com.microstrategy.web.objects.WebDimty

Class Overview

The WebDimty object represents a dimensionality object. A dimensionality object is a collection of one or more dimensionality unit (WebDimtyUnit) objects. This collection is indexed and has keys which can be used to refer to specific dimty unit objects.

This object is primarily used in answering level prompts and building expressions such as in security filter. It cannot be directly instantiated, and must be obtained from the WebPrompt, WebMDSecurityFilter or WebNode objects.

Summary

Public Methods
abstract WebDimtyUnit add(WebObjectInfo object)
Adds a new WebDimtyUnit object, where the dimty unit type is determined by the object passed in, to the collection, at the end of the collection.
abstract WebDimtyUnit add(int unitType)
Adds a new WebDimtyUnit object, with the given unit type, to the collection, at the end of the collection.
abstract WebDimtyUnit add(WebObjectInfo object, int beforeKey)
Adds a new WebDimtyUnit object, where the dimty unit type is determined by the object passed in, to the collection before the object with the given key.
abstract WebDimtyUnit add(int unitType, int beforeKey)
Adds a new WebDimtyUnit object, with the given unit type, to the collection, at the given position.
abstract void clear()
Removes all WebDimtyUnit objects from this collection.
abstract boolean containsKey(int key)
Returns true if a WebDimtyUnit with the given key exists in the collection, false if it does not.
abstract Enumeration elements()
Returns a java.util.Enumeration which can be used to iterate through the list of WebDimtyUnits in the collection.
abstract WebDimtyUnit get(int index)
Returns the WebDimtyUnit object in the collection with the given index.
abstract WebDimtyUnit getAvailableUnit(int unitType)
Returns a standalone dimty unit of specified unit type.
abstract boolean getCanContinue()
Returns the current value of the CanContinue(cct) property.
abstract WebDisplayUnits getChildUnits()
Returns the WebDisplayUnits collection containing the WebDimtyUnits.
abstract boolean getFilterRest()
Returns the current setting of the FilterRest(fr) option.
abstract WebDimtyUnit getItemByKey(int key)
Returns the WebDimtyUnit object in the collection with the given key.
abstract boolean isEmpty()
Returns whether the collection of WebDimtyUnits is empty.
abstract int keyOf(WebDimtyUnit dimtyUnit)
Returns the key of the given WebDimtyUnit object in the collection.
abstract void remove(int index)
Removes the WebDimtyUnit object in the collection with the given index.
abstract void remove(WebDimtyUnit dimtyUnit)
Removes the given dimensionality unit from the dimty collection, if it is a member.
abstract void removeItemByKey(int key)
Removes the object with the given key from the collection.
abstract void setCanContinue(boolean canContinue)
Sets the current value of the CanContinue(cct) property.
abstract void setFilterRest(boolean filterRest)
Sets the FilterRest(fr) option.
abstract int size()
Returns the number of dimensionality units in this collection.

Public Methods

public abstract WebDimtyUnit add (WebObjectInfo object)

Adds a new WebDimtyUnit object, where the dimty unit type is determined by the object passed in, to the collection, at the end of the collection.

Parameters
object The object which the dimensionality unit refers to, of type attribute or dimension.
Returns
Throws
UnsupportedOperationException Thrown if the collection is read-only.
IllegalArgumentException Thrown if the given object cannot be the subject of a dimensionality unit.

public abstract WebDimtyUnit add (int unitType)

Adds a new WebDimtyUnit object, with the given unit type, to the collection, at the end of the collection.

Parameters
unitType The type of dimensionality unit to create, from EnumDSSXMLDimtyUnitType.
Returns
Throws
UnsupportedOperationException Thrown if the collection is read-only.
IllegalArgumentException Thrown if the given unit type is attribute or dimension, which should have the object being referred to as one of the arguments to add.

public abstract WebDimtyUnit add (WebObjectInfo object, int beforeKey)

Adds a new WebDimtyUnit object, where the dimty unit type is determined by the object passed in, to the collection before the object with the given key.

Parameters
object The object which the dimensionality unit refers to, of type attribute or dimension.
beforeKey The key of the object in the collection which the new WebDimtyUnit object will be placed before.
Returns
Throws
UnsupportedOperationException Thrown if the collection is read-only.
IllegalArgumentException Thrown if the given object cannot be the subject of a dimensionality unit, or if the beforeKey does not exist.

public abstract WebDimtyUnit add (int unitType, int beforeKey)

Adds a new WebDimtyUnit object, with the given unit type, to the collection, at the given position.

Parameters
unitType The type of dimensionality unit to create, from EnumDSSXMLDimtyUnitType.
beforeKey The key of the WebDimtyUnit object which the new one should be placed before in the collection.
Returns
Throws
UnsupportedOperationException Thrown if the collection is read-only.
IllegalArgumentException Thrown if no WebDimtyUnit object in the collection with key beforeKey could be found, or if the unit type is invalid without a target.

public abstract void clear ()

Removes all WebDimtyUnit objects from this collection.

Throws
UnsupportedOperationException Thrown if the collection is read-only.

public abstract boolean containsKey (int key)

Returns true if a WebDimtyUnit with the given key exists in the collection, false if it does not.

Parameters
key The key whose existence we need to verify.
Returns
  • True if the given key exists in the collection, false if it does not.

public abstract Enumeration elements ()

Returns a java.util.Enumeration which can be used to iterate through the list of WebDimtyUnits in the collection.

Returns
  • An Enumeration which allows iteration through the collection.

public abstract WebDimtyUnit get (int index)

Returns the WebDimtyUnit object in the collection with the given index.

Parameters
index The index of the object to return from the collection.
Returns
Throws
IndexOutOfBoundsException Thrown if the index is not in the bounds of the collection.

public abstract WebDimtyUnit getAvailableUnit (int unitType)

Returns a standalone dimty unit of specified unit type. Unit type can NOT be DssXmlDimtyUnitTypeAttribute or DssXmlDimtyUnitTypeDimension. The returned unit will not be added into dimty units collection of this dimty, no matter it was in the collection or not.

Throws
IllegalArgumentException
IllegalArgumentException

public abstract boolean getCanContinue ()

Returns the current value of the CanContinue(cct) property. This property is used to indicate whether or not the environment that uses a metric with this dimensionality is allowed to extend the dimensionality by (in effect) adding additional units to the dimensionality.

The default value of this flag is true.

Returns
  • The current value of the CanContinue(cct) option.
See Also

public abstract WebDisplayUnits getChildUnits ()

Returns the WebDisplayUnits collection containing the WebDimtyUnits.

Returns
  • the child WebDisplayUnits collection

public abstract boolean getFilterRest ()

Returns the current setting of the FilterRest(fr) option. If this property is true, then any attribute found in the filter, which does not appear in this dimensionality, is (in effect) automatically added to the dimensionality.

The default value of this property is true.

Returns
  • The current value of the FilterRest property.
See Also

public abstract WebDimtyUnit getItemByKey (int key)

Returns the WebDimtyUnit object in the collection with the given key.

Parameters
key The key of the object to obtain from the collection.
Returns
Throws
IllegalArgumentException Thrown if the key is not found in the collection.

public abstract boolean isEmpty ()

Returns whether the collection of WebDimtyUnits is empty.

Returns
  • true if the collection is empty, false if it is not.

public abstract int keyOf (WebDimtyUnit dimtyUnit)

Returns the key of the given WebDimtyUnit object in the collection.

Parameters
dimtyUnit The WebDimtyUnit object to find.
Returns
  • The key of the given object.
Throws
IllegalArgumentException Thrown if the object is not found in the collection.

public abstract void remove (int index)

Removes the WebDimtyUnit object in the collection with the given index.

Parameters
index The index of the object to remove from the collection.
Throws
UnsupportedOperationException Signals that the collection is marked as read-only.
IndexOutOfBoundsException Thrown if the index is not in the bounds of the collection.

public abstract void remove (WebDimtyUnit dimtyUnit)

Removes the given dimensionality unit from the dimty collection, if it is a member.

Parameters
dimtyUnit A WebDimtyUnit object to be removed from the collection.
Throws
UnsupportedOperationException Thrown if the collection is read-only.
IllegalArgumentException Thrown if the given WebDimtyUnit object is not in the collection.

public abstract void removeItemByKey (int key)

Removes the object with the given key from the collection.

Parameters
key The key of the dimensionality unit to remove from the collection.
Throws
UnsupportedOperationException Thrown if the collection is read-only.
IllegalArgumentException Thrown if the given key is not found in the collection.

public abstract void setCanContinue (boolean canContinue)

Sets the current value of the CanContinue(cct) property. This property is used to indicate whether or not the environment that uses a metric with this dimensionality is allowed to extend the dimensionality by (in effect) adding additional units to the dimensionality.

Parameters
canContinue The new value of the CanContinue property.
See Also

public abstract void setFilterRest (boolean filterRest)

Sets the FilterRest(fr) option. If this property is true, then any attribute found in the filter, which does not appear in this dimensionality, is (in effect) automatically added to the dimensionality.

Parameters
filterRest The new value for the FilterRest property.
See Also

public abstract int size ()

Returns the number of dimensionality units in this collection.

Returns