global.sandbox.xmlutilities
Class XMLUtilities

java.lang.Object
  extended by global.sandbox.xmlutilities.XMLUtilities

public class XMLUtilities
extends java.lang.Object

This class provides simple XML utilities.

Version:
1.1
Author:
Petr Hadraba

Field Summary
private  javax.xml.namespace.NamespaceContext defaultNamespaceContext
          stores the default NamespaceContext
private  javax.xml.parsers.DocumentBuilder documentBuilder
          stores document builder
private  javax.xml.parsers.DocumentBuilderFactory documentBuilderFactory
          stores document builder factory
private  javax.xml.validation.SchemaFactory schemaFactory
          stores schema factory
private  javax.xml.transform.Transformer transformer
          stores localTransformer
private  javax.xml.transform.TransformerFactory transformerFactory
          stores localTransformer factory
private  javax.xml.xpath.XPath xpath
          stores xpath evaluator
private  javax.xml.xpath.XPathFactory xpathFactory
          stores XPath factory
 
Constructor Summary
XMLUtilities()
          initializes XMLUtilities Creates new factories and new instanties
XMLUtilities(javax.xml.parsers.DocumentBuilderFactory documentBuilderFactory, javax.xml.parsers.DocumentBuilder documentBuilder, javax.xml.validation.SchemaFactory schemaFactory, javax.xml.transform.TransformerFactory transformerFactory, javax.xml.transform.Transformer transformer, javax.xml.xpath.XPathFactory xpathFactory, javax.xml.xpath.XPath xpath, javax.xml.namespace.NamespaceContext defaultNamespaceContext)
          initializes XMLUtilities Creates new factories and new instaties according to custom objects.
 
Method Summary
 java.lang.String documentToString(org.w3c.dom.Document source)
          converts XML Document into String
 org.w3c.dom.NodeList evaluateXPath(java.lang.String query, org.w3c.dom.Node context)
          evaluates specified XPath expression on specified contenxt node
 org.w3c.dom.NodeList evaluateXPath(java.lang.String query, org.w3c.dom.Node context, javax.xml.namespace.NamespaceContext namespaces)
          evaluates specified XPath expression on specified contenxt node
 javax.xml.namespace.NamespaceContext getDefaultNamespaceContext()
          obtains default NamespaceContext used by the XMLUtilities
 javax.xml.parsers.DocumentBuilder getDocumentBuilder()
          obtains DocumentBuilder object internaly used by the XMLUtilities
 javax.xml.parsers.DocumentBuilderFactory getDocumentBuilderFactory()
          obtains DocumentBuilderFactory object internaly used by the XMLUtilities
 org.w3c.dom.Node getFirstNodeForXPath(java.lang.String query, org.w3c.dom.Node context)
          evaluates specified XPath expression and returnes first Node if XPath has matches
 org.w3c.dom.Node getFirstNodeForXPath(java.lang.String query, org.w3c.dom.Node context, javax.xml.namespace.NamespaceContext namespaces)
          evaluates specified XPath expression and returnes first Node if XPath has matches
 javax.xml.validation.SchemaFactory getSchemaFactory()
          obtains SchemaFactory object internaly used by the XMLUtilities
 javax.xml.transform.Transformer getTransformer()
          obtains Transformer object internaly used by the XMLUtilities
 javax.xml.transform.TransformerFactory getTransformerFactory()
          obtains TransformerFactory object internaly used by the XMLUtilities
 javax.xml.xpath.XPath getXPath()
          obtains XPath object internaly used by the XMLUtilities
 javax.xml.xpath.XPathFactory getXPathFactory()
          obtains XPathFactory object internaly used by the XMLUtilities
 org.w3c.dom.Document loadDocumentFromFile(java.io.File file)
          loads XML from file specified with the File object
 org.w3c.dom.Document loadDocumentFromFile(java.io.File file, javax.xml.parsers.DocumentBuilder documentBuilder)
          loads XML from file specified with the file object
 org.w3c.dom.Document loadDocumentFromFile(java.lang.String fileName)
          loads XML from file specified with file name
 org.w3c.dom.Document loadDocumentFromFile(java.lang.String fileName, javax.xml.parsers.DocumentBuilder documentBuilder)
          loads XML from file specified with file name
 org.w3c.dom.Document loadDocumentFromStream(java.io.InputStream is)
          loads XML from specified input stream
 org.w3c.dom.Document loadDocumentFromStream(java.io.InputStream is, javax.xml.parsers.DocumentBuilder documentBuilder)
          loads XML from specified input stream
 java.lang.String sourceToString(javax.xml.transform.Source source)
          converts XML Source into String
 org.w3c.dom.Document transformToDocument(javax.xml.transform.Source xsltTemplate, javax.xml.transform.Source document)
          transformes specified XML document using specified XSLT template
 org.w3c.dom.Document transformToDocument(javax.xml.transform.Source xsltTemplate, javax.xml.transform.Source document, java.util.Map<java.lang.String,java.lang.Object> parameters)
          transformes specified XML document using specified XSLT template
 org.w3c.dom.Document transformToDocument(javax.xml.transform.Templates xsltTemplate, javax.xml.transform.Source document)
          transforms specified XML document using XSLT (compiled) template
 org.w3c.dom.Document transformToDocument(javax.xml.transform.Templates xsltTemplate, javax.xml.transform.Source document, java.util.Map<java.lang.String,java.lang.Object> parameters)
          transforms sepecified XML using XSLT (compiled) template
 java.lang.String transformToString(javax.xml.transform.Source xsltTemplate, javax.xml.transform.Source document)
          transformes specified XML document using specified XSLT template
 java.lang.String transformToString(javax.xml.transform.Source xsltTemplate, javax.xml.transform.Source document, java.util.Map<java.lang.String,java.lang.Object> parameters)
          transformes specified XML source using specified XSLT template
 java.lang.String transformToString(javax.xml.transform.Templates xsltTemplate, javax.xml.transform.Source document)
          transforms specified XML source using specified XSLT (compiled) template
 java.lang.String transformToString(javax.xml.transform.Templates xsltTemplate, javax.xml.transform.Source document, java.util.Map<java.lang.String,java.lang.Object> parameters)
          transforms specified XML source using specified XSLT (compiled) template
 java.lang.String validateXmlUsingSchema(javax.xml.transform.Source xmlDocument, javax.xml.transform.Source xmlSchema)
          validates XML file using XML schema
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

schemaFactory

private final javax.xml.validation.SchemaFactory schemaFactory
stores schema factory


documentBuilderFactory

private final javax.xml.parsers.DocumentBuilderFactory documentBuilderFactory
stores document builder factory


documentBuilder

private final javax.xml.parsers.DocumentBuilder documentBuilder
stores document builder


transformerFactory

private final javax.xml.transform.TransformerFactory transformerFactory
stores localTransformer factory


transformer

private final javax.xml.transform.Transformer transformer
stores localTransformer


xpathFactory

private final javax.xml.xpath.XPathFactory xpathFactory
stores XPath factory


xpath

private final javax.xml.xpath.XPath xpath
stores xpath evaluator


defaultNamespaceContext

private final javax.xml.namespace.NamespaceContext defaultNamespaceContext
stores the default NamespaceContext

Constructor Detail

XMLUtilities

public XMLUtilities()
             throws javax.xml.parsers.ParserConfigurationException,
                    javax.xml.transform.TransformerConfigurationException,
                    javax.xml.xpath.XPathFactoryConfigurationException
initializes XMLUtilities Creates new factories and new instanties

Throws:
javax.xml.parsers.ParserConfigurationException
javax.xml.transform.TransformerConfigurationException
javax.xml.xpath.XPathFactoryConfigurationException

XMLUtilities

public XMLUtilities(javax.xml.parsers.DocumentBuilderFactory documentBuilderFactory,
                    javax.xml.parsers.DocumentBuilder documentBuilder,
                    javax.xml.validation.SchemaFactory schemaFactory,
                    javax.xml.transform.TransformerFactory transformerFactory,
                    javax.xml.transform.Transformer transformer,
                    javax.xml.xpath.XPathFactory xpathFactory,
                    javax.xml.xpath.XPath xpath,
                    javax.xml.namespace.NamespaceContext defaultNamespaceContext)
             throws javax.xml.parsers.ParserConfigurationException,
                    javax.xml.transform.TransformerConfigurationException,
                    javax.xml.xpath.XPathFactoryConfigurationException
initializes XMLUtilities Creates new factories and new instaties according to custom objects.

Parameters:
documentBuilderFactory - custom DocumentBuilderFactory
documentBuilder - custom DocumentBuilder
schemaFactory - custom SchemaFactory
transformerFactory - custom TransformerFactory
transformer - custom Transformer
xpathFactory - custom XPathFactory
xpath - custom XPath
defaultNamespaceContext - custom namespaces
Throws:
javax.xml.parsers.ParserConfigurationException
javax.xml.transform.TransformerConfigurationException
javax.xml.xpath.XPathFactoryConfigurationException
Method Detail

getSchemaFactory

public javax.xml.validation.SchemaFactory getSchemaFactory()
obtains SchemaFactory object internaly used by the XMLUtilities

Returns:
SchemaFactory object

getDocumentBuilderFactory

public javax.xml.parsers.DocumentBuilderFactory getDocumentBuilderFactory()
obtains DocumentBuilderFactory object internaly used by the XMLUtilities

Returns:
DocumentBuilderFactory object

getDocumentBuilder

public javax.xml.parsers.DocumentBuilder getDocumentBuilder()
obtains DocumentBuilder object internaly used by the XMLUtilities

Returns:
DocumentBuilder object

getTransformerFactory

public javax.xml.transform.TransformerFactory getTransformerFactory()
obtains TransformerFactory object internaly used by the XMLUtilities

Returns:
TransformerFactory object

getTransformer

public javax.xml.transform.Transformer getTransformer()
obtains Transformer object internaly used by the XMLUtilities

Returns:
Transformer object

getXPathFactory

public javax.xml.xpath.XPathFactory getXPathFactory()
obtains XPathFactory object internaly used by the XMLUtilities

Returns:
XPathFactory object

getXPath

public javax.xml.xpath.XPath getXPath()
obtains XPath object internaly used by the XMLUtilities

Returns:
XPath object

getDefaultNamespaceContext

public javax.xml.namespace.NamespaceContext getDefaultNamespaceContext()
obtains default NamespaceContext used by the XMLUtilities

Returns:
default NamespaceContenxt object

validateXmlUsingSchema

public java.lang.String validateXmlUsingSchema(javax.xml.transform.Source xmlDocument,
                                               javax.xml.transform.Source xmlSchema)
                                        throws java.io.IOException
validates XML file using XML schema

Parameters:
xmlDocument - document to validate
xmlSchema - XMLSchema
Returns:
null if successful, string with error otherwise
Throws:
java.io.IOException

loadDocumentFromFile

public org.w3c.dom.Document loadDocumentFromFile(java.lang.String fileName)
                                          throws java.io.FileNotFoundException,
                                                 java.io.IOException,
                                                 org.xml.sax.SAXException
loads XML from file specified with file name

Parameters:
fileName - file to load
Returns:
Document object
Throws:
org.xml.sax.SAXException
java.io.IOException
java.io.FileNotFoundException

loadDocumentFromFile

public org.w3c.dom.Document loadDocumentFromFile(java.lang.String fileName,
                                                 javax.xml.parsers.DocumentBuilder documentBuilder)
                                          throws java.io.FileNotFoundException,
                                                 java.io.IOException,
                                                 org.xml.sax.SAXException
loads XML from file specified with file name

Parameters:
fileName - file to load
documentBuilder - custom document builder
Returns:
Document object
Throws:
org.xml.sax.SAXException
java.io.IOException
java.io.FileNotFoundException

loadDocumentFromFile

public org.w3c.dom.Document loadDocumentFromFile(java.io.File file)
                                          throws java.io.FileNotFoundException,
                                                 java.io.IOException,
                                                 org.xml.sax.SAXException
loads XML from file specified with the File object

Parameters:
file - file to load
Returns:
Document object
Throws:
org.xml.sax.SAXException
java.io.IOException
java.io.FileNotFoundException

loadDocumentFromFile

public org.w3c.dom.Document loadDocumentFromFile(java.io.File file,
                                                 javax.xml.parsers.DocumentBuilder documentBuilder)
                                          throws java.io.FileNotFoundException,
                                                 java.io.IOException,
                                                 org.xml.sax.SAXException
loads XML from file specified with the file object

Parameters:
file - file to load
documentBuilder - custom document builder
Returns:
Document object
Throws:
java.io.FileNotFoundException
java.io.IOException
org.xml.sax.SAXException

loadDocumentFromStream

public org.w3c.dom.Document loadDocumentFromStream(java.io.InputStream is)
                                            throws java.io.IOException,
                                                   org.xml.sax.SAXException
loads XML from specified input stream

Parameters:
is - input stream
Returns:
Document object
Throws:
java.io.IOException
org.xml.sax.SAXException

loadDocumentFromStream

public org.w3c.dom.Document loadDocumentFromStream(java.io.InputStream is,
                                                   javax.xml.parsers.DocumentBuilder documentBuilder)
                                            throws java.io.IOException,
                                                   org.xml.sax.SAXException
loads XML from specified input stream

Parameters:
is - input stream
documentBuilder - custom Document Builder
Returns:
Document object
Throws:
java.io.IOException
org.xml.sax.SAXException

documentToString

public java.lang.String documentToString(org.w3c.dom.Document source)
                                  throws javax.xml.transform.TransformerException,
                                         java.io.IOException
converts XML Document into String

Parameters:
source - Document to convert
Returns:
XML in the String
Throws:
javax.xml.transform.TransformerException
java.io.IOException

sourceToString

public java.lang.String sourceToString(javax.xml.transform.Source source)
                                throws javax.xml.transform.TransformerException,
                                       java.io.IOException
converts XML Source into String

Parameters:
source - Document to convert
Returns:
XML in the String
Throws:
javax.xml.transform.TransformerException
java.io.IOException

evaluateXPath

public org.w3c.dom.NodeList evaluateXPath(java.lang.String query,
                                          org.w3c.dom.Node context)
                                   throws javax.xml.xpath.XPathExpressionException
evaluates specified XPath expression on specified contenxt node

Parameters:
query - XPath expression
context - context node
Returns:
NodeList or null if no matches
Throws:
javax.xml.xpath.XPathExpressionException

evaluateXPath

public org.w3c.dom.NodeList evaluateXPath(java.lang.String query,
                                          org.w3c.dom.Node context,
                                          javax.xml.namespace.NamespaceContext namespaces)
                                   throws javax.xml.xpath.XPathExpressionException
evaluates specified XPath expression on specified contenxt node

Parameters:
query - XPath expression
context - context node
namespaces - namespace context
Returns:
NodeList or null if no matches
Throws:
javax.xml.xpath.XPathExpressionException

getFirstNodeForXPath

public org.w3c.dom.Node getFirstNodeForXPath(java.lang.String query,
                                             org.w3c.dom.Node context)
                                      throws javax.xml.xpath.XPathExpressionException
evaluates specified XPath expression and returnes first Node if XPath has matches

Parameters:
query - XPath expression
context - context node
Returns:
first node or null
Throws:
javax.xml.xpath.XPathExpressionException

getFirstNodeForXPath

public org.w3c.dom.Node getFirstNodeForXPath(java.lang.String query,
                                             org.w3c.dom.Node context,
                                             javax.xml.namespace.NamespaceContext namespaces)
                                      throws javax.xml.xpath.XPathExpressionException
evaluates specified XPath expression and returnes first Node if XPath has matches

Parameters:
query - XPath expression
context - context node
namespaces - namespace context
Returns:
first node or null
Throws:
javax.xml.xpath.XPathExpressionException

transformToString

public java.lang.String transformToString(javax.xml.transform.Source xsltTemplate,
                                          javax.xml.transform.Source document,
                                          java.util.Map<java.lang.String,java.lang.Object> parameters)
                                   throws javax.xml.transform.TransformerConfigurationException,
                                          javax.xml.transform.TransformerException
transformes specified XML source using specified XSLT template

Parameters:
xsltTemplate - template to use
document - source XML document
parameters - parameters to propagate to the localTransformer
Returns:
resulting XML in the String
Throws:
javax.xml.transform.TransformerConfigurationException
javax.xml.transform.TransformerException

transformToString

public java.lang.String transformToString(javax.xml.transform.Templates xsltTemplate,
                                          javax.xml.transform.Source document,
                                          java.util.Map<java.lang.String,java.lang.Object> parameters)
                                   throws javax.xml.transform.TransformerException
transforms specified XML source using specified XSLT (compiled) template

Parameters:
xsltTemplate - template to use
document - source XML document to transform
parameters - parameters to propagate to the localTransformer
Returns:
resulting XML in the String
Throws:
javax.xml.transform.TransformerException

transformToString

public java.lang.String transformToString(javax.xml.transform.Templates xsltTemplate,
                                          javax.xml.transform.Source document)
                                   throws javax.xml.transform.TransformerException
transforms specified XML source using specified XSLT (compiled) template

Parameters:
xsltTemplate - template to use
document - source XML document to transform
Returns:
resulting XML in the String
Throws:
javax.xml.transform.TransformerException

transformToString

public java.lang.String transformToString(javax.xml.transform.Source xsltTemplate,
                                          javax.xml.transform.Source document)
                                   throws javax.xml.transform.TransformerConfigurationException,
                                          javax.xml.transform.TransformerException
transformes specified XML document using specified XSLT template

Parameters:
xsltTemplate - XSLT template
document - source XML document
Returns:
resulting XML document in the String
Throws:
javax.xml.transform.TransformerConfigurationException
javax.xml.transform.TransformerException

transformToDocument

public org.w3c.dom.Document transformToDocument(javax.xml.transform.Source xsltTemplate,
                                                javax.xml.transform.Source document)
                                         throws javax.xml.transform.TransformerConfigurationException,
                                                javax.xml.xpath.XPathFactoryConfigurationException,
                                                javax.xml.parsers.ParserConfigurationException,
                                                org.xml.sax.SAXException,
                                                java.io.IOException,
                                                javax.xml.transform.TransformerException
transformes specified XML document using specified XSLT template

Parameters:
xsltTemplate - XSLT template
document - source XML document
Returns:
resulting XML document in the Document
Throws:
javax.xml.transform.TransformerConfigurationException
javax.xml.xpath.XPathFactoryConfigurationException
javax.xml.parsers.ParserConfigurationException
org.xml.sax.SAXException
java.io.IOException
javax.xml.transform.TransformerException

transformToDocument

public org.w3c.dom.Document transformToDocument(javax.xml.transform.Templates xsltTemplate,
                                                javax.xml.transform.Source document)
                                         throws javax.xml.transform.TransformerConfigurationException,
                                                javax.xml.xpath.XPathFactoryConfigurationException,
                                                javax.xml.parsers.ParserConfigurationException,
                                                org.xml.sax.SAXException,
                                                java.io.IOException,
                                                javax.xml.transform.TransformerException
transforms specified XML document using XSLT (compiled) template

Parameters:
xsltTemplate - template to use
document - document to transform
Returns:
resulting XML document in the Document
Throws:
javax.xml.transform.TransformerConfigurationException
javax.xml.xpath.XPathFactoryConfigurationException
javax.xml.parsers.ParserConfigurationException
org.xml.sax.SAXException
java.io.IOException
javax.xml.transform.TransformerException

transformToDocument

public org.w3c.dom.Document transformToDocument(javax.xml.transform.Source xsltTemplate,
                                                javax.xml.transform.Source document,
                                                java.util.Map<java.lang.String,java.lang.Object> parameters)
                                         throws javax.xml.transform.TransformerConfigurationException,
                                                javax.xml.xpath.XPathFactoryConfigurationException,
                                                javax.xml.parsers.ParserConfigurationException,
                                                org.xml.sax.SAXException,
                                                java.io.IOException,
                                                javax.xml.transform.TransformerException
transformes specified XML document using specified XSLT template

Parameters:
xsltTemplate - XSLT template
document - source XML document
parameters - parameters for the template
Returns:
resulting XML document in the Document
Throws:
javax.xml.transform.TransformerConfigurationException
javax.xml.xpath.XPathFactoryConfigurationException
javax.xml.parsers.ParserConfigurationException
org.xml.sax.SAXException
java.io.IOException
javax.xml.transform.TransformerException

transformToDocument

public org.w3c.dom.Document transformToDocument(javax.xml.transform.Templates xsltTemplate,
                                                javax.xml.transform.Source document,
                                                java.util.Map<java.lang.String,java.lang.Object> parameters)
                                         throws javax.xml.transform.TransformerConfigurationException,
                                                javax.xml.xpath.XPathFactoryConfigurationException,
                                                javax.xml.parsers.ParserConfigurationException,
                                                org.xml.sax.SAXException,
                                                java.io.IOException,
                                                javax.xml.transform.TransformerException
transforms sepecified XML using XSLT (compiled) template

Parameters:
xsltTemplate - template to use
document - XML document to transform
parameters - parameters for the transformation
Returns:
resulting XML document in the Document
Throws:
javax.xml.transform.TransformerConfigurationException
javax.xml.xpath.XPathFactoryConfigurationException
javax.xml.parsers.ParserConfigurationException
org.xml.sax.SAXException
java.io.IOException
javax.xml.transform.TransformerException