org.teiid.query.processor.xml
Class AddCommentInstruction

java.lang.Object
  org.teiid.query.processor.xml.ProcessorInstruction
      org.teiid.query.processor.xml.AddCommentInstruction

public class AddCommentInstruction
extends ProcessorInstruction

Adds a comment to an element of the document in progress

Constructor Summary

AddCommentInstruction(java.lang.String commentText)
Constructor

Method Summary

PlanNode	getDescriptionProperties()
org.teiid.query.processor.xml.XMLContext	process(XMLProcessorEnvironment env, org.teiid.query.processor.xml.XMLContext context) outputs comment for an XML element (comment node is actually child of XML element node)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AddCommentInstruction

public AddCommentInstruction(java.lang.String commentText)

Constructor

Parameters:

commentText - text of the comment

Method Detail

process

public org.teiid.query.processor.xml.XMLContext process(XMLProcessorEnvironment env,
                                                        org.teiid.query.processor.xml.XMLContext context)
                                                 throws BlockedException,
                                                        TeiidComponentException,
                                                        TeiidProcessingException

outputs comment for an XML element (comment node is actually child of XML element node)

Specified by:

process in class ProcessorInstruction

Parameters:

env - instance of ProcessorEnvironment which is being used for the processing of the XML document model query

Throws:

BlockedException - if data is not available now but may be at a later time

TeiidComponentException - for non-business exception

TeiidProcessingException - for business exception due to user input or model

See Also:

ProcessorInstruction#process(ProcessorEnvironment)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getDescriptionProperties

public PlanNode getDescriptionProperties()

Specified by:

getDescriptionProperties in class ProcessorInstruction