com.metamatrix.soap.util
Class XMLTranslator

java.lang.Object
  com.metamatrix.soap.util.XMLTranslator

public class XMLTranslator
extends java.lang.Object

ResultDocuments is an organized way of structuring XML documents The following illustrates an example of an XML document Stored Procedure Parameters are an organized way of structuring data necessary for executing a stored procedure (SP) call against the MetaMatrix server The following illustrates an example of 2 stored procedure parameters with a value of 1 and null 1 Tabular Results (TR) is an organized way of structuring results data. The following example illustrates the TR format with full metadata from a ResultSet with two columns and 3 rows of data. FloatNum IntNum 5.05 8.05 3.56 The following example illustrates limited metadata (which is the default) of the same result set FloatNum IntNum 5.05 8.05 3.56

Nested Class Summary

static class

XMLTranslator.Constant_TAGS This class contains the Constant tag names used in construction of the XML results

Constructor Summary

XMLTranslator()
Constructor for XMLTranslator.

Method Summary

org.w3c.dom.Element	createMetadataParameter(java.lang.String parameterName, java.lang.String filter) Construct a metadata parameter which is used for the metadata method getMetdata
protected org.w3c.dom.Document	getDocument()
org.w3c.dom.Element	getMetadataParameterElement(org.w3c.dom.Element rootElement, java.lang.String parameterName) Gets the appropriate metadata parameter element based on it it's name
java.lang.String	getMetadataParameterName(org.w3c.dom.Element metadataParameterElement) Get the metadata parameter name of this element
java.lang.String	getMetadataParameterValue(org.w3c.dom.Element metadataParameterElement) Gets the metadata parameter value for a given element
org.w3c.dom.Element	getNewElement(java.lang.String elementName) This method will create a new w3c Element with a given name
protected org.w3c.dom.Node	getNewTextNode(java.lang.String nodeName) This method will create a new w3c Node with a given name
java.lang.String	translateElementToString(org.w3c.dom.Node element)
org.w3c.dom.Element	translateParameters(java.util.Map parameters) This method will translate MetaMatrix parameters into a literal XML Element containing The list of parameters will be a map of Integer indexes to Object values correlating to the StoredProcedure's modeled information
org.w3c.dom.Element	translateResultDocuments(java.sql.ResultSet documents) Translate a results document into a w3c Element
org.w3c.dom.Element	translateRowsAffected(int rowsAffected) Given an integer count of the rows affected, create a Literal XML Element to be returned
java.util.Map	translateStoredProcedureParameters(org.w3c.dom.Element parameters) Translates a literal XML parameter element into a Map with Int
org.w3c.dom.Element	translateTabularResults(java.sql.ResultSet results, boolean fullMetadata) Given a MetaMatrix Results object generate the Tabuluar Results
org.w3c.dom.Element	translateTabularResults(java.sql.ResultSet results, boolean fullMetadata, int[] rows) Given a MetaMatrix Results object generate the Tabuluar Results
org.w3c.dom.Element	translateXMLSchema(java.lang.String schema, boolean isPrimary) Translate the schema into a w3c Element
org.w3c.dom.Element	translateXMLSchemas(org.w3c.dom.Element root, java.util.Collection schemas) This method will translate a list of XML String Schemas into a w3c Element If the schema is null then it will return a schema of "Schema is not available" in the message node

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLTranslator

public XMLTranslator()

Constructor for XMLTranslator.

Method Detail

translateResultDocuments

public org.w3c.dom.Element translateResultDocuments(java.sql.ResultSet documents)
                                             throws java.sql.SQLException,
                                                    XMLTranslationException

Translate a results document into a w3c Element

Parameters:

documents - The documents to translate

returnSchema - whether to include the schema within the document

Returns:

resultsElement

Throws:

SOAPTranslationException - if a translation error occurs

java.sql.SQLException

XMLTranslationException

translateXMLSchema

public org.w3c.dom.Element translateXMLSchema(java.lang.String schema,
                                              boolean isPrimary)
                                       throws XMLTranslationException

Translate the schema into a w3c Element

Parameters:

schema - The String schema of the the XML document

Returns:

Element

Throws:

XMLTranslationException

translateXMLSchemas

public org.w3c.dom.Element translateXMLSchemas(org.w3c.dom.Element root,
                                               java.util.Collection schemas)
                                        throws XMLTranslationException

This method will translate a list of XML String Schemas into a w3c Element If the schema is null then it will return a schema of "Schema is not available" in the message node

Parameters:

schemas - a list of XML String schemas

Returns:

Element containing all the schemas

Throws:

XMLTranslationException

translateStoredProcedureParameters

public java.util.Map translateStoredProcedureParameters(org.w3c.dom.Element parameters)
                                                 throws XMLTranslationException

Translates a literal XML parameter element into a Map with Int

Parameters:

parameters - (index and value) parameters in an XML format

Throws:

XMLTranslationException

translateParameters

public org.w3c.dom.Element translateParameters(java.util.Map parameters)
                                        throws XMLTranslationException

This method will translate MetaMatrix parameters into a literal XML Element containing The list of parameters will be a map of Integer indexes to Object values correlating to the StoredProcedure's modeled information

Parameters:

parameters -

Returns:

literal xml element containing the parameters

Throws:

XMLTranslationException - if an error occurs

createMetadataParameter

public org.w3c.dom.Element createMetadataParameter(java.lang.String parameterName,
                                                   java.lang.String filter)
                                            throws XMLTranslationException

Construct a metadata parameter which is used for the metadata method getMetdata

Parameters:

parameterName - the name of the parameter

filter - the value to filter on

Returns:

Elemetn

Throws:

XMLTranslationException

getMetadataParameterElement

public org.w3c.dom.Element getMetadataParameterElement(org.w3c.dom.Element rootElement,
                                                       java.lang.String parameterName)
                                                throws XMLTranslationException

Gets the appropriate metadata parameter element based on it it's name

Parameters:

parameterName -

Returns:

Element

Throws:

XMLTranslationException

getMetadataParameterName

public java.lang.String getMetadataParameterName(org.w3c.dom.Element metadataParameterElement)
                                          throws XMLTranslationException

Get the metadata parameter name of this element

Returns:

the metadata parameter name

Throws:

XMLTranslationException

getMetadataParameterValue

public java.lang.String getMetadataParameterValue(org.w3c.dom.Element metadataParameterElement)
                                           throws XMLTranslationException

Gets the metadata parameter value for a given element

Parameters:

metadataParameterElemetn -

Throws:

XMLTranslationException

translateRowsAffected

public org.w3c.dom.Element translateRowsAffected(int rowsAffected)
                                          throws XMLTranslationException

Given an integer count of the rows affected, create a Literal XML Element to be returned

Parameters:

rowsAffected -

Returns:

Element

Throws:

XMLTranslationException - if an error occurs

translateTabularResults

public org.w3c.dom.Element translateTabularResults(java.sql.ResultSet results,
                                                   boolean fullMetadata)
                                            throws java.sql.SQLException,
                                                   XMLTranslationException

Given a MetaMatrix Results object generate the Tabuluar Results

Throws:

java.sql.SQLException

XMLTranslationException

translateTabularResults

public org.w3c.dom.Element translateTabularResults(java.sql.ResultSet results,
                                                   boolean fullMetadata,
                                                   int[] rows)
                                            throws java.sql.SQLException,
                                                   XMLTranslationException

Given a MetaMatrix Results object generate the Tabuluar Results

Throws:

java.sql.SQLException

XMLTranslationException

getNewElement

public org.w3c.dom.Element getNewElement(java.lang.String elementName)
                                  throws XMLTranslationException

This method will create a new w3c Element with a given name

Parameters:

elementName -

Returns:

Element

Throws:

XMLTranslationException - if it cannot create an Element

getDocument

protected org.w3c.dom.Document getDocument()
                                    throws javax.xml.parsers.ParserConfigurationException

Throws:

javax.xml.parsers.ParserConfigurationException

getNewTextNode

protected org.w3c.dom.Node getNewTextNode(java.lang.String nodeName)
                                   throws XMLTranslationException

This method will create a new w3c Node with a given name

Parameters:

nodeName -

Returns:

Node

Throws:

XMLTranslationException - if it cannot create a Node

translateElementToString

public java.lang.String translateElementToString(org.w3c.dom.Node element)
                                          throws XMLTranslationException

Throws:

XMLTranslationException