Summary: Methods | Inherited Methods | [Expand All]

public interface

WebRelationshipNode

implements WebPromptableNode

com.microstrategy.web.objects.WebRelationshipNode

Class Overview

The WebRelationshipNode interface represents a relationship node within an expression. A relationship node is a qualification which allows the user to filter a certain attribute by it's relationship to other attributes. Also worth noting is that a relationship node, like an operator node, can have child nodes. This interface contains methods specific to a relationship node. For methods which apply to all nodes, see the WebNode interface, which this one extends.

Summary

Public Methods
abstract boolean	getApplySubExpression() Returns the applySubExpression flag.
abstract WebRelationship	getRelationship() Returns the object describing the relationship which defines the relationship node.
abstract boolean	getUseSchema() Returns the useSchema flag.
abstract void	setApplySubExpression(boolean applySubExpression) Sets the applySubExpression flag.
abstract void	setRelationship(WebRelationship relationship) Sets the object describing the relationship which defines the relationship node.
abstract void	setUseSchema(boolean useSchema) Sets the useSchema flag.

[Expand]

Inherited Methods

From interface com.microstrategy.web.objects.WebNode

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.

From interface com.microstrategy.web.objects.WebPromptSite

Public Methods

public abstract boolean getApplySubExpression ()

Returns the applySubExpression flag.

Under normal use in a filter, the subexpression below the relationship node is converted to a different filter by applying the relationship on this node. The expression is not used, other than as a source for the relationship. Setting this property to True asks that the sub-expression is applied in its own right as well.

Returns

The current value of the applySubExpression flag.

public abstract WebRelationship getRelationship ()

Returns the object describing the relationship which defines the relationship node.

Returns

A WebRelationship object, corresponding to the relationship set on the node.

public abstract boolean getUseSchema ()

Returns the useSchema flag. If this is true, then the relationship object will be ignored, and instead, the schema will be used to determine the relationship used in the relationship node.

Returns

The current value of the useSchema flag.

public abstract void setApplySubExpression (boolean applySubExpression)

Sets the applySubExpression flag.

Under normal use in a filter, the subexpression below the relationship node is converted to a different filter by applying the relationship on this node. The expression is not used, other than as a source for the relationship. Setting this property to True asks that the sub-expression is applied in its own right as well.

Parameters

applySubExpression	The desired value of the applySubExpression flag.

public abstract void setRelationship (WebRelationship relationship)

Sets the object describing the relationship which defines the relationship node.

Parameters

relationship	A `WebRelationship` object, corresponding to the relationship set on the node.

public abstract void setUseSchema (boolean useSchema)

Sets the useSchema flag. If this is true, then the relationship object will be ignored and instead, the schema will be used to determine the relationship used in the relationship node.

Parameters

useSchema	The desired value of the useSchema flag.

Interfaces

Classes

Enums

Exceptions

WebRelationshipNode

Class Overview

Summary

Public Methods

public abstract boolean getApplySubExpression ()

Returns

See Also

public abstract WebRelationship getRelationship ()

Returns

public abstract boolean getUseSchema ()

Returns

See Also

public abstract void setApplySubExpression (boolean applySubExpression)

Parameters

See Also

public abstract void setRelationship (WebRelationship relationship)

Parameters

See Also

public abstract void setUseSchema (boolean useSchema)

Parameters

See Also