| org.apache.xerces.xni.XMLDTDHandler
All known Subclasses: org.apache.xerces.impl.xs.opti.DefaultXMLDocumentHandler, org.apache.xerces.parsers.AbstractXMLDocumentParser, org.apache.xerces.impl.dtd.DTDGrammar, org.apache.xerces.parsers.DTDParser,
| XMLDTDHandler | | public interface XMLDTDHandler (Code) | | 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 Also: XMLDTDContentModelHandler
author:
Andy Clark, IBM
version:
$Id: XMLDTDHandler.java 447247 2006-09-18 05:23:52Z mrglavas $ |
| Method Summary | |
| public void | attributeDecl(String elementName, String attributeName, String type, String[] enumeration, String defaultType, XMLString defaultValue, XMLString nonNormalizedDefaultValue, Augmentations augmentations)
An attribute declaration.
Parameters:
elementName - The name of the element that this attributeis associated with.
Parameters:
attributeName - The name of the attribute.
Parameters:
type - The attribute type. | | public void | comment(XMLString text, Augmentations augmentations)
A comment. | | public void | elementDecl(String name, String contentModel, Augmentations augmentations)
An element declaration. | | public void | endAttlist(Augmentations augmentations)
The end of an attribute list. | | public void | endConditional(Augmentations augmentations)
The end of a conditional section. | | public void | endDTD(Augmentations augmentations)
The end of the DTD. | | public void | endExternalSubset(Augmentations augmentations)
The end of the DTD external subset. | | public void | endParameterEntity(String name, Augmentations augmentations)
This method notifies the end of a parameter entity. | | public void | externalEntityDecl(String name, XMLResourceIdentifier identifier, Augmentations augmentations)
An external entity declaration.
Parameters:
name - The name of the entity. | | public XMLDTDSource | getDTDSource()
| | public void | ignoredCharacters(XMLString text, Augmentations augmentations)
Characters within an IGNORE conditional section. | | public void | internalEntityDecl(String name, XMLString text, XMLString nonNormalizedText, Augmentations augmentations)
An internal entity declaration.
Parameters:
name - The name of the entity. | | public void | notationDecl(String name, XMLResourceIdentifier identifier, Augmentations augmentations)
| | public void | processingInstruction(String target, XMLString data, Augmentations augmentations)
A processing instruction. | | public void | setDTDSource(XMLDTDSource source)
| | public void | startAttlist(String elementName, Augmentations augmentations)
The start of an attribute list. | | public void | startConditional(short type, Augmentations augmentations)
The start of a conditional section.
Parameters:
type - The type of the conditional section. | | public void | startDTD(XMLLocator locator, Augmentations augmentations)
The start of the DTD.
Parameters:
locator - The document locator, or null if the documentlocation cannot be reported during the parsing of the document DTD. | | public void | startExternalSubset(XMLResourceIdentifier identifier, Augmentations augmentations)
The start of the DTD external subset. | | public void | startParameterEntity(String name, XMLResourceIdentifier identifier, String encoding, Augmentations augmentations)
This method notifies of the start of a parameter entity. | | public void | textDecl(String version, String encoding, Augmentations augmentations)
Notifies of the presence of a TextDecl line in an entity. | | public void | unparsedEntityDecl(String name, XMLResourceIdentifier identifier, String notation, Augmentations augmentations)
An unparsed entity declaration. |
| attributeDecl | | public void attributeDecl(String elementName, String attributeName, String type, String[] enumeration, String defaultType, XMLString defaultValue, XMLString nonNormalizedDefaultValue, Augmentations augmentations) throws XNIException(Code) | | An attribute declaration.
Parameters:
elementName - The name of the element that this attributeis associated with.
Parameters:
attributeName - The name of the attribute.
Parameters:
type - The attribute type. This value will be one ofthe following: "CDATA", "ENTITY", "ENTITIES","ENUMERATION", "ID", "IDREF", "IDREFS", "NMTOKEN", "NMTOKENS", or "NOTATION".
Parameters:
enumeration - If the type has the value "ENUMERATION" or"NOTATION", this array holds the allowed attributevalues; otherwise, this array is null.
Parameters:
defaultType - The attribute default type. This value will beone of the following: "#FIXED", "#IMPLIED","#REQUIRED", or null.
Parameters:
defaultValue - The attribute default value, or null if nodefault value is specified.
Parameters:
nonNormalizedDefaultValue - The attribute default value with no normalization performed, or null if no default value is specified.
Parameters:
augmentations - Additional information that may include infosetaugmentations.
throws:
XNIException - Thrown by handler to signal an error. |
| comment | | public void comment(XMLString text, Augmentations augmentations) throws XNIException(Code) | | A comment.
Parameters:
text - The text in the comment.
Parameters:
augmentations - Additional information that may include infosetaugmentations.
throws:
XNIException - Thrown by application to signal an error. |
| elementDecl | | public void elementDecl(String name, String contentModel, Augmentations augmentations) throws XNIException(Code) | | An element declaration.
Parameters:
name - The name of the element.
Parameters:
contentModel - The element content model.
Parameters:
augmentations - Additional information that may include infosetaugmentations.
throws:
XNIException - Thrown by handler to signal an error. |
| endAttlist | | public void endAttlist(Augmentations augmentations) throws XNIException(Code) | | The end of an attribute list.
Parameters:
augmentations - Additional information that may include infosetaugmentations.
throws:
XNIException - Thrown by handler to signal an error. |
| endConditional | | public void endConditional(Augmentations augmentations) throws XNIException(Code) | | The end of a conditional section.
Parameters:
augmentations - Additional information that may include infosetaugmentations.
throws:
XNIException - Thrown by handler to signal an error. |
| endDTD | | public void endDTD(Augmentations augmentations) throws XNIException(Code) | | The end of the DTD.
Parameters:
augmentations - Additional information that may include infosetaugmentations.
throws:
XNIException - Thrown by handler to signal an error. |
| endExternalSubset | | public void endExternalSubset(Augmentations augmentations) throws XNIException(Code) | | The end of the DTD external subset.
Parameters:
augmentations - Additional information that may include infosetaugmentations.
throws:
XNIException - Thrown by handler to signal an error. |
| endParameterEntity | | public void endParameterEntity(String name, Augmentations augmentations) throws XNIException(Code) | | This method notifies the end of a parameter entity. Parameter entity
names begin with a '%' character.
Parameters:
name - The name of the parameter entity.
Parameters:
augmentations - Additional information that may include infosetaugmentations.
throws:
XNIException - Thrown by handler to signal an error. |
| externalEntityDecl | | public void externalEntityDecl(String name, XMLResourceIdentifier identifier, Augmentations augmentations) throws XNIException(Code) | | An external entity declaration.
Parameters:
name - The name of the entity. Parameter entity names startwith '%', whereas the name of a general entity is justthe entity name.
Parameters:
identifier - An object containing all location information pertinent to this external entity.
Parameters:
augmentations - Additional information that may include infosetaugmentations.
throws:
XNIException - Thrown by handler to signal an error. |
| ignoredCharacters | | public void ignoredCharacters(XMLString text, Augmentations augmentations) throws XNIException(Code) | | Characters within an IGNORE conditional section.
Parameters:
text - The ignored text.
Parameters:
augmentations - Additional information that may include infosetaugmentations.
throws:
XNIException - Thrown by handler to signal an error. |
| internalEntityDecl | | public void internalEntityDecl(String name, XMLString text, XMLString nonNormalizedText, Augmentations augmentations) throws XNIException(Code) | | An internal entity declaration.
Parameters:
name - The name of the entity. Parameter entity names start with'%', whereas the name of a general entity is just the entity name.
Parameters:
text - The value of the entity.
Parameters:
nonNormalizedText - The non-normalized value of the entity. Thisvalue contains the same sequence of characters that was in the internal entity declaration, without any entityreferences expanded.
Parameters:
augmentations - Additional information that may include infosetaugmentations.
throws:
XNIException - Thrown by handler to signal an error. |
| notationDecl | | public void notationDecl(String name, XMLResourceIdentifier identifier, Augmentations augmentations) throws XNIException(Code) | | A notation declaration
Parameters:
name - The name of the notation.
Parameters:
identifier - An object containing all location information pertinent to this notation.
Parameters:
augmentations - Additional information that may include infosetaugmentations.
throws:
XNIException - Thrown by handler to signal an error. |
| processingInstruction | | public void processingInstruction(String target, XMLString data, Augmentations augmentations) throws XNIException(Code) | | 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.
Parameters:
target - The target.
Parameters:
data - The data or null if none specified.
Parameters:
augmentations - Additional information that may include infosetaugmentations.
throws:
XNIException - Thrown by handler to signal an error. |
| startAttlist | | public void startAttlist(String elementName, Augmentations augmentations) throws XNIException(Code) | | The start of an attribute list.
Parameters:
elementName - The name of the element that this attributelist is associated with.
Parameters:
augmentations - Additional information that may include infosetaugmentations.
throws:
XNIException - Thrown by handler to signal an error. |
| startDTD | | public void startDTD(XMLLocator locator, Augmentations augmentations) throws XNIException(Code) | | The start of the DTD.
Parameters:
locator - The document locator, or null if the documentlocation cannot be reported during the parsing of the document DTD. However, it is stronglyrecommended that a locator be supplied that can at least report the base system identifier of theDTD.
Parameters:
augmentations - Additional information that may include infosetaugmentations.
throws:
XNIException - Thrown by handler to signal an error. |
| startExternalSubset | | public void startExternalSubset(XMLResourceIdentifier identifier, Augmentations augmentations) throws XNIException(Code) | | The start of the DTD external subset.
Parameters:
identifier - The resource identifier.
Parameters:
augmentations - Additional information that may include infosetaugmentations.
exception:
XNIException - Thrown by handler to signal an error. |
| startParameterEntity | | public void startParameterEntity(String name, XMLResourceIdentifier identifier, String encoding, Augmentations augmentations) throws XNIException(Code) | | This method notifies of the start of a parameter entity. The parameter
entity name start with a '%' character.
Parameters:
name - The name of the parameter entity.
Parameters:
identifier - The resource identifier.
Parameters:
encoding - The auto-detected IANA encoding name of the entitystream. This value will be null in those situationswhere the entity encoding is not auto-detected (e.g.internal parameter entities).
Parameters:
augmentations - Additional information that may include infosetaugmentations.
throws:
XNIException - Thrown by handler to signal an error. |
| textDecl | | public void textDecl(String version, String encoding, Augmentations augmentations) throws XNIException(Code) | | 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.
Parameters:
version - The XML version, or null if not specified.
Parameters:
encoding - The IANA encoding name of the entity.
Parameters:
augmentations - Additional information that may include infosetaugmentations.
throws:
XNIException - Thrown by handler to signal an error. |
| unparsedEntityDecl | | public void unparsedEntityDecl(String name, XMLResourceIdentifier identifier, String notation, Augmentations augmentations) throws XNIException(Code) | | An unparsed entity declaration.
Parameters:
name - The name of the entity.
Parameters:
identifier - An object containing all location information pertinent to this unparsed entity declaration.
Parameters:
notation - The name of the notation.
Parameters:
augmentations - Additional information that may include infosetaugmentations.
throws:
XNIException - Thrown by handler to signal an error. |
|
|