WindowResultSetNode (Apache Derby V10.14 Internals)

java.lang.Object
- org.apache.derby.impl.sql.compile.QueryTreeNode
- - org.apache.derby.impl.sql.compile.ResultSetNode
  - - org.apache.derby.impl.sql.compile.FromTable
    - - org.apache.derby.impl.sql.compile.SingleChildResultSetNode
      - org.apache.derby.impl.sql.compile.WindowResultSetNode

All Implemented Interfaces:

Optimizable, Visitable
```
class WindowResultSetNode
extends SingleChildResultSetNode
```
A WindowResultSetNode represents a result set for a window partitioning on a select. Modeled on the code in GroupByNode.

Nested Class Summary
- Nested classes/interfaces inherited from class org.apache.derby.impl.sql.compile.ResultSetNode
  ResultSetNode.QueryExpressionClauses

Field Summary

Fields
Modifier and Type	Field	Description
`(package private) FromTable`	`parent`	The parent to the WindowResultSetNode.
`(package private) WindowDefinitionNode`	`wdn`
`(package private) java.util.List<WindowFunctionNode>`	`windowFuncCalls`

Fields inherited from class org.apache.derby.impl.sql.compile.FromTable
ADD_PLAN, bestAccessPath, bestCostEstimate, bestSortAvoidancePath, correlationName, corrTableName, currentAccessPath, hashKeyColumns, initialCapacity, level, LOAD_PLAN, loadFactor, maxCapacity, origTableName, REMOVE_PLAN, tableNumber, tableProperties, trulyTheBestAccessPath, userSpecifiedJoinStrategy

Fields inherited from class org.apache.derby.impl.sql.compile.QueryTreeNode
AUTOINCREMENT_CREATE_MODIFY, AUTOINCREMENT_CYCLE, AUTOINCREMENT_INC_INDEX, AUTOINCREMENT_IS_AUTOINCREMENT_INDEX, AUTOINCREMENT_START_INDEX

Fields inherited from class org.apache.derby.impl.sql.compile.SingleChildResultSetNode
childResult, hasTrulyTheBestAccessPath

Constructor Summary

Constructors
Constructor	Description
`WindowResultSetNode(ResultSetNode bottomPR, WindowDefinitionNode windowDef, java.util.List<WindowFunctionNode> windowFuncCalls, int nestingLevel, ContextManager cm)`	Constructor for a WindowResultSetNode.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`private void`	`addNewColumns()`	Substitute new result columns for window function calls and add the result columns to childResult's list of columns.
`private void`	`addNewPRNode()`	Add a new PR node.
`private boolean`	`colRefAlreadySeen(java.util.List<ValueNode> uniqueColRefs, ColumnReference cand)`
`(package private) void`	`generate(ActivationClassBuilder acb, MethodBuilder mb)`	Do the code generation for this node.
`(package private) FromTable`	`getParent()`
`void`	`printSubNodes(int depth)`	QueryTreeNode override

Methods inherited from class org.apache.derby.impl.sql.compile.FromTable
assignCostEstimate, canBeOrdered, columnsAreUpdatable, considerSortAvoidancePath, convertAbsoluteToRelativeColumnPosition, cursorTargetTable, estimateCost, feasibleJoinStrategy, fillInReferencedTableMap, flatten, getBaseTableName, getBestAccessPath, getBestSortAvoidancePath, getCorrelationName, getCostEstimate, getCurrentAccessPath, getExposedName, getLevel, getMergeTableID, getName, getNumColumnsReturned, getOrigTableName, getProperties, getResultColumnsForList, getSchemaDescriptor, getSchemaDescriptor, getScratchCostEstimate, getTableDescriptor, getTableName, getTableNumber, getUserSpecifiedJoinStrategy, hashKeyColumns, hasLargeObjectColumns, hasTableNumber, initialCapacity, isBaseTable, isCoveringIndex, isFlattenableJoinNode, isJoinColumnForRightOuterJoin, isMaterializable, isOneRowScan, isTargetTable, legalJoinOrder, loadFactor, LOJ_reorderable, markUpdatableByCursor, maxCapacity, memoryUsageOK, modifyAccessPath, needsSpecialRCLBinding, nextAccessPath, optimizeIt, optimizeSubqueries, pushOptPredicate, rememberAsBest, rememberJoinStrategyAsBest, rememberSortAvoidancePath, resetJoinStrategies, setCostEstimateCost, setHashKeyColumns, setMergeTableID, setOrigTableName, setProperties, setTableNumber, startOptimizing, supportsMultipleInstantiations, tellRowOrderingAboutConstantColumns, toString, transformOuterJoins, uniqueJoin, verifyProperties

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.derby.iapi.sql.compile.Optimizable
getDataDictionary, getOptimizerTracer, getReferencedTableMap, getResultSetNumber, optimizerTracingIsOn

Methods inherited from class org.apache.derby.impl.sql.compile.QueryTreeNode
accept, addTag, addUDTUsagePriv, addUDTUsagePriv, bindOffsetFetch, bindRowMultiSet, bindUserCatalogType, bindUserType, checkReliability, checkReliability, convertDefaultNode, copyTagsFrom, createTypeDependency, debugFlush, debugPrint, disablePrivilegeCollection, formatNodeString, generateAuthorizeCheck, getBeginOffset, getClassFactory, getCompilerContext, getContext, getContextManager, getDataDictionary, getDependencyManager, getEndOffset, getExecutionFactory, getGenericConstantActionFactory, getIntProperty, getLanguageConnectionContext, getLongProperty, getNullNode, getOffsetOrderedNodes, getOptimizerFactory, getOptimizerTracer, getParameterTypes, getSchemaDescriptor, getSchemaDescriptor, getStatementType, getTableDescriptor, getTypeCompiler, getUDTDesc, isAtomic, isPrivilegeCollectionRequired, isSessionSchema, isSessionSchema, makeConstantAction, makeTableName, makeTableName, nodeHeader, optimizerTracingIsOn, orReliability, parseSearchCondition, parseStatement, printLabel, resolveTableToSynonym, setBeginOffset, setEndOffset, setRefActionInfo, stackPrint, taggedWith, treePrint, treePrint, verifyClassExist

Methods inherited from class org.apache.derby.impl.sql.compile.ResultSetNode
assignResultSetNumber, bindExpressions, bindExpressionsWithTables, bindNonVTITables, bindResultColumns, bindResultColumns, bindTargetExpressions, bindUntypedNullsToResultColumns, bindVTITables, columnTypesAndLengthsMatch, considerMaterialization, enhanceRCLForInsert, generateNormalizationResultSet, generateResultSet, genProjectRestrict, genProjectRestrict, genProjectRestrictForReordering, getAllResultColumns, getCandidateFinalCostEstimate, getCostEstimate, getCursorTargetTable, getFromList, getMatchingColumn, getNewCostEstimate, getOptimizer, getOptimizerImpl, getRCLForInsert, getReferencedTableMap, getResultColumns, getResultSetNumber, getScratchCostEstimate, isCursorTargetTable, isInsertSource, isPossibleDistinctScan, isStatementResultSet, isUpdatableCursor, LOJgetReferencedTables, makeResultDescription, makeResultDescriptors, markAsCursorTargetTable, markForDistinctScan, markStatementResultSet, modifyAccessPaths, notCursorTargetTable, notFlattenableJoin, numDistinctAggregates, parseDefault, performMaterialization, printQueryExpressionSuffixClauses, projectResultColumns, pushOffsetFetchFirst, pushOrderByList, pushQueryExpressionSuffix, rejectParameters, rejectXMLValues, renameGeneratedResultNames, replaceOrForbidDefaults, returnsAtMostOneRow, setCandidateFinalCostEstimate, setCostEstimate, setCursorTargetTable, setInsertSource, setOptimizer, setReferencedTableMap, setResultColumns, setResultSetNumber, setResultToBooleanTrueNode, setScratchCostEstimate, setTableConstructorTypes, verifySelectStarSubquery

Methods inherited from interface org.apache.derby.iapi.sql.compile.Visitable
accept, addTag, taggedWith

- Field Detail
  - parent
```
FromTable parent
```
    The parent to the WindowResultSetNode. We generate a ProjectRestrict over the windowing node and parent is set to that node.
  - windowFuncCalls
```
java.util.List<WindowFunctionNode> windowFuncCalls
```
  - wdn
```
WindowDefinitionNode wdn
```
- Constructor Detail
  - WindowResultSetNode
```
WindowResultSetNode(ResultSetNode bottomPR,
                    WindowDefinitionNode windowDef,
                    java.util.List<WindowFunctionNode> windowFuncCalls,
                    int nestingLevel,
                    ContextManager cm)
             throws StandardException
```
    Constructor for a WindowResultSetNode.
    
    Parameters:
    
    bottomPR - The project restrict result set we want to wrap
    
    windowDef - The window definition
    
    windowFuncCalls - All window function calls in SELECT's select list and order by list.
    
    nestingLevel - Nesting level
    
    cm - The context manager
    
    Throws:
    
    StandardException - Thrown on error
- Method Detail
  - addNewPRNode
```
private void addNewPRNode()
                   throws StandardException
```
    Add a new PR node. Put the new PR under any sort.
    
    Throws:
    
    StandardException - standard error policy
  - colRefAlreadySeen
```
private boolean colRefAlreadySeen(java.util.List<ValueNode> uniqueColRefs,
                                  ColumnReference cand)
                           throws StandardException
```
    Parameters:
    
    uniqueColRefs - list of unique column references
    
    cand - the candidate to check is present in list
    
    Returns:
    
    true if an equivalent column reference to cand is already present in uniqueColRefs
    
    Throws:
    
    StandardException - standard error policy
  - addNewColumns
```
private void addNewColumns()
                    throws StandardException
```
    Substitute new result columns for window function calls and add the result columns to childResult's list of columns.
    
    Throws:
    
    StandardException - standard error policy
  - generate
```
void generate(ActivationClassBuilder acb,
              MethodBuilder mb)
       throws StandardException
```
    Description copied from class: QueryTreeNode
    
    Do the code generation for this node. This is a place-holder method - it should be over-ridden in the sub-classes.
    
    Overrides:
    
    generate in class QueryTreeNode
    
    Parameters:
    
    acb - The ActivationClassBuilder for the class being built
    
    mb - The method for the generated code to go into
    
    Throws:
    
    StandardException - Thrown on error
  - getParent
```
final FromTable getParent()
```
    Returns:
    
    parent of this node, a PRN, used by SelectNode to retrieve new top result set node after window result set rewrite of result set tree.
  - printSubNodes
```
public void printSubNodes(int depth)
```
    QueryTreeNode override
    
    Overrides:
    
    printSubNodes in class SingleChildResultSetNode
    
    Parameters:
    
    depth - The depth of this node in the tree
    
    See Also:
    
    QueryTreeNode.printSubNodes(int)

Class WindowResultSetNode

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.derby.impl.sql.compile.ResultSetNode

Field Summary

Fields inherited from class org.apache.derby.impl.sql.compile.FromTable

Fields inherited from class org.apache.derby.impl.sql.compile.QueryTreeNode

Fields inherited from class org.apache.derby.impl.sql.compile.SingleChildResultSetNode

Constructor Summary

Method Summary

Methods inherited from class org.apache.derby.impl.sql.compile.FromTable

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.derby.iapi.sql.compile.Optimizable

Methods inherited from class org.apache.derby.impl.sql.compile.QueryTreeNode

Methods inherited from class org.apache.derby.impl.sql.compile.ResultSetNode

Methods inherited from class org.apache.derby.impl.sql.compile.SingleChildResultSetNode

Methods inherited from interface org.apache.derby.iapi.sql.compile.Visitable

Field Detail

parent

windowFuncCalls

wdn

Constructor Detail

WindowResultSetNode

Method Detail

addNewPRNode

colRefAlreadySeen

addNewColumns

generate

getParent

printSubNodes