Package org.custommonkey.xmlunit

Class Validator

java.lang.Object

org.xml.sax.helpers.DefaultHandler

org.custommonkey.xmlunit.Validator

All Implemented Interfaces:

ContentHandler, DTDHandler, EntityResolver, ErrorHandler

public class Validator
extends DefaultHandler

Validates XML against its internal or external DOCTYPE, or a completely different DOCTYPE. Usage:

• new Validator(readerForXML);
  to validate some XML that contains or references an accessible DTD or schema
• new Validator(readerForXML, systemIdForValidation);
  to validate some XML that references a DTD but using a local systemId to perform the validation
• new Validator(readerForXML, systemIdForValidation, doctypeName);
  to validate some XML against a completely different DTD

Constructor Summary

Constructors

Modifier	Constructor	Description
	Validator(Reader readerForValidation)	Basic constructor.
	Validator(Reader readerForValidation, String systemID)	Extended constructor.
	Validator(Reader readerForValidation, String systemID, String doctype)	Full constructor.
	Validator(String stringForValidation)	Basic constructor.
	Validator(String stringForValidation, String systemID)	Extended constructor.
	Validator(Document document, String systemID, String doctype)	DOM-style constructor: allows Document validation post-manipulation of the DOM tree's contents.
	Validator(InputSource sourceForValidation)	Basic constructor.
	Validator(InputSource sourceForValidation, String systemID)	Extended constructor.
protected	Validator(InputSource inputSource, String systemId, boolean usingDoctypeReader)	Baseline constructor: called by all others
	Validator(InputSource sourceForValidation, String systemID, String doctype)	Full constructor.

Method Summary

Modifier and Type	Method	Description
void	assertIsValid()	Assert that a document is valid.
boolean	isValid()	Perform the validation of the source against DTD / Schema.
void	setJAXP12SchemaSource(Object schemaSource)	As per JAXP 1.2 changes, which introduced a standard way for parsers to support schema validation.
String	toString()
void	useXMLSchema(boolean use)	Turn on XML Schema validation.

Methods inherited from class org.xml.sax.helpers.DefaultHandler

characters, endDocument, endElement, endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, setDocumentLocator, skippedEntity, startDocument, startElement, startPrefixMapping, unparsedEntityDecl, warning

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xml.sax.ContentHandler

declaration

Constructor Details

Validator

protected Validator(InputSource inputSource,
 String systemId,
 boolean usingDoctypeReader)

Baseline constructor: called by all others

Parameters:

inputSource - document to validate

systemId - system id of the DTD to use during validation

usingDoctypeReader - whether to use DoctypeReader

Validator

public Validator(Document document,
 String systemID,
 String doctype)

DOM-style constructor: allows Document validation post-manipulation of the DOM tree's contents. This takes a fairly tortuous route to validation as DOM level 2 does not allow creation of Doctype nodes. The supplied systemId and doctype name will replace any Doctype settings in the Document.

Parameters:

document - document to validate

systemID - system id of the DTD to use during validation

doctype - overrides the document's doctype

Validator

public Validator(Reader readerForValidation)

Basic constructor. Validates the contents of the Reader using the DTD or schema referenced by those contents.

Parameters:

readerForValidation - document to validate

Validator

public Validator(String stringForValidation)

Basic constructor. Validates the contents of the String using the DTD or schema referenced by those contents.

Parameters:

stringForValidation - document to validate

Validator

public Validator(InputSource sourceForValidation)

Basic constructor. Validates the contents of the InputSource using the DTD or schema referenced by those contents.

Parameters:

sourceForValidation - document to validate

Validator

public Validator(Reader readerForValidation,
 String systemID)

Extended constructor. Validates the contents of the Reader using the DTD specified with the systemID. There must be DOCTYPE instruction in the markup that references the DTD or else the markup will be considered invalid: if there is no DOCTYPE in the markup use the 3-argument constructor

Parameters:

readerForValidation - document to validate

systemID - system id of the DTD to use during validation

Validator

public Validator(String stringForValidation,
 String systemID)

Extended constructor. Validates the contents of the String using the DTD specified with the systemID. There must be DOCTYPE instruction in the markup that references the DTD or else the markup will be considered invalid: if there is no DOCTYPE in the markup use the 3-argument constructor

Parameters:

stringForValidation - document to validate

systemID - system id of the DTD to use during validation

Validator

public Validator(InputSource sourceForValidation,
 String systemID)

Extended constructor. Validates the contents of the InputSource using the DTD specified with the systemID. There must be DOCTYPE instruction in the markup that references the DTD or else the markup will be considered invalid: if there is no DOCTYPE in the markup use the 3-argument constructor

Parameters:

sourceForValidation - document to validate

systemID - system id of the DTD to use during validation

Validator

public Validator(InputSource sourceForValidation,
 String systemID,
 String doctype)

Full constructor. Validates the contents of the InputSource using the DTD specified with the systemID and named with the doctype name.

Parameters:

sourceForValidation - document to validate

systemID - system id of the DTD to use during validation

doctype - overrides the document's doctype

Validator

public Validator(Reader readerForValidation,
 String systemID,
 String doctype)

Full constructor. Validates the contents of the Reader using the DTD specified with the systemID and named with the doctype name.

Parameters:

readerForValidation - document to validate

systemID - system id of the DTD to use during validation

doctype - overrides the document's doctype

Method Details

useXMLSchema

public void useXMLSchema(boolean use)

Turn on XML Schema validation.

This feature should work with any XML parser that is JAXP 1.2 compliant and supports XML Schema validation.

For a fully JAXP 1.2 compliant parser the property http://java.sun.com/xml/jaxp/properties/schemaLanguage is set, if this fails the method falls back to the features http://apache.org/xml/features/validation/schema & http://apache.org/xml/features/validation/dynamic which should cover early versions of Xerces 2 as well.

Parameters:

use - indicate that XML Schema should be used to validate documents.

See Also:

• setJAXP12SchemaSource(Object)

isValid

public boolean isValid()

Perform the validation of the source against DTD / Schema.

Returns:

true if the input supplied to the constructor passes validation, false otherwise

assertIsValid

public void assertIsValid()

Assert that a document is valid.

toString

public String toString()

Overrides:

toString in class Object

Returns:

class name appended with validation messages

setJAXP12SchemaSource

public void setJAXP12SchemaSource(Object schemaSource)

As per JAXP 1.2 changes, which introduced a standard way for parsers to support schema validation. Since only W3C Schema support was included in JAXP 1.2, this is the only mechanism currently supported by this method.

Parameters:

schemaSource - This can be one of the following:

• String that points to the URI of the schema
• InputStream with the contents of the schema
• SAX InputSource
• File
• an array of Objects with the contents being one of the types defined above. An array of Objects can be used only when the schema language has the ability to assemble a schema at runtime. When an array of Objects is passed it is illegal to have two schemas that share the same namespace.

See Also:

• "http://java.sun.com/webservices/jaxp/change-requests-11.html"