Package org.teiid.query.processor.proc
Class ForEachRowPlan
- java.lang.Object
-
- org.teiid.query.processor.ProcessorPlan
-
- org.teiid.query.processor.proc.ForEachRowPlan
-
- All Implemented Interfaces:
Cloneable
,BatchCollector.BatchProducer
public class ForEachRowPlan extends ProcessorPlan
-
-
Constructor Summary
Constructors Constructor Description ForEachRowPlan()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ProcessorPlan
clone()
Return a safe clone of the ProcessorPlan.void
close()
Close the plan after processing.List<Expression>
getOutputElements()
Get list of resolved elements describing output columns for this plan.void
initialize(CommandContext context, ProcessorDataManager dataMgr, BufferManager bufferMgr)
Initialize the plan with some required pieces of data for making queries.TupleBatch
nextBatch()
Get a batch of results or possibly an Exception.void
open()
Open the plan for processing.Boolean
requiresTransaction(boolean transactionalReads)
void
reset()
Reset a plan so that it can be processed again.void
setLookupMap(Map<Expression,Integer> symbolMap)
void
setParams(Map<ElementSymbol,Expression> params)
void
setQueryPlan(ProcessorPlan queryPlan)
void
setRowProcedure(ProcedurePlan rowProcedure)
void
setSingleRow(boolean singleRow)
void
setTupleSource(TupleSource tupleSource)
String
toString()
-
Methods inherited from class org.teiid.query.processor.ProcessorPlan
addWarning, getBuffer, getContext, getDescriptionProperties, hasBuffer, setContext
-
-
-
-
Method Detail
-
clone
public ProcessorPlan clone()
Description copied from class:ProcessorPlan
Return a safe clone of the ProcessorPlan. A ProcessorPlan may only be safely cloned in between processings. That is, it is only safe to clone a plan before it isopened
or after it isclosed
.- Specified by:
clone
in classProcessorPlan
- Returns:
- safe clone of this ProcessorPlan, as long as it is not open for processing
-
close
public void close() throws TeiidComponentException
Description copied from class:ProcessorPlan
Close the plan after processing.- Specified by:
close
in interfaceBatchCollector.BatchProducer
- Specified by:
close
in classProcessorPlan
- Throws:
TeiidComponentException
-
getOutputElements
public List<Expression> getOutputElements()
Description copied from class:ProcessorPlan
Get list of resolved elements describing output columns for this plan.- Specified by:
getOutputElements
in interfaceBatchCollector.BatchProducer
- Specified by:
getOutputElements
in classProcessorPlan
- Returns:
- List of SingleElementSymbol
-
initialize
public void initialize(CommandContext context, ProcessorDataManager dataMgr, BufferManager bufferMgr)
Description copied from class:ProcessorPlan
Initialize the plan with some required pieces of data for making queries. The data manager is used to make queries and the processorID must be passed with the request so the data manager can find the processor again.- Overrides:
initialize
in classProcessorPlan
- Parameters:
context
- Process execution contextdataMgr
- Data manager referencebufferMgr
- Buffer manager reference
-
nextBatch
public TupleBatch nextBatch() throws BlockedException, TeiidComponentException, TeiidProcessingException
Description copied from class:ProcessorPlan
Get a batch of results or possibly an Exception.- Specified by:
nextBatch
in interfaceBatchCollector.BatchProducer
- Specified by:
nextBatch
in classProcessorPlan
- Returns:
- Batch of results
- Throws:
BlockedException
- indicating next batch is not available yetTeiidComponentException
- for non-business rule exceptionTeiidProcessingException
- for business rule exception, related to user input or modeling
-
open
public void open() throws TeiidComponentException, TeiidProcessingException
Description copied from class:ProcessorPlan
Open the plan for processing.- Specified by:
open
in classProcessorPlan
- Throws:
TeiidComponentException
TeiidProcessingException
-
setQueryPlan
public void setQueryPlan(ProcessorPlan queryPlan)
-
setRowProcedure
public void setRowProcedure(ProcedurePlan rowProcedure)
-
setParams
public void setParams(Map<ElementSymbol,Expression> params)
-
setLookupMap
public void setLookupMap(Map<Expression,Integer> symbolMap)
-
reset
public void reset()
Description copied from class:ProcessorPlan
Reset a plan so that it can be processed again.- Overrides:
reset
in classProcessorPlan
-
requiresTransaction
public Boolean requiresTransaction(boolean transactionalReads)
- Overrides:
requiresTransaction
in classProcessorPlan
-
setTupleSource
public void setTupleSource(TupleSource tupleSource)
-
setSingleRow
public void setSingleRow(boolean singleRow)
-
-