com.ctc.wstx.dtd
Class DTDValidatorBase

java.lang.Object
  extended by org.codehaus.stax2.validation.XMLValidator
      extended by com.ctc.wstx.dtd.DTDValidatorBase
All Implemented Interfaces:
NsDefaultProvider
Direct Known Subclasses:
DTDTypingNonValidator, DTDValidator

public abstract class DTDValidatorBase
extends XMLValidator
implements NsDefaultProvider

Shared abstract for Woodstox implementations of XMLValidator. Since there are 2 sub-types -- full actual DTD validator, and a dummy one that only adds type information and default values, with no actual validation -- common functionality was refactored into this base class.


Field Summary
protected static java.util.HashMap EMPTY_MAP
          Let's actually just reuse a local Map...
protected  int mAttrCount
          Number of attribute specification Objects in mAttrSpecs; needed to store in case type information is requested later on.
protected  DTDAttribute[] mAttrSpecs
          List of attribute declarations/specifications, one for each attribute of the current element, for which there is a matching value (either explicitly defined, or assigned via defaulting).
protected  java.util.HashMap mCurrAttrDefs
          Attribute definitions for attributes the current element may have
protected  DTDElement mCurrElem
          This is the element that is currently being validated; valid during validateElementStart, validateAttribute, validateElementAndAttributes calls.
protected  int mElemCount
          Number of elements in mElems.
protected  DTDElement[] mElems
          Stack of element definitions matching the current active element stack.
protected  int mIdAttrIndex
          Index of the attribute of type ID, within current element's attribute list.
protected  boolean mNormAttrs
          Flag that indicates whether parser wants the attribute values to be normalized (according to XML specs) or not (which may be more efficient, although not compliant with the specs)
protected  NameKey mTmpKey
           
 
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
 
Constructor Summary
DTDValidatorBase(DTDSubset schema, ValidationContext ctxt, boolean hasNsDefaults, java.util.Map elemSpecs, java.util.Map genEntities)
           
 
Method Summary
 void checkNsDefaults(InputElementStack nsStack)
          Method called by the input element stack to indicate that it has just added local namespace declarations from the current element, and is about to start resolving element and attribute namespace bindings.
protected  void doAddDefaultValue(DTDAttribute attr)
           
protected  void doReportProblem(java.lang.String msg, javax.xml.stream.Location loc)
           
 java.lang.String getAttributeType(int index)
          Method for getting schema-specified type of an attribute, if information is available.
 int getIdAttrIndex()
          Method for finding out the index of the attribute (collected using the attribute collector; having DTD-derived info in same order) that is of type ID.
protected abstract  com.ctc.wstx.dtd.ElementIdMap getIdMap()
           
 int getNotationAttrIndex()
          Method for finding out the index of the attribute (collected using the attribute collector; having DTD-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 hasNsDefaults()
           
 boolean mayHaveNsDefaults(java.lang.String elemPrefix, java.lang.String elemLN)
          Calling this method before checkNsDefaults(com.ctc.wstx.sr.InputElementStack) is necessary to pass information regarding the current element; although it will become available later on (via normal XMLValidator interface), that's too late (after namespace binding and resolving).
abstract  boolean reallyValidating()
           
 void setAttrValueNormalization(boolean state)
          Method that allows enabling/disabling attribute value normalization.
abstract  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.).
abstract  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.).
abstract  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.
abstract  int validateElementEnd(java.lang.String localName, java.lang.String uri, java.lang.String prefix)
          Method called right after encountering an element close tag.
abstract  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.
abstract  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

EMPTY_MAP

protected static final java.util.HashMap EMPTY_MAP
Let's actually just reuse a local Map...


mNormAttrs

protected boolean mNormAttrs
Flag that indicates whether parser wants the attribute values to be normalized (according to XML specs) or not (which may be more efficient, although not compliant with the specs)


mCurrElem

protected DTDElement mCurrElem
This is the element that is currently being validated; valid during validateElementStart, validateAttribute, validateElementAndAttributes calls.


mElems

protected DTDElement[] mElems
Stack of element definitions matching the current active element stack. Instances are elements definitions read from DTD.


mElemCount

protected int mElemCount
Number of elements in mElems.


mCurrAttrDefs

protected java.util.HashMap mCurrAttrDefs
Attribute definitions for attributes the current element may have


mAttrSpecs

protected DTDAttribute[] mAttrSpecs
List of attribute declarations/specifications, one for each attribute of the current element, for which there is a matching value (either explicitly defined, or assigned via defaulting).


mAttrCount

protected int mAttrCount
Number of attribute specification Objects in mAttrSpecs; needed to store in case type information is requested later on.


mIdAttrIndex

protected int mIdAttrIndex
Index of the attribute of type ID, within current element's attribute list. Track of this is kept separate from other attribute since id attributes often need to be used for resolving cross-references.


mTmpKey

protected final transient NameKey mTmpKey
Constructor Detail

DTDValidatorBase

public DTDValidatorBase(DTDSubset schema,
                        ValidationContext ctxt,
                        boolean hasNsDefaults,
                        java.util.Map elemSpecs,
                        java.util.Map genEntities)
Method Detail

setAttrValueNormalization

public void setAttrValueNormalization(boolean state)
Method that allows enabling/disabling attribute value normalization. In general, readers by default enable normalization (to be fully xml compliant), whereas writers do not (since there is usually little to gain, if anything -- it is even possible value may be written before validation is called in some cases)


reallyValidating

public abstract boolean reallyValidating()
Returns:
True for validator object that actually do validate content; false for objects that only use DTD type information.

getSchema

public final 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 abstract void validateElementStart(java.lang.String localName,
                                          java.lang.String uri,
                                          java.lang.String prefix)
                                   throws XMLValidationException
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:
XMLValidationException

validateAttribute

public abstract java.lang.String validateAttribute(java.lang.String localName,
                                                   java.lang.String uri,
                                                   java.lang.String prefix,
                                                   java.lang.String value)
                                            throws XMLValidationException
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:
XMLValidationException

validateAttribute

public abstract java.lang.String validateAttribute(java.lang.String localName,
                                                   java.lang.String uri,
                                                   java.lang.String prefix,
                                                   char[] valueChars,
                                                   int valueStart,
                                                   int valueEnd)
                                            throws XMLValidationException
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:
XMLValidationException

validateElementAndAttributes

public abstract int validateElementAndAttributes()
                                          throws XMLValidationException
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:
XMLValidationException

validateElementEnd

public abstract int validateElementEnd(java.lang.String localName,
                                       java.lang.String uri,
                                       java.lang.String prefix)
                                throws XMLValidationException
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:
XMLValidationException

validateText

public void validateText(java.lang.String text,
                         boolean lastTextSegment)
                  throws XMLValidationException
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:
XMLValidationException

validateText

public void validateText(char[] cbuf,
                         int textStart,
                         int textEnd,
                         boolean lastTextSegment)
                  throws XMLValidationException
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:
XMLValidationException

validationCompleted

public abstract void validationCompleted(boolean eod)
                                  throws XMLValidationException
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:
XMLValidationException

getAttributeType

public java.lang.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()
Method for finding out the index of the attribute (collected using the attribute collector; having DTD-derived info in same order) that is of type ID. DTD 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()
Method for finding out the index of the attribute (collected using the attribute collector; having DTD-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

mayHaveNsDefaults

public boolean mayHaveNsDefaults(java.lang.String elemPrefix,
                                 java.lang.String elemLN)
Calling this method before checkNsDefaults(com.ctc.wstx.sr.InputElementStack) is necessary to pass information regarding the current element; although it will become available later on (via normal XMLValidator interface), that's too late (after namespace binding and resolving).

Specified by:
mayHaveNsDefaults in interface NsDefaultProvider

checkNsDefaults

public void checkNsDefaults(InputElementStack nsStack)
                     throws XMLValidationException
Description copied from interface: NsDefaultProvider
Method called by the input element stack to indicate that it has just added local namespace declarations from the current element, and is about to start resolving element and attribute namespace bindings. This provider instance is to add namespace declarations from attribute defaults, if any, using callbacks to the input element stack.

Specified by:
checkNsDefaults in interface NsDefaultProvider
Throws:
XMLValidationException

getIdMap

protected abstract com.ctc.wstx.dtd.ElementIdMap getIdMap()

hasNsDefaults

public boolean hasNsDefaults()

doReportProblem

protected void doReportProblem(java.lang.String msg,
                               javax.xml.stream.Location loc)
                        throws XMLValidationException
Throws:
XMLValidationException

doAddDefaultValue

protected void doAddDefaultValue(DTDAttribute attr)
                          throws XMLValidationException
Throws:
XMLValidationException