org.iso_relax.verifier
Interface Verifier

All Known Implementing Classes:

VerifierImpl

public interface Verifier

An instance of this interface can validates documents.

An instance of this interface can be obtained through the VerifierFactory.newVerifier(java.lang.String) method or Schema.newVerifier() method. Once it is created, an application can use one instance to validate multiple documents.

This interface is not thread-safe and not reentrant. That is, only one thread can use it at any given time, and you can only validate one document at any given time.

Since:

Feb. 23, 2001

Version:

Mar. 4, 2001

Author:

ASAMI, Tomoharu (asami@zeomtech.com)

, Kohsuke KAWAGUCHI

Field Summary

static java.lang.String	FEATURE_FILTER Deprecated.
static java.lang.String	FEATURE_HANDLER Deprecated.

Method Summary

java.lang.Object	getProperty(java.lang.String property) Gets a property value
VerifierFilter	getVerifierFilter() Gets a VerifierFilter.
VerifierHandler	getVerifierHandler() Gets a VerifierHandler.
boolean	isFeature(java.lang.String feature) Checks whether a feature is supported or not.
void	setEntityResolver(EntityResolver handler) Sets a EntityResolver to resolve external entity locations.
void	setErrorHandler(ErrorHandler handler) Sets a ErrorHandler that receives validation errors/warnings.
void	setFeature(java.lang.String feature, boolean value) Sets a value to a feature.
void	setProperty(java.lang.String property, java.lang.Object value) Sets a property value
boolean	verify(java.io.File file) validates an XML document.
boolean	verify(InputSource source) validates an XML document.
boolean	verify(Node node) validates an XML document.
boolean	verify(java.lang.String uri) validates an XML document.

Field Detail

FEATURE_HANDLER

public static final java.lang.String FEATURE_HANDLER

Deprecated.

a read-only feature that checks whether the implementation supports getVerifierHandler method.

Now a verifier implementation is required to support VerifierHandler. Therefore an application doesn't need to check this feature.

See Also:

Constant Field Values

FEATURE_FILTER

public static final java.lang.String FEATURE_FILTER

Deprecated.

a read-only feature that checks whether the implementation supports getVerifierFilter method.

Now a verifier implementation is required to support VerifierFilter. Therefore an application doesn't need to check this feature.

See Also:

Constant Field Values

Method Detail

isFeature

public boolean isFeature(java.lang.String feature)
                  throws SAXNotRecognizedException,
                         SAXNotSupportedException

Checks whether a feature is supported or not.

This method is modeled after SAX2.

Parameters:

feature - feature name

SAXNotRecognizedException

SAXNotSupportedException

setFeature

public void setFeature(java.lang.String feature,
                       boolean value)
                throws SAXNotRecognizedException,
                       SAXNotSupportedException

Sets a value to a feature.

This method is modeled after SAX2.

Parameters:

feature - feature name

value - feature value

SAXNotRecognizedException

SAXNotSupportedException

getProperty

public java.lang.Object getProperty(java.lang.String property)
                             throws SAXNotRecognizedException,
                                    SAXNotSupportedException

Gets a property value

This method is modeled after SAX2.

Parameters:

property - property name

SAXNotRecognizedException

SAXNotSupportedException

setProperty

public void setProperty(java.lang.String property,
                        java.lang.Object value)
                 throws SAXNotRecognizedException,
                        SAXNotSupportedException

Sets a property value

This method is modeled after SAX2.

Parameters:

property - property name

value - property value

SAXNotRecognizedException

SAXNotSupportedException

setErrorHandler

public void setErrorHandler(ErrorHandler handler)

Sets a ErrorHandler that receives validation errors/warnings.

If no error handler is set explicitly, a verifier implementation will not report any error/warning at all. However, the caller can still obtain the result of validation through the return value.

Conscious developers should always set an error handler explicitly as the default behavior has been changed several times.

Parameters:

handler - this object will receive errors/warning encountered during the validation.

setEntityResolver

public void setEntityResolver(EntityResolver handler)

Sets a EntityResolver to resolve external entity locations.

The given entity resolver is used in the verify(String) method and the verify(InputSource) method.

Parameters:

handler - EntityResolver

verify

public boolean verify(java.lang.String uri)
               throws SAXException,
                      java.io.IOException

validates an XML document.

Parameters:

uri - URI of a document.

Returns:

true if the document is valid. false if otherwise.

SAXException

java.io.IOException

verify

public boolean verify(InputSource source)
               throws SAXException,
                      java.io.IOException

validates an XML document.

Parameters:

source - InputSource of a XML document to verify.

Returns:

true if the document is valid. false if otherwise.

SAXException

java.io.IOException

verify

public boolean verify(java.io.File file)
               throws SAXException,
                      java.io.IOException

validates an XML document.

Parameters:

file - File to be validated

Returns:

true if the document is valid. false if otherwise.

SAXException

java.io.IOException

verify

public boolean verify(Node node)
               throws SAXException

validates an XML document.

An implementation is required to accept Document object as the node parameter. If it also implements partial validation, it can also accepts things like Element.

Parameters:

node - the root DOM node of an XML document.

Returns:

true if the document is valid. false if otherwise.

Throws:

java.lang.UnsupportedOperationException - If the node type of the node parameter is something which this implementation does not support.

SAXException

getVerifierHandler

public VerifierHandler getVerifierHandler()
                                   throws SAXException

Gets a VerifierHandler.

you can use the returned VerifierHandler to validate documents through SAX.

Note that two different invocations of this method can return the same value; this method does NOT necessarily create a new VerifierHandler object.

SAXException

getVerifierFilter

public VerifierFilter getVerifierFilter()
                                 throws SAXException

Gets a VerifierFilter.

you can use the returned VerifierHandler to validate documents through SAX.

Note that two different invocations of this method can return the same value; this method does NOT necessarily create a new VerifierFilter object.

SAXException