org.dlese.dpc.xml

Class XMLValidator

java.lang.Object

org.dlese.dpc.xml.XMLValidator

public class XMLValidator
extends java.lang.Object

XMLValidator uses Xerces to parse and validate xml files in a directory or an individual xml file you specify. Each xml file should contain a DOCTYPE declaration or a schema reference, which is used to perform the validation. XMLValidator then writes a report to the file path indicated listing the number of files validated and any validation problems encountered. How: Use JAXP SAXPaser to parse 1 .xml file or all the .xml files in a directory.

Author:

John Weatherley

Field Summary

Fields

Modifier and Type	Field and Description
protected static boolean	DEFAULT_DYNAMIC_VALIDATION Default dynamic validation support (false).
protected static boolean	DEFAULT_MEMORY_USAGE Default memory usage report (false).
protected static boolean	DEFAULT_NAMESPACE_PREFIXES Default namespace prefixes (false).
protected static boolean	DEFAULT_NAMESPACES Default namespaces support (true).
protected static java.lang.String	DEFAULT_PARSER_NAME Default parser name.
protected static boolean	DEFAULT_SCHEMA_FULL_CHECKING Default Schema full checking support (false).
protected static boolean	DEFAULT_SCHEMA_VALIDATION Default Schema validation support (false).
protected static boolean	DEFAULT_TAGGINESS Default "tagginess" report (false).
protected static boolean	DEFAULT_VALIDATION Default validation support (false).
protected static java.lang.String	DYNAMIC_VALIDATION_FEATURE_ID Dynamic validation feature id (http://apache.org/xml/features/validation/dynamic).
protected static java.lang.String	NAMESPACE_PREFIXES_FEATURE_ID Namespace prefixes feature id (http://xml.org/sax/features/namespace-prefixes).
protected static java.lang.String	NAMESPACES_FEATURE_ID Namespaces feature id (http://xml.org/sax/features/namespaces).
protected static java.lang.String	SCHEMA_FULL_CHECKING_FEATURE_ID Schema full checking feature id (http://apache.org/xml/features/validation/schema-full-checking).
protected static java.lang.String	SCHEMA_VALIDATION_FEATURE_ID Schema validation feature id (http://apache.org/xml/features/validation/schema).
protected static java.lang.String	VALIDATION_FEATURE_ID Validation feature id (http://xml.org/sax/features/validation).

Constructor Summary

Constructors

Constructor and Description
XMLValidator()

Method Summary

Modifier and Type	Method and Description
static void	main(java.lang.String[] args) The main program for the XMLValidator class
java.lang.StringBuffer	validate(java.lang.String filePath) Validate a single XML file or directory of XML files.
java.lang.StringBuffer	validate(java.lang.String filePath, java.util.Date modifiedSinceDate)
java.lang.StringBuffer	validate(java.lang.String filePath, java.lang.String[] inputFileNames) Validate a single XML file or directory of XML files, processing only the xml files that match the ID list provided.
java.lang.StringBuffer	validate(java.lang.String filePath, java.lang.String[] inputFileNames, java.lang.String reportFilePath, java.util.Date modifiedSinceDate) Validate a single XML file or directory of XML files.
static java.lang.String	validateFile(java.io.File f) Validates an XML File to the external DTD or schema that is present in the File.
static java.lang.String	validateFile(java.io.File f, boolean showWarnings) Validates an XML File to the external DTD or schema that is present in the File.
static java.lang.String	validateString(java.lang.String s) Validates an XML String to the external DTD or schema that is present in the String.
static java.lang.String	validateString(java.lang.String s, boolean showWarnings) Validates an XML String to the external DTD or schema that is present in the String.
static java.lang.String	validateUri(java.lang.String URI) Validates an XML document at the given URI.
static java.lang.String	validateUri(java.lang.String URI, boolean showWarnings) Validates an XML document at the given URI.

Methods inherited from class java.lang.Object

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

Field Detail

NAMESPACES_FEATURE_ID

protected static final java.lang.String NAMESPACES_FEATURE_ID

Namespaces feature id (http://xml.org/sax/features/namespaces).

See Also:

Constant Field Values

NAMESPACE_PREFIXES_FEATURE_ID

protected static final java.lang.String NAMESPACE_PREFIXES_FEATURE_ID

Namespace prefixes feature id (http://xml.org/sax/features/namespace-prefixes).

See Also:

Constant Field Values

VALIDATION_FEATURE_ID

protected static final java.lang.String VALIDATION_FEATURE_ID

Validation feature id (http://xml.org/sax/features/validation).

See Also:

Constant Field Values

SCHEMA_VALIDATION_FEATURE_ID

protected static final java.lang.String SCHEMA_VALIDATION_FEATURE_ID

Schema validation feature id (http://apache.org/xml/features/validation/schema).

See Also:

Constant Field Values

SCHEMA_FULL_CHECKING_FEATURE_ID

protected static final java.lang.String SCHEMA_FULL_CHECKING_FEATURE_ID

Schema full checking feature id (http://apache.org/xml/features/validation/schema-full-checking).

See Also:

Constant Field Values

DYNAMIC_VALIDATION_FEATURE_ID

protected static final java.lang.String DYNAMIC_VALIDATION_FEATURE_ID

Dynamic validation feature id (http://apache.org/xml/features/validation/dynamic).

See Also:

Constant Field Values

DEFAULT_PARSER_NAME

protected static final java.lang.String DEFAULT_PARSER_NAME

Default parser name.

See Also:

Constant Field Values

DEFAULT_NAMESPACES

protected static final boolean DEFAULT_NAMESPACES

Default namespaces support (true).

See Also:

Constant Field Values

DEFAULT_NAMESPACE_PREFIXES

protected static final boolean DEFAULT_NAMESPACE_PREFIXES

Default namespace prefixes (false).

See Also:

Constant Field Values

DEFAULT_VALIDATION

protected static final boolean DEFAULT_VALIDATION

Default validation support (false).

See Also:

Constant Field Values

DEFAULT_SCHEMA_VALIDATION

protected static final boolean DEFAULT_SCHEMA_VALIDATION

Default Schema validation support (false).

See Also:

Constant Field Values

DEFAULT_SCHEMA_FULL_CHECKING

protected static final boolean DEFAULT_SCHEMA_FULL_CHECKING

Default Schema full checking support (false).

See Also:

Constant Field Values

DEFAULT_DYNAMIC_VALIDATION

protected static final boolean DEFAULT_DYNAMIC_VALIDATION

Default dynamic validation support (false).

See Also:

Constant Field Values

DEFAULT_MEMORY_USAGE

protected static final boolean DEFAULT_MEMORY_USAGE

Default memory usage report (false).

See Also:

Constant Field Values

DEFAULT_TAGGINESS

protected static final boolean DEFAULT_TAGGINESS

Default "tagginess" report (false).

See Also:

Constant Field Values

Constructor Detail

XMLValidator

public XMLValidator()

Method Detail

main

public static void main(java.lang.String[] args)

The main program for the XMLValidator class

Parameters:

args - The command line arguments

validate

public java.lang.StringBuffer validate(java.lang.String filePath)
                                throws java.io.FileNotFoundException,
                                       java.io.IOException,
                                       javax.xml.parsers.ParserConfigurationException,
                                       org.xml.sax.SAXException,
                                       java.lang.Exception

Validate a single XML file or directory of XML files. Same as calling validate(String, null).

Parameters:

filePath - A single XML file or directory contianing XML files to be validated.

Returns:

StringBuffer A StringBuffer containing the validation report.

Throws:

java.io.FileNotFoundException - DESCRIPTION

java.io.IOException - DESCRIPTION

javax.xml.parsers.ParserConfigurationException - DESCRIPTION

org.xml.sax.SAXException - DESCRIPTION

java.lang.Exception - DESCRIPTION

validate

public java.lang.StringBuffer validate(java.lang.String filePath,
                                       java.util.Date modifiedSinceDate)
                                throws java.io.FileNotFoundException,
                                       java.io.IOException,
                                       javax.xml.parsers.ParserConfigurationException,
                                       org.xml.sax.SAXException,
                                       java.lang.Exception

Throws:

java.io.FileNotFoundException

java.io.IOException

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

java.lang.Exception

validate

public java.lang.StringBuffer validate(java.lang.String filePath,
                                       java.lang.String[] inputFileNames)
                                throws java.io.FileNotFoundException,
                                       java.io.IOException,
                                       javax.xml.parsers.ParserConfigurationException,
                                       org.xml.sax.SAXException,
                                       java.lang.Exception

Validate a single XML file or directory of XML files, processing only the xml files that match the ID list provided. Same as calling validate(String, String [], null).

Parameters:

filePath - A single XML file or directory contianing XML files to be validated.

inputFileNames - An array of all the ID names found in the directory indicated in filePath to be validated. If null, then the list of files is obtained from the filePath directory.

Returns:

StringBuffer A StringBuffer containing the validation report.

Throws:

java.io.FileNotFoundException - DESCRIPTION

java.io.IOException - DESCRIPTION

javax.xml.parsers.ParserConfigurationException - DESCRIPTION

org.xml.sax.SAXException - DESCRIPTION

java.lang.Exception - DESCRIPTION

validate

public java.lang.StringBuffer validate(java.lang.String filePath,
                                       java.lang.String[] inputFileNames,
                                       java.lang.String reportFilePath,
                                       java.util.Date modifiedSinceDate)
                                throws java.lang.Exception

Validate a single XML file or directory of XML files. A report of what was found will be output to the given file specified.

Parameters:

filePath - A single XML file or directory contianing XML files to be validated.

inputFileNames - An array of all the ID names found in the directory indicated in filePath to be validated. If null, then the list of files is obtained from the filePath directory. the file list is obtained

reportFilePath - The file where a validation report will be appended. If null then nothing is written.

Returns:

StringBuffer A StringBuffer containing the validation report.

Throws:

java.lang.Exception - DESCRIPTION

validateString

public static final java.lang.String validateString(java.lang.String s)

Validates an XML String to the external DTD or schema that is present in the String. The String must contain a DTD or schema declaration within. Returns null if the String is valid or an appropriate error message if not.

Parameters:

s - An XML String, which must include a DTD or schema declaration.

Returns:

Null if valid, else a String containing an appropriate error message.

validateString

public static final java.lang.String validateString(java.lang.String s,
                                                    boolean showWarnings)

Validates an XML String to the external DTD or schema that is present in the String. The String must contain a DTD or schema declaration within. Returns null if the String is valid or an appropriate error message if not. The output message may contain only warnings if showWarnings is set to true.

Parameters:

s - An XML String, which must include a DTD or schema declaration.

showWarnings - Set to true to check for warnings as well as errors.

Returns:

Null if valid, else a String containing an appropriate error and/or warning message.

validateUri

public static final java.lang.String validateUri(java.lang.String URI)

Validates an XML document at the given URI. URI's must be of the form:

• file:///usr/local/nonesuch.xml - an XML document on the local system.
• http://www.nonesuch.com/nonsuch.xml - an XML document on the Internet.

Parameters:

URI - A URI path to an XML document.

Returns:

Null if valid, else a String containing an appropriate error message.

validateUri

public static final java.lang.String validateUri(java.lang.String URI,
                                                 boolean showWarnings)

Validates an XML document at the given URI. URI's must be of the form:

• file:///usr/local/nonesuch.xml - an XML document on the local system.
• http:///www.nonesuch.com/nonsuch.xml - an XML document on the Internet.

Parameters:

URI - A URI path to an XML document.

showWarnings - Set to true to check for warnings as well as errors.

Returns:

Null if valid, else a String containing an appropriate error message.

validateFile

public static final java.lang.String validateFile(java.io.File f)

Validates an XML File to the external DTD or schema that is present in the File. The File must contain a DTD or schema declaration within. Returns null if the File is valid or an appropriate error message if not.

Parameters:

f - An XML File, which must include a DTD or schema declaration.

Returns:

Null if valid, else a String containing an appropriate error message.

validateFile

public static final java.lang.String validateFile(java.io.File f,
                                                  boolean showWarnings)

Validates an XML File to the external DTD or schema that is present in the File. The File must contain a DTD or schema declaration within. Returns null if the File is valid or an appropriate error message if not. The output message may contain only warnings if showWarnings is set to true.

Parameters:

f - An XML File, which must include a DTD or schema declaration.

showWarnings - Set to true to check for warnings as well as errors.

Returns:

Null if valid, else a String containing an appropriate error and/or warning message.