Package com.sun.msv.reader.dtd

Class DTDReader

  • All Implemented Interfaces:
    DTDEventListener, java.util.EventListener
    public class DTDReader
extends java.lang.Object
implements DTDEventListener
    constructs TREXGrammar object that exactly matches to the parsed DTD.

    Each element declaration will have its own ReferenceExp by the name of the element.

    Note that this class does NOT extend GrammarReader, because DTD is not written in XML format.

    • Field Detail

      • controller

        protected final Controller controller

      • datatypeLibrary

        private org.relaxng.datatype.DatatypeLibrary datatypeLibrary
        Used to create Datatype objects. This datatype library should be able to handle XML Schema datatypes because those are the names we ask to this library.

      • namespaces

        protected final java.util.Map namespaces
        map from prefix to set of possible namespace URI. default namespace (without prefix) is stored by using "" as a key.

      • ABANDON_URI_SNIFFING

        protected static final java.lang.String ABANDON_URI_SNIFFING
        when this value is in the above set, that indicates we couldn't detect what URIs are going to be used with that prefix.
        See Also:
        Constant Field Values

      • locator

        protected org.xml.sax.Locator locator

      • elementDecls

        protected final java.util.Map elementDecls
        map from element name to its content model.

      • attributeDecls

        protected final java.util.Map attributeDecls
        map from element name to (map from attribute name to AttModel).

      • connectorType

        protected short connectorType

      • reportedXmlnsWarning

        private boolean reportedXmlnsWarning
        this flag is set to true after reporting WRN_ATTEMPT_TO_USE_NAMESPACE. this is used to prevent issuing the same warning more than once.

      • declaredLocations

        private final java.util.Map declaredLocations
        this map remembers where ReferenceExps are defined, and where user defined types are defined. some ReferenceExp can be defined in more than one location. In those cases, the last one is always memorized. This behavior is essential to correctly implement TREX constraint that no two <define> is allowed in the same file.

      • ERR_UNDEFINED_ELEMENT

        public static final java.lang.String ERR_UNDEFINED_ELEMENT
        See Also:
        Constant Field Values

      • WRN_ATTEMPT_TO_USE_NAMESPACE

        public static final java.lang.String WRN_ATTEMPT_TO_USE_NAMESPACE
        See Also:
        Constant Field Values

      • ERR_UNDECLARED_PREFIX

        public static final java.lang.String ERR_UNDECLARED_PREFIX
        See Also:
        Constant Field Values

    • Method Detail

      • setDatatypeLibrary

        public void setDatatypeLibrary​(org.relaxng.datatype.DatatypeLibrary datatypeLibrary)

      • createDatatype

        public org.relaxng.datatype.Datatype createDatatype​(java.lang.String name)
        Obtains a Datatype object from its name.

      • createInitialNamespaceMap

        protected static final java.util.Map createInitialNamespaceMap()

      • getNameClass

        protected NameClass getNameClass​(java.lang.String maybeQName,
                                 boolean handleAsAttribute)

      • splitQName

        protected java.lang.String[] splitQName​(java.lang.String maybeQName)
        returns an array of (URI,localName).

      • getResult

        public TREXGrammar getResult()
        Obtains the parsed grammar object.
        Returns:
        null if there was an error. Otherwise a parsed grammar object will be returned.

      • startContentModel

        public void startContentModel​(java.lang.String elementName,
                              short type)
        Description copied from interface: DTDEventListener
        receives notification that parsing of content model is beginning.
        Specified by:
        startContentModel in interface DTDEventListener
        Parameters:
        elementName - name of the element whose content model is going to be defined.
        type - DTDEventListener.CONTENT_MODEL_EMPTY this element has EMPTY content model. This notification will be immediately followed by the corresponding endContentModel. DTDEventListener.CONTENT_MODEL_ANY this element has ANY content model. This notification will be immediately followed by the corresponding endContentModel. DTDEventListener.CONTENT_MODEL_MIXED this element has mixed content model. #PCDATA will not be reported. each child element will be reported by mixedElement method. DTDEventListener.CONTENT_MODEL_CHILDREN this elemen has child content model. The actual content model will be reported by childElement, startModelGroup, endModelGroup, and connector methods. Possible call sequences are: START := MODEL_GROUP MODEL_GROUP := startModelGroup TOKEN (connector TOKEN)* endModelGroup TOKEN := childElement | MODEL_GROUP

      • getAnyExp

        protected final ReferenceExp getAnyExp()
        Gets the expression that corresponds to the "ANY".

        Its defeinition will be later filled by the choice of all elements.

      • endContentModel

        public void endContentModel​(java.lang.String elementName,
                            short type)
        Description copied from interface: DTDEventListener
        receives notification that parsing of content model is finished.
        Specified by:
        endContentModel in interface DTDEventListener

      • processOccurs

        protected Expression processOccurs​(Expression item,
                                   short occurence)
        processes occurence (?,+,*) of the given expression

      • childElement

        public void childElement​(java.lang.String elementName,
                         short occurence)
        Specified by:
        childElement in interface DTDEventListener

      • combineToContentModel

        protected void combineToContentModel​(Expression exp)

      • connector

        public void connector​(short type)
               throws org.xml.sax.SAXException
        Description copied from interface: DTDEventListener
        Connectors in one model group is guaranteed to be the same.

        IOW, you'll never see an event sequence like (a|b,c)

        Specified by:
        connector in interface DTDEventListener
        Throws:
        org.xml.sax.SAXException

      • getPossibleNamespaces

        private java.util.Set getPossibleNamespaces​(java.lang.String prefix)

      • attributeDecl

        public void attributeDecl​(java.lang.String elementName,
                          java.lang.String attributeName,
                          java.lang.String attributeType,
                          java.lang.String[] enums,
                          short attributeUse,
                          java.lang.String defaultValue)
                   throws org.xml.sax.SAXException
        Description copied from interface: DTDEventListener
        For each entry in an ATTLIST declaration, this event will be fired.

        DTD allows the same attributes to be declared more than once, and in that case the first one wins. I think this method will be only fired for the first one, but I need to check.

        Specified by:
        attributeDecl in interface DTDEventListener
        Throws:
        org.xml.sax.SAXException

      • createAttributeBody

        protected Expression createAttributeBody​(java.lang.String elementName,
                                         java.lang.String attributeName,
                                         java.lang.String attributeType,
                                         java.lang.String[] enums,
                                         short attributeUse,
                                         java.lang.String defaultValue)
                                  throws org.xml.sax.SAXException
        Creates an attribute body from the declaration found in the DTD.
        Throws:
        org.xml.sax.SAXException

      • createElementDeclaration

        protected ReferenceExp createElementDeclaration​(java.lang.String elementName)
        Creates an element declaration in the grammar object by using the parsed result.
        Returns:
        ReferenceExp that corresponds to the created element declaration.

      • createElementDeclarations

        protected Expression createElementDeclarations()
        Creates element declarations from the parsed result.
        Returns:
        An expression that corresponds to the choice of all element declarations. This will be used to implement "ANY".

      • fatalError

        public void fatalError​(org.xml.sax.SAXParseException e)
                throws org.xml.sax.SAXException
        Specified by:
        fatalError in interface DTDEventListener
        Throws:
        org.xml.sax.SAXException

      • error

        public void error​(org.xml.sax.SAXParseException e)
           throws org.xml.sax.SAXException
        Specified by:
        error in interface DTDEventListener
        Throws:
        org.xml.sax.SAXException

      • warning

        public void warning​(org.xml.sax.SAXParseException e)
             throws org.xml.sax.SAXException
        Specified by:
        warning in interface DTDEventListener
        Throws:
        org.xml.sax.SAXException

      • setDeclaredLocationOf

        public void setDeclaredLocationOf​(java.lang.Object o)

      • getDeclaredLocationOf

        public org.xml.sax.Locator getDeclaredLocationOf​(java.lang.Object o)

      • isUnparsedEntity

        public boolean isUnparsedEntity​(java.lang.String entityName)

      • resolveNamespacePrefix

        public java.lang.String resolveNamespacePrefix​(java.lang.String prefix)

      • processingInstruction

        public void processingInstruction​(java.lang.String target,
                                  java.lang.String data)
                           throws org.xml.sax.SAXException
        Description copied from interface: DTDEventListener
        Receive notification of a Processing Instruction. Processing instructions contain information meaningful to the application.
        Specified by:
        processingInstruction in interface DTDEventListener
        Parameters:
        target - The target of the proceessing instruction which should have meaning to the application.
        data - The instruction itself which should contain valid XML characters.
        Throws:
        org.xml.sax.SAXException

      • notationDecl

        public void notationDecl​(java.lang.String name,
                         java.lang.String publicId,
                         java.lang.String systemId)
                  throws org.xml.sax.SAXException
        Description copied from interface: DTDEventListener
        Receive notification of a Notation Declaration. Notation declarations are used by elements and entities for identifying embedded non-XML data.
        Specified by:
        notationDecl in interface DTDEventListener
        Parameters:
        name - The notation name, referred to by entities and elements.
        publicId - The public identifier
        systemId - The system identifier
        Throws:
        org.xml.sax.SAXException

      • unparsedEntityDecl

        public void unparsedEntityDecl​(java.lang.String name,
                               java.lang.String publicId,
                               java.lang.String systemId,
                               java.lang.String notationName)
                        throws org.xml.sax.SAXException
        Description copied from interface: DTDEventListener
        Receive notification of an unparsed entity declaration. Unparsed entities are non-XML data.
        Specified by:
        unparsedEntityDecl in interface DTDEventListener
        Parameters:
        name - The name of the unparsed entity.
        publicId - The public identifier
        systemId - The system identifier
        notationName - The associated notation
        Throws:
        org.xml.sax.SAXException

      • externalGeneralEntityDecl

        public void externalGeneralEntityDecl​(java.lang.String n,
                                      java.lang.String p,
                                      java.lang.String s)
                               throws org.xml.sax.SAXException
        Description copied from interface: DTDEventListener
        Receive notification of an external parsed general entity declaration event.

        If a system identifier is present, and it is a relative URL, the parser will have resolved it fully before passing it through this method to a listener.

        Specified by:
        externalGeneralEntityDecl in interface DTDEventListener
        Parameters:
        n - The entity name.
        p - The entity's public identifier, or null if none was given.
        s - The entity's system identifier.
        Throws:
        org.xml.sax.SAXException
        See Also:
        DTDEventListener.unparsedEntityDecl(String, String, String, String)

      • internalGeneralEntityDecl

        public void internalGeneralEntityDecl​(java.lang.String n,
                                      java.lang.String v)
                               throws org.xml.sax.SAXException
        Description copied from interface: DTDEventListener
        Receive notification of a internal general entity declaration event.
        Specified by:
        internalGeneralEntityDecl in interface DTDEventListener
        Parameters:
        n - The internal general entity name.
        v - The value of the entity, which may include unexpanded entity references. Character references will have been expanded.
        Throws:
        org.xml.sax.SAXException
        See Also:
        DTDEventListener.externalGeneralEntityDecl(String, String, String)

      • externalParameterEntityDecl

        public void externalParameterEntityDecl​(java.lang.String n,
                                        java.lang.String p,
                                        java.lang.String s)
                                 throws org.xml.sax.SAXException
        Description copied from interface: DTDEventListener
        Receive notification of an external parameter entity declaration event.

        If a system identifier is present, and it is a relative URL, the parser will have resolved it fully before passing it through this method to a listener.

        Specified by:
        externalParameterEntityDecl in interface DTDEventListener
        Parameters:
        n - The parameter entity name.
        p - The entity's public identifier, or null if none was given.
        s - The entity's system identifier.
        Throws:
        org.xml.sax.SAXException
        See Also:
        DTDEventListener.unparsedEntityDecl(String, String, String, String)

      • comment

        public void comment​(java.lang.String n)
             throws org.xml.sax.SAXException
        Description copied from interface: DTDEventListener
        Receive notification that a comment has been read.

        Note that processing instructions are the mechanism designed to hold information for consumption by applications, not comments. XML systems may rely on applications being able to access information found in processing instructions; this is not true of comments, which are typically discarded.

        Specified by:
        comment in interface DTDEventListener
        Parameters:
        n - the text within the comment delimiters.
        Throws:
        org.xml.sax.SAXException

      • characters

        public void characters​(char[] ch,
                       int start,
                       int length)
                throws org.xml.sax.SAXException
        Description copied from interface: DTDEventListener
        Receive notification of character data.

        The Parser will call this method to report each chunk of character data. SAX parsers may return all contiguous character data in a single chunk, or they may split it into several chunks; however, all of the characters in any single event must come from the same external entity, so that the Locator provides useful information.

        The application must not attempt to read from the array outside of the specified range.

        Note that some parsers will report whitespace using the ignorableWhitespace() method rather than this one (validating parsers must do so).

        Specified by:
        characters in interface DTDEventListener
        Parameters:
        ch - The characters from the DTD.
        start - The start position in the array.
        length - The number of characters to read from the array.
        Throws:
        org.xml.sax.SAXException
        See Also:
        DTDEventListener.ignorableWhitespace(char[], int, int)

      • ignorableWhitespace

        public void ignorableWhitespace​(char[] ch,
                                int start,
                                int length)
                         throws org.xml.sax.SAXException
        Description copied from interface: DTDEventListener
        Receive notification of ignorable whitespace in element content.

        Validating Parsers must use this method to report each chunk of ignorable whitespace (see the W3C XML 1.0 recommendation, section 2.10): non-validating parsers may also use this method if they are capable of parsing and using content models.

        SAX parsers may return all contiguous whitespace in a single chunk, or they may split it into several chunks; however, all of the characters in any single event must come from the same external entity, so that the Locator provides useful information.

        The application must not attempt to read from the array outside of the specified range.

        Specified by:
        ignorableWhitespace in interface DTDEventListener
        Parameters:
        ch - The characters from the DTD.
        start - The start position in the array.
        length - The number of characters to read from the array.
        Throws:
        org.xml.sax.SAXException
        See Also:
        DTDEventListener.characters(char[], int, int)

      • startCDATA

        public void startCDATA()
                throws org.xml.sax.SAXException
        Description copied from interface: DTDEventListener
        Receive notification that a CDATA section is beginning. Data in a CDATA section is is reported through the appropriate event, either characters() or ignorableWhitespace.
        Specified by:
        startCDATA in interface DTDEventListener
        Throws:
        org.xml.sax.SAXException
        See Also:
        DTDEventListener.endCDATA()