com.foundationdb.sql.parser

Class IndexDefinitionNode

java.lang.Object

com.foundationdb.sql.parser.QueryTreeNode

com.foundationdb.sql.parser.TableElementNode

com.foundationdb.sql.parser.IndexDefinitionNode

All Implemented Interfaces:

IndexDefinition, Visitable

public class IndexDefinitionNode
extends TableElementNode
implements IndexDefinition

Nested Class Summary

Nested classes/interfaces inherited from class com.foundationdb.sql.parser.TableElementNode

TableElementNode.ElementType

Field Summary

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

AUTOINCREMENT_CREATE_MODIFY, AUTOINCREMENT_INC_INDEX, AUTOINCREMENT_IS_AUTOINCREMENT_INDEX, AUTOINCREMENT_START_INDEX

Constructor Summary

Constructors

Constructor and Description
IndexDefinitionNode()

Method Summary

Methods

Modifier and Type	Method and Description
void	copyFrom(QueryTreeNode node) Fill this node with a deep copy of the given node.
IndexColumnList	getIndexColumnList()
JoinNode.JoinType	getJoinType()
StorageFormatNode	getStorageFormat()
void	init(Object unique, Object indexName, Object columnList, Object joinType, Object storageFormat) Initializer for a IndexDefinitionNode
boolean	isUnique()
void	printSubNodes(int depth) Print the sub-nodes of this node.
void	setUnique(boolean unique)
String	toString() Convert this object to a String.

Methods inherited from class com.foundationdb.sql.parser.TableElementNode

getName, init, init

Methods inherited from class com.foundationdb.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, 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

IndexDefinitionNode

public IndexDefinitionNode()

Method Detail

init

public void init(Object unique,
        Object indexName,
        Object columnList,
        Object joinType,
        Object storageFormat)
          throws StandardException

Initializer for a IndexDefinitionNode

Overrides:

init in class QueryTreeNode

Parameters:

unique - True means it's a unique index

indexName - The name of the index

columnList - A list of columns, in the order they

Throws:

StandardException - Thrown on error

copyFrom

public void copyFrom(QueryTreeNode node)
              throws StandardException

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

Overrides:

copyFrom in class TableElementNode

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 TableElementNode

Returns:

This object as a String

printSubNodes

public void printSubNodes(int depth)

Description copied from class: QueryTreeNode

Print the sub-nodes of this node. Each sub-class of QueryTreeNode is expected to provide its own printSubNodes() method. In each case, it calls super.printSubNodes(), passing along its depth, to get the sub-nodes of the super-class. Then it prints its own sub-nodes by calling treePrint() on each of its members that is a type of QueryTreeNode. In each case where it calls treePrint(), it should pass "depth + 1" to indicate that the sub-node should be indented one more level when printing. Also, it should call printLabel() to print the name of each sub-node before calling treePrint() on the sub-node, so that the reader of the printed tree can tell what the sub-node is.

Overrides:

printSubNodes in class QueryTreeNode

Parameters:

depth - The depth to indent the sub-nodes

setUnique

public void setUnique(boolean unique)

isUnique

public boolean isUnique()

Specified by:

isUnique in interface IndexDefinition

getJoinType

public JoinNode.JoinType getJoinType()

Specified by:

getJoinType in interface IndexDefinition

getIndexColumnList

public IndexColumnList getIndexColumnList()

Specified by:

getIndexColumnList in interface IndexDefinition

getStorageFormat

public StorageFormatNode getStorageFormat()

Specified by:

getStorageFormat in interface IndexDefinition