com.ctc.wstx.msv

Class GenericMsvValidator

java.lang.Object

org.codehaus.stax2.validation.XMLValidator

com.ctc.wstx.msv.GenericMsvValidator

All Implemented Interfaces:

com.sun.msv.grammar.IDContextProvider2, org.relaxng.datatype.ValidationContext

public final class GenericMsvValidator
extends XMLValidator
implements com.sun.msv.grammar.IDContextProvider2

Generic validator instance to be used for all Multi-Schema Validator backed implementations. A common class can be used since functionality is almost identical between variants (RNG, W3C SChema); minor differences that exist can be configured by settings provided.

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.

Field Summary

Fields

Modifier and Type	Field and Description
protected ArrayList	mAcceptors
protected ValidationContext	mContext
protected com.sun.msv.verifier.Acceptor	mCurrAcceptor
protected String	mCurrAttrLocalName
protected 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

Fields inherited from class org.codehaus.stax2.validation.XMLValidator

CONTENT_ALLOW_ANY_TEXT, CONTENT_ALLOW_NONE, CONTENT_ALLOW_UNDEFINED, CONTENT_ALLOW_VALIDATABLE_TEXT, CONTENT_ALLOW_WS, CONTENT_ALLOW_WS_NONSTRICT

Constructor Summary

Constructors

Constructor and Description
GenericMsvValidator(XMLValidationSchema parent, ValidationContext ctxt, com.sun.msv.verifier.DocumentDeclaration vgm)

Method Summary

Methods

Modifier and Type	Method and Description
String	getAttributeType(int index) Method for getting schema-specified type of an attribute, if information is available.
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(String notationName)
boolean	isUnparsedEntity(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.
String	resolveNamespacePrefix(String prefix)
String	validateAttribute(String localName, String uri, 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.).
String	validateAttribute(String localName, String uri, String prefix, 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(String localName, String uri, String prefix) Method called right after encountering an element close tag.
void	validateElementStart(String localName, String uri, 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(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).

Methods inherited from class org.codehaus.stax2.validation.XMLValidator

getSchemaType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

mParentSchema

protected final XMLValidationSchema mParentSchema

mContext

protected final ValidationContext mContext

mVGM

protected final com.sun.msv.verifier.DocumentDeclaration mVGM

mAcceptors

protected final ArrayList mAcceptors

mCurrAcceptor

protected com.sun.msv.verifier.Acceptor mCurrAcceptor

mTextAccumulator

protected final TextAccumulator mTextAccumulator

mIdDefs

protected ElementIdMap mIdDefs

Map that contains information about element id (values of attributes or textual content with type ID) declarations and references

mCurrAttrPrefix

protected String mCurrAttrPrefix

mCurrAttrLocalName

protected String mCurrAttrLocalName

mProblem

protected XMLValidationProblem mProblem

Sometimes a problem object has to be temporarily stored, and only reported later on. This happens when exceptions can not be thrown via code outside of Woodstox (like validation methods in MSV that do callbacks).

Constructor Detail

GenericMsvValidator

public GenericMsvValidator(XMLValidationSchema parent,
                   ValidationContext ctxt,
                   com.sun.msv.verifier.DocumentDeclaration vgm)

Method Detail

getBaseUri

public String getBaseUri()

Specified by:

getBaseUri in interface org.relaxng.datatype.ValidationContext

isNotation

public boolean isNotation(String notationName)

Specified by:

isNotation in interface org.relaxng.datatype.ValidationContext

isUnparsedEntity

public boolean isUnparsedEntity(String entityName)

Specified by:

isUnparsedEntity in interface org.relaxng.datatype.ValidationContext

resolveNamespacePrefix

public String resolveNamespacePrefix(String prefix)

Specified by:

resolveNamespacePrefix in interface org.relaxng.datatype.ValidationContext

onID

public void onID(org.relaxng.datatype.Datatype datatype,
        com.sun.msv.verifier.regexp.StringToken idToken)
          throws 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.

Specified by:

onID in interface com.sun.msv.grammar.IDContextProvider2

Throws:

IllegalArgumentException

getSchema

public XMLValidationSchema getSchema()

Description copied from class: XMLValidator

Returns the schema instance that created this validator object, if known (and applicable). May return null for some instances: specifically, ValidatorPair will return null since it 'contains' multiple validators and generally does not have just one parent or owner schema.

Specified by:

getSchema in class XMLValidator

validateElementStart

public void validateElementStart(String localName,
                        String uri,
                        String prefix)
                          throws XMLStreamException

Method called to update information about the newly encountered (start) element. At this point namespace information has been resolved, but no DTD validation has been done. Validator is to do these validations, including checking for attribute value (and existence) compatibility.

Specified by:

validateElementStart in class XMLValidator

Throws:

XMLStreamException

validateAttribute

public String validateAttribute(String localName,
                       String uri,
                       String prefix,
                       String value)
                         throws XMLStreamException

Description copied from class: XMLValidator

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

Specified by:

validateAttribute in class XMLValidator

Returns:

Null, if the passed value is fine as is; or a String, if it needs to be replaced. In latter case, caller will replace the value before passing it to other validators. Also, if the attribute value is accessible via caller (as is the case for stream readers), caller should return this value, instead of the original one.

Throws:

XMLStreamException

validateAttribute

public String validateAttribute(String localName,
                       String uri,
                       String prefix,
                       char[] valueChars,
                       int valueStart,
                       int valueEnd)
                         throws XMLStreamException

Description copied from class: XMLValidator

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

Specified by:

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 array

valueEnd - Index of the character AFTER the last character; so that the length of the value String is valueEnd - valueStart

Returns:

Null, if the passed value is fine as is; or a String, if it needs to be replaced. In latter case, caller will replace the value before passing it to other validators. Also, if the attribute value is accessible via caller (as is the case for stream readers), caller should return this value, instead of the original one.

Throws:

XMLStreamException

validateElementAndAttributes

public int validateElementAndAttributes()
                                 throws XMLStreamException

Description copied from class: XMLValidator

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.

Specified by:

validateElementAndAttributes in class XMLValidator

Returns:

One of CONTENT_ALLOW_ constants, to indicate what kind of textual content is allowed at the scope returned to after the element has closed.

Throws:

XMLStreamException

validateElementEnd

public int validateElementEnd(String localName,
                     String uri,
                     String prefix)
                       throws XMLStreamException

Description copied from class: XMLValidator

Method called right after encountering an element close tag.

Specified by:

validateElementEnd in class XMLValidator

Returns:

Validation state that should be effective for the parent element state

Throws:

XMLStreamException

validateText

public void validateText(String text,
                boolean lastTextSegment)
                  throws XMLStreamException

Description copied from class: XMLValidator

Method called to validate textual content.

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.

Specified by:

validateText in class XMLValidator

Parameters:

text - Text content to validate

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.

Throws:

XMLStreamException

validateText

public void validateText(char[] cbuf,
                int textStart,
                int textEnd,
                boolean lastTextSegment)
                  throws XMLStreamException

Description copied from class: XMLValidator

Method called to validate textual content.

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.

Specified by:

validateText in class XMLValidator

Parameters:

cbuf - Character array that contains text content to validate

textStart - Index of the first character of the content to validate

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

Throws:

XMLStreamException

validationCompleted

public void validationCompleted(boolean eod)
                         throws XMLStreamException

Description copied from class: XMLValidator

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

Specified by:

validationCompleted in class XMLValidator

Parameters:

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

Throws:

XMLStreamException

getAttributeType

public String getAttributeType(int index)

Description copied from class: XMLValidator

Method for getting schema-specified type of an attribute, if information is available. If not, validators can return null to explicitly indicate no information was available.

Specified by:

getAttributeType in class XMLValidator

getIdAttrIndex

public int getIdAttrIndex()

Description copied from class: XMLValidator

Method for finding out the index of the attribute that is of type ID; derived from DTD, W4C Schema, or some other validation source. Usually schemas explicitly specifies that at most one attribute can have this type for any element.

Specified by:

getIdAttrIndex in class XMLValidator

Returns:

Index of the attribute with type ID, in the current element, if one exists: -1 otherwise

getNotationAttrIndex

public int getNotationAttrIndex()

Description copied from class: XMLValidator

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. DTD explicitly specifies that at most one attribute can have this type for any element.

Specified by:

getNotationAttrIndex in class XMLValidator

Returns:

Index of the attribute with type NOTATION, in the current element, if one exists: -1 otherwise