VistALink v1.6

gov.va.med.xml
Class XmlUtilities

java.lang.Object
  extended by gov.va.med.xml.XmlUtilities

Deprecated. Need for XML utilities has been superceded by the many JRE-built-in and external XML frameworks

public class XmlUtilities
extends java.lang.Object

This class contains a number of static utility methods to help developers work with XML documents, nodes, attributes and strings


Field Summary
static java.lang.String XML_HEADER
          Deprecated. Represents the default header used for all xml documents that communicate with an M server via VistALink.
 
Method Summary
static java.lang.String convertXmlToStr(org.w3c.dom.Document doc)
          Deprecated. Need for XML utilities has been superceded by the many JRE-built-in and external XML frameworks
static org.w3c.dom.Attr getAttr(org.w3c.dom.Node node, java.lang.String attrName)
          Deprecated. Need for XML utilities has been superceded by the many JRE-built-in and external XML frameworks
static org.w3c.dom.Document getDocumentForXmlInputStream(java.io.InputStream xml)
          Deprecated. Need for XML utilities has been superceded by the many JRE-built-in and external XML frameworks
static org.w3c.dom.Document getDocumentForXmlString(java.lang.String xml)
          Deprecated. Need for XML utilities has been superceded by the many JRE-built-in and external XML frameworks
static org.w3c.dom.Node getNode(java.lang.String xpathStr, org.w3c.dom.Node node)
          Deprecated. Need for XML utilities has been superceded by the many JRE-built-in and external XML frameworks
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

XML_HEADER

public static final java.lang.String XML_HEADER
Deprecated. 
Represents the default header used for all xml documents that communicate with an M server via VistALink. It is important to use this header as keeps the client and M server in sync. Note that that as a String constant, this value is compiled into the calling class at compile time; it is not dynamically linked at runtime.

See Also:
Constant Field Values
Method Detail

convertXmlToStr

public static java.lang.String convertXmlToStr(org.w3c.dom.Document doc)
                                        throws FoundationsException
Deprecated. Need for XML utilities has been superceded by the many JRE-built-in and external XML frameworks

Converts a DOM document to a string.

Parameters:
doc -
Returns:
String
Throws:
FoundationsException

getNode

public static org.w3c.dom.Node getNode(java.lang.String xpathStr,
                                       org.w3c.dom.Node node)
Deprecated. Need for XML utilities has been superceded by the many JRE-built-in and external XML frameworks

Returns the first node at the specified XPath location.

Example:

This example returns the Customer/Address node in the specified document object.

Node address = XmlUtilities.getNode("/Customer/Address", custDoc);

Parameters:
xpathStr - XPath str
node - Node to search
Returns:
Node first node found

getAttr

public static org.w3c.dom.Attr getAttr(org.w3c.dom.Node node,
                                       java.lang.String attrName)
Deprecated. Need for XML utilities has been superceded by the many JRE-built-in and external XML frameworks

Returns the Attribute with the given attrName at node.

Example:

This example returns the 'state' attribute from the address node.

Attr state = getAttr(address,"state")

Parameters:
node - Node to search
attrName - Name of the attribute to find
Returns:
Attr Attribute found

getDocumentForXmlString

public static org.w3c.dom.Document getDocumentForXmlString(java.lang.String xml)
                                                    throws FoundationsException
Deprecated. Need for XML utilities has been superceded by the many JRE-built-in and external XML frameworks

Returns an XML DOM Document for the specified String.

Example:

This example creates a customer XML document for a serialized customer:

Document cust = XmlUtilities.getDocumentForXmlString(custXmlString);

Parameters:
xml - serialized XML document
Returns:
Document XML document
Throws:
FoundationsException

getDocumentForXmlInputStream

public static org.w3c.dom.Document getDocumentForXmlInputStream(java.io.InputStream xml)
                                                         throws FoundationsException
Deprecated. Need for XML utilities has been superceded by the many JRE-built-in and external XML frameworks

Returns an XML DOM Document for the specified InputStream

Example:

This example creates a customer XML document from an input stream.

Document cust = XmlUtilities.getDocumentForXmlInputStream(custStream);

Parameters:
xml - input stream to processed
Returns:
Document XML document
Throws:
FoundationsException

VistALink v1.6

VistALink v1.6