com.foundationdb.sql.parser

Class CreateIndexNode

java.lang.Object

com.foundationdb.sql.parser.QueryTreeNode

com.foundationdb.sql.parser.StatementNode

com.foundationdb.sql.parser.DDLStatementNode

com.foundationdb.sql.parser.CreateIndexNode

All Implemented Interfaces:

IndexDefinition, Visitable

public class CreateIndexNode
extends DDLStatementNode
implements IndexDefinition

A CreateIndexNode is the root of a QueryTree that represents a CREATE INDEX statement.

Field Summary

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

ADD_TYPE, DROP_TYPE, LOCKING_TYPE, MODIFY_TYPE, UNKNOWN_TYPE

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
CreateIndexNode()

Method Summary

Methods

Modifier and Type	Method and Description
void	copyFrom(QueryTreeNode node) Fill this node with a deep copy of the given node.
ExistenceCheck	getExistenceCheck()
IndexColumnList	getIndexColumnList()
TableName	getIndexName()
TableName	getIndexTableName()
JoinNode.JoinType	getJoinType()
Properties	getProperties()
StorageFormatNode	getStorageFormat()
void	init(Object unique, Object indexName, Object tableName, Object columnList, Object joinType, Object properties, Object existenceCheck, Object storageFormat) Initializer for a CreateIndexNode
boolean	isUnique()
void	printSubNodes(int depth) Print the sub-nodes of this node.
String	statementToString()
String	toString() Convert this object to a String.

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

getFullName, getObjectName, getRelativeName, init, initAndCheck, isAtomic

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, 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

CreateIndexNode

public CreateIndexNode()

Method Detail

init

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

Initializer for a CreateIndexNode

Overrides:

init in class QueryTreeNode

Parameters:

unique - True means it's a unique index

indexName - The name of the index

tableName - The name of the table the index will be on

columnList - A list of columns, in the order they appear in the index.

properties - The optional properties list associated with the index.

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 DDLStatementNode

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 DDLStatementNode

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

statementToString

public String statementToString()

Specified by:

statementToString in class StatementNode

getIndexName

public TableName getIndexName()

getIndexTableName

public TableName getIndexTableName()

getProperties

public Properties getProperties()

getExistenceCheck

public ExistenceCheck getExistenceCheck()

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