org.iso_relax.verifier

Interface Verifier

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 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.

Version:
Mar. 4, 2001
Authors:
ASAMI, Tomoharu (asami@zeomtech.com)
Kohsuke KAWAGUCHI
Since:
Feb. 23, 2001

Field Summary

static String
FEATURE_FILTER
Deprecated.
static String
FEATURE_HANDLER
Deprecated.

Method Summary

Object
getProperty(String property)
Gets a property value

This method is modeled after SAX2.

VerifierFilter
getVerifierFilter()
Gets a VerifierFilter.
VerifierHandler
getVerifierHandler()
Gets a VerifierHandler.
boolean
isFeature(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(String feature, boolean value)
Sets a value to a feature.
void
setProperty(String property, Object value)
Sets a property value

This method is modeled after SAX2.

boolean
verify(File file)
validates an XML document.
boolean
verify(InputSource source)
validates an XML document.
boolean
verify(Node node)
validates an XML document.
boolean
verify(String uri)
validates an XML document.

Field Details

FEATURE_FILTER

public static final 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.


FEATURE_HANDLER

public static final 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.

Method Details

getProperty

public Object getProperty(String property)
            throws SAXNotRecognizedException,
                   SAXNotSupportedException
Gets a property value

This method is modeled after SAX2.

Parameters:
property - property name

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.


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.


isFeature

public boolean isFeature(String feature)
            throws SAXNotRecognizedException,
                   SAXNotSupportedException
Checks whether a feature is supported or not.

This method is modeled after SAX2.

Parameters:
feature - feature name

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

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.

setFeature

public void setFeature(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

setProperty

public void setProperty(String property,
                        Object value)
            throws SAXNotRecognizedException,
                   SAXNotSupportedException
Sets a property value

This method is modeled after SAX2.

Parameters:
property - property name
value - property value

verify

public boolean verify(File file)
            throws SAXException,
                   IOException
validates an XML document.
Parameters:
file - File to be validated
Returns:
true if the document is valid. false if otherwise.

verify

public boolean verify(InputSource source)
            throws SAXException,
                   IOException
validates an XML document.
Parameters:
source - InputSource of a XML document to verify.
Returns:
true if the document is valid. false if otherwise.

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.

verify

public boolean verify(String uri)
            throws SAXException,
                   IOException
validates an XML document.
Parameters:
uri - URI of a document.
Returns:
true if the document is valid. false if otherwise.