Package org.teiid.query.processor.relational

Class SortNode

java.lang.Object

org.teiid.query.processor.relational.RelationalNode

org.teiid.query.processor.relational.SortNode

All Implemented Interfaces:

Cloneable, BatchCollector.BatchProducer

public class SortNode
extends RelationalNode

Field Summary

Fields inherited from class org.teiid.query.processor.relational.RelationalNode

childCount

Constructor Summary

Constructors

Constructor	Description
SortNode(int nodeID)

Method Summary

Modifier and Type	Method	Description
Object	clone()	All the implementation of Cloneable interface need to implement clone() method.
void	closeDirect()
protected void	copyTo(SortNode target)
TupleBuffer	getBufferDirect(int maxRows)	For subclasses to override if they wish to return a buffer rather than batches.
PlanNode	getDescriptionProperties()
SortUtility.Mode	getMode()
protected void	getNodeString(StringBuffer str)
List<OrderByItem>	getSortElements()
boolean	hasBuffer()	Return true if the node provides a final buffer via getBuffer
TupleBatch	nextBatchDirect()	Template method for subclasses to implement.
void	reset()
void	setMode(SortUtility.Mode mode)
void	setRowLimit(int rowLimit)
void	setSortElements(List<OrderByItem> items)

Methods inherited from class org.teiid.query.processor.relational.RelationalNode

addBatchRow, addChild, close, copyTo, createLookupMap, getBatchSize, getBuffer, getBufferManager, getChildCount, getChildren, getClassName, getConnectionID, getContext, getDataManager, getElements, getEstimateNodeCardinality, getID, getNodeStatistics, getOutputElements, getParent, getProjectionIndexes, hasPendingRows, initialize, isBatchFull, isClosed, isLastBatch, nextBatch, nodeToString, open, projectTuple, projectTuple, pullBatch, requiresTransaction, setContext, setElements, setEstimateDepAccessCardinality, setEstimateDepJoinCost, setEstimateJoinCost, setEstimateNodeCardinality, setEstimateNodeSetSize, setID, setParent, terminateBatches, toString, unwrapException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SortNode

public SortNode(int nodeID)

Method Detail

reset

public void reset()

Overrides:

reset in class RelationalNode

setSortElements

public void setSortElements(List<OrderByItem> items)

getSortElements

public List<OrderByItem> getSortElements()

getMode

public SortUtility.Mode getMode()

setMode

public void setMode(SortUtility.Mode mode)

nextBatchDirect

public TupleBatch nextBatchDirect()
                           throws BlockedException,
                                  TeiidComponentException,
                                  TeiidProcessingException

Description copied from class: RelationalNode

Template method for subclasses to implement.

Specified by:

nextBatchDirect in class RelationalNode

Returns:

Throws:

BlockedException

TeiidComponentException

TeiidProcessingException - if exception related to user input occured

closeDirect

public void closeDirect()

Overrides:

closeDirect in class RelationalNode

getNodeString

protected void getNodeString(StringBuffer str)

Overrides:

getNodeString in class RelationalNode

copyTo

protected void copyTo(SortNode target)

clone

public Object clone()

Description copied from class: RelationalNode

All the implementation of Cloneable interface need to implement clone() method. The plan is only clonable in the pre-execution stage, not the execution state (things like program state, result sets, etc). It's only safe to call that method in between query processings, in other words, it's only safe to call clone() on a plan after nextTuple() returns null, meaning the plan has finished processing.

Specified by:

clone in class RelationalNode

getDescriptionProperties

public PlanNode getDescriptionProperties()

Overrides:

getDescriptionProperties in class RelationalNode

getBufferDirect

public TupleBuffer getBufferDirect(int maxRows)
                            throws BlockedException,
                                   TeiidComponentException,
                                   TeiidProcessingException

Description copied from class: RelationalNode

For subclasses to override if they wish to return a buffer rather than batches.

Overrides:

getBufferDirect in class RelationalNode

Returns:

Throws:

BlockedException

TeiidComponentException

TeiidProcessingException

hasBuffer

public boolean hasBuffer()

Description copied from class: RelationalNode

Return true if the node provides a final buffer via getBuffer

Specified by:

hasBuffer in interface BatchCollector.BatchProducer

Overrides:

hasBuffer in class RelationalNode

setRowLimit

public void setRowLimit(int rowLimit)