Package com.microstrategy.web.objects

Interface WebDimty

  • public interface WebDimty
    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.

    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Method Detail

      • getCanContinue

        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:
        setCanContinue(boolean)

      • setCanContinue

        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:
        getCanContinue()

      • getFilterRest

        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:
        setFilterRest(boolean)

      • setFilterRest

        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:
        getFilterRest()

      • add

        WebDimtyUnit add​(int unitType)
          throws java.lang.IllegalArgumentException,
                 java.lang.UnsupportedOperationException
        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:
        The newly created WebDimtyUnit object.
        Throws:
        java.lang.UnsupportedOperationException - Thrown if the collection is read-only.
        java.lang.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.

      • add

        WebDimtyUnit add​(int unitType,
                 int beforeKey)
          throws java.lang.IllegalArgumentException,
                 java.lang.UnsupportedOperationException
        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:
        The newly created WebDimtyUnit object.
        Throws:
        java.lang.UnsupportedOperationException - Thrown if the collection is read-only.
        java.lang.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.

      • add

        WebDimtyUnit add​(WebObjectInfo object)
          throws java.lang.IllegalArgumentException,
                 java.lang.UnsupportedOperationException
        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:
        The newly created WebDimtyUnit object.
        Throws:
        java.lang.UnsupportedOperationException - Thrown if the collection is read-only.
        java.lang.IllegalArgumentException - Thrown if the given object cannot be the subject of a dimensionality unit.

      • add

        WebDimtyUnit add​(WebObjectInfo object,
                 int beforeKey)
          throws java.lang.IllegalArgumentException,
                 java.lang.UnsupportedOperationException
        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:
        The newly created WebDimtyUnit object.
        Throws:
        java.lang.UnsupportedOperationException - Thrown if the collection is read-only.
        java.lang.IllegalArgumentException - Thrown if the given object cannot be the subject of a dimensionality unit, or if the beforeKey does not exist.

      • add

        void add​(WebDimtyUnit object,
         int beforeKey)
  throws java.lang.IllegalArgumentException,
         java.lang.UnsupportedOperationException
        Adds a new WebDimtyUnit object. For ReportLevel, it class type is WebDymtyUnit.
        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.
        Throws:
        java.lang.IllegalArgumentException - Thrown if the given object cannot be the subject of a dimensionality unit, or if the beforeKey does not exist.
        java.lang.UnsupportedOperationException - Thrown if the collection is read-only.

      • add

        void add​(WebDimtyUnit object)
  throws java.lang.IllegalArgumentException,
         java.lang.UnsupportedOperationException
        Adds a new WebDimtyUnit object. For ReportLevel, it class type is WebDymtyUnit.
        Parameters:
        object - The object which the dimensionality unit refers to, of type attribute or dimension.
        Throws:
        java.lang.IllegalArgumentException - Thrown if the given object cannot be the subject of a dimensionality unit, or if the beforeKey does not exist.
        java.lang.UnsupportedOperationException - Thrown if the collection is read-only.

      • get

        WebDimtyUnit get​(int index)
          throws java.lang.IndexOutOfBoundsException
        Returns the WebDimtyUnit object in the collection with the given index.
        Parameters:
        index - The index of the object to return from the collection.
        Returns:
        The WebDimtyUnit object corresponding to the given index.
        Throws:
        java.lang.IndexOutOfBoundsException - Thrown if the index is not in the bounds of the collection.

      • getItemByKey

        WebDimtyUnit getItemByKey​(int key)
                   throws java.lang.IllegalArgumentException
        Returns the WebDimtyUnit object in the collection with the given key.
        Parameters:
        key - The key of the object to obtain from the collection.
        Returns:
        The WebDimtyUnit object corresponding to the given key.
        Throws:
        java.lang.IllegalArgumentException - Thrown if the key is not found in the collection.

      • remove

        void remove​(int index)
     throws java.lang.UnsupportedOperationException,
            java.lang.IndexOutOfBoundsException
        Removes the WebDimtyUnit object in the collection with the given index.
        Parameters:
        index - The index of the object to remove from the collection.
        Throws:
        java.lang.UnsupportedOperationException - Signals that the collection is marked as read-only.
        java.lang.IndexOutOfBoundsException - Thrown if the index is not in the bounds of the collection.

      • removeItemByKey

        void removeItemByKey​(int key)
              throws java.lang.UnsupportedOperationException,
                     java.lang.IllegalArgumentException
        Removes the object with the given key from the collection.
        Parameters:
        key - The key of the dimensionality unit to remove from the collection.
        Throws:
        java.lang.UnsupportedOperationException - Thrown if the collection is read-only.
        java.lang.IllegalArgumentException - Thrown if the given key is not found in the collection.

      • remove

        void remove​(WebDimtyUnit dimtyUnit)
     throws java.lang.UnsupportedOperationException,
            java.lang.IllegalArgumentException
        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:
        java.lang.UnsupportedOperationException - Thrown if the collection is read-only.
        java.lang.IllegalArgumentException - Thrown if the given WebDimtyUnit object is not in the collection.

      • clear

        void clear()
    throws java.lang.UnsupportedOperationException
        Removes all WebDimtyUnit objects from this collection.
        Throws:
        java.lang.UnsupportedOperationException - Thrown if the collection is read-only.

      • isEmpty

        boolean isEmpty()
        Returns whether the collection of WebDimtyUnits is empty.
        Returns:
        true if the collection is empty, false if it is not.

      • size

        int size()
        Returns the number of dimensionality units in this collection.
        Returns:
        The number of WebDimtyUnits in the WebDimty object.

      • containsKey

        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.

      • keyOf

        int keyOf​(WebDimtyUnit dimtyUnit)
   throws java.lang.IllegalArgumentException
        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:
        java.lang.IllegalArgumentException - Thrown if the object is not found in the collection.

      • elements

        java.util.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.

      • getChildUnits

        WebDisplayUnits getChildUnits()
        Returns the WebDisplayUnits collection containing the WebDimtyUnits.
        Returns:
        the child WebDisplayUnits collection
        Since:
        MicroStrategy Web 9.0.0