public interface

WebNode

com.microstrategy.web.objects.WebNode
Known Indirect Subclasses

Class Overview

The WebNode interface represents a node within an expression tree. The object which implements this interface is not directly instantiatable - the only way to obtain a WebNode object is through WebExpression or another WebNode. The only way to create a new node in an expression tree is by calling the appropriate create method on WebExpression. Note that a WebNode object is linked to its expression object, and cannot be directly moved between expression trees.

Summary

Public Methods
abstract void appendChild(WebNode newChild)
Appends the given node to the end of the current node's list of child nodes.
abstract void clear()
Removes all child nodes from the current node.
abstract void clearPlaceHolder()
Deletes the place holder defined on this node.
abstract boolean containsPrompts()
Returns true if this node or any of its children has prompts.
abstract WebNodePlaceHolder createPlaceHolder()
Creates a place holder on this node.
abstract boolean getCanExpand()
Returns the value of the can expand property on the node.
abstract WebNode getChild(int index)
Returns the child node with the given (0-based) index in the collection.
abstract int getChildCount()
Returns the number of child nodes of the current node.
abstract int getDataType()
Returns the datatype of the current node.
abstract WebDimty getDimensionality()
Returns an object which can be used to specify the dimensionality of the node.
abstract int getDimensionalityType()
Returns the dimensionality type of the current node.
abstract String getDisplayName()
Returns the currently set display name of this node.
abstract int getExpressionType()
Returns the expression type of the current node.
abstract WebNode getFirstChild()
Returns the first child node of the current node, or null if the current node has no child nodes.
abstract boolean getIsIndependentCSI()
Returns whether this node is independent from others.
abstract boolean getIsSpliced()
Returns the value of the Is spliced property This is currently used in custom group elements.@return
abstract int getKey()
Returns the key of this node.
abstract WebNode getLastChild()
Returns the last child node of the current node, or null if the current node has no child nodes.
abstract WebNode getNextSibling()
Returns the current node's next sibling.
abstract int getNodeType()
Returns the node type of the current node.
abstract WebNode getParent()
Returns the parent of the current node, or null if this is the root node.
abstract WebNodePlaceHolder getPlaceHolder()
Returns the place holder associated on this node.
abstract WebNode getPreviousSibling()
Returns the current node's previous sibling.
abstract String getShortXML()
Return the short xml representation of the node.
abstract String getTag()
Returns the tag which is currently set on this node.
abstract int getUCFlag()
Returns the value of ucFlag.
abstract boolean hasChildNodes()
Returns true if this node has child nodes, false if it does not.
abstract boolean hasPlaceHolder()
Returns whether this node has a place holder defined on it.
abstract void insertAfter(WebNode newChild, WebNode refNode)
Adds the given node to the current node's list of child nodes immediately after the reference node.
abstract void insertBefore(WebNode newChild, WebNode refNode)
Adds the given node to the current node's list of child nodes immediately before the reference node.
abstract boolean isCancelledPrompt()
abstract void removeChild(WebNode childNode)
Removes the given node from the collection of child nodes.
abstract void replaceChild(WebNode newChild, WebNode oldChild)
Replaces the old node with the given new node in the expression.
abstract void setCanExpand(boolean expand)
Sets the can expand property.
abstract void setDataType(int dataType)
Sets the datatype of the current node.
abstract void setDimensionalityType(int dimensionalityType)
Sets the dimensionality type of the current node.
abstract void setDisplayName(String displayName)
Sets the display name of this node to the given value.
abstract void setExpressionType(int expressionType)
Sets the expression type of the current node to the given type.
abstract void setIsIndependentCSI(boolean isIndependentCSI)
Sets the node whether it is independent from others.
abstract void setIsSpliced(boolean spliced)
Sets the is spliced property.
abstract void setTag(String tag)
Sets the tag on the node.
abstract void setUCFlag(int flag)
Sets the value of ucFlag.

Public Methods

public abstract 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 Thrown if the given node is null or if the node being appended is from a different expression.

public abstract void clear ()

Removes all child nodes from the current node.

public abstract void clearPlaceHolder ()

Deletes the place holder defined on this node.

public abstract 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 abstract WebNodePlaceHolder createPlaceHolder ()

Creates a place holder on this node.

Returns
  • the newly created place holder

public abstract boolean getCanExpand ()

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

public abstract 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 Thrown if the given index does not exist in the collection.

public abstract int getChildCount ()

Returns the number of child nodes of the current node.

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

public abstract int getDataType ()

Returns the datatype of the current node.

Returns
See Also

public abstract 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 abstract int getDimensionalityType ()

Returns the dimensionality type of the current node.

Returns

public abstract String getDisplayName ()

Returns the currently set display name of this node.

Returns
  • The current display name of this node.

public abstract int getExpressionType ()

Returns the expression type of the current node.

Returns

public abstract 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 abstract boolean getIsIndependentCSI ()

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

Returns
  • true if it is independent

public abstract boolean getIsSpliced ()

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

public abstract 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 abstract 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 abstract 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 abstract int getNodeType ()

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

Returns

public abstract 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 abstract WebNodePlaceHolder getPlaceHolder ()

Returns the place holder associated on this node.

Returns

public abstract 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 abstract String getShortXML ()

Return the short xml representation of the node.

public abstract 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 abstract int getUCFlag ()

Returns the value of ucFlag.

Returns
  • The value of ucFlag.

public abstract boolean hasChildNodes ()

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

Returns
  • Whether this node has child nodes.

public abstract boolean hasPlaceHolder ()

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

Returns
  • true if it has a place holder

public abstract 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 Thrown if either node is null, if the reference node is not found, or if the node to insert belongs to a different expression.

public abstract 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 Thrown if either node is null, if the reference node is not found, or if the node to insert belongs to a different expression.

public abstract boolean isCancelledPrompt ()

public abstract 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 Signals that the given node is null or not found.

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

public abstract void setCanExpand (boolean expand)

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

See Also

public abstract 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.
See Also

public abstract 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 abstract 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.
See Also

public abstract 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 abstract void setIsIndependentCSI (boolean isIndependentCSI)

Sets the node whether it is independent from others.

public abstract void setIsSpliced (boolean spliced)

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

See Also

public abstract 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 abstract void setUCFlag (int flag)

Sets the value of ucFlag.

Parameters
flag The value to be set for ucFlag.
See Also