|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.metamatrix.query.processor.xml.ProcessorInstruction com.metamatrix.query.processor.xml.EndBlockInstruction
public class EndBlockInstruction
This instruction closes a result set, which closes and removes the TupleSource associated with it. This is needed to explicitly close temporary group result sets once processing moves out of their scope, otherwise they would not get cleaned up. But it can be used for other result sets besides temporary groups.
(This instruction does the same thing that a
WhileInstruction
does when the end of a
result set is reached.)
Field Summary |
---|
Constructor Summary | |
---|---|
EndBlockInstruction(java.lang.String resultSetName)
Constructor for CloseResultSetInstruction. |
Method Summary | |
---|---|
java.util.Map |
getDescriptionProperties()
Get a description as a set of properties of primitive types such as String, Integer, etc. |
com.metamatrix.query.processor.xml.XMLContext |
process(XMLProcessorEnvironment env,
com.metamatrix.query.processor.xml.XMLContext context)
Allow this ProcessorInstruction to do whatever processing it needs, and to in turn manipulate the running program, (via the ProcessorEnvironment getProgramStack method.)
A typical instruction should simply increment
the program counter of the current program, but specialized instructions may add
sub programs to the stack or not increment the counter (so that they are
executed again.) |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public EndBlockInstruction(java.lang.String resultSetName)
Method Detail |
---|
public com.metamatrix.query.processor.xml.XMLContext process(XMLProcessorEnvironment env, com.metamatrix.query.processor.xml.XMLContext context) throws BlockedException, MetaMatrixComponentException, MetaMatrixProcessingException
ProcessorInstruction
getProgramStack
method.)
A typical instruction should simply increment
the program counter of the current program, but specialized instructions may add
sub programs to the stack or not increment the counter (so that they are
executed again.)
process
in class ProcessorInstruction
env
- instance of ProcessorEnvironment which is being used for the processing
of the XML document model query
BlockedException
- if data is not available now but may be at a later time
MetaMatrixComponentException
- for non-business exception
MetaMatrixProcessingException
- for business exception due to user input or modelProcessorInstruction#process(ProcessorEnvironment)
public java.lang.String toString()
toString
in class java.lang.Object
public java.util.Map getDescriptionProperties()
Describable
getDescriptionProperties
in interface Describable
getDescriptionProperties
in class ProcessorInstruction
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |