Package com.ctc.wstx.dtd

Class DTDValidatorBase

  • All Implemented Interfaces:
    NsDefaultProvider
    Direct Known Subclasses:
    DTDTypingNonValidator, DTDValidator
    public abstract class DTDValidatorBase
extends XMLValidator
implements NsDefaultProvider
    Shared abstract base class for Woodstox implementations of XMLValidator for DTD validation. 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 Detail

      • EMPTY_MAP

        protected static final HashMap<String,​EntityDecl> 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.

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

    • 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​(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 abstract 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 abstract 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

      • 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 abstract 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()
        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

      • checkNsDefaults

        public void checkNsDefaults​(InputElementStack nsStack)
                     throws XMLStreamException
        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:
        XMLStreamException

      • hasNsDefaults

        public boolean hasNsDefaults()