com.metamatrix.query.processor.xml
Class AddNodeInstruction

java.lang.Object
  com.metamatrix.query.processor.xml.ProcessorInstruction
      com.metamatrix.query.processor.xml.AddNodeInstruction

All Implemented Interfaces:

Describable

public class AddNodeInstruction
extends ProcessorInstruction

Field Summary

static boolean	ATTRIBUTE
static boolean	ELEMENT

Fields inherited from interface com.metamatrix.query.processor.Describable

PROP_BINDINGS, PROP_CHILDREN, PROP_CONDITIONS, PROP_CRITERIA, PROP_DATA_COL, PROP_DEFAULT, PROP_DEFAULT_PROGRAM, PROP_ELSE, PROP_ENCODING, PROP_EXECUTION_PLAN, PROP_EXPRESSION, PROP_FORMATTED, PROP_GROUP, PROP_GROUP_COLS, PROP_IN_MEMORY, PROP_INTO_GROUP, PROP_IS_STAGING, PROP_JOIN_CRITERIA, PROP_JOIN_STRATEGY, PROP_JOIN_TYPE, PROP_MESSAGE, PROP_MODEL_NAME, PROP_NAMESPACE, PROP_NAMESPACE_DECL, PROP_NODE_COST_ESTIMATES, PROP_NODE_STATS_LIST, PROP_NODE_STATS_PROPS, PROP_OPTIONAL, PROP_OUTPUT_COLS, PROP_PROGRAM, PROP_PROGRAMS, PROP_RECURSE_DIR, PROP_REMOVE_DUPS, PROP_RESULT_SET, PROP_ROW_LIMIT, PROP_ROW_OFFSET, PROP_SELECT_COLS, PROP_SORT_COLS, PROP_SQL, PROP_TAG, PROP_THEN, PROP_TYPE, PROP_VARIABLE

Constructor Summary

AddNodeInstruction(NodeDescriptor descriptor)
Constructor for AddElementInstruction.

AddNodeInstruction(NodeDescriptor descriptor, ElementSymbol symbol)
Constructor for AddElementInstruction.

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) Outputs an element or an attribute, or nothing, based on the state of the instruction.
void	setNillableDescriptor(NodeDescriptor nillableDescriptor)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

ELEMENT

public static final boolean ELEMENT

See Also:

Constant Field Values

ATTRIBUTE

public static final boolean ATTRIBUTE

See Also:

Constant Field Values

Constructor Detail

AddNodeInstruction

public AddNodeInstruction(NodeDescriptor descriptor)

Constructor for AddElementInstruction.

Parameters:

tag - Tag name

namespacePrefix - String prefix that maps to a namespace (optional, may be null)

isElement - indicates an element or an attribute

fixedValue -

namespaceDeclarations -

isOptional -

AddNodeInstruction

public AddNodeInstruction(NodeDescriptor descriptor,
                          ElementSymbol symbol)

Constructor for AddElementInstruction.

Parameters:

tag - Tag name

namespacePrefix - String prefix that maps to a namespace (optional, may be null)

isElement - indicates an element or an attribute

resultSetName -

resultSetColumn -

type -

defaultValue -

namespaceDeclarations -

isOptional -

Method Detail

process

public com.metamatrix.query.processor.xml.XMLContext process(XMLProcessorEnvironment env,
                                                             com.metamatrix.query.processor.xml.XMLContext context)
                                                      throws BlockedException,
                                                             MetaMatrixComponentException,
                                                             MetaMatrixProcessingException

Outputs an element or an attribute, or nothing, based on the state of the instruction.

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

MetaMatrixComponentException - for non-business exception

MetaMatrixProcessingException - 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 java.util.Map getDescriptionProperties()

Description copied from interface: Describable

Get a description as a set of properties of primitive types such as String, Integer, etc.

Specified by:

getDescriptionProperties in interface Describable

Overrides:

getDescriptionProperties in class ProcessorInstruction

Returns:

Map of properties

setNillableDescriptor

public void setNillableDescriptor(NodeDescriptor nillableDescriptor)

Parameters:

nillableDescriptor - The nillableDescriptor to set.

Since:

4.3