NormalizeResultSetNode (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.NormalizeResultSetNode

All Implemented Interfaces:

Optimizable, Visitable
```
class NormalizeResultSetNode
extends SingleChildResultSetNode
```
A NormalizeResultSetNode represents a normalization result set for any child result set that needs one. See non-javadoc comments for a walk-through of a couple sample code paths.

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

private boolean forUpdate
this indicates if the normalize is being performed for an Update statement or not.
- 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

Fields
Modifier and Type	Field	Description
`private boolean`	`forUpdate`	this indicates if the normalize is being performed for an Update statement or not.

Constructor Summary

Constructors
Constructor	Description
`NormalizeResultSetNode(ResultSetNode chldRes, ResultColumnList targetResultColumnList, java.util.Properties tableProperties, boolean forUpdate, ContextManager cm)`	Constructor for a NormalizeResultSetNode.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`(package private) void`	`generate(ActivationClassBuilder acb, MethodBuilder mb)`	Do the code generation for this node.
`(package private) void`	`pushOffsetFetchFirst(ValueNode offset, ValueNode fetchFirst, boolean hasJDBClimitClause)`	Push through the offset and fetch first parameters, if any, to the child result set.
`(package private) void`	`pushOrderByList(OrderByList orderByList)`	Push the order by list down from InsertNode into its child result set so that the optimizer has all of the information that it needs to consider sort avoidance.
`void`	`pushQueryExpressionSuffix()`	Set up a new level for order by and fetch/offset clauses.
`(package private) void`	`setRefActionInfo(long fkIndexConglomId, int[] fkColArray, java.lang.String parentResultSetId, boolean dependentScan)`	set the Information gathered from the parent table that is required to perform a referential action on dependent table.

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, 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, 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
  - forUpdate
```
private boolean forUpdate
```
    this indicates if the normalize is being performed for an Update statement or not. The row passed to update also has before values of the columns being updated-- we need not normalize these values.
- Constructor Detail
  - NormalizeResultSetNode
```
NormalizeResultSetNode(ResultSetNode chldRes,
                       ResultColumnList targetResultColumnList,
                       java.util.Properties tableProperties,
                       boolean forUpdate,
                       ContextManager cm)
                throws StandardException
```
    Constructor for a NormalizeResultSetNode. ColumnReferences must continue to point to the same ResultColumn, so that ResultColumn must percolate up to the new PRN. However, that ResultColumn will point to a new expression, a VirtualColumnNode, which points to the FromTable and the ResultColumn that is the source for the ColumnReference. (The new NRSN will have the original of the ResultColumnList and the ResultColumns from that list. The FromTable will get shallow copies of the ResultColumnList and its ResultColumns. ResultColumn.expression will remain at the FromTable, with the PRN getting a new VirtualColumnNode for each ResultColumn.expression.) This is useful for UNIONs, where we want to generate a DistinctNode above the UnionNode to eliminate the duplicates, because the type going into the sort has to agree with what the sort expects. (insert into t1 (smallintcol) values 1 union all values 2;
    
    Parameters:
    
    chldRes - The child ResultSetNode
    
    targetResultColumnList - The target resultColumnList from the InsertNode or UpdateNode. These will be the types used for the NormalizeResultSetNode.
    
    tableProperties - Properties list associated with the table
    
    forUpdate - tells us if the normalize operation is being performed on behalf of an update statement.
    
    cm - The context manager
    
    Throws:
    
    StandardException
- Method Detail
  - 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
  - setRefActionInfo
```
void setRefActionInfo(long fkIndexConglomId,
                      int[] fkColArray,
                      java.lang.String parentResultSetId,
                      boolean dependentScan)
```
    set the Information gathered from the parent table that is required to perform a referential action on dependent table.
    
    Overrides:
    
    setRefActionInfo in class QueryTreeNode
  - pushQueryExpressionSuffix
```
public void pushQueryExpressionSuffix()
```
    Description copied from class: ResultSetNode
    
    Set up a new level for order by and fetch/offset clauses. See Javadoc for ResultSetNode.QueryExpressionClauses. Overridden by implementors of pushOrderByNode, pushOffsetFetchFirst.
    
    Overrides:
    
    pushQueryExpressionSuffix in class ResultSetNode
  - pushOrderByList
```
void pushOrderByList(OrderByList orderByList)
```
    Push the order by list down from InsertNode into its child result set so that the optimizer has all of the information that it needs to consider sort avoidance.
    
    Overrides:
    
    pushOrderByList in class ResultSetNode
    
    Parameters:
    
    orderByList - The order by list
  - pushOffsetFetchFirst
```
void pushOffsetFetchFirst(ValueNode offset,
                          ValueNode fetchFirst,
                          boolean hasJDBClimitClause)
```
    Push through the offset and fetch first parameters, if any, to the child result set.
    
    Overrides:
    
    pushOffsetFetchFirst in class ResultSetNode
    
    Parameters:
    
    offset - the OFFSET, if any
    
    fetchFirst - the OFFSET FIRST, if any
    
    hasJDBClimitClause - true if the clauses were added by (and have the semantics of) a JDBC limit clause

Class NormalizeResultSetNode

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

forUpdate

Constructor Detail

NormalizeResultSetNode

Method Detail

generate

setRefActionInfo

pushQueryExpressionSuffix

pushOrderByList

pushOffsetFetchFirst