com.ctc.wstx.msv
public final class GenericMsvValidator extends XMLValidator implements com.sun.msv.grammar.IDContextProvider2
Note about id context provider interface: while it'd be nice to separate that part out, it is unfortunately closely tied to the validation process. Hence it's directly implemented by this class.
Modifier and Type | Field and Description |
---|---|
protected java.util.ArrayList |
mAcceptors |
protected ValidationContext |
mContext |
protected com.sun.msv.verifier.Acceptor |
mCurrAcceptor |
protected java.lang.String |
mCurrAttrLocalName |
protected java.lang.String |
mCurrAttrPrefix |
protected ElementIdMap |
mIdDefs
Map that contains information about element id (values of attributes
or textual content with type ID) declarations and references
|
protected XMLValidationSchema |
mParentSchema |
protected XMLValidationProblem |
mProblem
Sometimes a problem object has to be temporarily
stored, and only reported later on.
|
protected TextAccumulator |
mTextAccumulator |
protected com.sun.msv.verifier.DocumentDeclaration |
mVGM |
CONTENT_ALLOW_ANY_TEXT, CONTENT_ALLOW_NONE, CONTENT_ALLOW_UNDEFINED, CONTENT_ALLOW_VALIDATABLE_TEXT, CONTENT_ALLOW_WS, CONTENT_ALLOW_WS_NONSTRICT
Constructor and Description |
---|
GenericMsvValidator(XMLValidationSchema parent,
ValidationContext ctxt,
com.sun.msv.verifier.DocumentDeclaration vgm) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAttributeType(int index)
Method for getting schema-specified type of an attribute, if
information is available.
|
java.lang.String |
getBaseUri() |
int |
getIdAttrIndex()
Method for finding out the index of the attribute that
is of type ID; derived from DTD, W4C Schema, or some other validation
source.
|
int |
getNotationAttrIndex()
Method for finding out the index of the attribute (collected using
the attribute collector; having DTD/Schema-derived info in same order)
that is of type NOTATION.
|
XMLValidationSchema |
getSchema()
Returns the schema instance that created this validator
object, if known (and applicable).
|
boolean |
isNotation(java.lang.String notationName) |
boolean |
isUnparsedEntity(java.lang.String entityName) |
void |
onID(org.relaxng.datatype.Datatype datatype,
com.sun.msv.verifier.regexp.StringToken idToken)
Note: we have to throw a dummy marker exception, which merely
signals that a validation problem is to be reported.
|
java.lang.String |
resolveNamespacePrefix(java.lang.String prefix) |
java.lang.String |
validateAttribute(java.lang.String localName,
java.lang.String uri,
java.lang.String prefix,
char[] valueChars,
int valueStart,
int valueEnd)
Callback method called on validator to give it a chance to validate
the value of an attribute, as well as to normalize its value if
appropriate (remove leading/trailing/intervening white space for
certain token types etc.).
|
java.lang.String |
validateAttribute(java.lang.String localName,
java.lang.String uri,
java.lang.String prefix,
java.lang.String value)
Callback method called on validator to give it a chance to validate
the value of an attribute, as well as to normalize its value if
appropriate (remove leading/trailing/intervening white space for
certain token types etc.).
|
int |
validateElementAndAttributes()
Method called after calling
XMLValidator.validateAttribute(java.lang.String, java.lang.String, java.lang.String, java.lang.String) on all
attributes (if any), but before starting to handle element
content. |
int |
validateElementEnd(java.lang.String localName,
java.lang.String uri,
java.lang.String prefix)
Method called right after encountering an element close tag.
|
void |
validateElementStart(java.lang.String localName,
java.lang.String uri,
java.lang.String prefix)
Method called to update information about the newly encountered (start)
element.
|
void |
validateText(char[] cbuf,
int textStart,
int textEnd,
boolean lastTextSegment)
Method called to validate textual content.
|
void |
validateText(java.lang.String text,
boolean lastTextSegment)
Method called to validate textual content.
|
void |
validationCompleted(boolean eod)
Method called when the validation is completed; either due to the
input stream ending, or due to an explicit 'stop validation' request
by the application (via context object).
|
getSchemaType
protected final XMLValidationSchema mParentSchema
protected final ValidationContext mContext
protected final com.sun.msv.verifier.DocumentDeclaration mVGM
protected final java.util.ArrayList mAcceptors
protected com.sun.msv.verifier.Acceptor mCurrAcceptor
protected final TextAccumulator mTextAccumulator
protected ElementIdMap mIdDefs
protected java.lang.String mCurrAttrPrefix
protected java.lang.String mCurrAttrLocalName
protected XMLValidationProblem mProblem
public GenericMsvValidator(XMLValidationSchema parent, ValidationContext ctxt, com.sun.msv.verifier.DocumentDeclaration vgm)
public java.lang.String getBaseUri()
getBaseUri
in interface org.relaxng.datatype.ValidationContext
public boolean isNotation(java.lang.String notationName)
isNotation
in interface org.relaxng.datatype.ValidationContext
public boolean isUnparsedEntity(java.lang.String entityName)
isUnparsedEntity
in interface org.relaxng.datatype.ValidationContext
public java.lang.String resolveNamespacePrefix(java.lang.String prefix)
resolveNamespacePrefix
in interface org.relaxng.datatype.ValidationContext
public void onID(org.relaxng.datatype.Datatype datatype, com.sun.msv.verifier.regexp.StringToken idToken) throws java.lang.IllegalArgumentException
Note: we have to throw a dummy marker exception, which merely signals that a validation problem is to be reported. This is obviously messy, but has to do for now.
onID
in interface com.sun.msv.grammar.IDContextProvider2
java.lang.IllegalArgumentException
public XMLValidationSchema getSchema()
XMLValidator
ValidatorPair
will return null since it 'contains' multiple validators
and generally does not have just one parent or owner schema.getSchema
in class XMLValidator
public void validateElementStart(java.lang.String localName, java.lang.String uri, java.lang.String prefix) throws javax.xml.stream.XMLStreamException
validateElementStart
in class XMLValidator
javax.xml.stream.XMLStreamException
public java.lang.String validateAttribute(java.lang.String localName, java.lang.String uri, java.lang.String prefix, java.lang.String value) throws javax.xml.stream.XMLStreamException
XMLValidator
validateAttribute
in class XMLValidator
javax.xml.stream.XMLStreamException
public java.lang.String validateAttribute(java.lang.String localName, java.lang.String uri, java.lang.String prefix, char[] valueChars, int valueStart, int valueEnd) throws javax.xml.stream.XMLStreamException
XMLValidator
validateAttribute
in class XMLValidator
valueChars
- Character array that contains value (possibly
along with some other text)valueStart
- Index of the first character of the value in
in valueChars
arrayvalueEnd
- Index of the character AFTER the last character;
so that the length of the value String is
valueEnd - valueStart
javax.xml.stream.XMLStreamException
public int validateElementAndAttributes() throws javax.xml.stream.XMLStreamException
XMLValidator
XMLValidator.validateAttribute(java.lang.String, java.lang.String, java.lang.String, java.lang.String)
on all
attributes (if any), but before starting to handle element
content.validateElementAndAttributes
in class XMLValidator
CONTENT_ALLOW_
constants, to indicate
what kind of textual content is allowed at the scope returned
to after the element has closed.javax.xml.stream.XMLStreamException
public int validateElementEnd(java.lang.String localName, java.lang.String uri, java.lang.String prefix) throws javax.xml.stream.XMLStreamException
XMLValidator
validateElementEnd
in class XMLValidator
javax.xml.stream.XMLStreamException
public void validateText(java.lang.String text, boolean lastTextSegment) throws javax.xml.stream.XMLStreamException
XMLValidator
Note: this method is only guaranteed to be called when
XMLValidator.validateElementAndAttributes()
for the currently open
element returned XMLValidator.CONTENT_ALLOW_VALIDATABLE_TEXT
(or,
in case of mixed content, XMLValidator.validateElementEnd(java.lang.String, java.lang.String, java.lang.String)
, for the
last enclosed element). Otherwise, validator context may choose
not to call the method as an optimization.
validateText
in class XMLValidator
text
- Text content to validatelastTextSegment
- Whether this text content is the last text
segment before a close element; true if it is, false if it is not,
or no determination can be made. Can be used for optimizing
validation -- if this is true, no text needs to be buffered since
no more will be sent before the current element closes.javax.xml.stream.XMLStreamException
public void validateText(char[] cbuf, int textStart, int textEnd, boolean lastTextSegment) throws javax.xml.stream.XMLStreamException
XMLValidator
Note: this method is only guaranteed to be called when
XMLValidator.validateElementAndAttributes()
for the currently open
element returned XMLValidator.CONTENT_ALLOW_VALIDATABLE_TEXT
(or,
in case of mixed content, XMLValidator.validateElementEnd(java.lang.String, java.lang.String, java.lang.String)
, for the
last enclosed element). Otherwise, validator context may choose
not to call the method as an optimization.
validateText
in class XMLValidator
cbuf
- Character array that contains text content to validatetextStart
- Index of the first character of the content to
validatetextEnd
- Character following the last character of the
content to validate (that is, length of content to validate is
textEnd - textStart
).lastTextSegment
- Whether this text content is the last text
segment before a close element; true if it is, false if it is not,
or no determination can be made. Can be used for optimizing
validation -- if this is true, no text needs to be buffered since
no more will be sent before the current element closes.javax.xml.stream.XMLStreamException
public void validationCompleted(boolean eod) throws javax.xml.stream.XMLStreamException
XMLValidator
validationCompleted
in class XMLValidator
eod
- Flag that indicates whether this method was called by the
context due to the end of the stream (true); or by an application
requesting end of validation (false).javax.xml.stream.XMLStreamException
public java.lang.String getAttributeType(int index)
XMLValidator
getAttributeType
in class XMLValidator
public int getIdAttrIndex()
XMLValidator
getIdAttrIndex
in class XMLValidator
public int getNotationAttrIndex()
XMLValidator
getNotationAttrIndex
in class XMLValidator