Package org.smooks.engine.delivery.sax.ng.org.apache.xerces.parsers

Class AbstractXMLDocumentParser

    • Field Detail

      • fInDTD

        protected boolean fInDTD
        True if inside DTD.

    • Constructor Detail

      • AbstractXMLDocumentParser

        protected AbstractXMLDocumentParser​(XMLParserConfiguration config)
        Constructs a document parser using the default symbol table and grammar pool.

    • Method Detail

      • 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
        augs - Additional information that may include infoset augmentations otherwise.
        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. If the document specifies the start element by using an empty tag, then the startElement method will immediately be followed by the endElement method, with no intervening methods.
        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.

      • startGeneralEntity

        public void startGeneralEntity​(String name,
                               XMLResourceIdentifier identifier,
                               String encoding,
                               Augmentations augs)
                        throws XNIException
        This method notifies the start of an 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 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.

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

        Note: This method will never be called for the document entity; it is only called for external general entities referenced in document content.

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

        Specified by:
        textDecl in interface XMLDocumentHandler
        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.

      • endGeneralEntity

        public void endGeneralEntity​(String name,
                             Augmentations augs)
                      throws XNIException
        This method notifies the end of an 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.

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

      • endExternalSubset

        public void endExternalSubset​(Augmentations augmentations)
                       throws XNIException
        The end of the DTD external subset.
        Specified by:
        endExternalSubset in interface XMLDTDHandler
        Parameters:
        augmentations - 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 the start of an entity.

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

        Specified by:
        startParameterEntity in interface XMLDTDHandler
        Parameters:
        name - The name of the 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.

      • endParameterEntity

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

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

        Specified by:
        endParameterEntity in interface XMLDTDHandler
        Parameters:
        name - The name of the entity.
        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.

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