Package org.olap4j.mdx

Class DrillThroughNode

java.lang.Object
org.olap4j.mdx.DrillThroughNode
All Implemented Interfaces:
ParseTreeNode
public class DrillThroughNode extends Object implements ParseTreeNode
Parse tree model for an MDX DRILLTHROUGH statement.
Since:
Feb 24, 2012
Author:
jhyde

  • Constructor Details

    • DrillThroughNode

      public DrillThroughNode(ParseRegion region, SelectNode select, int maxRowCount, int firstRowOrdinal, List<ParseTreeNode> returnList)
      Creates a DrillThroughNode.
      Parameters:
      region - Region of source code from which this node was created
      select - Select statement
      maxRowCount - Maximum number of rows to return, or -1
      firstRowOrdinal - Ordinal of first row to return, or -1
      returnList - List of columns to return

  • Method Details

    • 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

    • 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

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • 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

    • deepCopy

      public DrillThroughNode 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