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 org.codehaus.stax2.validation.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
(package private) java.util.ArrayList<java.lang.Object>	mAcceptors
(package private) AttributeProxy	mAttributeProxy This object provides limited access to attribute values of the currently validated element.
(package private) org.codehaus.stax2.validation.ValidationContext	mContext
(package private) com.sun.msv.verifier.Acceptor	mCurrAcceptor
(package private) java.lang.String	mCurrAttrLocalName
(package private) java.lang.String	mCurrAttrPrefix
(package private) com.sun.msv.util.StringRef	mErrorRef
(package private) ElementIdMap	mIdDefs Map that contains information about element id (values of attributes or textual content with type ID) declarations and references
(package private) org.codehaus.stax2.validation.XMLValidationSchema	mParentSchema
(package private) org.codehaus.stax2.validation.XMLValidationProblem	mProblem Sometimes a problem object has to be temporarily stored, and only reported later on.
(package private) com.sun.msv.util.StartTagInfo	mStartTag StartTagInfo instance need not be thread-safe, and it is not immutable so let's reuse one instance during a single validation.
(package private) TextAccumulator	mTextAccumulator
(package private) 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(org.codehaus.stax2.validation.XMLValidationSchema parent, org.codehaus.stax2.validation.ValidationContext ctxt, com.sun.msv.verifier.DocumentDeclaration vgm)

Method Summary

Modifier and Type	Method and Description
(package private) void	doValidateText(TextAccumulator textAcc)
java.lang.String	getAttributeType(int index)
(package private) PrefixedName	getAttrPName()
java.lang.String	getBaseUri()
(package private) PrefixedName	getElementPName()
int	getIdAttrIndex()
int	getNotationAttrIndex()
org.codehaus.stax2.validation.XMLValidationSchema	getSchema()
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.
private void	reportError(java.lang.String msg)
private void	reportError(java.lang.String msg, javax.xml.stream.Location loc)
private void	reportError(com.sun.msv.util.StringRef errorRef)
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)
java.lang.String	validateAttribute(java.lang.String localName, java.lang.String uri, java.lang.String prefix, java.lang.String value)
int	validateElementAndAttributes()
int	validateElementEnd(java.lang.String localName, java.lang.String uri, java.lang.String prefix)
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)
void	validateText(java.lang.String text, boolean lastTextSegment)
void	validationCompleted(boolean eod)

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

final org.codehaus.stax2.validation.XMLValidationSchema mParentSchema

mContext

final org.codehaus.stax2.validation.ValidationContext mContext

mVGM

final com.sun.msv.verifier.DocumentDeclaration mVGM

mAcceptors

final java.util.ArrayList<java.lang.Object> mAcceptors

mCurrAcceptor

com.sun.msv.verifier.Acceptor mCurrAcceptor

mTextAccumulator

final TextAccumulator mTextAccumulator

mIdDefs

ElementIdMap mIdDefs

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

mCurrAttrPrefix

java.lang.String mCurrAttrPrefix

mCurrAttrLocalName

java.lang.String mCurrAttrLocalName

mProblem

org.codehaus.stax2.validation.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).

mErrorRef

final com.sun.msv.util.StringRef mErrorRef

mStartTag

final com.sun.msv.util.StartTagInfo mStartTag

StartTagInfo instance need not be thread-safe, and it is not immutable so let's reuse one instance during a single validation.

mAttributeProxy

final AttributeProxy mAttributeProxy

This object provides limited access to attribute values of the currently validated element.

Constructor Detail

GenericMsvValidator

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

Method Detail

getBaseUri

public java.lang.String getBaseUri()

Specified by:

getBaseUri in interface org.relaxng.datatype.ValidationContext

isNotation

public boolean isNotation(java.lang.String notationName)

Specified by:

isNotation in interface org.relaxng.datatype.ValidationContext

isUnparsedEntity

public boolean isUnparsedEntity(java.lang.String entityName)

Specified by:

isUnparsedEntity in interface org.relaxng.datatype.ValidationContext

resolveNamespacePrefix

public java.lang.String resolveNamespacePrefix(java.lang.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 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.

Specified by:

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

Throws:

java.lang.IllegalArgumentException

getSchema

public org.codehaus.stax2.validation.XMLValidationSchema getSchema()

Specified by:

getSchema in class org.codehaus.stax2.validation.XMLValidator

validateElementStart

public void validateElementStart(java.lang.String localName,
                                 java.lang.String uri,
                                 java.lang.String prefix)
                          throws javax.xml.stream.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 org.codehaus.stax2.validation.XMLValidator

Throws:

javax.xml.stream.XMLStreamException

validateAttribute

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

Specified by:

validateAttribute in class org.codehaus.stax2.validation.XMLValidator

Throws:

javax.xml.stream.XMLStreamException

validateAttribute

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

Specified by:

validateAttribute in class org.codehaus.stax2.validation.XMLValidator

Throws:

javax.xml.stream.XMLStreamException

validateElementAndAttributes

public int validateElementAndAttributes()
                                 throws javax.xml.stream.XMLStreamException

Specified by:

validateElementAndAttributes in class org.codehaus.stax2.validation.XMLValidator

Throws:

javax.xml.stream.XMLStreamException

validateElementEnd

public int validateElementEnd(java.lang.String localName,
                              java.lang.String uri,
                              java.lang.String prefix)
                       throws javax.xml.stream.XMLStreamException

Specified by:

validateElementEnd in class org.codehaus.stax2.validation.XMLValidator

Returns:

Validation state that should be effective for the parent element state

Throws:

javax.xml.stream.XMLStreamException

validateText

public void validateText(java.lang.String text,
                         boolean lastTextSegment)
                  throws javax.xml.stream.XMLStreamException

Specified by:

validateText in class org.codehaus.stax2.validation.XMLValidator

Throws:

javax.xml.stream.XMLStreamException

validateText

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

Specified by:

validateText in class org.codehaus.stax2.validation.XMLValidator

Throws:

javax.xml.stream.XMLStreamException

validationCompleted

public void validationCompleted(boolean eod)
                         throws javax.xml.stream.XMLStreamException

Specified by:

validationCompleted in class org.codehaus.stax2.validation.XMLValidator

Throws:

javax.xml.stream.XMLStreamException

getAttributeType

public java.lang.String getAttributeType(int index)

Specified by:

getAttributeType in class org.codehaus.stax2.validation.XMLValidator

getIdAttrIndex

public int getIdAttrIndex()

Specified by:

getIdAttrIndex in class org.codehaus.stax2.validation.XMLValidator

getNotationAttrIndex

public int getNotationAttrIndex()

Specified by:

getNotationAttrIndex in class org.codehaus.stax2.validation.XMLValidator

getElementPName

PrefixedName getElementPName()

getAttrPName

PrefixedName getAttrPName()

doValidateText

void doValidateText(TextAccumulator textAcc)
             throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

reportError

private void reportError(com.sun.msv.util.StringRef errorRef)
                  throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

reportError

private void reportError(java.lang.String msg)
                  throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

reportError

private void reportError(java.lang.String msg,
                         javax.xml.stream.Location loc)
                  throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException