org.olap4j.mdx
Class WithSetNode

java.lang.Object
  org.olap4j.mdx.WithSetNode

All Implemented Interfaces:

ParseTreeNode

public class WithSetNode
extends Object
implements ParseTreeNode

Parse tree node which declares a calculated set. Represented as the WITH SET clause of an MDX SELECT statement.

Version:

$Id: WithSetNode.java 482 2012-01-05 23:27:27Z jhyde $

Author:

jhyde

Constructor Summary

WithSetNode(ParseRegion region, IdentifierNode name, ParseTreeNode expression)
Creates a declaration of a named set.

Method Summary

<T> T	accept(ParseTreeVisitor<T> visitor) Accepts a visitor to this MDX parse tree node.
WithSetNode	deepCopy() Creates a deep copy of this ParseTreeNode object.
ParseTreeNode	getExpression() Returns the expression which calculates the set.
IdentifierNode	getIdentifier() Returns the name of the set.
ParseRegion	getRegion() Returns the region of the source code which this node was created from, if it was created by parsing.
Type	getType() Returns the type of this expression.
void	setExpression(ParseTreeNode expression) Sets the expression which calculates the set.
void	unparse(ParseTreeWriter writer) Converts this node into MDX text.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WithSetNode

public WithSetNode(ParseRegion region,
                   IdentifierNode name,
                   ParseTreeNode expression)

Creates a declaration of a named set.

Parameters:

region - Region of source code

name - Name of set

expression - Expression to calculate set

Method Detail

getRegion

public ParseRegion getRegion()

Description copied from interface: ParseTreeNode

Returns the region of the source code which this node was created from, if it was created by parsing.

A non-leaf node's region will encompass the regions of all of its children. For example, a the region of a function call node Crossjoin([Gender], {[Store].[USA]}) stretches from the first character of the function name to the closing parenthesis.

Region may be null, if the node was created programmatically, not from a piece of source code.

Specified by:

getRegion in interface ParseTreeNode

Returns:

Region of the source code this node was created from, if it was created by parsing

unparse

public void unparse(ParseTreeWriter writer)

Description copied from interface: ParseTreeNode

Converts this node into MDX text.

Specified by:

unparse in interface ParseTreeNode

Parameters:

writer - Parse tree writer

getIdentifier

public IdentifierNode getIdentifier()

Returns the name of the set.

Returns:

name of the set

getExpression

public ParseTreeNode getExpression()

Returns the expression which calculates the set.

Returns:

expression which calculates the set

setExpression

public void setExpression(ParseTreeNode expression)

Sets the expression which calculates the set.

Parameters:

expression - expression which calculates the set

accept

public <T> T accept(ParseTreeVisitor<T> visitor)

Description copied from interface: ParseTreeNode

Accepts a visitor to this MDX parse tree node.

The implementation should generally dispatches to the ParseTreeVisitor.visit(org.olap4j.mdx.SelectNode) method appropriate to the type of expression.

Specified by:

accept in interface ParseTreeNode

Parameters:

visitor - Visitor

Returns:

T, the specific return type of the visitor

getType

public Type getType()

Description copied from interface: ParseTreeNode

Returns the type of this expression.

Returns null if this node is not an expression, for instance a SELECT node.

Specified by:

getType in interface ParseTreeNode

Returns:

type of this expression

deepCopy

public WithSetNode deepCopy()

Description copied from interface: ParseTreeNode

Creates a deep copy of this ParseTreeNode object.

Note: implementing classes can return the concrete type instead of ParseTreeNode (using Java 1.5 covariant return types)

Specified by:

deepCopy in interface ParseTreeNode

Returns:

The deep copy of this ParseTreeNode