dk.heick.properties.types.custom

Class DefaultXmlFileValidator

java.lang.Object

dk.heick.properties.types.custom.DefaultFileValidator

dk.heick.properties.types.custom.DefaultXmlFileValidator

All Implemented Interfaces:

FileValidator, Serializable

public class DefaultXmlFileValidator
extends DefaultFileValidator

The implementation of FileValidator for XML files. An exception is always thrown if the file is null.
This will parse that the XML is wellformed, throwing an exception on "error" and "fatalError" but ignoring "warning". (org.xml.sax.ErrorHandler)
It is now possible (since 1.7) to attach a XSD or DTD file/url to validate against the XML file, be aware that this can take some time before, especially when a remote URL is used.

Since:

1.1

Author:

Frederik Heick

See Also:

DefaultFileValidator, ErrorHandler, XMLUtils.loadXmlFromFile(File), Serialized Form

Field Summary

Fields inherited from class dk.heick.properties.types.custom.DefaultFileValidator

ALL

Constructor Summary

Constructors

Constructor and Description
DefaultXmlFileValidator() Default constructor, where the parameters are: mustExists = true readable = true writable = false acceptFileType = AcceptFileType.FILE
DefaultXmlFileValidator(boolean writable) Constructor, where the parameters are: mustExists = true readable = true acceptFileType = AcceptFileType.FILE
DefaultXmlFileValidator(File schemaFile) Creates a DefaultXmlFileValidator where the XML file will be validated against a schema file.
DefaultXmlFileValidator(String resourceName) Constructor where the file is load through "Class.class.getResource(resourceName);".
DefaultXmlFileValidator(URL schemaUrl) Creates a DefaultXmlFileValidator where the XML file will be validated against a schema url.

Method Summary

Modifier and Type	Method and Description
Document	getDocument(File file) Loads a XML file as an DOM Document and validates it against the defined schema.
org.apache.commons.logging.Log	getLogger() Gets the logger
List<String>	getRestrictions() Gets a detailed description of the FileValidator with any constraints that might influence the validation.
URL	getSchemaUrl() Gets the schema URL,
String	getType() A short string defining the type of "file" the FileValidator is validating.
void	setSchemaUrl(URL schemaUrl) Sets the schema URL
void	validate(String sourceType, String sourceName, String intialValue, File file) Method to implement for validation a File.
void	validateFile(File file) Validates a XML file using the SchemaURL.

Methods inherited from class dk.heick.properties.types.custom.DefaultFileValidator

getAcceptFileType, isMustExists, isReadable, isWriteable

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultXmlFileValidator

public DefaultXmlFileValidator()

Default constructor, where the parameters are:

• mustExists = true
• readable = true
• writable = false
• acceptFileType = AcceptFileType.FILE

DefaultXmlFileValidator

public DefaultXmlFileValidator(File schemaFile)
                        throws PropertyException

Creates a DefaultXmlFileValidator where the XML file will be validated against a schema file.

Parameters:

schemaFile - the schema file, ignored if null.

Throws:

PropertyException - if the schemaFile cannot be converted to a URL representation.

DefaultXmlFileValidator

public DefaultXmlFileValidator(URL schemaUrl)

Creates a DefaultXmlFileValidator where the XML file will be validated against a schema url.

Parameters:

schemaUrl - the schema url, ignored if null.

DefaultXmlFileValidator

public DefaultXmlFileValidator(String resourceName)

Constructor where the file is load through "Class.class.getResource(resourceName);".

Parameters:

resourceName - the path/name of the desired resource

DefaultXmlFileValidator

public DefaultXmlFileValidator(boolean writable)

Constructor, where the parameters are:

• mustExists = true
• readable = true
• acceptFileType = AcceptFileType.FILE

Parameters:

writable - if true test that the file/directory must be writable otherwise an exception is thrown when validating.

Method Detail

getSchemaUrl

public URL getSchemaUrl()

Gets the schema URL,

Returns:

the schema URL, if no schema is set than null is returned.

setSchemaUrl

public void setSchemaUrl(URL schemaUrl)

Sets the schema URL

Parameters:

schemaUrl - the schema url.

validate

public void validate(String sourceType,
                     String sourceName,
                     String intialValue,
                     File file)
              throws PropertyException

Description copied from interface: FileValidator

Method to implement for validation a File.

Specified by:

validate in interface FileValidator

Overrides:

validate in class DefaultFileValidator

Parameters:

sourceType - the type from where the FileValidator is called, this is used to make sensible exception messages.

sourceName - the sourceName of from where the FileValidator is called, this is used to make sensible exception messages.

intialValue - the initial value which the File has been initialized.

file - the file instance.

Throws:

PropertyException - thrown if fails validation. The intention of the message build is sourceType [sourceName with value [intialValue] <the error message> [file.getAbsolutePath()].

getDocument

public Document getDocument(File file)
                     throws PropertyIOException

Loads a XML file as an DOM Document and validates it against the defined schema.

Parameters:

file - the

Returns:

the XML file in DOM Document-

Throws:

PropertyIOException - if loading or validation failed.

See Also:

XMLUtils.loadXmlFromFile(File, URL)

validateFile

public void validateFile(File file)
                  throws PropertyIOException

Validates a XML file using the SchemaURL.

Parameters:

file - the file

Throws:

PropertyIOException - if the file wasnt found or the XML did not validate.

See Also:

getSchemaUrl(), XMLUtils.validateXmlFile(File, URL)

getRestrictions

public List<String> getRestrictions()

Description copied from interface: FileValidator

Gets a detailed description of the FileValidator with any constraints that might influence the validation.

Specified by:

getRestrictions in interface FileValidator

Overrides:

getRestrictions in class DefaultFileValidator

Returns:

the a list of validation restrictions.

getType

public String getType()

Description copied from interface: FileValidator

A short string defining the type of "file" the FileValidator is validating.

Specified by:

getType in interface FileValidator

Overrides:

getType in class DefaultFileValidator

Returns:

the file type which is validated.

getLogger

public org.apache.commons.logging.Log getLogger()

Description copied from interface: FileValidator

Gets the logger

Specified by:

getLogger in interface FileValidator

Overrides:

getLogger in class DefaultFileValidator

Returns:

the logger