com.akiban.sql.parser
Class OrderByColumn

java.lang.Object
  com.akiban.sql.parser.QueryTreeNode
      com.akiban.sql.parser.OrderedColumn
          com.akiban.sql.parser.OrderByColumn

All Implemented Interfaces:

Visitable

public class OrderByColumn
extends OrderedColumn

An OrderByColumn is a column in the ORDER BY clause. An OrderByColumn can be ordered ascending or descending. We need to make sure that the named columns are columns in that query, and that positions are within range.

Field Summary

Fields inherited from class com.akiban.sql.parser.OrderedColumn

columnPosition, UNMATCHEDPOSITION

Fields inherited from class com.akiban.sql.parser.QueryTreeNode

AUTOINCREMENT_CREATE_MODIFY, AUTOINCREMENT_INC_INDEX, AUTOINCREMENT_IS_AUTOINCREMENT_INDEX, AUTOINCREMENT_START_INDEX

Constructor Summary

OrderByColumn()

Method Summary

void	copyFrom(QueryTreeNode node) Fill this node with a deep copy of the given node.
ValueNode	getExpression()
void	init(Object expression) Initializer.
boolean	isAscending() Get the column order.
boolean	isNullsOrderedLow() Get the column NULL ordering.
void	printSubNodes(int depth) Prints the sub-nodes of this object.
void	setDescending() Mark the column as descending order
void	setNullsOrderedLow() Mark the column as ordered NULL values lower than non-NULL values.
String	toString() Convert this object to a String.

Methods inherited from class com.akiban.sql.parser.OrderedColumn

getColumnPosition, setColumnPosition

Methods inherited from class com.akiban.sql.parser.QueryTreeNode

accept, convertDefaultNode, debugFlush, debugPrint, formatNodeString, getBeginOffset, getDebugOutput, getEndOffset, getNodeFactory, getNodeType, getNullNode, getParserContext, getStatementType, getUserData, init, init, init, init, init, init, init, init, init, init, init, init, init, isInstanceOf, makeTableName, makeTableName, nodeHeader, printLabel, setBeginOffset, setDebugOutput, setEndOffset, setNodeType, setParserContext, setUserData, stackPrint, treePrint, treePrint, treePrint

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

OrderByColumn

public OrderByColumn()

Method Detail

init

public void init(Object expression)

Initializer.

Overrides:

init in class QueryTreeNode

Parameters:

expression - Expression of this column

copyFrom

public void copyFrom(QueryTreeNode node)
              throws StandardException

Fill this node with a deep copy of the given node.

Overrides:

copyFrom in class OrderedColumn

Throws:

StandardException

toString

public String toString()

Convert this object to a String. See comments in QueryTreeNode.java for how this should be done for tree printing.

Overrides:

toString in class OrderedColumn

Returns:

This object as a String

printSubNodes

public void printSubNodes(int depth)

Prints the sub-nodes of this object. See QueryTreeNode.java for how tree printing is supposed to work.

Overrides:

printSubNodes in class QueryTreeNode

Parameters:

depth - The depth of this node in the tree

getExpression

public ValueNode getExpression()

setDescending

public void setDescending()

Mark the column as descending order

isAscending

public boolean isAscending()

Get the column order. Overrides OrderedColumn.isAscending.

Overrides:

isAscending in class OrderedColumn

Returns:

true if ascending, false if descending

setNullsOrderedLow

public void setNullsOrderedLow()

Mark the column as ordered NULL values lower than non-NULL values.

isNullsOrderedLow

public boolean isNullsOrderedLow()

Get the column NULL ordering. Overrides OrderedColumn.getIsNullsOrderedLow.

Overrides:

isNullsOrderedLow in class OrderedColumn

Returns:

true if NULLs ordered low, false if NULLs ordered high