001: // SAX DTD handler.
002: // http://www.saxproject.org
003: // No warranty; no copyright -- use this as you will.
004:
005: package org.xml.sax;
006:
007: /**
008: * Receive notification of basic DTD-related events.
009: *
010: * <blockquote>
011: * <em>This module, both source code and documentation, is in the
012: * Public Domain, and comes with <strong>NO WARRANTY</strong>.</em>
013: * See <a href='http://www.saxproject.org'>http://www.saxproject.org</a>
014: * for further information.
015: * </blockquote>
016: *
017: * <p>If a SAX application needs information about notations and
018: * unparsed entities, then the application implements this
019: * interface and registers an instance with the SAX parser using
020: * the parser's setDTDHandler method. The parser uses the
021: * instance to report notation and unparsed entity declarations to
022: * the application.</p>
023: *
024: * <p>Note that this interface includes only those DTD events that
025: * the XML recommendation <em>requires</em> processors to report:
026: * notation and unparsed entity declarations.</p>
027: *
028: * <p>The SAX parser may report these events in any order, regardless
029: * of the order in which the notations and unparsed entities were
030: * declared; however, all DTD events must be reported after the
031: * document handler's startDocument event, and before the first
032: * startElement event.
033: * (If the {@link org.xml.sax.ext.LexicalHandler LexicalHandler} is
034: * used, these events must also be reported before the endDTD event.)
035: * </p>
036: *
037: * <p>It is up to the application to store the information for
038: * future use (perhaps in a hash table or object tree).
039: * If the application encounters attributes of type "NOTATION",
040: * "ENTITY", or "ENTITIES", it can use the information that it
041: * obtained through this interface to find the entity and/or
042: * notation corresponding with the attribute value.</p>
043: *
044: * @since SAX 1.0
045: * @author David Megginson
046: * @version 2.0.1 (sax2r2)
047: * @see org.xml.sax.XMLReader#setDTDHandler
048: */
049: public interface DTDHandler {
050:
051: /**
052: * Receive notification of a notation declaration event.
053: *
054: * <p>It is up to the application to record the notation for later
055: * reference, if necessary;
056: * notations may appear as attribute values and in unparsed entity
057: * declarations, and are sometime used with processing instruction
058: * target names.</p>
059: *
060: * <p>At least one of publicId and systemId must be non-null.
061: * If a system identifier is present, and it is a URL, the SAX
062: * parser must resolve it fully before passing it to the
063: * application through this event.</p>
064: *
065: * <p>There is no guarantee that the notation declaration will be
066: * reported before any unparsed entities that use it.</p>
067: *
068: * @param name The notation name.
069: * @param publicId The notation's public identifier, or null if
070: * none was given.
071: * @param systemId The notation's system identifier, or null if
072: * none was given.
073: * @exception org.xml.sax.SAXException Any SAX exception, possibly
074: * wrapping another exception.
075: * @see #unparsedEntityDecl
076: * @see org.xml.sax.Attributes
077: */
078: public abstract void notationDecl(String name, String publicId,
079: String systemId) throws SAXException;
080:
081: /**
082: * Receive notification of an unparsed entity declaration event.
083: *
084: * <p>Note that the notation name corresponds to a notation
085: * reported by the {@link #notationDecl notationDecl} event.
086: * It is up to the application to record the entity for later
087: * reference, if necessary;
088: * unparsed entities may appear as attribute values.
089: * </p>
090: *
091: * <p>If the system identifier is a URL, the parser must resolve it
092: * fully before passing it to the application.</p>
093: *
094: * @exception org.xml.sax.SAXException Any SAX exception, possibly
095: * wrapping another exception.
096: * @param name The unparsed entity's name.
097: * @param publicId The entity's public identifier, or null if none
098: * was given.
099: * @param systemId The entity's system identifier.
100: * @param notationName The name of the associated notation.
101: * @see #notationDecl
102: * @see org.xml.sax.Attributes
103: */
104: public abstract void unparsedEntityDecl(String name,
105: String publicId, String systemId, String notationName)
106: throws SAXException;
107:
108: }
109:
110: // end of DTDHandler.java
|