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

Class DTDGrammar

    • Field Detail

      • TOP_LEVEL_SCOPE

        public static final int TOP_LEVEL_SCOPE
        Top level scope (-1).
        See Also:
        Constant Field Values

      • fCurrentElementIndex

        protected int fCurrentElementIndex
        Current element index.

      • fCurrentAttributeIndex

        protected int fCurrentAttributeIndex
        Current attribute index.

      • fReadingExternalDTD

        protected boolean fReadingExternalDTD
        fReadingExternalDTD

      • fAttributeDecl

        protected final XMLAttributeDecl fAttributeDecl
        Temporary Attribute decl.

    • Method Detail

      • getElementDeclIsExternal

        public boolean getElementDeclIsExternal​(int elementDeclIndex)
        Returns true if the specified element declaration is external.
        Parameters:
        elementDeclIndex - The element declaration index.

      • getAttributeDeclIsExternal

        public boolean getAttributeDeclIsExternal​(int attributeDeclIndex)
        Returns true if the specified attribute declaration is external.
        Parameters:
        attributeDeclIndex - Attribute declaration index.

      • getAttributeDeclIndex

        public int getAttributeDeclIndex​(int elementDeclIndex,
                                 String attributeDeclName)

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

      • startParameterEntity

        public void startParameterEntity​(String name,
                                 XMLResourceIdentifier identifier,
                                 String encoding,
                                 Augmentations augs)
                          throws XNIException
        This method notifies of the start of an entity. The DTD has the pseudo-name of "[dtd]" and parameter entity names start with '%'.

        Note: Since the DTD is an entity, the handler will be notified of the start of the DTD entity by calling the startParameterEntity method with the entity name "[dtd]" before calling the startDTD method.

        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 an entity. The DTD has the pseudo-name of "[dtd]" and parameter entity names start with '%'.

        Note: Since the DTD is an entity, the handler will be notified of the end of the DTD entity by calling the endEntity method with the entity name "[dtd]" after calling the endDTD method.

        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.

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

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

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

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

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

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

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

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

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

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

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

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

      • isNamespaceAware

        public boolean isNamespaceAware()
        Returns true if this grammar is namespace aware.

      • getSymbolTable

        public SymbolTable getSymbolTable()
        Returns the symbol table.

      • getNextElementDeclIndex

        public int getNextElementDeclIndex​(int elementDeclIndex)
        Returns the next index of the element declaration following the specified element declaration.
        Parameters:
        elementDeclIndex - The element declaration index.

      • getElementDeclIndex

        public int getElementDeclIndex​(String elementDeclName)
        getElementDeclIndex
        Parameters:
        elementDeclName -
        Returns:
        index of the elementDeclName in scope

      • getElementDeclIndex

        public int getElementDeclIndex​(QName elementDeclQName)
        Returns the element decl index.
        Parameters:
        elementDeclQName - qualilfied name of the element

      • getContentSpecType

        public short getContentSpecType​(int elementIndex)
        make separate function for getting contentSpecType of element. we can avoid setting of the element values.

      • getElementDecl

        public boolean getElementDecl​(int elementDeclIndex,
                              XMLElementDecl elementDecl)
        getElementDecl
        Parameters:
        elementDeclIndex -
        elementDecl - The values of this structure are set by this call.
        Returns:
        True if find the element, False otherwise.

      • getFirstAttributeDeclIndex

        public int getFirstAttributeDeclIndex​(int elementDeclIndex)
        getFirstAttributeDeclIndex
        Parameters:
        elementDeclIndex -
        Returns:
        index of the first attribute for element declaration elementDeclIndex

      • getNextAttributeDeclIndex

        public int getNextAttributeDeclIndex​(int attributeDeclIndex)
        getNextAttributeDeclIndex
        Parameters:
        attributeDeclIndex -
        Returns:
        index of the next attribute of the attribute at attributeDeclIndex

      • getAttributeDecl

        public boolean getAttributeDecl​(int attributeDeclIndex,
                                XMLAttributeDecl attributeDecl)
        getAttributeDecl
        Parameters:
        attributeDeclIndex -
        attributeDecl - The values of this structure are set by this call.
        Returns:
        true if getAttributeDecl was able to fill in the value of attributeDecl

      • isCDATAAttribute

        public boolean isCDATAAttribute​(QName elName,
                                QName atName)
        Returns whether the given attribute is of type CDATA or not
        Parameters:
        elName - The element name.
        atName - The attribute name.
        Returns:
        true if the attribute is of type CDATA

      • getEntityDeclIndex

        public int getEntityDeclIndex​(String entityDeclName)
        getEntityDeclIndex
        Parameters:
        entityDeclName -
        Returns:
        the index of the EntityDecl

      • getEntityDecl

        public boolean getEntityDecl​(int entityDeclIndex,
                             XMLEntityDecl entityDecl)
        getEntityDecl
        Parameters:
        entityDeclIndex -
        entityDecl -
        Returns:
        true if getEntityDecl was able to fill entityDecl with the contents of the entity with index entityDeclIndex

      • getNotationDeclIndex

        public int getNotationDeclIndex​(String notationDeclName)
        getNotationDeclIndex
        Parameters:
        notationDeclName -
        Returns:
        the index if found a notation with the name, otherwise -1.

      • getNotationDecl

        public boolean getNotationDecl​(int notationDeclIndex,
                               XMLNotationDecl notationDecl)
        getNotationDecl
        Parameters:
        notationDeclIndex -
        notationDecl -
        Returns:
        return true of getNotationDecl can fill notationDecl with information about the notation at notationDeclIndex.

      • getContentSpec

        public boolean getContentSpec​(int contentSpecIndex,
                              XMLContentSpec contentSpec)
        getContentSpec
        Parameters:
        contentSpecIndex -
        contentSpec -
        Returns:
        true if find the requested contentSpec node, false otherwise

      • getContentSpecIndex

        public int getContentSpecIndex​(int elementDeclIndex)
        Returns the index to the content spec for the given element declaration, or -1 if the element declaration index was invalid.

      • getContentSpecAsString

        public String getContentSpecAsString​(int elementDeclIndex)
        getContentSpecAsString
        Parameters:
        elementDeclIndex -
        Returns:
        String

      • printElements

        public void printElements()

      • printAttributes

        public void printAttributes​(int elementDeclIndex)

      • addContentSpecToElement

        protected void addContentSpecToElement​(XMLElementDecl elementDecl)
        Adds the content spec to the given element declaration.

      • getElementContentModelValidator

        protected ContentModelValidator getElementContentModelValidator​(int elementDeclIndex)
        getElementContentModelValidator
        Parameters:
        elementDeclIndex -
        Returns:
        its ContentModelValidator if any.

      • createElementDecl

        protected int createElementDecl()

      • setElementDecl

        protected void setElementDecl​(int elementDeclIndex,
                              XMLElementDecl elementDecl)

      • putElementNameMapping

        protected void putElementNameMapping​(QName name,
                                     int scope,
                                     int elementDeclIndex)

      • setFirstAttributeDeclIndex

        protected void setFirstAttributeDeclIndex​(int elementDeclIndex,
                                          int newFirstAttrIndex)

      • setContentSpecIndex

        protected void setContentSpecIndex​(int elementDeclIndex,
                                   int contentSpecIndex)

      • createAttributeDecl

        protected int createAttributeDecl()

      • setAttributeDecl

        protected void setAttributeDecl​(int elementDeclIndex,
                                int attributeDeclIndex,
                                XMLAttributeDecl attributeDecl)

      • createContentSpec

        protected int createContentSpec()

      • setContentSpec

        protected void setContentSpec​(int contentSpecIndex,
                              XMLContentSpec contentSpec)

      • createEntityDecl

        protected int createEntityDecl()

      • setEntityDecl

        protected void setEntityDecl​(int entityDeclIndex,
                             XMLEntityDecl entityDecl)

      • createNotationDecl

        protected int createNotationDecl()

      • setNotationDecl

        protected void setNotationDecl​(int notationDeclIndex,
                               XMLNotationDecl notationDecl)

      • addContentSpecNode

        protected int addContentSpecNode​(short nodeType,
                                 String nodeValue)
        Create an XMLContentSpec for a single non-leaf
        Parameters:
        nodeType - the type of XMLContentSpec to create - from XMLContentSpec.CONTENTSPECNODE_*
        nodeValue - handle to an XMLContentSpec
        Returns:
        handle to the newly create XMLContentSpec

      • addUniqueLeafNode

        protected int addUniqueLeafNode​(String elementName)
        create an XMLContentSpec for a leaf
        Parameters:
        elementName - the name (Element) for the node
        Returns:
        handle to the newly create XMLContentSpec

      • addContentSpecNode

        protected int addContentSpecNode​(short nodeType,
                                 int leftNodeIndex,
                                 int rightNodeIndex)
        Create an XMLContentSpec for a two child leaf
        Parameters:
        nodeType - the type of XMLContentSpec to create - from XMLContentSpec.CONTENTSPECNODE_*
        leftNodeIndex - handle to an XMLContentSpec
        rightNodeIndex - handle to an XMLContentSpec
        Returns:
        handle to the newly create XMLContentSpec

      • initializeContentModelStack

        protected void initializeContentModelStack()
        Initialize content model stack.

      • isEntityDeclared

        public boolean isEntityDeclared​(String name)
        Description copied from interface: EntityState
        Query method to check if entity with this name was declared.
        Specified by:
        isEntityDeclared in interface EntityState
        Returns:
        true if name is a declared entity

      • isEntityUnparsed

        public boolean isEntityUnparsed​(String name)
        Description copied from interface: EntityState
        Query method to check if entity is unparsed.
        Specified by:
        isEntityUnparsed in interface EntityState
        Returns:
        true if name is an unparsed entity