FileDocCategorySizeDatePackage
XMLDTDHandler.javaAPI DocApache Xerces 3.0.115370Fri Sep 14 20:33:54 BST 2007org.apache.xerces.xni

XMLDTDHandler

public interface XMLDTDHandler
The DTD handler interface defines callback methods to report information items in the DTD of an XML document. Parser components interested in DTD information implement this interface and are registered as the DTD handler on the DTD source.
see
XMLDTDContentModelHandler
author
Andy Clark, IBM
version
$Id: XMLDTDHandler.java 447247 2006-09-18 05:23:52Z mrglavas $

Fields Summary
public static final short
CONDITIONAL_INCLUDE
Conditional section: INCLUDE.
public static final short
CONDITIONAL_IGNORE
Conditional section: IGNORE.
Constructors Summary
Methods Summary
public voidattributeDecl(java.lang.String elementName, java.lang.String attributeName, java.lang.String type, java.lang.String[] enumeration, java.lang.String defaultType, XMLString defaultValue, XMLString nonNormalizedDefaultValue, Augmentations augmentations)
An attribute declaration.

param
elementName The name of the element that this attribute is associated with.
param
attributeName The name of the attribute.
param
type The attribute type. This value will be one of the following: "CDATA", "ENTITY", "ENTITIES", "ENUMERATION", "ID", "IDREF", "IDREFS", "NMTOKEN", "NMTOKENS", or "NOTATION".
param
enumeration If the type has the value "ENUMERATION" or "NOTATION", this array holds the allowed attribute values; otherwise, this array is null.
param
defaultType The attribute default type. This value will be one of the following: "#FIXED", "#IMPLIED", "#REQUIRED", or null.
param
defaultValue The attribute default value, or null if no default value is specified.
param
nonNormalizedDefaultValue The attribute default value with no normalization performed, or null if no default value is specified.
param
augmentations Additional information that may include infoset augmentations.
throws
XNIException Thrown by handler to signal an error.

public voidcomment(XMLString text, Augmentations augmentations)
A comment.

param
text The text in the comment.
param
augmentations Additional information that may include infoset augmentations.
throws
XNIException Thrown by application to signal an error.

public voidelementDecl(java.lang.String name, java.lang.String contentModel, Augmentations augmentations)
An element declaration.

param
name The name of the element.
param
contentModel The element content model.
param
augmentations Additional information that may include infoset augmentations.
throws
XNIException Thrown by handler to signal an error.

public voidendAttlist(Augmentations augmentations)
The end of an attribute list.

param
augmentations Additional information that may include infoset augmentations.
throws
XNIException Thrown by handler to signal an error.

public voidendConditional(Augmentations augmentations)
The end of a conditional section.

param
augmentations Additional information that may include infoset augmentations.
throws
XNIException Thrown by handler to signal an error.

public voidendDTD(Augmentations augmentations)
The end of the DTD.

param
augmentations Additional information that may include infoset augmentations.
throws
XNIException Thrown by handler to signal an error.

public voidendExternalSubset(Augmentations augmentations)
The end of the DTD external subset.

param
augmentations Additional information that may include infoset augmentations.
throws
XNIException Thrown by handler to signal an error.

public voidendParameterEntity(java.lang.String name, Augmentations augmentations)
This method notifies the end of a parameter entity. Parameter entity names begin with a '%' character.

param
name The name of the parameter entity.
param
augmentations Additional information that may include infoset augmentations.
throws
XNIException Thrown by handler to signal an error.

public voidexternalEntityDecl(java.lang.String name, XMLResourceIdentifier identifier, Augmentations augmentations)
An external entity declaration.

param
name The name of the entity. Parameter entity names start with '%', whereas the name of a general entity is just the entity name.
param
identifier An object containing all location information pertinent to this external entity.
param
augmentations Additional information that may include infoset augmentations.
throws
XNIException Thrown by handler to signal an error.

public org.apache.xerces.xni.parser.XMLDTDSourcegetDTDSource()

public voidignoredCharacters(XMLString text, Augmentations augmentations)
Characters within an IGNORE conditional section.

param
text The ignored text.
param
augmentations Additional information that may include infoset augmentations.
throws
XNIException Thrown by handler to signal an error.

public voidinternalEntityDecl(java.lang.String name, XMLString text, XMLString nonNormalizedText, Augmentations augmentations)
An internal entity declaration.

param
name The name of the entity. Parameter entity names start with '%', whereas the name of a general entity is just the entity name.
param
text The value of the entity.
param
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.
param
augmentations Additional information that may include infoset augmentations.
throws
XNIException Thrown by handler to signal an error.

public voidnotationDecl(java.lang.String name, XMLResourceIdentifier identifier, Augmentations augmentations)
A notation declaration

param
name The name of the notation.
param
identifier An object containing all location information pertinent to this notation.
param
augmentations Additional information that may include infoset augmentations.
throws
XNIException Thrown by handler to signal an error.

public voidprocessingInstruction(java.lang.String target, XMLString data, Augmentations augmentations)
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.

param
target The target.
param
data The data or null if none specified.
param
augmentations Additional information that may include infoset augmentations.
throws
XNIException Thrown by handler to signal an error.

public voidsetDTDSource(org.apache.xerces.xni.parser.XMLDTDSource source)

public voidstartAttlist(java.lang.String elementName, Augmentations augmentations)
The start of an attribute list.

param
elementName The name of the element that this attribute list is associated with.
param
augmentations Additional information that may include infoset augmentations.
throws
XNIException Thrown by handler to signal an error.

public voidstartConditional(short type, Augmentations augmentations)
The start of a conditional section.

param
type The type of the conditional section. This value will either be CONDITIONAL_INCLUDE or CONDITIONAL_IGNORE.
param
augmentations Additional information that may include infoset augmentations.
throws
XNIException Thrown by handler to signal an error.
see
#CONDITIONAL_INCLUDE
see
#CONDITIONAL_IGNORE

public voidstartDTD(XMLLocator locator, Augmentations augmentations)
The start of the DTD.

param
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.
param
augmentations Additional information that may include infoset augmentations.
throws
XNIException Thrown by handler to signal an error.

public voidstartExternalSubset(XMLResourceIdentifier identifier, Augmentations augmentations)
The start of the DTD external subset.

param
identifier The resource identifier.
param
augmentations Additional information that may include infoset augmentations.
exception
XNIException Thrown by handler to signal an error.

public voidstartParameterEntity(java.lang.String name, XMLResourceIdentifier identifier, java.lang.String encoding, Augmentations augmentations)
This method notifies of the start of a parameter entity. The parameter entity name start with a '%' character.

param
name The name of the parameter entity.
param
identifier The resource identifier.
param
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).
param
augmentations Additional information that may include infoset augmentations.
throws
XNIException Thrown by handler to signal an error.

public voidtextDecl(java.lang.String version, java.lang.String encoding, Augmentations augmentations)
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.

param
version The XML version, or null if not specified.
param
encoding The IANA encoding name of the entity.
param
augmentations Additional information that may include infoset augmentations.
throws
XNIException Thrown by handler to signal an error.

public voidunparsedEntityDecl(java.lang.String name, XMLResourceIdentifier identifier, java.lang.String notation, Augmentations augmentations)
An unparsed entity declaration.

param
name The name of the entity.
param
identifier An object containing all location information pertinent to this unparsed entity declaration.
param
notation The name of the notation.
param
augmentations Additional information that may include infoset augmentations.
throws
XNIException Thrown by handler to signal an error.