Class Verifier
- All Implemented Interfaces:
IDContextProvider2
,IVerifier
,org.iso_relax.verifier.VerifierHandler
,org.relaxng.datatype.ValidationContext
,ContentHandler
,DTDHandler
- Direct Known Subclasses:
IDConstraintChecker
,TREXIslandVerifier
,TypeDetector
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final DatatypeRef
the same instance is reused by the feedAttribute method to reduce the number of the object creation.private final DatatypeRef
this field is used to receive type information of character literals.protected Acceptor
private static final int
protected final DocumentDeclaration
Schema object against which the validation will be doneprivate Set
Stores all duplicate id values.static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
protected ErrorHandler
Error handlerprotected boolean
This flag will be set to true if an error is foundprivate int
Initial panic level when an error is found.private boolean
This flag will be set to true after endDocument method is called.protected int
Panic level.(package private) Verifier.Context
context stackprivate final StartTagInfo
An object used to store start tag information.private int
current string care level.private StringBuffer
characters that were read (but not processed)Fields inherited from class com.sun.msv.verifier.AbstractVerifier
dummyLocator, idrefs, ids, locator, namespaceSupport, performIDcheck
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
characters
(char[] buf, int start, int len) void
void
endElement
(String namespaceUri, String localName, String qName) protected org.relaxng.datatype.Datatype[]
returns current element type.final ErrorHandler
org.relaxng.datatype.Datatype[]
gets DataType that validated the last characters.void
ignorableWhitespace
(char[] buf, int start, int len) protected void
init()
final boolean
isValid()
checks if the document was valid.static String
localizeMessage
(String propertyName, Object[] args) void
onDuplicateId
(String id) this method is called when a duplicate id value is found.protected ValidityViolation
signals an error.protected ValidityViolation
protected void
onNextAcceptorReady
(StartTagInfo sti, Acceptor nextAcceptor) this method is called from the startElement method after the tag name is processed and the child acceptor is created.final void
setErrorHandler
(ErrorHandler handler) final void
setPanicMode
(boolean usePanicMode) Turns on/off the panic mode.void
void
startElement
(String namespaceUri, String localName, String qName, Attributes atts) protected void
Methods inherited from class com.sun.msv.verifier.AbstractVerifier
endPrefixMapping, getBaseUri, getLocator, isNotation, isUnparsedEntity, notationDecl, onID, processingInstruction, resolveNamespacePrefix, setDocumentLocator, skippedEntity, startPrefixMapping, unparsedEntityDecl
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.xml.sax.ContentHandler
endPrefixMapping, processingInstruction, setDocumentLocator, skippedEntity, startPrefixMapping
Methods inherited from interface com.sun.msv.verifier.IVerifier
getLocator
-
Field Details
-
current
-
stack
Verifier.Context stackcontext stack -
stringCareLevel
private int stringCareLevelcurrent string care level. See Acceptor.getStringCareLevel -
text
characters that were read (but not processed) -
errorHandler
Error handler -
hadError
protected boolean hadErrorThis flag will be set to true if an error is found -
isFinished
private boolean isFinishedThis flag will be set to true after endDocument method is called. -
sti
An object used to store start tag information. the same object is reused. -
docDecl
Schema object against which the validation will be done -
panicLevel
protected int panicLevelPanic level. If the level is non-zero, createChildAcceptors will silently recover from error. This effectively suppresses spurious error messages. This value is set to INITIAL_PANIC_LEVEL when first an error is encountered, and is decreased by successful stepForward and createChildAcceptor. This value is also propagated to child acceptors. -
initialPanicLevel
private int initialPanicLevelInitial panic level when an error is found. If this value is bigger, MSV will take more time to recover from errors, Setting this value to 0 means turning the panic mode off entirely. -
DEFAULT_PANIC_LEVEL
private static final int DEFAULT_PANIC_LEVEL- See Also:
-
characterType
this field is used to receive type information of character literals. -
attributeType
the same instance is reused by the feedAttribute method to reduce the number of the object creation. -
duplicateIds
Stores all duplicate id values. Errors are reported at the endDocument method because the onDuplicateId method cannot throw an exception. -
ERR_UNEXPECTED_TEXT
- See Also:
-
ERR_UNEXPECTED_ATTRIBUTE
- See Also:
-
ERR_MISSING_ATTRIBUTE
- See Also:
-
ERR_UNEXPECTED_STARTTAG
- See Also:
-
ERR_UNCOMPLETED_CONTENT
- See Also:
-
ERR_UNEXPECTED_ELEMENT
- See Also:
-
ERR_UNSOLD_IDREF
- See Also:
-
ERR_DUPLICATE_ID
- See Also:
-
-
Constructor Details
-
Verifier
-
-
Method Details
-
getErrorHandler
- Specified by:
getErrorHandler
in interfaceIVerifier
-
setErrorHandler
- Specified by:
setErrorHandler
in interfaceIVerifier
-
isValid
public final boolean isValid()Description copied from interface:IVerifier
checks if the document was valid. This method may not be called before verification was completed. -
setPanicMode
public final void setPanicMode(boolean usePanicMode) Description copied from interface:IVerifier
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,)
- Specified by:
setPanicMode
in interfaceIVerifier
-
getLastCharacterType
public org.relaxng.datatype.Datatype[] getLastCharacterType()Description copied from interface:IVerifier
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.
- Specified by:
getLastCharacterType
in interfaceIVerifier
- Returns:
- null if type-assignment was not possible.
-
verifyText
- Throws:
SAXException
-
startElement
public void startElement(String namespaceUri, String localName, String qName, Attributes atts) throws SAXException - Specified by:
startElement
in interfaceContentHandler
- Overrides:
startElement
in classAbstractVerifier
- Throws:
SAXException
-
onNextAcceptorReady
this method is called from the startElement method after the tag name is processed and the child acceptor is created.This method is called before the attributes are consumed.
derived class can use this method to do something useful.
- Throws:
SAXException
-
feedAttribute
protected org.relaxng.datatype.Datatype[] feedAttribute(Acceptor child, String uri, String localName, String qName, String value) throws SAXException - Throws:
SAXException
-
endElement
- Specified by:
endElement
in interfaceContentHandler
- Overrides:
endElement
in classAbstractVerifier
- Throws:
SAXException
-
onError
protected ValidityViolation onError(StringRef ref, String defaultMsg, ErrorInfo ei) throws SAXException signals an error. This method can be overrided by the derived class to provide different behavior.- Throws:
SAXException
-
onError
- Throws:
SAXException
-
getCurrentElementType
Description copied from interface:IVerifier
returns current element type. Actual java type depends on the implementation. This method works correctly only when called immediately after handling startElement event.- Specified by:
getCurrentElementType
in interfaceIVerifier
- 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).
-
characters
- Specified by:
characters
in interfaceContentHandler
- Throws:
SAXException
-
ignorableWhitespace
- Specified by:
ignorableWhitespace
in interfaceContentHandler
- Throws:
SAXException
-
init
protected void init()- Overrides:
init
in classAbstractVerifier
-
startDocument
- Specified by:
startDocument
in interfaceContentHandler
- Throws:
SAXException
-
endDocument
- Specified by:
endDocument
in interfaceContentHandler
- Throws:
SAXException
-
onDuplicateId
Description copied from class:AbstractVerifier
this method is called when a duplicate id value is found.- Specified by:
onDuplicateId
in classAbstractVerifier
-
localizeMessage
-