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

Class XMLDTDProcessor

  • All Implemented Interfaces:
    XMLComponent, XMLDTDContentModelFilter, XMLDTDContentModelSource, XMLDTDFilter, XMLDTDSource, XMLDTDContentModelHandler, XMLDTDHandler
    Direct Known Subclasses:
    XMLDTDLoader
    public class XMLDTDProcessor
extends Object
implements XMLComponent, XMLDTDFilter, XMLDTDContentModelFilter
    The DTD processor. The processor implements a DTD filter: receiving DTD events from the DTD scanner; validating the content and structure; building a grammar, if applicable; and notifying the DTDHandler of the information resulting from the process.

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

    • http://xml.org/sax/features/namespaces
    • 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:
    Neil Graham, IBM

    • Field Detail

      • NOTIFY_CHAR_REFS

        protected static final String NOTIFY_CHAR_REFS
        Feature identifier: notify character references.
        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

      • WARN_ON_UNDECLARED_ELEMDEF

        protected static final String WARN_ON_UNDECLARED_ELEMDEF
        Feature identifier: warn on undeclared element referenced in content model.
        See Also:
        Constant Field Values

      • fValidation

        protected boolean fValidation
        Validation.

      • fDTDValidation

        protected boolean fDTDValidation
        Validation against only DTD

      • fWarnDuplicateAttdef

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

      • fWarnOnUndeclaredElemdef

        protected boolean fWarnOnUndeclaredElemdef
        warn on undeclared element referenced in content model, this feature only works when valiation is true

      • fSymbolTable

        protected SymbolTable fSymbolTable
        Symbol table.

      • fLocale

        protected Locale fLocale

      • fDTDGrammar

        protected DTDGrammar fDTDGrammar
        DTD Grammar.

      • fInDTDIgnore

        protected boolean fInDTDIgnore
        True if in an ignore conditional section of the DTD.

    • Constructor Detail

      • XMLDTDProcessor

        public XMLDTDProcessor()
        Default constructor.

    • Method Detail

      • reset

        protected void reset()

      • 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

      • setDTDHandler

        public void setDTDHandler​(XMLDTDHandler dtdHandler)
        Sets the DTD handler.
        Specified by:
        setDTDHandler in interface XMLDTDSource
        Parameters:
        dtdHandler - The DTD handler.

      • endExternalSubset

        public void endExternalSubset​(Augmentations augs)
                       throws XNIException
        The end of the DTD external subset.
        Specified by:
        endExternalSubset in interface XMLDTDHandler
        Parameters:
        augs - Additional information that may include infoset augmentations.
        Throws:
        XNIException - Thrown by handler to signal an error.

      • checkStandaloneEntityRef

        protected static void checkStandaloneEntityRef​(String name,
                                               DTDGrammar grammar,
                                               XMLEntityDecl tempEntityDecl,
                                               XMLErrorReporter errorReporter)
                                        throws XNIException
        Check standalone entity reference. Made static to make common between the validator and loader.
        Parameters:
        name -
        grammar - grammar to which entity belongs
        tempEntityDecl - empty entity declaration to put results in
        errorReporter - error reporter to send errors to
        Throws:
        XNIException - Thrown by application to signal an error.

      • comment

        public void comment​(XMLString text,
                    Augmentations augs)
             throws XNIException
        A comment.
        Specified by:
        comment in interface XMLDTDHandler
        Parameters:
        text - The text in the comment.
        augs - Additional information that may include infoset augmentations
        Throws:
        XNIException - Thrown by application 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 XMLDTDHandler
        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.

      • startDTD

        public void startDTD​(XMLLocator locator,
                     Augmentations augs)
              throws XNIException
        The start of the DTD.
        Specified by:
        startDTD in interface XMLDTDHandler
        Parameters:
        locator - The document locator, or null if the document location cannot be reported during the parsing of the document DTD. However, it is strongly recommended that a locator be supplied that can at least report the base system identifier of the DTD.
        augs - Additional information that may include infoset augmentations.
        Throws:
        XNIException - Thrown by handler to signal an error.

      • ignoredCharacters

        public void ignoredCharacters​(XMLString text,
                              Augmentations augs)
                       throws XNIException
        Characters within an IGNORE conditional section.
        Specified by:
        ignoredCharacters in interface XMLDTDHandler
        Parameters:
        text - The ignored text.
        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 XMLDTDHandler
        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.

      • startParameterEntity

        public void startParameterEntity​(String name,
                                 XMLResourceIdentifier identifier,
                                 String encoding,
                                 Augmentations augs)
                          throws XNIException
        This method notifies of the start of a parameter entity. The parameter entity name start with a '%' character.
        Specified by:
        startParameterEntity in interface XMLDTDHandler
        Parameters:
        name - The name of the parameter 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 parameter entities).
        augs - Additional information that may include infoset augmentations.
        Throws:
        XNIException - Thrown by handler to signal an error.

      • endParameterEntity

        public void endParameterEntity​(String name,
                               Augmentations augs)
                        throws XNIException
        This method notifies the end of a parameter entity. Parameter entity names begin with a '%' character.
        Specified by:
        endParameterEntity in interface XMLDTDHandler
        Parameters:
        name - The name of the parameter entity.
        augs - Additional information that may include infoset augmentations.
        Throws:
        XNIException - Thrown by handler to signal an error.

      • elementDecl

        public void elementDecl​(String name,
                        String contentModel,
                        Augmentations augs)
                 throws XNIException
        An element declaration.
        Specified by:
        elementDecl in interface XMLDTDHandler
        Parameters:
        name - The name of the element.
        contentModel - The element content model.
        augs - Additional information that may include infoset augmentations.
        Throws:
        XNIException - Thrown by handler to signal an error.

      • startAttlist

        public void startAttlist​(String elementName,
                         Augmentations augs)
                  throws XNIException
        The start of an attribute list.
        Specified by:
        startAttlist in interface XMLDTDHandler
        Parameters:
        elementName - The name of the element that this attribute list is associated with.
        augs - Additional information that may include infoset augmentations.
        Throws:
        XNIException - Thrown by handler to signal an error.

      • attributeDecl

        public void attributeDecl​(String elementName,
                          String attributeName,
                          String type,
                          String[] enumeration,
                          String defaultType,
                          XMLString defaultValue,
                          XMLString nonNormalizedDefaultValue,
                          Augmentations augs)
                   throws XNIException
        An attribute declaration.
        Specified by:
        attributeDecl in interface XMLDTDHandler
        Parameters:
        elementName - The name of the element that this attribute is associated with.
        attributeName - The name of the attribute.
        type - The attribute type. This value will be one of the following: "CDATA", "ENTITY", "ENTITIES", "ENUMERATION", "ID", "IDREF", "IDREFS", "NMTOKEN", "NMTOKENS", or "NOTATION".
        enumeration - If the type has the value "ENUMERATION" or "NOTATION", this array holds the allowed attribute values; otherwise, this array is null.
        defaultType - The attribute default type. This value will be one of the following: "#FIXED", "#IMPLIED", "#REQUIRED", or null.
        defaultValue - The attribute default value, or null if no default value is specified.
        nonNormalizedDefaultValue - The attribute default value with no normalization performed, or null if no default value is specified.
        augs - Additional information that may include infoset augmentations.
        Throws:
        XNIException - Thrown by handler to signal an error.

      • endAttlist

        public void endAttlist​(Augmentations augs)
                throws XNIException
        The end of an attribute list.
        Specified by:
        endAttlist in interface XMLDTDHandler
        Parameters:
        augs - Additional information that may include infoset augmentations.
        Throws:
        XNIException - Thrown by handler to signal an error.

      • internalEntityDecl

        public void internalEntityDecl​(String name,
                               XMLString text,
                               XMLString nonNormalizedText,
                               Augmentations augs)
                        throws XNIException
        An internal entity declaration.
        Specified by:
        internalEntityDecl in interface XMLDTDHandler
        Parameters:
        name - The name of the entity. Parameter entity names start with '%', whereas the name of a general entity is just the entity name.
        text - The value of the entity.
        nonNormalizedText - The non-normalized value of the entity. This value contains the same sequence of characters that was in the internal entity declaration, without any entity references expanded.
        augs - Additional information that may include infoset augmentations.
        Throws:
        XNIException - Thrown by handler to signal an error.

      • externalEntityDecl

        public void externalEntityDecl​(String name,
                               XMLResourceIdentifier identifier,
                               Augmentations augs)
                        throws XNIException
        An external entity declaration.
        Specified by:
        externalEntityDecl in interface XMLDTDHandler
        Parameters:
        name - The name of the entity. Parameter entity names start with '%', whereas the name of a general entity is just the entity name.
        identifier - An object containing all location information pertinent to this external entity.
        augs - Additional information that may include infoset augmentations.
        Throws:
        XNIException - Thrown by handler to signal an error.

      • unparsedEntityDecl

        public void unparsedEntityDecl​(String name,
                               XMLResourceIdentifier identifier,
                               String notation,
                               Augmentations augs)
                        throws XNIException
        An unparsed entity declaration.
        Specified by:
        unparsedEntityDecl in interface XMLDTDHandler
        Parameters:
        name - The name of the entity.
        identifier - An object containing all location information pertinent to this entity.
        notation - The name of the notation.
        augs - Additional information that may include infoset augmentations.
        Throws:
        XNIException - Thrown by handler to signal an error.

      • notationDecl

        public void notationDecl​(String name,
                         XMLResourceIdentifier identifier,
                         Augmentations augs)
                  throws XNIException
        A notation declaration
        Specified by:
        notationDecl in interface XMLDTDHandler
        Parameters:
        name - The name of the notation.
        identifier - An object containing all location information pertinent to this notation.
        augs - Additional information that may include infoset augmentations.
        Throws:
        XNIException - Thrown by handler to signal an error.

      • endConditional

        public void endConditional​(Augmentations augs)
                    throws XNIException
        The end of a conditional section.
        Specified by:
        endConditional in interface XMLDTDHandler
        Parameters:
        augs - Additional information that may include infoset augmentations.
        Throws:
        XNIException - Thrown by handler to signal an error.

      • endDTD

        public void endDTD​(Augmentations augs)
            throws XNIException
        The end of the DTD.
        Specified by:
        endDTD in interface XMLDTDHandler
        Parameters:
        augs - Additional information that may include infoset augmentations.
        Throws:
        XNIException - Thrown by handler to signal an error.

      • startContentModel

        public void startContentModel​(String elementName,
                              Augmentations augs)
                       throws XNIException
        The start of a content model. Depending on the type of the content model, specific methods may be called between the call to the startContentModel method and the call to the endContentModel method.
        Specified by:
        startContentModel in interface XMLDTDContentModelHandler
        Parameters:
        elementName - The name of the element.
        augs - Additional information that may include infoset augmentations.
        Throws:
        XNIException - Thrown by handler to signal an error.

      • element

        public void element​(String elementName,
                    Augmentations augs)
             throws XNIException
        A referenced element in a mixed or children content model.
        Specified by:
        element in interface XMLDTDContentModelHandler
        Parameters:
        elementName - The name of the referenced element.
        augs - Additional information that may include infoset augmentations.
        Throws:
        XNIException - Thrown by handler to signal an error.

      • isValidNmtoken

        protected boolean isValidNmtoken​(String nmtoken)

      • isValidName

        protected boolean isValidName​(String name)