org.apache.derby.impl.sql.compile
Class OrderByNode

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.OrderByNode

All Implemented Interfaces:

Node, Optimizable, Visitable

public class OrderByNode
extends SingleChildResultSetNode

An OrderByNode represents a result set for a sort operation for an order by list. It is expected to only be generated at the end of optimization, once we have determined that a sort is required.

Field Summary

(package private) OrderByList

orderByList

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

childResult, hasTrulyTheBestAccessPath

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.ResultSetNode

costEstimate, cursorTargetTable, finalCostEstimate, insertSource, optimizer, referencedTableMap, resultColumns, resultSetNumber, scratchCostEstimate, statementResultSet

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

AUTOINCREMENT_CREATE_MODIFY, AUTOINCREMENT_INC_INDEX, AUTOINCREMENT_IS_AUTOINCREMENT_INDEX, AUTOINCREMENT_START_INDEX, isPrivilegeCollectionRequired

Constructor Summary

OrderByNode()

Method Summary

void	generate(ActivationClassBuilder acb, MethodBuilder mb) generate the distinct result set operating over the source resultset.
void	init(java.lang.Object childResult, java.lang.Object orderByList, java.lang.Object tableProperties) Initializer for a OrderByNode.
(package private) ResultColumnDescriptor[]	makeResultDescriptors()
void	printSubNodes(int depth) Prints the sub-nodes of this object.

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

acceptChildren, addNewPredicate, adjustForSortElimination, adjustForSortElimination, changeAccessPath, decrementLevel, ensurePredicateList, flattenableInFromSubquery, forUpdate, getChildResult, getFinalCostEstimate, getFromTableByName, getTrulyTheBestAccessPath, init, initAccessPaths, isNotExists, isOneRowResultSet, isOrderedOn, modifyAccessPaths, optimize, preprocess, pullOptPredicates, pushExpressions, referencesSessionSchema, referencesTarget, reflectionNeededForProjection, setChildResult, setLevel, subqueryReferencesTarget, updateBestPlanMap, updateTargetLockMode

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

assignCostEstimate, canBeOrdered, considerSortAvoidancePath, convertAbsoluteToRelativeColumnPosition, cursorTargetTable, estimateCost, feasibleJoinStrategy, fillInReferencedTableMap, flatten, getBaseTableName, getBestAccessPath, getBestSortAvoidancePath, getCorrelationName, getCostEstimate, getCurrentAccessPath, getExposedName, getLevel, 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, setCostEstimate, setHashKeyColumns, setOrigTableName, setProperties, setTableNumber, startOptimizing, supportsMultipleInstantiations, tellRowOrderingAboutConstantColumns, toString, transformOuterJoins, uniqueJoin, verifyProperties

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, getCostEstimate, getCursorTargetTable, getFromList, getMatchingColumn, getNewCostEstimate, getOptimizer, getOptimizerImpl, getRCLForInsert, getReferencedTableMap, getResultColumns, getResultSetNumber, isPossibleDistinctScan, isUpdatableCursor, LOJgetReferencedTables, makeResultDescription, markAsCursorTargetTable, markForDistinctScan, markStatementResultSet, modifyAccessPaths, notCursorTargetTable, notFlattenableJoin, numDistinctAggregates, parseDefault, performMaterialization, projectResultColumns, pushOffsetFetchFirst, pushOrderByList, rejectParameters, rejectXMLValues, renameGeneratedResultNames, replaceOrForbidDefaults, returnsAtMostOneRow, setInsertSource, setReferencedTableMap, setResultColumns, setResultToBooleanTrueNode, setTableConstructorTypes, verifySelectStarSubquery

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

accept, bindOffsetFetch, bindRowMultiSet, bindUserCatalogType, bindUserType, checkReliability, checkReliability, convertDefaultNode, createTypeDependency, debugFlush, debugPrint, disablePrivilegeCollection, formatNodeString, foundString, generateAuthorizeCheck, getBeginOffset, getClassFactory, getCompilerContext, getContextManager, getCursorInfo, getDataDictionary, getDependencyManager, getEndOffset, getExecutionFactory, getGenericConstantActionFactory, getIntProperty, getLanguageConnectionContext, getNodeFactory, getNodeType, getNullNode, getParameterTypes, getSchemaDescriptor, getSchemaDescriptor, getStatementType, getTableDescriptor, getTypeCompiler, init, init, init, init, init, init, init, init, init, init, init, init, isAtomic, isInstanceOf, isPrivilegeCollectionRequired, isSessionSchema, isSessionSchema, makeConstantAction, makeTableName, makeTableName, nodeHeader, orReliability, parseStatement, printLabel, resolveTableToSynonym, setBeginOffset, setContextManager, setEndOffset, setNodeType, setRefActionInfo, stackPrint, treePrint, treePrint, verifyClassExist

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

Field Detail

orderByList

OrderByList orderByList

Constructor Detail

OrderByNode

public OrderByNode()

Method Detail

init

public void init(java.lang.Object childResult,
                 java.lang.Object orderByList,
                 java.lang.Object tableProperties)
          throws StandardException

Initializer for a OrderByNode.

Specified by:

init in interface Node

Overrides:

init in class QueryTreeNode

Parameters:

childResult - The child ResultSetNode

orderByList - The order by list.

tableProperties - Properties list associated with the table

Throws:

StandardException - Thrown on error

printSubNodes

public void printSubNodes(int depth)

Prints the sub-nodes of this object. See QueryTreeNode.java for how tree printing is supposed to work.

Overrides:

printSubNodes in class SingleChildResultSetNode

Parameters:

depth - The depth of this node in the tree

makeResultDescriptors

ResultColumnDescriptor[] makeResultDescriptors()

Overrides:

makeResultDescriptors in class ResultSetNode

generate

public void generate(ActivationClassBuilder acb,
                     MethodBuilder mb)
              throws StandardException

generate the distinct result set operating over the source resultset.

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