|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
XMLDTDContentModelHandler
Field Summary | |
static short |
CONDITIONAL_IGNORE
Conditional section: IGNORE. |
static short |
CONDITIONAL_INCLUDE
Conditional section: INCLUDE. |
Method Summary | |
void |
attributeDecl(java.lang.String elementName,
java.lang.String attributeName,
java.lang.String type,
java.lang.String[] enumeration,
java.lang.String defaultType,
XMLString defaultValue)
An attribute declaration. |
void |
characters(XMLString text)
Characters within an IGNORE conditional section. |
void |
comment(XMLString text)
A comment. |
void |
elementDecl(java.lang.String name,
java.lang.String contentModel)
An element declaration. |
void |
endAttlist()
The end of an attribute list. |
void |
endConditional()
The end of a conditional section. |
void |
endDTD()
The end of the DTD. |
void |
endEntity(java.lang.String name)
This method notifies the end of an entity. |
void |
externalEntityDecl(java.lang.String name,
java.lang.String publicId,
java.lang.String systemId,
java.lang.String baseSystemId)
An external entity declaration. |
void |
internalEntityDecl(java.lang.String name,
XMLString text,
XMLString nonNormalizedText)
An internal entity declaration. |
void |
notationDecl(java.lang.String name,
java.lang.String publicId,
java.lang.String systemId)
A notation declaration |
void |
processingInstruction(java.lang.String target,
XMLString data)
A processing instruction. |
void |
startAttlist(java.lang.String elementName)
The start of an attribute list. |
void |
startConditional(short type)
The start of a conditional section. |
void |
startDTD(XMLLocator locator)
The start of the DTD. |
void |
startEntity(java.lang.String name,
java.lang.String publicId,
java.lang.String systemId,
java.lang.String baseSystemId,
java.lang.String encoding)
This method notifies of the start of an entity. |
void |
textDecl(java.lang.String version,
java.lang.String encoding)
Notifies of the presence of a TextDecl line in an entity. |
void |
unparsedEntityDecl(java.lang.String name,
java.lang.String publicId,
java.lang.String systemId,
java.lang.String notation)
An unparsed entity declaration. |
Field Detail |
public static final short CONDITIONAL_INCLUDE
CONDITIONAL_IGNORE
public static final short CONDITIONAL_IGNORE
CONDITIONAL_INCLUDE
Method Detail |
public void startDTD(XMLLocator locator) throws XNIException
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.XNIException
- Thrown by handler to signal an error.public void startEntity(java.lang.String name, java.lang.String publicId, java.lang.String systemId, java.lang.String baseSystemId, java.lang.String encoding) throws XNIException
name
- The name of the entity.publicId
- The public identifier of the entity if the entity
is external, null otherwise.systemId
- The system identifier of the entity if the entity
is external, null otherwise.baseSystemId
- The base system identifier of the entity if
the entity is external, null otherwise.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).XNIException
- Thrown by handler to signal an error.public void textDecl(java.lang.String version, java.lang.String encoding) throws XNIException
Note: This method is only called for external parameter entities referenced in the DTD.
version
- The XML version, or null if not specified.encoding
- The IANA encoding name of the entity.XNIException
- Thrown by handler to signal an error.public void endEntity(java.lang.String name) throws XNIException
name
- The name of the entity.XNIException
- Thrown by handler to signal an error.public void comment(XMLString text) throws XNIException
text
- The text in the comment.XNIException
- Thrown by application to signal an error.public void processingInstruction(java.lang.String target, XMLString data) throws XNIException
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.
target
- The target.data
- The data or null if none specified.XNIException
- Thrown by handler to signal an error.public void elementDecl(java.lang.String name, java.lang.String contentModel) throws XNIException
name
- The name of the element.contentModel
- The element content model.XNIException
- Thrown by handler to signal an error.public void startAttlist(java.lang.String elementName) throws XNIException
elementName
- The name of the element that this attribute
list is associated with.XNIException
- Thrown by handler to signal an error.public void attributeDecl(java.lang.String elementName, java.lang.String attributeName, java.lang.String type, java.lang.String[] enumeration, java.lang.String defaultType, XMLString defaultValue) throws XNIException
elementName
- The name of the element that this attribute
is associated with.attributeName
- The name of the attribute.type
- The attribute type. This value will be one of
the following: "CDATA", "ENTITY", "ENTITIES",
"ENUMERATION", "ID", "IDREF", "IDREFS",
"NMTOKEN", "NMTOKENS", or "NOTATION".enumeration
- If the type has the value "ENUMERATION" or
"NOTATION", this array holds the allowed attribute
values; otherwise, this array is null.defaultType
- The attribute default type. This value will be
one of the following: "#FIXED", "#IMPLIED",
"#REQUIRED", or null.defaultValue
- The attribute default value, or null if no
default value is specified.XNIException
- Thrown by handler to signal an error.public void endAttlist() throws XNIException
XNIException
- Thrown by handler to signal an error.public void internalEntityDecl(java.lang.String name, XMLString text, XMLString nonNormalizedText) throws XNIException
name
- The name of the entity. Parameter entity names start with
'%', whereas the name of a general entity is just the
entity name.text
- The value of the entity.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.XNIException
- Thrown by handler to signal an error.public void externalEntityDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId, java.lang.String baseSystemId) throws XNIException
name
- The name of the entity. Parameter entity names start
with '%', whereas the name of a general entity is just
the entity name.publicId
- The public identifier of the entity or null if the
the entity was specified with SYSTEM.systemId
- The system identifier of the entity.baseSystemId
- The base system identifier where this entity
is declared.XNIException
- Thrown by handler to signal an error.public void unparsedEntityDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId, java.lang.String notation) throws XNIException
name
- The name of the entity.publicId
- The public identifier of the entity, or null if not
specified.systemId
- The system identifier of the entity, or null if not
specified.notation
- The name of the notation.XNIException
- Thrown by handler to signal an error.public void notationDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId) throws XNIException
name
- The name of the notation.publicId
- The public identifier of the notation, or null if not
specified.systemId
- The system identifier of the notation, or null if not
specified.XNIException
- Thrown by handler to signal an error.public void startConditional(short type) throws XNIException
type
- The type of the conditional section. This value will
either be CONDITIONAL_INCLUDE or CONDITIONAL_IGNORE.XNIException
- Thrown by handler to signal an error.CONDITIONAL_INCLUDE
,
CONDITIONAL_IGNORE
public void characters(XMLString text) throws XNIException
text
- The ignored text.public void endConditional() throws XNIException
XNIException
- Thrown by handler to signal an error.public void endDTD() throws XNIException
XNIException
- Thrown by handler to signal an error.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |