com.sun.msv.verifier

Interface IVerifier

All Superinterfaces:
VerifierHandler
Known Implementing Classes:
IDConstraintChecker, TypeDetector, Verifier, VerifierFilter

public interface IVerifier
extends VerifierHandler

Interface of verifier.
Author:
Kohsuke KAWAGUCHI

Method Summary

Object
getCurrentElementType()
returns current element type.
ErrorHandler
getErrorHandler()
Datatype[]
getLastCharacterType()
gets DataType that validated the last characters.
Locator
getLocator()
boolean
isValid()
checks if the document was valid.
void
setErrorHandler(ErrorHandler handler)
void
setPanicMode(boolean usePanicMode)
Turns on/off the panic mode.

Method Details

getCurrentElementType

public Object getCurrentElementType()
returns current element type. Actual java type depends on the implementation. This method works correctly only when called immediately after handling startElement event.
Returns:
null this method returns null when it doesn't support type-assignment feature, or type-assignment is impossible for the current element (for example due to the ambiguous grammar).

getErrorHandler

public ErrorHandler getErrorHandler()

getLastCharacterType

public Datatype[] getLastCharacterType()
gets DataType that validated the last characters.

This method works correctly only when called immediately after startElement and endElement method. When called, this method returns DataType object that validated the last character literals.

For RELAX NG grammar, this method can return an array of length 2 or more. This happens when the last character matches <list> pattern. In that case, each type corresponds to each token (where tokens are the white-space separation of the last characters).

For any other grammar, this method always returns an array of length 1 (or null, if the type assignment failed).

So when you are using VerifierFilter, you can call this method only in your startElement and endElement method.

Returns:
null if type-assignment was not possible.

getLocator

public Locator getLocator()

isValid

public boolean isValid()
checks if the document was valid. This method may not be called before verification was completed.

setErrorHandler

public void setErrorHandler(ErrorHandler handler)

setPanicMode

public void setPanicMode(boolean usePanicMode)
Turns on/off the panic mode. Panic mode is on by default. Turning it on is good for general use. It prevents false error messages to appear.

However, turning it off is sometimes useful, when you are sure that the structure of the document is almost valid (e.g., validating a document generated by an application or when you are sure about the validity of the structure and only interested in validating datatypes,)