com.foundationdb.sql.parser

Class CreateSequenceNode

java.lang.Object

com.foundationdb.sql.parser.QueryTreeNode

com.foundationdb.sql.parser.StatementNode

com.foundationdb.sql.parser.DDLStatementNode

com.foundationdb.sql.parser.CreateSequenceNode

All Implemented Interfaces:

Visitable

public class CreateSequenceNode
extends DDLStatementNode

A CreateSequenceNode is the root of a QueryTree that represents a CREATE SEQUENCE statement.

Note that this node represents *only* what was in the statement and all unspecified properties will be null. A standard conforming implementation would use minValue, 1 and false for missing startValue, incrementBy and isCycle, respectively.

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

Method Summary

Methods

Modifier and Type	Method and Description
void	copyFrom(QueryTreeNode node) Fill this node with a deep copy of the given node.
DataTypeDescriptor	getDataType()
Long	getIncrementBy()
Long	getMaxValue()
Long	getMinValue()
TableName	getSequenceName()
Long	getStartWith()
StorageFormatNode	getStorageFormat()
void	init(Object sequenceName, Object dataType, Object startWith, Object incrementBy, Object maxValue, Object minValue, Object isCycle, Object storageFormat) Initializer for a CreateSequenceNode
Boolean	isCycle()
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

CreateSequenceNode

public CreateSequenceNode()

Method Detail

init

public void init(Object sequenceName,
        Object dataType,
        Object startWith,
        Object incrementBy,
        Object maxValue,
        Object minValue,
        Object isCycle,
        Object storageFormat)
          throws StandardException

Initializer for a CreateSequenceNode

Overrides:

init in class QueryTreeNode

Parameters:

sequenceName - The name of the new sequence

dataType - Exact numeric type of the new sequence

startWith - Starting value

incrementBy - Increment amount

maxValue - Largest value returned by the sequence generator

minValue - Smallest value returned by the sequence generator

isCycle - True if the generator should wrap around, false otherwise

Throws:

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

getSequenceName

public final TableName getSequenceName()

getDataType

public final DataTypeDescriptor getDataType()

getStartWith

public final Long getStartWith()

getMaxValue

public final Long getMaxValue()

getMinValue

public final Long getMinValue()

getIncrementBy

public final Long getIncrementBy()

isCycle

public final Boolean isCycle()

getStorageFormat

public StorageFormatNode getStorageFormat()