Module esa.opensf.osfi

Package esa.opensf.osfi.xmlutils

Class XmlFiles

java.lang.Object

esa.opensf.osfi.xmlutils.XmlFiles

public final class XmlFiles
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	W3C_NS_URI_XSD10	Default version of the XSD standard; Java 8 states that at least XSD 1.0 is supported.
static final String	W3C_NS_URI_XSD11	XSD standard version 1.1 (specifically).

Method Summary

Modifier and Type	Method	Description
static LoadResult<Document>	load(File file)	Read and parse a XML document, without validation.
static LoadResult<Document>	load(File file, boolean stopOnFirstError)	Read and parse a XML document, without validation.
static LoadResult<Document>	loadAndValidate(File file, File schema, String schemaLang, boolean stopOnFirstError)	Read and parse a XML document, validating against an internal or external schema.
static LoadResult<Void>	validate(File xmlFile, File schemaFile, String schemaLanguage, boolean stopOnFirstError)	Validates an XML file against a schema.

Methods inherited from class java.lang.Object

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

Field Details

W3C_NS_URI_XSD10

public static final String W3C_NS_URI_XSD10

Default version of the XSD standard; Java 8 states that at least XSD 1.0 is supported.

See Also:

• Constant Field Values

W3C_NS_URI_XSD11

public static final String W3C_NS_URI_XSD11

XSD standard version 1.1 (specifically). It may not be supported if not using a specific library e.g. Xerces-J 2.11 or later.

See Also:

• Constant Field Values

Method Details

load

public static LoadResult<Document> load(File file)
                                 throws FileNotFoundException

Read and parse a XML document, without validation. Equivalent to calling the other overload with true as the second argument

Parameters:

file - Path to the XML document

Returns:

Object containing the result (if successful) and the list of parsing errors (if not).

Throws:

FileNotFoundException - if the file cannot be read.

See Also:

• to validate at the same time as parsing
• to validate after parsing
• to validate after parsing

load

public static LoadResult<Document> load(File file,
 boolean stopOnFirstError)
                                 throws FileNotFoundException

Read and parse a XML document, without validation.

Parameters:

file - Path to the XML document

stopOnFirstError - If true, parsing will stop once any error is found. Otherwise, only a fatal error will stop the process and all errors will be logged.

Returns:

Object containing the result (if successful) and the list of parsing errors (if not).

Throws:

FileNotFoundException - if the file cannot be read.

See Also:

• to validate at the same time as parsing
• to validate after parsing
• to validate after parsing

loadAndValidate

public static LoadResult<Document> loadAndValidate(File file,
 File schema,
 String schemaLang,
 boolean stopOnFirstError)
                                            throws FileNotFoundException

Read and parse a XML document, validating against an internal or external schema.

Parameters:

file - Path to the XML document

schema - Path to the schema

schemaLang - One of the constants in this class denoting a schema language.

stopOnFirstError - If true, validation will stop once any error is found. Otherwise, only a fatal error will stop the process and all errors will be logged.

Returns:

An object containing the result (if successful) and the list of parsing/validation warnings and errors.

Throws:

FileNotFoundException - if the file cannot be loaded.

See Also:

• to parse without validation
• to validate a file without retrieving the data
• to validate after parsing
• to validate after parsing

validate

public static LoadResult<Void> validate(File xmlFile,
 File schemaFile,
 String schemaLanguage,
 boolean stopOnFirstError)

Validates an XML file against a schema. This function never throws.

Parameters:

xmlFile - XML file location, must not be null.

schemaFile - Schema file location. If null, the result depends on the schema language. For XSD, a schema linked by the XML file ("internal schema") will be used.

schemaLanguage - Constant for the schema language to use.

stopOnFirstError - If true, processing will be interrupted on the first error issued.

Returns:

An instance of LoadResult with the parse+validation events. The result field itself is always null.

See Also:

• to also get the DOM document
• to validate a loaded DOM tree
• to validate a loaded DOM tree