dk.heick.properties.types.utils

Class XMLUtils

java.lang.Object

dk.heick.properties.types.utils.XMLUtils

public class XMLUtils
extends Object

Assorted XML utility methods.

Since:

1.3

Author:

Frederik Heick

Constructor Summary

Constructors

Constructor and Description
XMLUtils()

Method Summary

Modifier and Type	Method and Description
static Document	loadXmlFromFile(File xmlFile) Will load the XML from a file.
static Document	loadXmlFromFile(File xmlFile, URL schemaUrl) Will load and validate angainst a schema the XML from a file.
static Document	loadXmlFromInputStream(InputStream inputStream) Loads the Document (DOM) from an InputStream.
static void	validateXmlFile(File xmlFile, File schemaFile) Validates a XML file against schema located at schemaFile. Inspirational code: http://stackoverflow.com/questions/15732/whats-the-best-way-to-validate-an-xml-file-against-an-xsd-file http://www.edankert.com/validate.html#Validate_using_external_Schema_s_ Note: Storing the schemas locally will greatly speed up the validating processing time.
static void	validateXmlFile(File xmlFile, URL schemaUrl) Validates a XML file against schema located at schemaUrl. Inspirational code: http://stackoverflow.com/questions/15732/whats-the-best-way-to-validate-an-xml-file-against-an-xsd-file http://www.edankert.com/validate.html#Validate_using_external_Schema_s_ Note: Storing the schemas locally will greatly speed up the validating processing time.

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLUtils

public XMLUtils()

Method Detail

validateXmlFile

public static void validateXmlFile(File xmlFile,
                                   URL schemaUrl)
                            throws PropertyIOException

Validates a XML file against schema located at schemaUrl.
Inspirational code:

• http://stackoverflow.com/questions/15732/whats-the-best-way-to-validate-an-xml-file-against-an-xsd-file
• http://www.edankert.com/validate.html#Validate_using_external_Schema_s_

Note: Storing the schemas locally will greatly speed up the validating processing time.

Parameters:

xmlFile - the xml file that shall be validated.

schemaUrl - the URL for the schema to validate the file.

Throws:

PropertyIOException - if xmlFile or schemaURL or invalid, or xml file did not validate against the schma

validateXmlFile

public static void validateXmlFile(File xmlFile,
                                   File schemaFile)
                            throws PropertyIOException

Validates a XML file against schema located at schemaFile.
Inspirational code:

• http://stackoverflow.com/questions/15732/whats-the-best-way-to-validate-an-xml-file-against-an-xsd-file
• http://www.edankert.com/validate.html#Validate_using_external_Schema_s_

Note: Storing the schemas locally will greatly speed up the validating processing time.

Parameters:

xmlFile - the xml file that shall be validated.

schemaFile - the file containing the schema to validate the file.

Throws:

PropertyIOException - if xmlFile or schemaFile or invalid, or xml file did not validate against the schma

loadXmlFromFile

public static Document loadXmlFromFile(File xmlFile)
                                throws PropertyIOException

Will load the XML from a file.
The DocumentBuilderFactory is setup as:

• validating = false
• ignoringComments = true
• ignoringElementContentWhitespace = false
• namespaceAware = true

Parameters:

xmlFile - the xml file

Returns:

the dom Document for further processing if needed.

Throws:

PropertyIOException - if the XML file is not well formed, or an IOException is thrown.

loadXmlFromFile

public static Document loadXmlFromFile(File xmlFile,
                                       URL schemaUrl)
                                throws PropertyIOException

Will load and validate angainst a schema the XML from a file.
The DocumentBuilderFactory is setup as:

• validating = false
• ignoringComments = true
• ignoringElementContentWhitespace = false
• namespaceAware = true
Note: Storing the schemas locally will greatly speed up the validating processing time.

Parameters:

xmlFile - the xml file

schemaUrl - the url for schema to validate against, if null then ignored.

Returns:

the dom Document for further processing if needed.

Throws:

PropertyIOException - if the XML file is not wellformed did validate against the schema, or an IOException is thrown.

loadXmlFromInputStream

public static Document loadXmlFromInputStream(InputStream inputStream)
                                       throws PropertyIOException

Loads the Document (DOM) from an InputStream.
The DocumentBuilderFactory is setup as:

• validating = false
• ignoringComments = true
• ignoringElementContentWhitespace = false
• namespaceAware = true

Parameters:

inputStream - the inputstream provided.

Returns:

a loaded Document.

Throws:

PropertyIOException - if any error loading the Document.

See Also:

Document