Package org.smooks.engine.delivery.sax.ng.org.apache.xerces.impl.dtd

Class XMLDTDValidator

  • All Implemented Interfaces:
    XMLDTDValidatorFilter, RevalidationHandler, XMLComponent, XMLDocumentFilter, XMLDocumentSource, XMLDocumentHandler
    Direct Known Subclasses:
    XML11DTDValidator, XMLNSDTDValidator
    public class XMLDTDValidator
extends Object
implements XMLComponent, XMLDocumentFilter, XMLDTDValidatorFilter, RevalidationHandler
    The DTD validator. The validator implements a document filter: receiving document events from the scanner; validating the content and structure; augmenting the InfoSet, if applicable; and notifying the parser of the information resulting from the validation process.

    Formerly, this component also handled DTD events and grammar construction. To facilitate the development of a meaningful DTD grammar caching/preparsing framework, this functionality has been moved into the XMLDTDLoader class. Therefore, this class no longer implements the DTDFilter or DTDContentModelFilter interfaces.

    This component requires the following features and properties from the component manager that uses it:

    • http://xml.org/sax/features/namespaces
    • http://xml.org/sax/features/validation
    • http://apache.org/xml/features/validation/dynamic
    • http://apache.org/xml/properties/internal/symbol-table
    • http://apache.org/xml/properties/internal/error-reporter
    • http://apache.org/xml/properties/internal/grammar-pool
    • http://apache.org/xml/properties/internal/datatype-validator-factory
    Version:
    $Id$
    Author:
    Eric Ye, IBM, Andy Clark, IBM, Jeffrey Rodriguez IBM, Neil Graham, IBM

    • Field Detail

      • DYNAMIC_VALIDATION

        protected static final String DYNAMIC_VALIDATION
        Feature identifier: dynamic validation.
        See Also:
        Constant Field Values

      • BALANCE_SYNTAX_TREES

        protected static final String BALANCE_SYNTAX_TREES
        Feature identifier: balance syntax trees.
        See Also:
        Constant Field Values

      • WARN_ON_DUPLICATE_ATTDEF

        protected static final String WARN_ON_DUPLICATE_ATTDEF
        Feature identifier: warn on duplicate attdef
        See Also:
        Constant Field Values

      • DATATYPE_VALIDATOR_FACTORY

        protected static final String DATATYPE_VALIDATOR_FACTORY
        Property identifier: datatype validator factory.
        See Also:
        Constant Field Values

      • fNamespaces

        protected boolean fNamespaces
        Namespaces.

      • fValidation

        protected boolean fValidation
        Validation.

      • fDTDValidation

        protected boolean fDTDValidation
        Validation against only DTD

      • fDynamicValidation

        protected boolean fDynamicValidation
        Dynamic validation. This state of this feature is only useful when the validation feature is set to true.

      • fBalanceSyntaxTrees

        protected boolean fBalanceSyntaxTrees
        Controls whether the DTD grammar produces balanced syntax trees.

      • fWarnDuplicateAttdef

        protected boolean fWarnDuplicateAttdef
        warn on duplicate attribute definition, this feature works only when validation is true

      • fSymbolTable

        protected SymbolTable fSymbolTable
        Symbol table.

      • fNamespaceContext

        protected NamespaceContext fNamespaceContext
        Namespace support.

      • fDatatypeValidatorFactory

        protected DTDDVFactory fDatatypeValidatorFactory
        Datatype validator factory.

      • fDTDGrammar

        protected DTDGrammar fDTDGrammar
        DTD Grammar.

      • fSeenDoctypeDecl

        protected boolean fSeenDoctypeDecl
        True if seen DOCTYPE declaration.

      • fValENTITIES

        protected DatatypeValidator fValENTITIES
        Datatype validator: ENTITIES.

      • fValNMTOKENS

        protected DatatypeValidator fValNMTOKENS
        Datatype validator: NMTOKENS.

      • fValNOTATION

        protected DatatypeValidator fValNOTATION
        Datatype validator: NOTATION.

    • Constructor Detail

      • XMLDTDValidator

        public XMLDTDValidator()
        Default constructor.

    • Method Detail

      • getRecognizedFeatures

        public String[] getRecognizedFeatures()
        Returns a list of feature identifiers that are recognized by this component. This method may return null if no features are recognized by this component.
        Specified by:
        getRecognizedFeatures in interface XMLComponent

      • setFeature

        public void setFeature​(String featureId,
                       boolean state)
                throws XMLConfigurationException
        Sets the state of a feature. This method is called by the component manager any time after reset when a feature changes state.

        Note: Components should silently ignore features that do not affect the operation of the component.

        Specified by:
        setFeature in interface XMLComponent
        Parameters:
        featureId - The feature identifier.
        state - The state of the feature.
        Throws:
        SAXNotRecognizedException - The component should not throw this exception.
        SAXNotSupportedException - The component should not throw this exception.
        XMLConfigurationException - Thrown for configuration error. In general, components should only throw this exception if it is really a critical error.

      • getRecognizedProperties

        public String[] getRecognizedProperties()
        Returns a list of property identifiers that are recognized by this component. This method may return null if no properties are recognized by this component.
        Specified by:
        getRecognizedProperties in interface XMLComponent

      • setProperty

        public void setProperty​(String propertyId,
                        Object value)
                 throws XMLConfigurationException
        Sets the value of a property. This method is called by the component manager any time after reset when a property changes value.

        Note: Components should silently ignore properties that do not affect the operation of the component.

        Specified by:
        setProperty in interface XMLComponent
        Parameters:
        propertyId - The property identifier.
        value - The value of the property.
        Throws:
        SAXNotRecognizedException - The component should not throw this exception.
        SAXNotSupportedException - The component should not throw this exception.
        XMLConfigurationException - Thrown for configuration error. In general, components should only throw this exception if it is really a critical error.

      • getFeatureDefault

        public Boolean getFeatureDefault​(String featureId)
        Returns the default state for a feature, or null if this component does not want to report a default value for this feature.
        Specified by:
        getFeatureDefault in interface XMLComponent
        Parameters:
        featureId - The feature identifier.
        Since:
        Xerces 2.2.0

      • getPropertyDefault

        public Object getPropertyDefault​(String propertyId)
        Returns the default state for a property, or null if this component does not want to report a default value for this property.
        Specified by:
        getPropertyDefault in interface XMLComponent
        Parameters:
        propertyId - The property identifier.
        Since:
        Xerces 2.2.0

      • startDocument

        public void startDocument​(XMLLocator locator,
                          String encoding,
                          NamespaceContext namespaceContext,
                          Augmentations augs)
                   throws XNIException
        The start of the document.
        Specified by:
        startDocument in interface XMLDocumentHandler
        Parameters:
        locator - The system identifier of the entity if the entity is external, null otherwise.
        encoding - The auto-detected IANA encoding name of the entity stream. This value will be null in those situations where the entity encoding is not auto-detected (e.g. internal entities or a document entity that is parsed from a java.io.Reader).
        namespaceContext - The namespace context in effect at the start of this document. This object represents the current context. Implementors of this class are responsible for copying the namespace bindings from the the current context (and its parent contexts) if that information is important.
        augs - Additional information that may include infoset augmentations
        Throws:
        XNIException - Thrown by handler to signal an error.

      • xmlDecl

        public void xmlDecl​(String version,
                    String encoding,
                    String standalone,
                    Augmentations augs)
             throws XNIException
        Notifies of the presence of an XMLDecl line in the document. If present, this method will be called immediately following the startDocument call.
        Specified by:
        xmlDecl in interface XMLDocumentHandler
        Parameters:
        version - The XML version.
        encoding - The IANA encoding name of the document, or null if not specified.
        standalone - The standalone value, or null if not specified.
        augs - Additional information that may include infoset augmentations
        Throws:
        XNIException - Thrown by handler to signal an error.

      • doctypeDecl

        public void doctypeDecl​(String rootElement,
                        String publicId,
                        String systemId,
                        Augmentations augs)
                 throws XNIException
        Notifies of the presence of the DOCTYPE line in the document.
        Specified by:
        doctypeDecl in interface XMLDocumentHandler
        Parameters:
        rootElement - The name of the root element.
        publicId - The public identifier if an external DTD or null if the external DTD is specified using SYSTEM.
        systemId - The system identifier if an external DTD, null otherwise.
        augs - Additional information that may include infoset augmentations
        Throws:
        XNIException - Thrown by handler to signal an error.

      • startElement

        public void startElement​(QName element,
                         XMLAttributes attributes,
                         Augmentations augs)
                  throws XNIException
        The start of an element.
        Specified by:
        startElement in interface XMLDocumentHandler
        Parameters:
        element - The name of the element.
        attributes - The element attributes.
        augs - Additional information that may include infoset augmentations
        Throws:
        XNIException - Thrown by handler to signal an error.

      • ignorableWhitespace

        public void ignorableWhitespace​(XMLString text,
                                Augmentations augs)
                         throws XNIException
        Ignorable whitespace. For this method to be called, the document source must have some way of determining that the text containing only whitespace characters should be considered ignorable. For example, the validator can determine if a length of whitespace characters in the document are ignorable based on the element content model.
        Specified by:
        ignorableWhitespace in interface XMLDocumentHandler
        Parameters:
        text - The ignorable whitespace.
        augs - Additional information that may include infoset augmentations
        Throws:
        XNIException - Thrown by handler to signal an error.

      • endElement

        public void endElement​(QName element,
                       Augmentations augs)
                throws XNIException
        The end of an element.
        Specified by:
        endElement in interface XMLDocumentHandler
        Parameters:
        element - The name of the element.
        augs - Additional information that may include infoset augmentations
        Throws:
        XNIException - Thrown by handler to signal an error.

      • processingInstruction

        public void processingInstruction​(String target,
                                  XMLString data,
                                  Augmentations augs)
                           throws XNIException
        A processing instruction. Processing instructions consist of a target name and, optionally, text data. The data is only meaningful to the application.

        Typically, a processing instruction's data will contain a series of pseudo-attributes. These pseudo-attributes follow the form of element attributes but are not parsed or presented to the application as anything other than text. The application is responsible for parsing the data.

        Specified by:
        processingInstruction in interface XMLDocumentHandler
        Parameters:
        target - The target.
        data - The data or null if none specified.
        augs - Additional information that may include infoset augmentations
        Throws:
        XNIException - Thrown by handler to signal an error.

      • startGeneralEntity

        public void startGeneralEntity​(String name,
                               XMLResourceIdentifier identifier,
                               String encoding,
                               Augmentations augs)
                        throws XNIException
        This method notifies the start of a general entity.

        Note: This method is not called for entity references appearing as part of attribute values.

        Specified by:
        startGeneralEntity in interface XMLDocumentHandler
        Parameters:
        name - The name of the general entity.
        identifier - The resource identifier.
        encoding - The auto-detected IANA encoding name of the entity stream. This value will be null in those situations where the entity encoding is not auto-detected (e.g. internal entities or a document entity that is parsed from a java.io.Reader).
        augs - Additional information that may include infoset augmentations
        Throws:
        XNIException - Thrown by handler to signal an error.

      • endGeneralEntity

        public void endGeneralEntity​(String name,
                             Augmentations augs)
                      throws XNIException
        This method notifies the end of a general entity.

        Note: This method is not called for entity references appearing as part of attribute values.

        Specified by:
        endGeneralEntity in interface XMLDocumentHandler
        Parameters:
        name - The name of the entity.
        augs - Additional information that may include infoset augmentations
        Throws:
        XNIException - Thrown by handler to signal an error.

      • textDecl

        public void textDecl​(String version,
                     String encoding,
                     Augmentations augs)
              throws XNIException
        Notifies of the presence of a TextDecl line in an entity. If present, this method will be called immediately following the startParameterEntity call.

        Note: This method is only called for external parameter entities referenced in the DTD.

        Specified by:
        textDecl in interface XMLDocumentHandler
        Parameters:
        version - The XML version, or null if not specified.
        encoding - The IANA encoding name of the entity.
        augs - Additional information that may include infoset augmentations.
        Throws:
        XNIException - Thrown by handler to signal an error.

      • hasGrammar

        public final boolean hasGrammar()
        Description copied from interface: XMLDTDValidatorFilter
        Returns true if the validator has a DTD grammar
        Specified by:
        hasGrammar in interface XMLDTDValidatorFilter
        Returns:
        true if the validator has a DTD grammar

      • validate

        public final boolean validate()
        Description copied from interface: XMLDTDValidatorFilter
        Return true if validator must validate the document
        Specified by:
        validate in interface XMLDTDValidatorFilter
        Returns:
        true if validator must validate the document

      • addDTDDefaultAttrsAndValidate

        protected void addDTDDefaultAttrsAndValidate​(QName elementName,
                                             int elementIndex,
                                             XMLAttributes attributes)
                                      throws XNIException
        Add default attributes and validate.
        Throws:
        XNIException

      • getExternalEntityRefInAttrValue

        protected String getExternalEntityRefInAttrValue​(String nonNormalizedValue)
        Checks entities in attribute values for standalone VC.

      • invalidStandaloneAttDef

        protected boolean invalidStandaloneAttDef​(QName element,
                                          QName attribute)
        Returns true if invalid standalone attribute definition.

      • init

        protected void init()
        initialization

      • endNamespaceScope

        protected void endNamespaceScope​(QName element,
                                 Augmentations augs,
                                 boolean isEmpty)

      • isSpace

        protected boolean isSpace​(int c)