public class

WebControlShortcutNodeImpl

extends Object
implements WebControlShortcutNode WebFormatHost WebNode
java.lang.Object
   ↳ com.microstrategy.web.objects.WebControlShortcutNodeImpl

Summary

Public Methods
void appendChild(WebNode newChild)
Appends the given node to the end of the current node's list of child nodes.
void clear()
Removes all child nodes from the current node.
void clearPlaceHolder()
Deletes the place holder defined on this node.
boolean containsPrompts()
Returns true if this node or any of its children has prompts.
WebNodePlaceHolder createPlaceHolder()
Creates a place holder on this node.
void generateFormatDelta(WebFormat f, WebPropertyObj p)
boolean getCanExpand()
Returns the value of the can expand property on the node.
WebNode getChild(int index)
Returns the child node with the given (0-based) index in the collection.
int getChildCount()
Returns the number of child nodes of the current node.
String getControlKey()
Return the controlKey
int getDataType()
Returns the datatype of the current node.
WebDimty getDimensionality()
Returns an object which can be used to specify the dimensionality of the node.
int getDimensionalityType()
Returns the dimensionality type of the current node.
String getDisplayName()
Returns the currently set display name of this node.
int getExpressionType()
Returns the expression type of the current node.
WebObjectsFactory getFactory()
WebNode getFirstChild()
Returns the first child node of the current node, or null if the current node has no child nodes.
boolean getIsIndependentCSI()
Returns whether this node is independent from others.
boolean getIsSpliced()
Returns the value of the Is spliced property This is currently used in custom group elements.@return
int getKey()
Returns the key of this node.
WebNode getLastChild()
Returns the last child node of the current node, or null if the current node has no child nodes.
WebNode getNextSibling()
Returns the current node's next sibling.
String getNodeKey()
Return the nodeKey
int getNodeType()
Returns the node type of the current node.
WebNode getParent()
Returns the parent of the current node, or null if this is the root node.
WebNodePlaceHolder getPlaceHolder()
Returns the place holder associated on this node.
WebNode getPreviousSibling()
Returns the current node's previous sibling.
String getShortXML()
Return the short xml representation of the node.
boolean getShowChildren()
boolean getShowParent()
int getSubExpressionCount()
String getTag()
Returns the tag which is currently set on this node.
int getUCFlag()
Returns the value of ucFlag.
boolean hasChildNodes()
Returns true if this node has child nodes, false if it does not.
boolean hasPlaceHolder()
Returns whether this node has a place holder defined on it.
void insertAfter(WebNode newChild, WebNode refNode)
Adds the given node to the current node's list of child nodes immediately after the reference node.
void insertBefore(WebNode newChild, WebNode refNode)
Adds the given node to the current node's list of child nodes immediately before the reference node.
boolean isCancelledPrompt()
void removeChild(WebNode childNode)
Removes the given node from the collection of child nodes.
void replaceChild(WebNode newChild, WebNode oldChild)
Replaces the old node with the given new node in the expression.
void setCanExpand(boolean b)
Sets the can expand property.
void setControlKey(String _controlKey)
Set the controlKey
void setDataType(int _dataType)
Sets the datatype of the current node.
void setDimensionalityType(int dimensionalityType)
Sets the dimensionality type of the current node.
void setDisplayName(String _displayName)
Sets the display name of this node to the given value.
void setExpressionType(int _expressionType)
Sets the expression type of the current node to the given type.
void setIsIndependentCSI(boolean isIndependentCSI)
Sets the node whether it is independent from others.
void setIsSpliced(boolean b)
Sets the is spliced property.
void setNodeKey(String _nodeKey)
Set the nodeKey
void setShowChildren(boolean value)
void setShowParent(boolean value)
void setTag(String _tag)
Sets the tag on the node.
void setUCFlag(int flag)
Sets the value of ucFlag.
String toString()
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.microstrategy.web.objects.WebControlShortcutNode
From interface com.microstrategy.web.objects.WebFormatHost
From interface com.microstrategy.web.objects.WebNode

Public Methods

public void appendChild (WebNode newChild)

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.

Parameters
newChild The node to be appended.
Throws
IllegalArgumentException

public void clear ()

Removes all child nodes from the current node.

public void clearPlaceHolder ()

Deletes the place holder defined on this node.

public boolean containsPrompts ()

Returns true if this node or any of its children has prompts.

Returns
  • true if this node or any of its children has prompts.

public WebNodePlaceHolder createPlaceHolder ()

Creates a place holder on this node.

Returns
  • the newly created place holder

public void generateFormatDelta (WebFormat f, WebPropertyObj p)

public boolean getCanExpand ()

Returns the value of the can expand property on the node. This is currently used in custom group elements.@return

public WebNode getChild (int index)

Returns the child node with the given (0-based) index in the collection.

Parameters
index The index of the child node to return.
Returns
  • A WebNode object, corresponding to the given index.
Throws
IndexOutOfBoundsException

public int getChildCount ()

Returns the number of child nodes of the current node.

Returns
  • The number of child nodes, or 0 if none exist.

public String getControlKey ()

Return the controlKey

Returns
  • {String} controlKey

public int getDataType ()

Returns the datatype of the current node.

Returns

public WebDimty getDimensionality ()

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).

Returns
  • An object of type WebDimty, which can then be used to specify dimensionality.

public int getDimensionalityType ()

Returns the dimensionality type of the current node.

Returns

public String getDisplayName ()

Returns the currently set display name of this node.

Returns
  • The current display name of this node.

public int getExpressionType ()

Returns the expression type of the current node.

Returns

public WebObjectsFactory getFactory ()

public WebNode getFirstChild ()

Returns the first child node of the current node, or null if the current node has no child nodes.

Returns
  • A WebNode object which is the first child (the index 0 child) of this node, or null if no children are found.

public boolean getIsIndependentCSI ()

Returns whether this node is independent from others. It is used for metric qualifications.

Returns
  • true if it is independent

public boolean getIsSpliced ()

Returns the value of the Is spliced property This is currently used in custom group elements.@return

public int getKey ()

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.

Returns
  • The key of this node.

public WebNode getLastChild ()

Returns the last child node of the current node, or null if the current node has no child nodes.

Returns
  • A WebNode object which is the last child (the last index child) of this node, or null if no children are found.

public WebNode getNextSibling ()

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.

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).

public String getNodeKey ()

Return the nodeKey

Returns
  • {String} nodeKey

public int getNodeType ()

Returns the node type of the current node. This is set upon creation of the node, and cannot be changed.

Returns

public WebNode getParent ()

Returns the parent of the current node, or null if this is the root node.

Returns
  • A WebNode object, which is the parent of the current node, or null if the current node has no parent.

public WebNodePlaceHolder getPlaceHolder ()

Returns the place holder associated on this node.

Returns

public WebNode getPreviousSibling ()

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.

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).

public String getShortXML ()

Return the short xml representation of the node.

public boolean getShowChildren ()

public boolean getShowParent ()

public int getSubExpressionCount ()

public String getTag ()

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.

Returns
  • The tag currently set on the node.

public int getUCFlag ()

Returns the value of ucFlag.

Returns
  • The value of ucFlag.

public boolean hasChildNodes ()

Returns true if this node has child nodes, false if it does not.

Returns
  • Whether this node has child nodes.

public boolean hasPlaceHolder ()

Returns whether this node has a place holder defined on it.

Returns
  • true if it has a place holder

public void insertAfter (WebNode newChild, WebNode refNode)

Adds the given node to the current node's list of child nodes immediately after the reference node.

Parameters
newChild The node to be appended.
refNode The node after which the new node is to be inserted.
Throws
IllegalArgumentException

public void insertBefore (WebNode newChild, WebNode refNode)

Adds the given node to the current node's list of child nodes immediately before the reference node.

Parameters
newChild The node to be appended.
refNode The node before which the new node is to be inserted.
Throws
IllegalArgumentException

public boolean isCancelledPrompt ()

public void removeChild (WebNode childNode)

Removes the given node from the collection of child nodes.

Parameters
childNode The WebNode object to be removed from the child collection.
Throws
IllegalArgumentException

public void replaceChild (WebNode newChild, WebNode oldChild)

Replaces the old node with the given new node in the expression.

Parameters
newChild The node to be used as the replacement.
oldChild The node to be replaced.
Throws
IllegalArgumentException

public void setCanExpand (boolean b)

Sets the can expand property. This is currently used in custom group elements.

public void setControlKey (String _controlKey)

Set the controlKey

public void setDataType (int _dataType)

Sets the datatype of the current node.

Parameters
_dataType A value from EnumDSSXMLDataType, which will be used as the datatype of the current node.

public void setDimensionalityType (int dimensionalityType)

Sets the dimensionality type of the current node.

Parameters
dimensionalityType The dimensionality type to assign to this node, from EnumDSSXMLNodeDimty.

public void setDisplayName (String _displayName)

Sets the display name of this node to the given value.

Parameters
_displayName The display name to use when describing the node.

public void setExpressionType (int _expressionType)

Sets the expression type of the current node to the given type.

Parameters
_expressionType The expression type to use for the node, from EnumDSSXMLExpressionType.

public void setIsIndependentCSI (boolean isIndependentCSI)

Sets the node whether it is independent from others.

public void setIsSpliced (boolean b)

Sets the is spliced property. This is currently used in custom group elements.

public void setNodeKey (String _nodeKey)

Set the nodeKey

public void setShowChildren (boolean value)

public void setShowParent (boolean value)

public void setTag (String _tag)

Sets the tag on the node. If this value is null, the current tag will be removed.

Parameters
_tag The tag to attach to the current node.

public void setUCFlag (int flag)

Sets the value of ucFlag.

Parameters
flag The value to be set for ucFlag.

public String toString ()