global.sandbox.xmlutilities
Class XmlTools

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

public final class XmlTools
extends Object

Static version of the XML utilities class.

Version:
1.2
Author:
Petr Hadraba

Field Summary
private static XmlUtilities INTERNAL_XMLUTILITIES
          Use this constant, if you want to use internal XMLUtilities for the static methods.
private static Logger LOGGER
          Internal logger.
private static XmlUtilities xmlUtilities
          Stores XMLUtilities object for the static usage.
 
Constructor Summary
private XmlTools()
          Utility class.
 
Method Summary
static void disableLogging()
          Disables logging of XmlTools and XmlUtilities.
(package private) static void disableLogging0()
          Disables logging.
static Source documentToDomSource(Document source)
          Converts Document to DOMSource object.
static Source documentToDomSource(Document source, String systemId)
          Converts Document to DOMSource object.
static String documentToString(Document source)
          Converts XML Document into String.
static String documentToString(Document source, OutputFormat outputFormat)
          Converts XML Document into String.
static String documentToString(Document source, OutputFormat outputFormat, XmlUtilities xmlUtilities)
          Converts XML Document into String.
static String documentToString(Document source, Properties outputProperties)
          Converts XML Document into String.
static String documentToString(Document source, Properties outputProperties, XmlUtilities xmlUtilities)
          Converts XML Document into String.
static String documentToString(Document source, XmlUtilities xmlUtilities)
          Converts XML Document into String.
static NodeList evaluateXPath(String query, Node context)
          Evaluates specified XPath expression on specified context node.
static
<E extends Node>
NodeListCollection<E>
evaluateXPath(String query, Node context, Class<E> elementType)
          Evaluates specified XPath expression on specified context node and returns results as NodeListCollection of specified element types.
static
<E extends Node>
NodeListCollection<E>
evaluateXPath(String query, Node context, Class<E> elementType, XmlUtilities xmlUtilities)
          Evaluates specified XPath expression on specified context node and returns results as NodeListCollection of specified element types.
static NodeList evaluateXPath(String query, Node context, NamespaceContext namespaces)
          Evaluates specified XPath expression on specified context node.
static
<E extends Node>
NodeListCollection<E>
evaluateXPath(String query, Node context, NamespaceContext namespaces, Class<E> elementType)
          Evaluates specified XPath expression on specified context node and returns results as NodeListCollection of specified element types.
static
<E extends Node>
NodeListCollection<E>
evaluateXPath(String query, Node context, NamespaceContext namespaces, Class<E> elementType, XmlUtilities xmlUtilities)
          Evaluates specified XPath expression on specified context node and returns results as NodeListCollection of specified element types.
static NodeList evaluateXPath(String query, Node context, NamespaceContext namespaces, XmlUtilities xmlUtilities)
          Evaluates specified XPath expression on specified context node.
static NodeList evaluateXPath(String query, Node context, XmlUtilities xmlUtilities)
          Evaluates specified XPath expression on specified context node.
static Node getFirstNodeForXPath(String query, Node context)
          Evaluates specified XPath expression and returns first Node if XPath has matches.
static
<E extends Node>
E
getFirstNodeForXPath(String query, Node context, Class<E> elementType)
          Evaluates specified XPath expression and returns first Node as specified element type if XPath has matches.
static
<E extends Node>
E
getFirstNodeForXPath(String query, Node context, Class<E> elementType, XmlUtilities xmlUtilities)
          Evaluates specified XPath expression and returns first Node as specified element type if XPath has matches.
static Node getFirstNodeForXPath(String query, Node context, NamespaceContext namespaces)
          Evaluates specified XPath expression and returns first Node if XPath has matches.
static
<E extends Node>
E
getFirstNodeForXPath(String query, Node context, NamespaceContext namespaces, Class<E> elementType)
          Evaluates specified XPath expression and returns first Node as specified element type if XPath has matches.
static
<E extends Node>
E
getFirstNodeForXPath(String query, Node context, NamespaceContext namespaces, Class<E> elementType, XmlUtilities xmlUtilities)
          Evaluates specified XPath expression and returns first Node as specified element type if XPath has matches.
static Node getFirstNodeForXPath(String query, Node context, NamespaceContext namespaces, XmlUtilities xmlUtilities)
          Evaluates specified XPath expression and returns first Node if XPath has matches.
static Node getFirstNodeForXPath(String query, Node context, XmlUtilities xmlUtilities)
          Evaluates specified XPath expression and returns first Node if XPath has matches.
static DocumentBuilder getInternalDocumentBuilder()
          Returns DocumentBuilder object internally used by the XMLUtilities static methods.
static DocumentBuilderFactory getInternalDocumentBuilderFactory()
          Returns DocumentBuilderFactory object internally used by the XMLUtilities static methods.
static NamespaceContext getInternalNamespaceContext()
          Returns NamespaceContext object internally used by the XMLUtilities static methods.
static SchemaFactory getInternalSchemaFactory()
          Returns SchemaFactory object internally used by the XMLUtilities static methods.
static Transformer getInternalTransformer()
          Returns Transformer object internally used by the XMLUtilities static methods.
static TransformerFactory getInternalTransformerFactory()
          Returns TransformerFactory object internally used by the XMLUtilities static methods.
static XPath getInternalXPath()
          Returns XPath object internally used by the XMLUtilities static methods.
static XPathFactory getInternalXPathFactory()
          Returns XPathFactory object internally used by the XMLUtilities static methods.
private static void initializeXmlUtilities()
          Initializes XMLUtilities static member for the static usage.
static void initializeXmlUtilities(XmlUtilities xmlUtilities)
          Initializes XMLUtilities static member for the static usage using specified XMLUtilities.
static Document loadDocumentFromClassLoader(String resource, Class<?> fallbackClazz)
          Loads document from ClassLoaders.
static Document loadDocumentFromClassLoader(String resource, Class<?> fallbackClazz, XmlUtilities xmlUtilities)
          Loads document from ClassLoaders.
static Document loadDocumentFromClassLoader(String resource, DocumentBuilder documentBuilder, Class<?> fallbackClazz)
          Loads document from ClassLoaders.
static Document loadDocumentFromClassLoader(String resource, DocumentBuilder documentBuilder, Class<?> fallbackClazz, XmlUtilities xmlUtilities)
          Loads document from ClassLoaders.
static Document loadDocumentFromFile(File file)
          Loads XML from file specified with the File object.
static Document loadDocumentFromFile(File file, DocumentBuilder documentBuilder)
          Loads XML from file specified with the file object.
static Document loadDocumentFromFile(File file, DocumentBuilder documentBuilder, XmlUtilities xmlUtilities)
          Loads XML from file specified with the file object.
static Document loadDocumentFromFile(File file, XmlUtilities xmlUtilities)
          Loads XML from file specified with the File object.
static Document loadDocumentFromFile(String fileName)
          Loads XML from file specified with file name.
static Document loadDocumentFromFile(String fileName, DocumentBuilder documentBuilder)
          Loads XML from file specified with file name.
static Document loadDocumentFromFile(String fileName, DocumentBuilder documentBuilder, XmlUtilities xmlUtilities)
          Loads XML from file specified with file name.
static Document loadDocumentFromFile(String fileName, XmlUtilities xmlUtilities)
          Loads XML from file specified with file name.
static Document loadDocumentFromResource(String resource, Class<?> clazz)
          Loads Document from resource from given class.
static Document loadDocumentFromResource(String resource, Class<?> clazz, XmlUtilities xmlUtilities)
          Loads Document from resource from given class.
static Document loadDocumentFromResource(String resource, ClassLoader classLoader)
          Loads document from resource using specified ClassLoader.
static Document loadDocumentFromResource(String resource, ClassLoader classLoader, XmlUtilities xmlUtilities)
          Loads document from resource using specified ClassLoader.
static Document loadDocumentFromResource(String resource, DocumentBuilder documentBuilder, Class<?> clazz)
          Loads Document from resource from given class.
static Document loadDocumentFromResource(String resource, DocumentBuilder documentBuilder, Class<?> clazz, XmlUtilities xmlUtilities)
          Loads Document from resource from given class.
static Document loadDocumentFromResource(String resource, DocumentBuilder documentBuilder, ClassLoader classLoader)
          Loads document from resource using specified ClassLoader.
static Document loadDocumentFromResource(String resource, DocumentBuilder documentBuilder, ClassLoader classLoader, XmlUtilities xmlUtilities)
          Loads document from resource using specified ClassLoader.
static Document loadDocumentFromStream(InputStream is)
          Loads XML from specified stream.
static Document loadDocumentFromStream(InputStream is, DocumentBuilder documentBuilder)
          Loads XML from specified input stream.
static Document loadDocumentFromStream(InputStream is, DocumentBuilder documentBuilder, XmlUtilities xmlUtilities)
          Loads XML from specified input stream.
static Document loadDocumentFromStream(InputStream is, XmlUtilities xmlUtilities)
          Loads XML from specified stream.
static Document loadDocumentFromString(String source)
          Loads document from String into the Document.
static Document loadDocumentFromString(String source, DocumentBuilder documentBuilder)
          Loads document from String into the Document.
static Document loadDocumentFromString(String source, DocumentBuilder documentBuilder, XmlUtilities xmlUtilities)
          Loads document from String into the Document.
static Document loadDocumentFromString(String source, XmlUtilities xmlUtilities)
          Loads document from String into the Document.
static Source loadSourceFromString(String source)
          Loads XML from String.
static Source loadSourceFromString(String source, String systemId)
          Loads XML from String.
static void resetXmlUtilities()
          Rests internal XML Utilities so new instance will be created while next relevant call is invoked.
static void setLoggingLevel(Level newLevel)
          Sets new logging level of XmlTools and XmlUtilities.
(package private) static void setLoggingLevel0(Level newLevel)
          Sets new logging level.
static String sourceToString(Source source)
          Converts XML Source into String.
static String sourceToString(Source source, OutputFormat outputFormat)
          Converts XML Source into String.
static String sourceToString(Source source, OutputFormat outputFormat, XmlUtilities xmlUtilities)
          Converts XML Source into String.
static String sourceToString(Source source, Properties outputProperties)
          Converts XML Source into String.
static String sourceToString(Source source, Properties outputProperties, XmlUtilities xmlUtilities)
          Converts XML Source into String.
static String sourceToString(Source source, XmlUtilities xmlUtilities)
          Converts XML Source into String.
static Document transformToDocument(Source xsltTemplate, Source document)
          Transforms specified XML using specified XSLT template.
static Document transformToDocument(Source xsltTemplate, Source document, Map<String,Object> parameters)
          Transforms specified XML using specified XSLT template.
static Document transformToDocument(Source xsltTemplate, Source document, Map<String,Object> parameters, XmlUtilities xmlUtilities)
          Transforms specified XML using specified XSLT template.
static Document transformToDocument(Source xsltTemplate, Source document, XmlUtilities xmlUtilities)
          Transforms specified XML using specified XSLT template.
static Document transformToDocument(Templates xsltTemplate, Source document)
          Transforms specified XML document using XSLT (compiled) template.
static Document transformToDocument(Templates xsltTemplate, Source document, Map<String,Object> parameters)
          Transforms specified XML document using XSLT (compiled) template.
static Document transformToDocument(Templates xsltTemplate, Source document, Map<String,Object> parameters, XmlUtilities xmlUtilities)
          Transforms specified XML document using XSLT (compiled) template.
static Document transformToDocument(Templates xsltTemplate, Source document, XmlUtilities xmlUtilities)
          Transforms specified XML document using XSLT (compiled) template.
static String transformToString(Source xsltTemplate, Source document)
          Transforms specified XML document using specified XSLT template.
static String transformToString(Source xsltTemplate, Source document, Map<String,Object> parameters)
          Transforms specified XML document using specified XSLT template.
static String transformToString(Source xsltTemplate, Source document, Map<String,Object> parameters, XmlUtilities xmlUtilities)
          Transforms specified XML document using specified XSLT template.
static String transformToString(Source xsltTemplate, Source document, XmlUtilities xmlUtilities)
          Transforms specified XML document using specified XSLT template.
static String transformToString(Templates xsltTemplate, Source document)
          Transforms specified XML document using XSLT (compiled) template.
static String transformToString(Templates xsltTemplate, Source document, Map<String,Object> parameters)
          Transforms specified XML document using XSLT (compiled) template.
static String transformToString(Templates xsltTemplate, Source document, Map<String,Object> parameters, XmlUtilities xmlUtilities)
          Transforms specified XML document using XSLT (compiled) template.
static String transformToString(Templates xsltTemplate, Source document, XmlUtilities xmlUtilities)
          Transforms specified XML document using XSLT (compiled) template.
static String validateXmlUsingSchema(Source xmlDocument, Source xmlSchema)
          Validates specified XML with the specified XMLScheme.
static String validateXmlUsingSchema(Source xmlDocument, Source xmlSchema, XmlUtilities xmlUtilities)
          Validates specified XML with the specified XMLScheme.
static void writeDocumentToFile(Document doc, File file)
          Writes Document to specified file.
static void writeDocumentToFile(Document doc, File file, Integer bufferSize)
          Writes Document to specified file using internal buffer.
static void writeDocumentToFile(Document doc, File file, Integer bufferSize, OutputFormat outputFormat)
          Writes Document to specified file using internal buffer.
static void writeDocumentToFile(Document doc, File file, Integer bufferSize, OutputFormat outputFormat, XmlUtilities xmlUtilities)
          Writes Document to specified file using internal buffer.
static void writeDocumentToFile(Document doc, File file, Integer bufferSize, Properties outputProperties)
          Writes Document to specified file using internal buffer.
static void writeDocumentToFile(Document doc, File file, Integer bufferSize, Properties outputProperties, XmlUtilities xmlUtilities)
          Writes Document to specified file using internal buffer.
static void writeDocumentToFile(Document doc, File file, Integer bufferSize, Transformer transformer)
          Writes Document to specified file using internal buffer.
static void writeDocumentToFile(Document doc, File file, Integer bufferSize, Transformer transformer, XmlUtilities xmlUtilities)
          Writes Document to specified file using internal buffer.
static void writeDocumentToFile(Document doc, File file, Integer bufferSize, XmlUtilities xmlUtilities)
          Writes Document to specified file using internal buffer.
static void writeDocumentToFile(Document doc, File file, OutputFormat outputFormat)
          Writes Document to specified file.
static void writeDocumentToFile(Document doc, File file, OutputFormat outputFormat, XmlUtilities xmlUtilities)
          Writes Document to specified file.
static void writeDocumentToFile(Document doc, File file, Properties outputProperties)
          Writes Document to specified file.
static void writeDocumentToFile(Document doc, File file, Properties outputProperties, XmlUtilities xmlUtilities)
          Writes Document to specified file.
static void writeDocumentToFile(Document doc, File file, Transformer transformer)
          Writes Document to specified file.
static void writeDocumentToFile(Document doc, File file, Transformer transformer, XmlUtilities xmlUtilities)
          Writes Document to specified file.
static void writeDocumentToFile(Document doc, File file, XmlUtilities xmlUtilities)
          Writes Document to specified file.
static void writeDocumentToFile(Document doc, String file)
          Writes Document to specified file.
static void writeDocumentToFile(Document doc, String file, Integer bufferSize)
          Writes Document to specified file using internal buffer.
static void writeDocumentToFile(Document doc, String file, Integer bufferSize, OutputFormat outputFormat)
          Writes Document to specified file using internal buffer.
static void writeDocumentToFile(Document doc, String file, Integer bufferSize, OutputFormat outputFormat, XmlUtilities xmlUtilities)
          Writes Document to specified file using internal buffer.
static void writeDocumentToFile(Document doc, String file, Integer bufferSize, Properties outputProperties)
          Writes Document to specified file using internal buffer.
static void writeDocumentToFile(Document doc, String file, Integer bufferSize, Properties outputProperties, XmlUtilities xmlUtilities)
          Writes Document to specified file using internal buffer.
static void writeDocumentToFile(Document doc, String file, Integer bufferSize, Transformer transformer)
          Writes Document to specified file using internal buffer.
static void writeDocumentToFile(Document doc, String file, Integer bufferSize, Transformer transformer, XmlUtilities xmlUtilities)
          Writes Document to specified file using internal buffer.
static void writeDocumentToFile(Document doc, String file, Integer bufferSize, XmlUtilities xmlUtilities)
          Writes Document to specified file using internal buffer.
static void writeDocumentToFile(Document doc, String file, OutputFormat outputFormat)
          Writes Document to specified file.
static void writeDocumentToFile(Document doc, String file, OutputFormat outputFormat, XmlUtilities xmlUtilities)
          Writes Document to specified file.
static void writeDocumentToFile(Document doc, String file, Properties outputProperties)
          Writes Document to specified file.
static void writeDocumentToFile(Document doc, String file, Properties outputProperties, XmlUtilities xmlUtilities)
          Writes Document to specified file.
static void writeDocumentToFile(Document doc, String file, Transformer transformer)
          Writes Document to specified file.
static void writeDocumentToFile(Document doc, String file, Transformer transformer, XmlUtilities xmlUtilities)
          Writes Document to specified file.
static void writeDocumentToFile(Document doc, String file, XmlUtilities xmlUtilities)
          Writes Document to specified file.
static void writeDocumentToStream(Document doc, OutputStream os)
          Writes specified document into specified output stream.
static void writeDocumentToStream(Document doc, OutputStream os, OutputFormat outputFormat)
          Writes specified document into specified stream and specified output format.
static void writeDocumentToStream(Document doc, OutputStream os, OutputFormat outputFormat, XmlUtilities xmlUtilities)
          Writes specified document into specified stream and specified output format.
static void writeDocumentToStream(Document doc, OutputStream os, Properties outputProperties)
          Writes specified document into specified stream and specified output format properties.
static void writeDocumentToStream(Document doc, OutputStream os, Properties outputProperties, XmlUtilities xmlUtilities)
          Writes specified document into specified stream and specified output format properties.
static void writeDocumentToStream(Document doc, OutputStream os, Transformer transformer)
          Writes specified document into specified stream and specified Transformer.
static void writeDocumentToStream(Document doc, OutputStream os, Transformer transformer, XmlUtilities xmlUtilities)
          Writes specified document into specified stream and specified Transformer.
static void writeDocumentToStream(Document doc, OutputStream os, XmlUtilities xmlUtilities)
          Writes specified document into specified output stream.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

LOGGER

private static final Logger LOGGER
Internal logger.


INTERNAL_XMLUTILITIES

private static final XmlUtilities INTERNAL_XMLUTILITIES
Use this constant, if you want to use internal XMLUtilities for the static methods.


xmlUtilities

private static XmlUtilities xmlUtilities
Stores XMLUtilities object for the static usage.

Constructor Detail

XmlTools

private XmlTools()
Utility class.

Method Detail

documentToDomSource

public static Source documentToDomSource(Document source)
Converts Document to DOMSource object.

Parameters:
source - Document XML representation
Returns:
converted XML source

documentToDomSource

public static Source documentToDomSource(Document source,
                                         String systemId)
Converts Document to DOMSource object.

Parameters:
source - Document XML representation
systemId - system ID
Returns:
converted XML source

documentToString

public static String documentToString(Document source,
                                      XmlUtilities xmlUtilities)
                               throws XmlUtilitiesException
Converts XML Document into String.

Parameters:
source - Document to convert
xmlUtilities - custom XMLUtilities; can be null
Returns:
XML in the String
Throws:
XmlUtilitiesException - on error

documentToString

public static String documentToString(Document source,
                                      OutputFormat outputFormat)
                               throws XmlUtilitiesException
Converts XML Document into String.

Parameters:
source - Document to convert
outputFormat - output format configuration
Returns:
XML in the String
Throws:
XmlUtilitiesException - on error

documentToString

public static String documentToString(Document source,
                                      Properties outputProperties)
                               throws XmlUtilitiesException
Converts XML Document into String.

Parameters:
source - Document to convert
outputProperties - output properties (see OutputFormat)
Returns:
XML in the String
Throws:
XmlUtilitiesException - on error

documentToString

public static String documentToString(Document source,
                                      OutputFormat outputFormat,
                                      XmlUtilities xmlUtilities)
                               throws XmlUtilitiesException
Converts XML Document into String.

Parameters:
source - Document to convert
outputFormat - output format configuration
xmlUtilities - custom XMLUtilities; can be null
Returns:
XML in the String
Throws:
XmlUtilitiesException - on error

documentToString

public static String documentToString(Document source,
                                      Properties outputProperties,
                                      XmlUtilities xmlUtilities)
                               throws XmlUtilitiesException
Converts XML Document into String.

Parameters:
source - Document to convert
outputProperties - output properties (see OutputFormat)
xmlUtilities - custom XMLUtilities; can be null
Returns:
XML in the String
Throws:
XmlUtilitiesException - on error

documentToString

public static String documentToString(Document source)
                               throws XmlUtilitiesException
Converts XML Document into String.

Parameters:
source - Document to convert
Returns:
XML in the String
Throws:
XmlUtilitiesException - on error

evaluateXPath

public static NodeList evaluateXPath(String query,
                                     Node context,
                                     NamespaceContext namespaces,
                                     XmlUtilities xmlUtilities)
                              throws XmlUtilitiesException
Evaluates specified XPath expression on specified context node.

Parameters:
query - XPath expression
context - context node
namespaces - name space context
xmlUtilities - custom XMLUtilities; can be null
Returns:
NodeList or null if no matches
Throws:
XmlUtilitiesException - on error

evaluateXPath

public static NodeList evaluateXPath(String query,
                                     Node context,
                                     NamespaceContext namespaces)
                              throws XmlUtilitiesException
Evaluates specified XPath expression on specified context node.

Parameters:
query - XPath expression
context - context node
namespaces - name space context
Returns:
NodeList or null if no matches
Throws:
XmlUtilitiesException - on error

evaluateXPath

public static NodeList evaluateXPath(String query,
                                     Node context,
                                     XmlUtilities xmlUtilities)
                              throws XmlUtilitiesException
Evaluates specified XPath expression on specified context node.

Parameters:
query - XPath expression
context - context node
xmlUtilities - custom XMLUtilities; can be null
Returns:
NodeList or null if no matches
Throws:
XmlUtilitiesException - on error

evaluateXPath

public static NodeList evaluateXPath(String query,
                                     Node context)
                              throws XmlUtilitiesException
Evaluates specified XPath expression on specified context node.

Parameters:
query - XPath expression
context - context node
Returns:
NodeList or null if no matches
Throws:
XmlUtilitiesException - on error

evaluateXPath

public static <E extends Node> NodeListCollection<E> evaluateXPath(String query,
                                                                   Node context,
                                                                   Class<E> elementType)
                                                        throws XmlUtilitiesException
Evaluates specified XPath expression on specified context node and returns results as NodeListCollection of specified element types. This method never returns null.

Type Parameters:
E - type of element
Parameters:
query - XPath expression
context - context node
elementType - class type of element
Returns:
NodeListCollection of element type or empty list if no matches.
Throws:
XmlUtilitiesException - on error

evaluateXPath

public static <E extends Node> NodeListCollection<E> evaluateXPath(String query,
                                                                   Node context,
                                                                   NamespaceContext namespaces,
                                                                   Class<E> elementType)
                                                        throws XmlUtilitiesException
Evaluates specified XPath expression on specified context node and returns results as NodeListCollection of specified element types. This method never returns null.

Type Parameters:
E - type of element
Parameters:
query - XPath expression
context - context node
namespaces - name space context
elementType - class type of element
Returns:
NodeListCollection of element type or empty list if no matches.
Throws:
XmlUtilitiesException - on error

evaluateXPath

public static <E extends Node> NodeListCollection<E> evaluateXPath(String query,
                                                                   Node context,
                                                                   Class<E> elementType,
                                                                   XmlUtilities xmlUtilities)
                                                        throws XmlUtilitiesException
Evaluates specified XPath expression on specified context node and returns results as NodeListCollection of specified element types. This method never returns null.

Type Parameters:
E - type of element
Parameters:
query - XPath expression
context - context node
elementType - class type of element
xmlUtilities - custom XMLUtilities; can be null
Returns:
NodeListCollection of element type or empty list if no matches.
Throws:
XmlUtilitiesException - on error

evaluateXPath

public static <E extends Node> NodeListCollection<E> evaluateXPath(String query,
                                                                   Node context,
                                                                   NamespaceContext namespaces,
                                                                   Class<E> elementType,
                                                                   XmlUtilities xmlUtilities)
                                                        throws XmlUtilitiesException
Evaluates specified XPath expression on specified context node and returns results as NodeListCollection of specified element types. This method never returns null.

Type Parameters:
E - type of element
Parameters:
query - XPath expression
context - context node
namespaces - name space context
elementType - class type of element
xmlUtilities - custom XMLUtilities; can be null
Returns:
NodeListCollection of element type or empty list if no matches.
Throws:
XmlUtilitiesException - on error

getFirstNodeForXPath

public static Node getFirstNodeForXPath(String query,
                                        Node context,
                                        XmlUtilities xmlUtilities)
                                 throws XmlUtilitiesException
Evaluates specified XPath expression and returns first Node if XPath has matches.

Parameters:
query - XPath expression
context - context node
xmlUtilities - custom XMLUtilities; can be null
Returns:
first node or null
Throws:
XmlUtilitiesException - on error

getFirstNodeForXPath

public static Node getFirstNodeForXPath(String query,
                                        Node context)
                                 throws XmlUtilitiesException
Evaluates specified XPath expression and returns first Node if XPath has matches.

Parameters:
query - XPath expression
context - context node
Returns:
first node or null
Throws:
XmlUtilitiesException - on error

getFirstNodeForXPath

public static Node getFirstNodeForXPath(String query,
                                        Node context,
                                        NamespaceContext namespaces,
                                        XmlUtilities xmlUtilities)
                                 throws XmlUtilitiesException
Evaluates specified XPath expression and returns first Node if XPath has matches.

Parameters:
query - XPath expression
context - context node
namespaces - name space context
xmlUtilities - custom XMLUtilities; can be null
Returns:
first node or null
Throws:
XmlUtilitiesException - on error

getFirstNodeForXPath

public static Node getFirstNodeForXPath(String query,
                                        Node context,
                                        NamespaceContext namespaces)
                                 throws XmlUtilitiesException
Evaluates specified XPath expression and returns first Node if XPath has matches.

Parameters:
query - XPath expression
context - context node
namespaces - name space context
Returns:
first node or null
Throws:
XmlUtilitiesException - on error

getFirstNodeForXPath

public static <E extends Node> E getFirstNodeForXPath(String query,
                                                      Node context,
                                                      Class<E> elementType)
                                           throws XmlUtilitiesException
Evaluates specified XPath expression and returns first Node as specified element type if XPath has matches.

Type Parameters:
E - type of element
Parameters:
query - XPath expression
context - context node
elementType - class type of element
Returns:
first node as specified type or null
Throws:
XmlUtilitiesException - on error

getFirstNodeForXPath

public static <E extends Node> E getFirstNodeForXPath(String query,
                                                      Node context,
                                                      NamespaceContext namespaces,
                                                      Class<E> elementType)
                                           throws XmlUtilitiesException
Evaluates specified XPath expression and returns first Node as specified element type if XPath has matches.

Type Parameters:
E - type of element
Parameters:
query - XPath expression
context - context node
namespaces - name space context
elementType - class type of element
Returns:
first node as specified type or null
Throws:
XmlUtilitiesException - on error

getFirstNodeForXPath

public static <E extends Node> E getFirstNodeForXPath(String query,
                                                      Node context,
                                                      Class<E> elementType,
                                                      XmlUtilities xmlUtilities)
                                           throws XmlUtilitiesException
Evaluates specified XPath expression and returns first Node as specified element type if XPath has matches.

Type Parameters:
E - type of element
Parameters:
query - XPath expression
context - context node
elementType - class type of element
xmlUtilities - custom XMLUtilities; can be null
Returns:
first node as specified type or null
Throws:
XmlUtilitiesException - on error

getFirstNodeForXPath

public static <E extends Node> E getFirstNodeForXPath(String query,
                                                      Node context,
                                                      NamespaceContext namespaces,
                                                      Class<E> elementType,
                                                      XmlUtilities xmlUtilities)
                                           throws XmlUtilitiesException
Evaluates specified XPath expression and returns first Node as specified element type if XPath has matches.

Type Parameters:
E - type of element
Parameters:
query - XPath expression
context - context node
namespaces - name space context
elementType - class type of element
xmlUtilities - custom XMLUtilities; can be null
Returns:
first node as specified type or null
Throws:
XmlUtilitiesException - on error

initializeXmlUtilities

private static void initializeXmlUtilities()
                                    throws XmlUtilitiesException
Initializes XMLUtilities static member for the static usage.

Throws:
XmlUtilitiesException - on error

initializeXmlUtilities

public static void initializeXmlUtilities(XmlUtilities xmlUtilities)
Initializes XMLUtilities static member for the static usage using specified XMLUtilities.

Parameters:
xmlUtilities - XMLUtilities to use

resetXmlUtilities

public static void resetXmlUtilities()
Rests internal XML Utilities so new instance will be created while next relevant call is invoked.


getInternalSchemaFactory

public static SchemaFactory getInternalSchemaFactory()
Returns SchemaFactory object internally used by the XMLUtilities static methods.

Returns:
SchemaFactory object

getInternalDocumentBuilder

public static DocumentBuilder getInternalDocumentBuilder()
Returns DocumentBuilder object internally used by the XMLUtilities static methods.

Returns:
DocumentBuilder object

getInternalTransformerFactory

public static TransformerFactory getInternalTransformerFactory()
Returns TransformerFactory object internally used by the XMLUtilities static methods.

Returns:
TransformerFactory object

getInternalTransformer

public static Transformer getInternalTransformer()
Returns Transformer object internally used by the XMLUtilities static methods.

Returns:
Transformer object

getInternalXPathFactory

public static XPathFactory getInternalXPathFactory()
Returns XPathFactory object internally used by the XMLUtilities static methods.

Returns:
XPathFactory object

getInternalNamespaceContext

public static NamespaceContext getInternalNamespaceContext()
Returns NamespaceContext object internally used by the XMLUtilities static methods.

Returns:
NamespaceContext object

validateXmlUsingSchema

public static String validateXmlUsingSchema(Source xmlDocument,
                                            Source xmlSchema,
                                            XmlUtilities xmlUtilities)
                                     throws XmlUtilitiesException
Validates specified XML with the specified XMLScheme.

Parameters:
xmlDocument - XML document to validate
xmlSchema - XMLSchema
xmlUtilities - specified XMLUtilities. if null, internal will be used
Returns:
null if successful, string with error message otherwise
Throws:
XmlUtilitiesException - on technical error

validateXmlUsingSchema

public static String validateXmlUsingSchema(Source xmlDocument,
                                            Source xmlSchema)
                                     throws XmlUtilitiesException
Validates specified XML with the specified XMLScheme.

Parameters:
xmlDocument - XML document to validate
xmlSchema - XMLSchema
Returns:
null if successful, string with error otherwise
Throws:
XmlUtilitiesException - on technical error

loadDocumentFromFile

public static Document loadDocumentFromFile(String fileName,
                                            XmlUtilities xmlUtilities)
                                     throws XmlUtilitiesException
Loads XML from file specified with file name.

Parameters:
fileName - file to load
xmlUtilities - custom XMLUtilities object; can be null
Returns:
Document object
Throws:
XmlUtilitiesException - on error

loadDocumentFromFile

public static Document loadDocumentFromFile(String fileName)
                                     throws XmlUtilitiesException
Loads XML from file specified with file name.

Parameters:
fileName - file to load
Returns:
Document object
Throws:
XmlUtilitiesException - on error

loadDocumentFromFile

public static Document loadDocumentFromFile(String fileName,
                                            DocumentBuilder documentBuilder,
                                            XmlUtilities xmlUtilities)
                                     throws XmlUtilitiesException
Loads XML from file specified with file name.

Parameters:
fileName - file to load
documentBuilder - custom DocumentBuilder
xmlUtilities - custom XMLUtilities; can be null
Returns:
Document object
Throws:
XmlUtilitiesException - on error

loadDocumentFromFile

public static Document loadDocumentFromFile(String fileName,
                                            DocumentBuilder documentBuilder)
                                     throws XmlUtilitiesException
Loads XML from file specified with file name.

Parameters:
fileName - file to load
documentBuilder - custom DocumentBuilder
Returns:
Document object
Throws:
XmlUtilitiesException - on error

loadDocumentFromFile

public static Document loadDocumentFromFile(File file,
                                            XmlUtilities xmlUtilities)
                                     throws XmlUtilitiesException
Loads XML from file specified with the File object.

Parameters:
file - file to load
xmlUtilities - custom XMLUtilities; can be null
Returns:
Document object
Throws:
XmlUtilitiesException - on error

loadDocumentFromFile

public static Document loadDocumentFromFile(File file)
                                     throws XmlUtilitiesException
Loads XML from file specified with the File object.

Parameters:
file - file to load
Returns:
Document object
Throws:
XmlUtilitiesException - on error

loadDocumentFromFile

public static Document loadDocumentFromFile(File file,
                                            DocumentBuilder documentBuilder,
                                            XmlUtilities xmlUtilities)
                                     throws XmlUtilitiesException
Loads XML from file specified with the file object.

Parameters:
file - file to load
documentBuilder - custom document builder
xmlUtilities - custom XMLUtilities; can be null
Returns:
Document object
Throws:
XmlUtilitiesException - on error

loadDocumentFromFile

public static Document loadDocumentFromFile(File file,
                                            DocumentBuilder documentBuilder)
                                     throws XmlUtilitiesException
Loads XML from file specified with the file object.

Parameters:
file - file to load
documentBuilder - custom document builder
Returns:
Document object
Throws:
XmlUtilitiesException - on error

loadDocumentFromStream

public static Document loadDocumentFromStream(InputStream is,
                                              XmlUtilities xmlUtilities)
                                       throws XmlUtilitiesException
Loads XML from specified stream.

Parameters:
is - input stream
xmlUtilities - custom XMLUtilities (can be null)
Returns:
Document object
Throws:
XmlUtilitiesException - on error

loadDocumentFromStream

public static Document loadDocumentFromStream(InputStream is)
                                       throws XmlUtilitiesException
Loads XML from specified stream.

Parameters:
is - input stream
Returns:
Document object
Throws:
XmlUtilitiesException - on error

loadDocumentFromStream

public static Document loadDocumentFromStream(InputStream is,
                                              DocumentBuilder documentBuilder,
                                              XmlUtilities xmlUtilities)
                                       throws XmlUtilitiesException
Loads XML from specified input stream.

Parameters:
is - input stream
documentBuilder - custom Document Builder
xmlUtilities - custom XMLUtilities (can be null)
Returns:
Document object
Throws:
XmlUtilitiesException - on error

loadDocumentFromStream

public static Document loadDocumentFromStream(InputStream is,
                                              DocumentBuilder documentBuilder)
                                       throws XmlUtilitiesException
Loads XML from specified input stream.

Parameters:
is - input stream
documentBuilder - custom Document Builder
Returns:
Document object
Throws:
XmlUtilitiesException - on error

loadDocumentFromClassLoader

public static Document loadDocumentFromClassLoader(String resource,
                                                   Class<?> fallbackClazz)
                                            throws XmlUtilitiesException
Loads document from ClassLoaders. The first of ContextClassLoader, fallBackClazz#getClassLoader() or SystemClassLoader is used whichever is find first.

Parameters:
resource - resource name to load from
fallbackClazz - ClassLoader to use if ContextClassLoader does not exist
Returns:
Document object
Throws:
XmlUtilitiesException - on error

loadDocumentFromClassLoader

public static Document loadDocumentFromClassLoader(String resource,
                                                   DocumentBuilder documentBuilder,
                                                   Class<?> fallbackClazz)
                                            throws XmlUtilitiesException
Loads document from ClassLoaders. The first of ContextClassLoader, fallBackClazz#getClassLoader() or SystemClassLoader is used whichever is find first.

Parameters:
resource - resource name to load from
documentBuilder - custom DocumentBuilder
fallbackClazz - ClassLoader to use if ContextClassLoader does not exist
Returns:
Document object
Throws:
XmlUtilitiesException - on error

loadDocumentFromClassLoader

public static Document loadDocumentFromClassLoader(String resource,
                                                   Class<?> fallbackClazz,
                                                   XmlUtilities xmlUtilities)
                                            throws XmlUtilitiesException
Loads document from ClassLoaders. The first of ContextClassLoader, fallBackClazz#getClassLoader() or SystemClassLoader is used whichever is find first.

Parameters:
resource - resource name to load from
fallbackClazz - ClassLoader to use if ContextClassLoader does not exist
xmlUtilities - custom XMLUtilities (can be null)
Returns:
Document object
Throws:
XmlUtilitiesException - on error

loadDocumentFromClassLoader

public static Document loadDocumentFromClassLoader(String resource,
                                                   DocumentBuilder documentBuilder,
                                                   Class<?> fallbackClazz,
                                                   XmlUtilities xmlUtilities)
                                            throws XmlUtilitiesException
Loads document from ClassLoaders. The first of ContextClassLoader, fallBackClazz#getClassLoader() or SystemClassLoader is used whichever is find first.

Parameters:
resource - resource name to load from
documentBuilder - custom DocumentBuilder
fallbackClazz - ClassLoader to use if ContextClassLoader does not exist
xmlUtilities - custom XMLUtilities (can be null)
Returns:
Document object
Throws:
XmlUtilitiesException - on error

loadDocumentFromResource

public static Document loadDocumentFromResource(String resource,
                                                Class<?> clazz,
                                                XmlUtilities xmlUtilities)
                                         throws XmlUtilitiesException
Loads Document from resource from given class.

Parameters:
resource - resource to load
clazz - class to use
xmlUtilities - custom XMLUtilities (can be null)
Returns:
Document object
Throws:
XmlUtilitiesException - on error

loadDocumentFromResource

public static Document loadDocumentFromResource(String resource,
                                                DocumentBuilder documentBuilder,
                                                Class<?> clazz,
                                                XmlUtilities xmlUtilities)
                                         throws XmlUtilitiesException
Loads Document from resource from given class.

Parameters:
resource - resource to load
documentBuilder - custom DocumentBuilder
clazz - class to use
xmlUtilities - custom XMLUtilities (can be null)
Returns:
Document object
Throws:
XmlUtilitiesException - on error

loadDocumentFromResource

public static Document loadDocumentFromResource(String resource,
                                                Class<?> clazz)
                                         throws XmlUtilitiesException
Loads Document from resource from given class.

Parameters:
resource - resource to load
clazz - class to use
Returns:
Document object
Throws:
XmlUtilitiesException - on error

loadDocumentFromResource

public static Document loadDocumentFromResource(String resource,
                                                DocumentBuilder documentBuilder,
                                                Class<?> clazz)
                                         throws XmlUtilitiesException
Loads Document from resource from given class.

Parameters:
resource - resource to load
documentBuilder - custom DocumentBuilder
clazz - class to use
Returns:
Document object
Throws:
XmlUtilitiesException - on error

loadDocumentFromResource

public static Document loadDocumentFromResource(String resource,
                                                ClassLoader classLoader)
                                         throws XmlUtilitiesException
Loads document from resource using specified ClassLoader.

Parameters:
resource - resource to load
classLoader - ClassLoader to use
Returns:
Document object
Throws:
XmlUtilitiesException - on error

loadDocumentFromResource

public static Document loadDocumentFromResource(String resource,
                                                DocumentBuilder documentBuilder,
                                                ClassLoader classLoader)
                                         throws XmlUtilitiesException
Loads document from resource using specified ClassLoader.

Parameters:
resource - resource to load
documentBuilder - custom DocumentBuilder
classLoader - ClassLoader to use
Returns:
Document object
Throws:
XmlUtilitiesException - on error

loadDocumentFromResource

public static Document loadDocumentFromResource(String resource,
                                                ClassLoader classLoader,
                                                XmlUtilities xmlUtilities)
                                         throws XmlUtilitiesException
Loads document from resource using specified ClassLoader.

Parameters:
resource - resource to load
classLoader - ClassLoader to use
xmlUtilities - custom XMLUtilities (can be null)
Returns:
Document object
Throws:
XmlUtilitiesException - on error

loadDocumentFromResource

public static Document loadDocumentFromResource(String resource,
                                                DocumentBuilder documentBuilder,
                                                ClassLoader classLoader,
                                                XmlUtilities xmlUtilities)
                                         throws XmlUtilitiesException
Loads document from resource using specified ClassLoader.

Parameters:
resource - resource to load
documentBuilder - custom DocumentBuilder
classLoader - ClassLoader to use
xmlUtilities - custom XMLUtilities (can be null)
Returns:
Document object
Throws:
XmlUtilitiesException - on error

getInternalDocumentBuilderFactory

public static DocumentBuilderFactory getInternalDocumentBuilderFactory()
Returns DocumentBuilderFactory object internally used by the XMLUtilities static methods.

Returns:
DocumentBuilderFactory object

getInternalXPath

public static XPath getInternalXPath()
Returns XPath object internally used by the XMLUtilities static methods.

Returns:
XPath object

transformToString

public static String transformToString(Source xsltTemplate,
                                       Source document)
                                throws XmlUtilitiesException
Transforms specified XML document using specified XSLT template.

Parameters:
xsltTemplate - template to use
document - source XML document
Returns:
resulting document in the String
Throws:
XmlUtilitiesException - on error

transformToString

public static String transformToString(Source xsltTemplate,
                                       Source document,
                                       XmlUtilities xmlUtilities)
                                throws XmlUtilitiesException
Transforms specified XML document using specified XSLT template.

Parameters:
xsltTemplate - XSLT template
document - source XML document
xmlUtilities - custom XMLUtilities
Returns:
resulting XML document in the String
Throws:
XmlUtilitiesException - on error

transformToString

public static String transformToString(Source xsltTemplate,
                                       Source document,
                                       Map<String,Object> parameters)
                                throws XmlUtilitiesException
Transforms specified XML document using specified XSLT template.

Parameters:
xsltTemplate - XSLT template to use
document - source XML document
parameters - parameters for the XSLT processor
Returns:
resulting XML file in the String
Throws:
XmlUtilitiesException - on error

transformToString

public static String transformToString(Source xsltTemplate,
                                       Source document,
                                       Map<String,Object> parameters,
                                       XmlUtilities xmlUtilities)
                                throws XmlUtilitiesException
Transforms specified XML document using specified XSLT template.

Parameters:
xsltTemplate - XSLT template to use
document - source XML document
parameters - parameters for the XSLT processor
xmlUtilities - custom XMLUtilities to use
Returns:
resulting XML document in the String
Throws:
XmlUtilitiesException - on error

transformToString

public static String transformToString(Templates xsltTemplate,
                                       Source document,
                                       Map<String,Object> parameters,
                                       XmlUtilities xmlUtilities)
                                throws XmlUtilitiesException
Transforms specified XML document using XSLT (compiled) template.

Parameters:
xsltTemplate - template to use
document - XML document to transform
parameters - parameters for the transformation
xmlUtilities - custom XMLUtilities to use
Returns:
resulting XML document in the String
Throws:
XmlUtilitiesException - on error

transformToString

public static String transformToString(Templates xsltTemplate,
                                       Source document,
                                       Map<String,Object> parameters)
                                throws XmlUtilitiesException
Transforms specified XML document 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 String
Throws:
XmlUtilitiesException - on error

transformToString

public static String transformToString(Templates xsltTemplate,
                                       Source document,
                                       XmlUtilities xmlUtilities)
                                throws XmlUtilitiesException
Transforms specified XML document using XSLT (compiled) template.

Parameters:
xsltTemplate - template to use
document - XML document to transform
xmlUtilities - custom XMLUtilities to use
Returns:
resulting XML in the String
Throws:
XmlUtilitiesException - on error

transformToString

public static String transformToString(Templates xsltTemplate,
                                       Source document)
                                throws XmlUtilitiesException
Transforms specified XML document using XSLT (compiled) template.

Parameters:
xsltTemplate - template to use
document - XML document to transform
Returns:
resulting XML in the String
Throws:
XmlUtilitiesException - on error

transformToDocument

public static Document transformToDocument(Templates xsltTemplate,
                                           Source document,
                                           Map<String,Object> parameters,
                                           XmlUtilities xmlUtilities)
                                    throws XmlUtilitiesException
Transforms specified XML document using XSLT (compiled) template.

Parameters:
xsltTemplate - template to use
document - XML document to transform
parameters - parameters for the transformation
xmlUtilities - custom XMLUtilities to use
Returns:
resulting XML in the Document
Throws:
XmlUtilitiesException - on error

transformToDocument

public static Document transformToDocument(Templates xsltTemplate,
                                           Source document,
                                           Map<String,Object> parameters)
                                    throws XmlUtilitiesException
Transforms specified XML document using XSLT (compiled) template.

Parameters:
xsltTemplate - template to use
document - XML document to transform
parameters - parameters for the transformation
Returns:
resulting XML in the Document
Throws:
XmlUtilitiesException - on error

transformToDocument

public static Document transformToDocument(Templates xsltTemplate,
                                           Source document,
                                           XmlUtilities xmlUtilities)
                                    throws XmlUtilitiesException
Transforms specified XML document using XSLT (compiled) template.

Parameters:
xsltTemplate - template to use
document - XML document to transform
xmlUtilities - custom XMLUtilities to use
Returns:
resulting XML in the Document
Throws:
XmlUtilitiesException - on error

transformToDocument

public static Document transformToDocument(Templates xsltTemplate,
                                           Source document)
                                    throws XmlUtilitiesException
Transforms specified XML document using XSLT (compiled) template.

Parameters:
xsltTemplate - template to use
document - XML document to transform
Returns:
resulting XML in the Document
Throws:
XmlUtilitiesException - on error

loadDocumentFromString

public static Document loadDocumentFromString(String source)
                                       throws XmlUtilitiesException
Loads document from String into the Document.

Parameters:
source - source XML
Returns:
resulting XML
Throws:
XmlUtilitiesException - on error

loadDocumentFromString

public static Document loadDocumentFromString(String source,
                                              XmlUtilities xmlUtilities)
                                       throws XmlUtilitiesException
Loads document from String into the Document.

Parameters:
source - source XML
xmlUtilities - custom XMLUtilities to use
Returns:
resulting XML
Throws:
XmlUtilitiesException - on error

loadDocumentFromString

public static Document loadDocumentFromString(String source,
                                              DocumentBuilder documentBuilder)
                                       throws XmlUtilitiesException
Loads document from String into the Document.

Parameters:
source - source XML
documentBuilder - custom document builder
Returns:
resulting XML
Throws:
XmlUtilitiesException - on error

loadDocumentFromString

public static Document loadDocumentFromString(String source,
                                              DocumentBuilder documentBuilder,
                                              XmlUtilities xmlUtilities)
                                       throws XmlUtilitiesException
Loads document from String into the Document.

Parameters:
source - source XML
documentBuilder - custom DocumentBuilder to use
xmlUtilities - custom XMLUtilities to use
Returns:
resulting XML
Throws:
XmlUtilitiesException - on error

sourceToString

public static String sourceToString(Source source)
                             throws XmlUtilitiesException
Converts XML Source into String.

Parameters:
source - source Document
Returns:
XML in the String
Throws:
XmlUtilitiesException - on error

sourceToString

public static String sourceToString(Source source,
                                    XmlUtilities xmlUtilities)
                             throws XmlUtilitiesException
Converts XML Source into String.

Parameters:
source - source Document
xmlUtilities - XMLUtilities to use
Returns:
XML in the String
Throws:
XmlUtilitiesException - on error

sourceToString

public static String sourceToString(Source source,
                                    OutputFormat outputFormat)
                             throws XmlUtilitiesException
Converts XML Source into String.

Parameters:
source - source Document
outputFormat - output format configuration
Returns:
XML in the String
Throws:
XmlUtilitiesException - on error

sourceToString

public static String sourceToString(Source source,
                                    Properties outputProperties)
                             throws XmlUtilitiesException
Converts XML Source into String.

Parameters:
source - source Document
outputProperties - output properties (see OutputFormat)
Returns:
XML in the String
Throws:
XmlUtilitiesException - on error

sourceToString

public static String sourceToString(Source source,
                                    OutputFormat outputFormat,
                                    XmlUtilities xmlUtilities)
                             throws XmlUtilitiesException
Converts XML Source into String.

Parameters:
source - source Document
outputFormat - output format configuration
xmlUtilities - XMLUtilities to use
Returns:
XML in the String
Throws:
XmlUtilitiesException - on error

sourceToString

public static String sourceToString(Source source,
                                    Properties outputProperties,
                                    XmlUtilities xmlUtilities)
                             throws XmlUtilitiesException
Converts XML Source into String.

Parameters:
source - source Document
outputProperties - output properties (see OutputFormat)
xmlUtilities - XMLUtilities to use
Returns:
XML in the String
Throws:
XmlUtilitiesException - on error

transformToDocument

public static Document transformToDocument(Source xsltTemplate,
                                           Source document,
                                           Map<String,Object> parameters,
                                           XmlUtilities xmlUtilities)
                                    throws XmlUtilitiesException
Transforms specified XML using specified XSLT template.

Parameters:
xsltTemplate - XSLT template
document - source XML document
parameters - parameters for the template
xmlUtilities - XMLUtilities to use
Returns:
resulting XML in the Document
Throws:
XmlUtilitiesException - on error

transformToDocument

public static Document transformToDocument(Source xsltTemplate,
                                           Source document,
                                           Map<String,Object> parameters)
                                    throws XmlUtilitiesException
Transforms specified XML using specified XSLT template.

Parameters:
xsltTemplate - XSLT template
document - source XML document
parameters - parameters for the template
Returns:
resulting XML in the Document
Throws:
XmlUtilitiesException - on error

transformToDocument

public static Document transformToDocument(Source xsltTemplate,
                                           Source document,
                                           XmlUtilities xmlUtilities)
                                    throws XmlUtilitiesException
Transforms specified XML using specified XSLT template.

Parameters:
xsltTemplate - XSLT template
document - source XML document
xmlUtilities - XMLUtilities to use
Returns:
resulting XML in the Document
Throws:
XmlUtilitiesException - on error

transformToDocument

public static Document transformToDocument(Source xsltTemplate,
                                           Source document)
                                    throws XmlUtilitiesException
Transforms specified XML using specified XSLT template.

Parameters:
xsltTemplate - XSLT template
document - source XML document
Returns:
resulting XML in the Document
Throws:
XmlUtilitiesException - on error

writeDocumentToStream

public static void writeDocumentToStream(Document doc,
                                         OutputStream os)
                                  throws XmlUtilitiesException
Writes specified document into specified output stream.

Parameters:
doc - document
os - output stream
Throws:
XmlUtilitiesException - on error

writeDocumentToStream

public static void writeDocumentToStream(Document doc,
                                         OutputStream os,
                                         XmlUtilities xmlUtilities)
                                  throws XmlUtilitiesException
Writes specified document into specified output stream.

Parameters:
doc - document
os - output stream
xmlUtilities - XMLUtilities to use
Throws:
XmlUtilitiesException - on error

writeDocumentToStream

public static void writeDocumentToStream(Document doc,
                                         OutputStream os,
                                         OutputFormat outputFormat)
                                  throws XmlUtilitiesException
Writes specified document into specified stream and specified output format.

Parameters:
doc - document
os - output stream
outputFormat - output format
Throws:
XmlUtilitiesException - on error

writeDocumentToStream

public static void writeDocumentToStream(Document doc,
                                         OutputStream os,
                                         OutputFormat outputFormat,
                                         XmlUtilities xmlUtilities)
                                  throws XmlUtilitiesException
Writes specified document into specified stream and specified output format.

Parameters:
doc - document
os - output stream
outputFormat - output format
xmlUtilities - XMLUtilities to use
Throws:
XmlUtilitiesException - on error

writeDocumentToStream

public static void writeDocumentToStream(Document doc,
                                         OutputStream os,
                                         Properties outputProperties)
                                  throws XmlUtilitiesException
Writes specified document into specified stream and specified output format properties.

Parameters:
doc - document
os - output stream
outputProperties - output format properties
Throws:
XmlUtilitiesException - on error

writeDocumentToStream

public static void writeDocumentToStream(Document doc,
                                         OutputStream os,
                                         Properties outputProperties,
                                         XmlUtilities xmlUtilities)
                                  throws XmlUtilitiesException
Writes specified document into specified stream and specified output format properties.

Parameters:
doc - document
os - output stream
outputProperties - output format properties
xmlUtilities - XMLUtilities to use
Throws:
XmlUtilitiesException - on error

writeDocumentToStream

public static void writeDocumentToStream(Document doc,
                                         OutputStream os,
                                         Transformer transformer)
                                  throws XmlUtilitiesException
Writes specified document into specified stream and specified Transformer.

Parameters:
doc - document
os - output stream
transformer - Transformer to use
Throws:
XmlUtilitiesException - on error

writeDocumentToStream

public static void writeDocumentToStream(Document doc,
                                         OutputStream os,
                                         Transformer transformer,
                                         XmlUtilities xmlUtilities)
                                  throws XmlUtilitiesException
Writes specified document into specified stream and specified Transformer.

Parameters:
doc - document
os - output stream
transformer - Transformer to use
xmlUtilities - XMLUtilities to use
Throws:
XmlUtilitiesException - on error

writeDocumentToFile

public static void writeDocumentToFile(Document doc,
                                       String file)
                                throws XmlUtilitiesException
Writes Document to specified file.

Parameters:
doc - document
file - target file
Throws:
XmlUtilitiesException - on error

writeDocumentToFile

public static void writeDocumentToFile(Document doc,
                                       String file,
                                       OutputFormat outputFormat)
                                throws XmlUtilitiesException
Writes Document to specified file.

Parameters:
doc - document
file - target file
outputFormat - output format
Throws:
XmlUtilitiesException - on error

writeDocumentToFile

public static void writeDocumentToFile(Document doc,
                                       String file,
                                       Properties outputProperties)
                                throws XmlUtilitiesException
Writes Document to specified file.

Parameters:
doc - document
file - target file
outputProperties - output format properties
Throws:
XmlUtilitiesException - on error

writeDocumentToFile

public static void writeDocumentToFile(Document doc,
                                       String file,
                                       Transformer transformer)
                                throws XmlUtilitiesException
Writes Document to specified file.

Parameters:
doc - document
file - target file
transformer - transformer
Throws:
XmlUtilitiesException - on error

writeDocumentToFile

public static void writeDocumentToFile(Document doc,
                                       String file,
                                       Integer bufferSize)
                                throws XmlUtilitiesException
Writes Document to specified file using internal buffer.

Parameters:
doc - document
file - target file
bufferSize - buffer size or null for default
Throws:
XmlUtilitiesException - on error

writeDocumentToFile

public static void writeDocumentToFile(Document doc,
                                       String file,
                                       Integer bufferSize,
                                       OutputFormat outputFormat)
                                throws XmlUtilitiesException
Writes Document to specified file using internal buffer.

Parameters:
doc - document
file - target file
bufferSize - buffer size or null for default
outputFormat - output format
Throws:
XmlUtilitiesException - on error

writeDocumentToFile

public static void writeDocumentToFile(Document doc,
                                       String file,
                                       Integer bufferSize,
                                       Properties outputProperties)
                                throws XmlUtilitiesException
Writes Document to specified file using internal buffer.

Parameters:
doc - document
file - target file
bufferSize - buffer size or null for default
outputProperties - output format properties
Throws:
XmlUtilitiesException - on error

writeDocumentToFile

public static void writeDocumentToFile(Document doc,
                                       String file,
                                       Integer bufferSize,
                                       Transformer transformer)
                                throws XmlUtilitiesException
Writes Document to specified file using internal buffer.

Parameters:
doc - document
file - target file
bufferSize - buffer size or null for default
transformer - transformer
Throws:
XmlUtilitiesException - on error

writeDocumentToFile

public static void writeDocumentToFile(Document doc,
                                       String file,
                                       XmlUtilities xmlUtilities)
                                throws XmlUtilitiesException
Writes Document to specified file.

Parameters:
doc - document
file - target file
xmlUtilities - XML Utilities to use
Throws:
XmlUtilitiesException - on error

writeDocumentToFile

public static void writeDocumentToFile(Document doc,
                                       String file,
                                       OutputFormat outputFormat,
                                       XmlUtilities xmlUtilities)
                                throws XmlUtilitiesException
Writes Document to specified file.

Parameters:
doc - document
file - target file
outputFormat - output format
xmlUtilities - XML Utilities to use
Throws:
XmlUtilitiesException - on error

writeDocumentToFile

public static void writeDocumentToFile(Document doc,
                                       String file,
                                       Properties outputProperties,
                                       XmlUtilities xmlUtilities)
                                throws XmlUtilitiesException
Writes Document to specified file.

Parameters:
doc - document
file - target file
outputProperties - output format properties
xmlUtilities - XML Utilities to use
Throws:
XmlUtilitiesException - on error

writeDocumentToFile

public static void writeDocumentToFile(Document doc,
                                       String file,
                                       Transformer transformer,
                                       XmlUtilities xmlUtilities)
                                throws XmlUtilitiesException
Writes Document to specified file.

Parameters:
doc - document
file - target file
transformer - transformer
xmlUtilities - XML Utilities to use
Throws:
XmlUtilitiesException - on error

writeDocumentToFile

public static void writeDocumentToFile(Document doc,
                                       String file,
                                       Integer bufferSize,
                                       XmlUtilities xmlUtilities)
                                throws XmlUtilitiesException
Writes Document to specified file using internal buffer.

Parameters:
doc - document
file - target file
bufferSize - buffer size or null for default
xmlUtilities - XML Utilities to use
Throws:
XmlUtilitiesException - on error

writeDocumentToFile

public static void writeDocumentToFile(Document doc,
                                       String file,
                                       Integer bufferSize,
                                       OutputFormat outputFormat,
                                       XmlUtilities xmlUtilities)
                                throws XmlUtilitiesException
Writes Document to specified file using internal buffer.

Parameters:
doc - document
file - target file
bufferSize - buffer size or null for default
outputFormat - output format
xmlUtilities - XML Utilities to use
Throws:
XmlUtilitiesException - on error

writeDocumentToFile

public static void writeDocumentToFile(Document doc,
                                       String file,
                                       Integer bufferSize,
                                       Properties outputProperties,
                                       XmlUtilities xmlUtilities)
                                throws XmlUtilitiesException
Writes Document to specified file using internal buffer.

Parameters:
doc - document
file - target file
bufferSize - buffer size or null for default
outputProperties - output format properties
xmlUtilities - XML Utilities to use
Throws:
XmlUtilitiesException - on error

writeDocumentToFile

public static void writeDocumentToFile(Document doc,
                                       String file,
                                       Integer bufferSize,
                                       Transformer transformer,
                                       XmlUtilities xmlUtilities)
                                throws XmlUtilitiesException
Writes Document to specified file using internal buffer.

Parameters:
doc - document
file - target file
bufferSize - buffer size or null for default
transformer - transformer
xmlUtilities - XML Utilities to use
Throws:
XmlUtilitiesException - on error

writeDocumentToFile

public static void writeDocumentToFile(Document doc,
                                       File file)
                                throws XmlUtilitiesException
Writes Document to specified file.

Parameters:
doc - document
file - target file
Throws:
XmlUtilitiesException - on error

writeDocumentToFile

public static void writeDocumentToFile(Document doc,
                                       File file,
                                       OutputFormat outputFormat)
                                throws XmlUtilitiesException
Writes Document to specified file.

Parameters:
doc - document
file - target file
outputFormat - output format
Throws:
XmlUtilitiesException - on error

writeDocumentToFile

public static void writeDocumentToFile(Document doc,
                                       File file,
                                       Properties outputProperties)
                                throws XmlUtilitiesException
Writes Document to specified file.

Parameters:
doc - document
file - target file
outputProperties - output format properties
Throws:
XmlUtilitiesException - on error

writeDocumentToFile

public static void writeDocumentToFile(Document doc,
                                       File file,
                                       Transformer transformer)
                                throws XmlUtilitiesException
Writes Document to specified file.

Parameters:
doc - document
file - target file
transformer - transformer
Throws:
XmlUtilitiesException - on error

writeDocumentToFile

public static void writeDocumentToFile(Document doc,
                                       File file,
                                       Integer bufferSize)
                                throws XmlUtilitiesException
Writes Document to specified file using internal buffer.

Parameters:
doc - document
file - target file
bufferSize - buffer size or null for default
Throws:
XmlUtilitiesException - on error

writeDocumentToFile

public static void writeDocumentToFile(Document doc,
                                       File file,
                                       Integer bufferSize,
                                       OutputFormat outputFormat)
                                throws XmlUtilitiesException
Writes Document to specified file using internal buffer.

Parameters:
doc - document
file - target file
bufferSize - buffer size or null for default
outputFormat - output format
Throws:
XmlUtilitiesException - on error

writeDocumentToFile

public static void writeDocumentToFile(Document doc,
                                       File file,
                                       Integer bufferSize,
                                       Properties outputProperties)
                                throws XmlUtilitiesException
Writes Document to specified file using internal buffer.

Parameters:
doc - document
file - target file
bufferSize - buffer size or null for default
outputProperties - output format properties
Throws:
XmlUtilitiesException - on error

writeDocumentToFile

public static void writeDocumentToFile(Document doc,
                                       File file,
                                       Integer bufferSize,
                                       Transformer transformer)
                                throws XmlUtilitiesException
Writes Document to specified file using internal buffer.

Parameters:
doc - document
file - target file
bufferSize - buffer size or null for default
transformer - transformer
Throws:
XmlUtilitiesException - on error

writeDocumentToFile

public static void writeDocumentToFile(Document doc,
                                       File file,
                                       XmlUtilities xmlUtilities)
                                throws XmlUtilitiesException
Writes Document to specified file.

Parameters:
doc - document
file - target file
xmlUtilities - XML Utilities to use
Throws:
XmlUtilitiesException - on error

writeDocumentToFile

public static void writeDocumentToFile(Document doc,
                                       File file,
                                       OutputFormat outputFormat,
                                       XmlUtilities xmlUtilities)
                                throws XmlUtilitiesException
Writes Document to specified file.

Parameters:
doc - document
file - target file
outputFormat - output format
xmlUtilities - XML Utilities to use
Throws:
XmlUtilitiesException - on error

writeDocumentToFile

public static void writeDocumentToFile(Document doc,
                                       File file,
                                       Properties outputProperties,
                                       XmlUtilities xmlUtilities)
                                throws XmlUtilitiesException
Writes Document to specified file.

Parameters:
doc - document
file - target file
outputProperties - output format properties
xmlUtilities - XML Utilities to use
Throws:
XmlUtilitiesException - on error

writeDocumentToFile

public static void writeDocumentToFile(Document doc,
                                       File file,
                                       Transformer transformer,
                                       XmlUtilities xmlUtilities)
                                throws XmlUtilitiesException
Writes Document to specified file.

Parameters:
doc - document
file - target file
transformer - transformer
xmlUtilities - XML Utilities to use
Throws:
XmlUtilitiesException - on error

writeDocumentToFile

public static void writeDocumentToFile(Document doc,
                                       File file,
                                       Integer bufferSize,
                                       XmlUtilities xmlUtilities)
                                throws XmlUtilitiesException
Writes Document to specified file using internal buffer.

Parameters:
doc - document
file - target file
bufferSize - buffer size or null for default
xmlUtilities - XML Utilities to use
Throws:
XmlUtilitiesException - on error

writeDocumentToFile

public static void writeDocumentToFile(Document doc,
                                       File file,
                                       Integer bufferSize,
                                       OutputFormat outputFormat,
                                       XmlUtilities xmlUtilities)
                                throws XmlUtilitiesException
Writes Document to specified file using internal buffer.

Parameters:
doc - document
file - target file
bufferSize - buffer size or null for default
outputFormat - output format
xmlUtilities - XML Utilities to use
Throws:
XmlUtilitiesException - on error

writeDocumentToFile

public static void writeDocumentToFile(Document doc,
                                       File file,
                                       Integer bufferSize,
                                       Properties outputProperties,
                                       XmlUtilities xmlUtilities)
                                throws XmlUtilitiesException
Writes Document to specified file using internal buffer.

Parameters:
doc - document
file - target file
bufferSize - buffer size or null for default
outputProperties - output format properties
xmlUtilities - XML Utilities to use
Throws:
XmlUtilitiesException - on error

writeDocumentToFile

public static void writeDocumentToFile(Document doc,
                                       File file,
                                       Integer bufferSize,
                                       Transformer transformer,
                                       XmlUtilities xmlUtilities)
                                throws XmlUtilitiesException
Writes Document to specified file using internal buffer.

Parameters:
doc - document
file - target file
bufferSize - buffer size or null for default
transformer - transformer
xmlUtilities - XML Utilities to use
Throws:
XmlUtilitiesException - on error

loadSourceFromString

public static Source loadSourceFromString(String source)
Loads XML from String.

Parameters:
source - source string
Returns:
XML in the Source

loadSourceFromString

public static Source loadSourceFromString(String source,
                                          String systemId)
Loads XML from String.

Parameters:
source - source string
systemId - system ID
Returns:
XML in the Source

disableLogging

public static void disableLogging()
Disables logging of XmlTools and XmlUtilities.


disableLogging0

static void disableLogging0()
Disables logging.


setLoggingLevel

public static void setLoggingLevel(Level newLevel)
Sets new logging level of XmlTools and XmlUtilities.

Parameters:
newLevel - level to set

setLoggingLevel0

static void setLoggingLevel0(Level newLevel)
Sets new logging level.

Parameters:
newLevel - level to set


Copyright © 2006–2018. All rights reserved.