com.metamatrix.query.optimizer.xml
Class XMLPlannerEnvironment

java.lang.Object
  com.metamatrix.query.optimizer.xml.XMLPlannerEnvironment

public final class XMLPlannerEnvironment
extends java.lang.Object

This handy little class simply holds data that is sent recursively throughout the XMLPlanner. It is useful to define it all here, where more data can be added as needed, rather than change parameters to all the method calls later on. A single instance will be used in XMLPlanner.

Field Summary

static java.lang.Integer

XML_FORM_RESULTS_PROPERTY Property key to indicate what form the XML result documents should be in, either String (default) or JDOM document.

Constructor Summary

XMLPlannerEnvironment(QueryMetadataInterface qmi)

Method Summary

void	addQueryNodeToMetadata(java.lang.Object metadataId, QueryNode node)
void	addStagingTable(java.lang.Object groupId, java.lang.Object intoGroupId) Dynamically setting up the staging tables as meterialized views.
void	addToGlobalMetadata(java.util.Map data)
java.lang.String	getAliasName(java.lang.String rsName)
java.lang.String	getStagedResultName(java.lang.String rsName)
ResultSetInfo	getStagingTableResultsInfo(java.lang.String groupName)
boolean	isStagingTable(java.lang.Object groupId)
java.lang.String	unLoadResultName(java.lang.String loadName)

Methods inherited from class java.lang.Object

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

Field Detail

XML_FORM_RESULTS_PROPERTY

public static final java.lang.Integer XML_FORM_RESULTS_PROPERTY

Property key to indicate what form the XML result documents should be in, either String (default) or JDOM document. The value of the property should be one of ProcessorEnvironment#STRING_RESULT or ProcessorEnvironment#JDOM_DOCUMENT_RESULT or This is to be used in conjunction with CommandTreeNode property methods.

Constructor Detail

XMLPlannerEnvironment

public XMLPlannerEnvironment(QueryMetadataInterface qmi)

Method Detail

getStagingTableResultsInfo

public ResultSetInfo getStagingTableResultsInfo(java.lang.String groupName)

addStagingTable

public void addStagingTable(java.lang.Object groupId,
                            java.lang.Object intoGroupId)

Dynamically setting up the staging tables as meterialized views.

Parameters:

groupSymbol -

intoGroupSymbol -

isStagingTable

public boolean isStagingTable(java.lang.Object groupId)

addToGlobalMetadata

public void addToGlobalMetadata(java.util.Map data)

addQueryNodeToMetadata

public void addQueryNodeToMetadata(java.lang.Object metadataId,
                                   QueryNode node)

unLoadResultName

public java.lang.String unLoadResultName(java.lang.String loadName)

getStagedResultName

public java.lang.String getStagedResultName(java.lang.String rsName)

getAliasName

public java.lang.String getAliasName(java.lang.String rsName)