Interface IDeclHandler

SAX2 extension handler for DTD declaration events.

Namespace: Sax.Ext
Assembly: Lucene.Net.Benchmark.dll
Syntax
public interface IDeclHandler
Remarks

This module, both source code and documentation, is in the Public Domain, and comes with NO WARRANTY. See http://www.saxproject.org for further information.

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(string, string, string) and the EndDTD() events.

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

Methods

AttributeDecl(string, string, string, string, string)

Report an attribute type declaration.

Declaration
void AttributeDecl(string eName, string aName, string type, string mode, string value)
Parameters
Type Name Description
string eName

The name of the associated element.
string aName

The name of the attribute.
string type

A string representing the attribute type.
string mode

A string representing the attribute defaulting mode ("#IMPLIED", "#REQUIRED", or "#FIXED") or null if none of these applies.
string value

A string representing the attribute's default value, or null if there is none.
Remarks

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.
Exceptions
Type Condition
SAXException

The application may raise an exception.

ElementDecl(string, string)

Report an element type declaration.

Declaration
void ElementDecl(string name, string model)
Parameters
Type Name Description
string name

The element type name.
string model

The content model as a normalized string.
Remarks

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.

Exceptions
Type Condition
SAXException

The application may raise an exception.

ExternalEntityDecl(string, string, string)

Report a parsed external entity declaration.

Declaration
void ExternalEntityDecl(string name, string publicId, string systemId)
Parameters
Type Name Description
string name

The name of the entity. If it is a parameter entity, the name will begin with '%'.
string publicId

The entity's public identifier, or null if none was given.
string systemId

The entity's system identifier.
Remarks

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

If the system identifier is a URL, the parser must resolve it fully before passing it to the application.
Exceptions
Type Condition
SAXException

The application may raise an exception.
See Also

InternalEntityDecl(string, string)

Report an internal entity declaration.

Declaration
void InternalEntityDecl(string name, string value)
Parameters
Type Name Description
string name

The name of the entity. If it is a parameter entity, the name will begin with '%'.
string value

The replacement text of the entity.
Remarks

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.

Exceptions
Type Condition
SAXException

The application may raise an exception.
See Also