Package com.microstrategy.web.objects

Class WebGridUnitShortcutNodeImpl

    • Method Detail

      • setFormInfo

        public void setFormInfo​(WebAttributeForm _formInfo)
                 throws java.lang.IllegalArgumentException
        Description copied from interface: WebGridUnitShortcutNode
        set the attribute form which the shortcut node refers to.
        Specified by:
        setFormInfo in interface WebGridUnitShortcutNode
        Parameters:
        _formInfo - A WebAttributeForm object which describes the attribute form which the shortcut node will refer to.
        Throws:
        java.lang.IllegalArgumentException - Thrown if the argument is null.

      • setDataSetObj

        public void setDataSetObj​(WebObjectInfo _dataSet)
                   throws java.lang.IllegalArgumentException
        Description copied from interface: WebShortcutNode
        Sets the data set object a metric belongs to. This property is used for shortcut nodes in the RS conditional formatting metric expressions.
        Specified by:
        setDataSetObj in interface WebShortcutNode
        Parameters:
        _dataSet - A WebObjectInfo a data set object.
        Throws:
        java.lang.IllegalArgumentException

      • getDataSetObj

        public WebObjectInfo getDataSetObj()
        Description copied from interface: WebShortcutNode
        Returns the data set object a metric belongs to. This property is used for shortcut nodes in the RS conditional formatting metric expressions.
        Specified by:
        getDataSetObj in interface WebShortcutNode
        Returns:
        A WebObjectInfo a data set object.

      • getTypesAllowed

        protected int[] getTypesAllowed()

      • containsPrompts

        public boolean containsPrompts()
        Description copied from interface: WebNode
        Returns true if this node or any of its children has prompts.
        Specified by:
        containsPrompts in interface WebNode
        Returns:
        true if this node or any of its children has prompts.

      • getShowChildren

        public boolean getShowChildren()

      • setShowChildren

        public void setShowChildren​(boolean value)

      • getShowParent

        public boolean getShowParent()

      • setShowParent

        public void setShowParent​(boolean value)

      • getTag

        public java.lang.String getTag()
        Description copied from interface: WebNode
        Returns the tag which is currently set on this node. The tag is a user-defined piece of information which can be attached to a node, and will be persisted with the expression's state.
        Specified by:
        getTag in interface WebNode
        Returns:
        The tag currently set on the node.

      • setTag

        public void setTag​(java.lang.String _tag)
        Description copied from interface: WebNode
        Sets the tag on the node. If this value is null, the current tag will be removed.
        Specified by:
        setTag in interface WebNode
        Parameters:
        _tag - The tag to attach to the current node.

      • getNodeType

        public int getNodeType()
        Description copied from interface: WebNode
        Returns the node type of the current node. This is set upon creation of the node, and cannot be changed.
        Specified by:
        getNodeType in interface WebNode
        Returns:
        The node type of the node, from EnumDSSXMLNodeType.

      • setNodeType

        protected void setNodeType​(int _nodeType)
        Set node type
        Parameters:
        _nodeType - node type

      • setDataType

        public void setDataType​(int _dataType)
        Description copied from interface: WebNode
        Sets the datatype of the current node.
        Specified by:
        setDataType in interface WebNode
        Parameters:
        _dataType - A value from EnumDSSXMLDataType, which will be used as the datatype of the current node.
        See Also:
        WebNode.getDataType()

      • getUCFlag

        public int getUCFlag()
        Description copied from interface: WebNode
        Returns the value of ucFlag.
        Specified by:
        getUCFlag in interface WebNode
        Returns:
        The value of ucFlag.

      • setUCFlag

        public void setUCFlag​(int flag)
        Description copied from interface: WebNode
        Sets the value of ucFlag.
        Specified by:
        setUCFlag in interface WebNode
        Parameters:
        flag - The value to be set for ucFlag.
        See Also:
        WebNode.getUCFlag()

      • getDimensionality

        public WebDimty getDimensionality()
        Description copied from interface: WebNode
        Returns an object which can be used to specify the dimensionality of the node. This will only be relevant if the dimensionality type is set to something other than the default (none).
        Specified by:
        getDimensionality in interface WebNode
        Returns:
        An object of type WebDimty, which can then be used to specify dimensionality.

      • setDisplayName

        public void setDisplayName​(java.lang.String _displayName)
        Description copied from interface: WebNode
        Sets the display name of this node to the given value.
        Specified by:
        setDisplayName in interface WebNode
        Parameters:
        _displayName - The display name to use when describing the node.
        See Also:
        WebNode.getDisplayName()

      • hasChildNodes

        public boolean hasChildNodes()
        Description copied from interface: WebNode
        Returns true if this node has child nodes, false if it does not.
        Specified by:
        hasChildNodes in interface WebNode
        Returns:
        Whether this node has child nodes.

      • getChildCount

        public int getChildCount()
        Description copied from interface: WebNode
        Returns the number of child nodes of the current node.
        Specified by:
        getChildCount in interface WebNode
        Returns:
        The number of child nodes, or 0 if none exist.

      • getSubExpressionCount

        public int getSubExpressionCount()

      • getFirstChild

        public WebNode getFirstChild()
        Description copied from interface: WebNode
        Returns the first child node of the current node, or null if the current node has no child nodes.
        Specified by:
        getFirstChild in interface WebNode
        Returns:
        A WebNode object which is the first child (the index 0 child) of this node, or null if no children are found.

      • getLastChild

        public WebNode getLastChild()
        Description copied from interface: WebNode
        Returns the last child node of the current node, or null if the current node has no child nodes.
        Specified by:
        getLastChild in interface WebNode
        Returns:
        A WebNode object which is the last child (the last index child) of this node, or null if no children are found.

      • getChild

        public WebNode getChild​(int index)
                 throws java.lang.IndexOutOfBoundsException
        Description copied from interface: WebNode
        Returns the child node with the given (0-based) index in the collection.
        Specified by:
        getChild in interface WebNode
        Parameters:
        index - The index of the child node to return.
        Returns:
        A WebNode object, corresponding to the given index.
        Throws:
        java.lang.IndexOutOfBoundsException - Thrown if the given index does not exist in the collection.

      • getParent

        public WebNode getParent()
        Description copied from interface: WebNode
        Returns the parent of the current node, or null if this is the root node.
        Specified by:
        getParent in interface WebNode
        Returns:
        A WebNode object, which is the parent of the current node, or null if the current node has no parent.

      • getPreviousSibling

        public WebNode getPreviousSibling()
        Description copied from interface: WebNode
        Returns the current node's previous sibling. This will be a node with the same parent as the current node, but with 1 less index in the parent node's collection. This method will return null if the parent node does not exist, or if this is the first node in the parent node's collection.
        Specified by:
        getPreviousSibling in interface WebNode
        Returns:
        WebNode The previous sibling, or null if none exists(i.e. this is the first child of its parent, or this is the root node).

      • getNextSibling

        public WebNode getNextSibling()
        Description copied from interface: WebNode
        Returns the current node's next sibling. This will be a node with the same parent as the current node, but with 1 greater index in the parent node's collection. This method will return null if the parent node does not exist, or if this is the last node in the parent node's collection.
        Specified by:
        getNextSibling in interface WebNode
        Returns:
        WebNode The next sibling, or null if none exists(i.e. this is the last child of its parent, or this is the root node).

      • appendChild

        public void appendChild​(WebNode newChild)
                 throws java.lang.IllegalArgumentException
        Description copied from interface: WebNode
        Appends the given node to the end of the current node's list of child nodes. The node to be appended must be from the same expression as the node it is being appended to.
        Specified by:
        appendChild in interface WebNode
        Parameters:
        newChild - The node to be appended.
        Throws:
        java.lang.IllegalArgumentException - Thrown if the given node is null or if the node being appended is from a different expression.

      • insertBefore

        public void insertBefore​(WebNode newChild,
                         WebNode refNode)
                  throws java.lang.IllegalArgumentException
        Description copied from interface: WebNode
        Adds the given node to the current node's list of child nodes immediately before the reference node.
        Specified by:
        insertBefore in interface WebNode
        Parameters:
        newChild - The node to be appended.
        refNode - The node before which the new node is to be inserted.
        Throws:
        java.lang.IllegalArgumentException - Thrown if either node is null, if the reference node is not found, or if the node to insert belongs to a different expression.

      • replaceChild

        public void replaceChild​(WebNode newChild,
                         WebNode oldChild)
                  throws java.lang.IllegalArgumentException
        Description copied from interface: WebNode
        Replaces the old node with the given new node in the expression.
        Specified by:
        replaceChild in interface WebNode
        Parameters:
        newChild - The node to be used as the replacement.
        oldChild - The node to be replaced.
        Throws:
        java.lang.IllegalArgumentException - Signals that one or both input parameters to this method were null, the reference node is not found, or the replacement node is from a different expression.

      • removeChild

        public void removeChild​(WebNode childNode)
                 throws java.lang.IllegalArgumentException
        Description copied from interface: WebNode
        Removes the given node from the collection of child nodes.
        Specified by:
        removeChild in interface WebNode
        Parameters:
        childNode - The WebNode object to be removed from the child collection.
        Throws:
        java.lang.IllegalArgumentException - Signals that the given node is null or not found.

      • clear

        public void clear()
        Description copied from interface: WebNode
        Removes all child nodes from the current node.
        Specified by:
        clear in interface WebNode

      • getKey

        public int getKey()
        Description copied from interface: WebNode
        Returns the key of this node. Every node in an expression has a unique key, though they are not necessarily in order, or even consecutive.
        Specified by:
        getKey in interface WebNode
        Returns:
        The key of this node.

      • insertAfter

        public void insertAfter​(WebNode newChild,
                        WebNode refNode)
                 throws java.lang.IllegalArgumentException
        Description copied from interface: WebNode
        Adds the given node to the current node's list of child nodes immediately after the reference node.
        Specified by:
        insertAfter in interface WebNode
        Parameters:
        newChild - The node to be appended.
        refNode - The node after which the new node is to be inserted.
        Throws:
        java.lang.IllegalArgumentException - Thrown if either node is null, if the reference node is not found, or if the node to insert belongs to a different expression.

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
        Since:
        MicroStrategy Web 8.0.1

      • setCanExpand

        public void setCanExpand​(boolean b)
        Description copied from interface: WebNode
        Sets the can expand property. This is currently used in custom group elements.
        Specified by:
        setCanExpand in interface WebNode
        See Also:
        WebNode.getCanExpand()

      • setIsSpliced

        public void setIsSpliced​(boolean b)
        Description copied from interface: WebNode
        Sets the is spliced property. This is currently used in custom group elements.
        Specified by:
        setIsSpliced in interface WebNode
        See Also:
        WebNode.getIsSpliced()

      • getCanExpand

        public boolean getCanExpand()
        Description copied from interface: WebNode
        Returns the value of the can expand property on the node. This is currently used in custom group elements.
        Specified by:
        getCanExpand in interface WebNode
        Returns:
        See Also:
        WebNode.setCanExpand(boolean)

      • getIsSpliced

        public boolean getIsSpliced()
        Description copied from interface: WebNode
        Returns the value of the Is spliced property This is currently used in custom group elements.
        Specified by:
        getIsSpliced in interface WebNode
        Returns:
        See Also:
        WebNode.setCanExpand(boolean)

      • getShortXML

        public java.lang.String getShortXML()
        Description copied from interface: WebNode
        Return the short xml representation of the node.
        Specified by:
        getShortXML in interface WebNode
        Returns:

      • hasPlaceHolder

        public boolean hasPlaceHolder()
        Description copied from interface: WebNode
        Returns whether this node has a place holder defined on it.
        Specified by:
        hasPlaceHolder in interface WebNode
        Returns:
        true if it has a place holder

      • clearPlaceHolder

        public void clearPlaceHolder()
        Description copied from interface: WebNode
        Deletes the place holder defined on this node.
        Specified by:
        clearPlaceHolder in interface WebNode

      • getIsIndependentCSI

        public boolean getIsIndependentCSI()
        Description copied from interface: WebNode
        Returns whether this node is independent from others. It is used for metric qualifications.
        Specified by:
        getIsIndependentCSI in interface WebNode
        Returns:
        true if it is independent

      • setIsIndependentCSI

        public void setIsIndependentCSI​(boolean isIndependentCSI)
        Description copied from interface: WebNode
        Sets the node whether it is independent from others.
        Specified by:
        setIsIndependentCSI in interface WebNode