com.akiban.sql.parser
Class OrderedColumn

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

All Implemented Interfaces:

Visitable

Direct Known Subclasses:

GroupByColumn, OrderByColumn, PartitionByColumn

public abstract class OrderedColumn
extends QueryTreeNode

An ordered column has position. It is an abstract class for group by and order by columns.

Field Summary

protected int	columnPosition
protected static int	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

OrderedColumn()

Method Summary

void	copyFrom(QueryTreeNode node) Fill this node with a deep copy of the given node.
int	getColumnPosition() Get the position of this column
boolean	isAscending() Indicate whether this column is ascending or not.
boolean	isNullsOrderedLow() Indicate whether this column should be ordered NULLS low.
void	setColumnPosition(int columnPosition) Set the position of this column
String	toString() Convert this object to a String.

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, init, isInstanceOf, makeTableName, makeTableName, nodeHeader, printLabel, printSubNodes, 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

Field Detail

UNMATCHEDPOSITION

protected static final int UNMATCHEDPOSITION

See Also:

Constant Field Values

columnPosition

protected int columnPosition

Constructor Detail

OrderedColumn

public OrderedColumn()

Method Detail

copyFrom

public void copyFrom(QueryTreeNode node)
              throws StandardException

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

Overrides:

copyFrom in class QueryTreeNode

Throws:

StandardException

isAscending

public boolean isAscending()

Indicate whether this column is ascending or not. By default assume that all ordered columns are necessarily ascending. If this class is inherited by someone that can be desceneded, they are expected to override this method.

Returns:

true

isNullsOrderedLow

public boolean isNullsOrderedLow()

Indicate whether this column should be ordered NULLS low. By default we assume that all ordered columns are ordered with NULLS higher than non-null values. If this class is inherited by someone that can be specified to have NULLs ordered lower than non-null values, they are expected to override this method.

Returns:

false

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 QueryTreeNode

Returns:

This object as a String

getColumnPosition

public int getColumnPosition()

Get the position of this column

Returns:

The position of this column

setColumnPosition

public void setColumnPosition(int columnPosition)

Set the position of this column