Interface Summary : IDeclHandler

SAX2 extension handler for DTD declaration events.
This module, both source code and documentation, is in the Public Domain, and comes with NO WARRANTY.

This is an optional extension handler for SAX2 to provide more complete information about DTD declarations in an XML document. XML readers are not required to recognize this handler, and it is not part of core-only SAX2 distributions.

Note that data-related DTD declarations (unparsed entities and notations) are already reported through the IDTDHandler interface.

If you are using the declaration handler together with a lexical handler, all of the events will occur between the startDTD and the endDTD events.

To set the DeclHandler for an XML reader, use the getProperty method with the property name http://xml.org/sax/properties/declaration-handler and an object implementing this interface (or nil) as the value. If the reader does not report declaration events, it will throw a ESAXNotRecognizedException when you attempt to register the handler.


Since : SAX 2.0 (extensions 1.0)
See : IXMLReader

Methods

procedure elementDecl(SAXString, SAXString)
procedure attributeDecl(SAXString, SAXString, SAXString, SAXString, SAXString)
procedure internalEntityDecl(SAXString, SAXString)
procedure externalEntityDecl(SAXString, SAXString, SAXString)


procedure elementDecl(const name : SAXString; const model : SAXString);

Report an element type declaration.

The content model will consist of the string "EMPTY", the string "ANY", or a parenthesised group, optionally followed by an occurrence indicator. The model will be normalized so that all parameter entities are fully resolved and all whitespace is removed,and will include the enclosing parentheses. Other normalization (such as removing redundant parentheses or simplifying occurrence indicators) is at the discretion of the parser.


Parameter : name The element type name.
Parameter : model The content model as a normalized string.
Exception : ESAXException The application may raise an exception. /

Top


procedure attributeDecl(const eName : SAXString; const aName : SAXString; const attrType : SAXString; const mode : SAXString; const value : SAXString);

Report an attribute type declaration.

Only the effective (first) declaration for an attribute will be reported. The type will be one of the strings "CDATA", "ID", "IDREF", "IDREFS", "NMTOKEN", "NMTOKENS", "ENTITY", "ENTITIES", a parenthesized token group with the separator "|" and all whitespace removed, or the word "NOTATION" followed by a space followed by a parenthesized token group with all whitespace removed.

The value will be the value as reported to applications, appropriately normalized and with entity and character references expanded.


Parameter : eName The name of the associated element.
Parameter : aName The name of the attribute.
Parameter : attrType A string representing the attribute type.
Parameter : mode A string representing the attribute defaulting mode ("#IMPLIED", "#REQUIRED", or "#FIXED") or '' if none of these applies.
Parameter : value A string representing the attribute's default value, or '' if there is none.
Exception : ESAXException The application may raise an exception.

Top


procedure internalEntityDecl(const name : SAXString; const value : SAXString);

Report an internal entity declaration.

Only the effective (first) declaration for each entity will be reported. All parameter entities in the value will be expanded, but general entities will not.


Parameter : name The name of the entity. If it is a parameter entity, the name will begin with '%'.
Parameter : value The replacement text of the entity.
Exception : ESAXException The application may raise an exception.
See : IDeclHandler.externalEntityDecl
See : IDTDHandler.unparsedEntityDecl

Top


procedure externalEntityDecl(const name : SAXString; const publicId : SAXString; const systemId : SAXString);

Report a parsed external entity declaration.

Only the effective (first) declaration for each entity will be reported.


Parameter : name The name of the entity. If it is a parameter entity, the name will begin with '%'.
Parameter : publicId The declared public identifier of the entity, or an empty string if none was declared.
Parameter : systemId The declared system identifier of the entity.
Exception : ESAXException The application may raise an exception.
See : IDeclHandler.internalEntityDecl
See : IDTDHandler.unparsedEntityDecl

Top