com.splicemachine.db.impl.sql.compile

Class OverClause

java.lang.Object

com.splicemachine.db.impl.sql.compile.QueryTreeNode

com.splicemachine.db.impl.sql.compile.OverClause

All Implemented Interfaces:

Node, Visitable

public class OverClause
extends QueryTreeNode

This class aggregates objects that make up a Window Over() clause.
This class is immutable and so functions with equivalent over() clauses can share a single instance.
This also allows window functions that are defined over the same space to be grouped and processed together.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OverClause.Builder Over clause builder used by SQL grammar (generated parser).

Nested classes/interfaces inherited from class com.splicemachine.db.impl.sql.compile.QueryTreeNode

QueryTreeNode.WordUtils

Field Summary

Fields inherited from class com.splicemachine.db.impl.sql.compile.QueryTreeNode

AUTOINCREMENT_CREATE_MODIFY, AUTOINCREMENT_INC_INDEX, AUTOINCREMENT_IS_AUTOINCREMENT_INDEX, AUTOINCREMENT_START_INDEX, depth, isPrivilegeCollectionRequired

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
WindowFrameDefinition	getFrameDefinition()
java.util.List<OrderedColumn>	getKeyColumns() Use this method exclusively to get the key columns for a given window definition.
OrderByList	getOrderByClause()
java.util.List<OrderedColumn>	getOverColumns() Use this method to get all columns, with possible duplicates,
Partition	getPartition()
int	hashCode()
boolean	isEquivalent(OverClause other)
void	printSubNodes(int depth) QueryTreeNode override.
java.lang.String	toHTMLString()
java.lang.String	toString() java.lang.Object override.

Methods inherited from class com.splicemachine.db.impl.sql.compile.QueryTreeNode

accept, accept, acceptChildren, bindOffsetFetch, bindRowMultiSet, bindUserCatalogType, bindUserType, buildTree, checkReliability, checkReliability, childParentMap, collectReferencedColumns, convertDefaultNode, createTypeDependency, debugFlush, debugPrint, disablePrivilegeCollection, formatNodeString, foundString, generate, generateAuthorizeCheck, getBeginOffset, getClassFactory, getCompilerContext, getConstantNode, getConstantNodeType, getContextManager, getCursorInfo, getDataDictionary, getDependencyManager, getEndOffset, getExecutionFactory, getExtraInformation, getGenericConstantActionFactory, getHashableJoinColumnReference, getIntProperty, getLanguageConnectionContext, getNodeFactory, getNodeType, getNullNode, getParameterTypes, getSchemaDescriptor, getSchemaDescriptor, getStatementType, getTableDescriptor, getTypeCompiler, init, init, init, init, init, init, init, init, init, init, init, init, init, init, init, isAtomic, isInstanceOf, isPrivilegeCollectionRequired, isSessionSchema, isSessionSchema, makeConstantAction, makeTableName, makeTableName, markReferencedResultColumns, nodeHeader, orReliability, parseStatement, printExplainInformation, printExplainInformation, printExplainInformation, printExplainInformationForActivation, printLabel, printRuntimeInformation, projectionListPruning, referencesSessionSchema, resolveTableToSynonym, rsnChainMap, setBeginOffset, setContextManager, setDepth, setEndOffset, setHashableJoinColumnReference, setNodeType, setRefActionInfo, spaceToLevel, treePrint, treePrint, verifyClassExist

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getPartition

public Partition getPartition()

getOrderByClause

public OrderByList getOrderByClause()

getKeyColumns

public java.util.List<OrderedColumn> getKeyColumns()

Use this method exclusively to get the key columns for a given window definition. These key columns will be used to build a row key to sort rows incoming to the window function.

Key columns are comprised of the concatenation of Partition columns and OrderBy columns, in the form of this set {[P1,P2,...][O1,O2,...]}, where Pn is Partition element n and On is OrderBy element n. As a set, duplicate columns are not included. This is fine since we don't need to "re-sort" rows on a column.

Returns:

the ordered set of de-duplicated key columns.

getOverColumns

public java.util.List<OrderedColumn> getOverColumns()

Use this method to get all columns, with possible duplicates,

Returns:

the list of all over() columns in order {[P1,P2,...][O1,O2,...]}, where Pn is a Partition column and On is an OrderBy column.

getFrameDefinition

public WindowFrameDefinition getFrameDefinition()

toString

public java.lang.String toString()

java.lang.Object override.

Overrides:

toString in class QueryTreeNode

Returns:

This node formatted as a String

See Also:

QueryTreeNode.toString()

toHTMLString

public java.lang.String toHTMLString()

Overrides:

toHTMLString in class QueryTreeNode

printSubNodes

public void printSubNodes(int depth)

QueryTreeNode override. Prints the sub-nodes of this object.

Overrides:

printSubNodes in class QueryTreeNode

Parameters:

depth - The depth of this node in the tree

See Also:

QueryTreeNode.printSubNodes(int)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

isEquivalent

public boolean isEquivalent(OverClause other)
                     throws StandardException

Returns:

true if the window specifications are equivalent; no need to create more than one window then.

Throws:

StandardException