This is the base class for all XML document parsers. XMLDocumentParser
provides a common implementation shared by the various document parsers
in the Xerces package. While this class is provided for convenience, it
does not prevent other kinds of parsers to be constructed using the XNI
interfaces.
any
public void any(org.apache.xerces.xni.Augmentations augs)
throws org.apache.xerces.xni.XNIException
A content model of ANY.
- any in interface org.apache.xerces.xni.XMLDTDContentModelHandler
augs
- Additional information that may include infoset
augmentations.
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
attributeDecl
public void attributeDecl(String elementName,
String attributeName,
String type,
String[] enumeration,
String defaultType,
org.apache.xerces.xni.XMLString defaultValue,
org.apache.xerces.xni.XMLString nonNormalizedDefaultValue,
org.apache.xerces.xni.Augmentations augs)
throws org.apache.xerces.xni.XNIException
An attribute declaration.
- attributeDecl in interface org.apache.xerces.xni.XMLDTDHandler
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.nonNormalizedDefaultValue
- The attribute default value with no normalization
performed, or null if no default value is specified.augs
- Additional information that may include infoset
augmentations.
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
characters
public void characters(org.apache.xerces.xni.XMLString text,
org.apache.xerces.xni.Augmentations augs)
throws org.apache.xerces.xni.XNIException
Character content.
- characters in interface org.apache.xerces.xni.XMLDocumentHandler
text
- The content.augs
- Additional information that may include infoset augmentations
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
comment
public void comment(org.apache.xerces.xni.XMLString text,
org.apache.xerces.xni.Augmentations augs)
throws org.apache.xerces.xni.XNIException
A comment.
- comment in interface org.apache.xerces.xni.XMLDocumentHandler
- comment in interface org.apache.xerces.xni.XMLDTDHandler
text
- The text in the comment.augs
- Additional information that may include infoset augmentations
org.apache.xerces.xni.XNIException
- Thrown by application to signal an error.
doctypeDecl
public void doctypeDecl(String rootElement,
String publicId,
String systemId,
org.apache.xerces.xni.Augmentations augs)
throws org.apache.xerces.xni.XNIException
Notifies of the presence of the DOCTYPE line in the document.
- doctypeDecl in interface org.apache.xerces.xni.XMLDocumentHandler
rootElement
- The name of the root element.publicId
- The public identifier if an external DTD or null
if the external DTD is specified using SYSTEM.systemId
- The system identifier if an external DTD, nullaugs
- Additional information that may include infoset augmentations
otherwise.
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
element
public void element(String elementName,
org.apache.xerces.xni.Augmentations augs)
throws org.apache.xerces.xni.XNIException
A referenced element in a mixed or children content model.
- element in interface org.apache.xerces.xni.XMLDTDContentModelHandler
elementName
- The name of the referenced element.augs
- Additional information that may include infoset
augmentations.
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
elementDecl
public void elementDecl(String name,
String contentModel,
org.apache.xerces.xni.Augmentations augs)
throws org.apache.xerces.xni.XNIException
An element declaration.
- elementDecl in interface org.apache.xerces.xni.XMLDTDHandler
name
- The name of the element.contentModel
- The element content model.augs
- Additional information that may include infoset
augmentations.
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
empty
public void empty(org.apache.xerces.xni.Augmentations augs)
throws org.apache.xerces.xni.XNIException
A content model of EMPTY.
- empty in interface org.apache.xerces.xni.XMLDTDContentModelHandler
augs
- Additional information that may include infoset
augmentations.
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
emptyElement
public void emptyElement(org.apache.xerces.xni.QName element,
org.apache.xerces.xni.XMLAttributes attributes,
org.apache.xerces.xni.Augmentations augs)
throws org.apache.xerces.xni.XNIException
An empty element.
- emptyElement in interface org.apache.xerces.xni.XMLDocumentHandler
element
- The name of the element.attributes
- The element attributes.augs
- Additional information that may include infoset augmentations
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
endAttlist
public void endAttlist(org.apache.xerces.xni.Augmentations augs)
throws org.apache.xerces.xni.XNIException
The end of an attribute list.
- endAttlist in interface org.apache.xerces.xni.XMLDTDHandler
augs
- Additional information that may include infoset
augmentations.
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
endCDATA
public void endCDATA(org.apache.xerces.xni.Augmentations augs)
throws org.apache.xerces.xni.XNIException
The end of a CDATA section.
- endCDATA in interface org.apache.xerces.xni.XMLDocumentHandler
augs
- Additional information that may include infoset augmentations
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
endConditional
public void endConditional(org.apache.xerces.xni.Augmentations augs)
throws org.apache.xerces.xni.XNIException
The end of a conditional section.
- endConditional in interface org.apache.xerces.xni.XMLDTDHandler
augs
- Additional information that may include infoset
augmentations.
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
endContentModel
public void endContentModel(org.apache.xerces.xni.Augmentations augs)
throws org.apache.xerces.xni.XNIException
The end of a content model.
- endContentModel in interface org.apache.xerces.xni.XMLDTDContentModelHandler
augs
- Additional information that may include infoset
augmentations.
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
endDTD
public void endDTD(org.apache.xerces.xni.Augmentations augs)
throws org.apache.xerces.xni.XNIException
The end of the DTD.
- endDTD in interface org.apache.xerces.xni.XMLDTDHandler
augs
- Additional information that may include infoset
augmentations.
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
endDocument
public void endDocument(org.apache.xerces.xni.Augmentations augs)
throws org.apache.xerces.xni.XNIException
The end of the document.
- endDocument in interface org.apache.xerces.xni.XMLDocumentHandler
augs
- Additional information that may include infoset augmentations
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
endElement
public void endElement(org.apache.xerces.xni.QName element,
org.apache.xerces.xni.Augmentations augs)
throws org.apache.xerces.xni.XNIException
The end of an element.
- endElement in interface org.apache.xerces.xni.XMLDocumentHandler
element
- The name of the element.augs
- Additional information that may include infoset augmentations
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
endExternalSubset
public void endExternalSubset(org.apache.xerces.xni.Augmentations augmentations)
throws org.apache.xerces.xni.XNIException
The end of the DTD external subset.
- endExternalSubset in interface org.apache.xerces.xni.XMLDTDHandler
augmentations
- Additional information that may include infoset
augmentations.
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
endGeneralEntity
public void endGeneralEntity(String name,
org.apache.xerces.xni.Augmentations augs)
throws org.apache.xerces.xni.XNIException
This method notifies the end of an entity.
Note: This method is not called for entity references
appearing as part of attribute values.
- endGeneralEntity in interface org.apache.xerces.xni.XMLDocumentHandler
name
- The name of the entity.augs
- Additional information that may include infoset augmentations
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
endGroup
public void endGroup(org.apache.xerces.xni.Augmentations augs)
throws org.apache.xerces.xni.XNIException
The end of a group for mixed or children content models.
- endGroup in interface org.apache.xerces.xni.XMLDTDContentModelHandler
augs
- Additional information that may include infoset
augmentations.
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
endParameterEntity
public void endParameterEntity(String name,
org.apache.xerces.xni.Augmentations augs)
throws org.apache.xerces.xni.XNIException
This method notifies the end of an entity.
Note: This method is not called for entity references
appearing as part of attribute values.
- endParameterEntity in interface org.apache.xerces.xni.XMLDTDHandler
name
- The name of the entity.augs
- Additional information that may include infoset augmentations
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
externalEntityDecl
public void externalEntityDecl(String name,
org.apache.xerces.xni.XMLResourceIdentifier identifier,
org.apache.xerces.xni.Augmentations augs)
throws org.apache.xerces.xni.XNIException
An external entity declaration.
- externalEntityDecl in interface org.apache.xerces.xni.XMLDTDHandler
name
- The name of the entity. Parameter entity names start
with '%', whereas the name of a general entity is just
the entity name.identifier
- An object containing all location information
pertinent to this entity.augs
- Additional information that may include infoset
augmentations.
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
getDTDContentModelSource
public org.apache.xerces.xni.parser.XMLDTDContentModelSource getDTDContentModelSource()
- getDTDContentModelSource in interface org.apache.xerces.xni.XMLDTDContentModelHandler
getDTDSource
public org.apache.xerces.xni.parser.XMLDTDSource getDTDSource()
- getDTDSource in interface org.apache.xerces.xni.XMLDTDHandler
getDocumentSource
public org.apache.xerces.xni.parser.XMLDocumentSource getDocumentSource()
Returns the document source
- getDocumentSource in interface org.apache.xerces.xni.XMLDocumentHandler
ignorableWhitespace
public void ignorableWhitespace(org.apache.xerces.xni.XMLString text,
org.apache.xerces.xni.Augmentations augs)
throws org.apache.xerces.xni.XNIException
Ignorable whitespace. For this method to be called, the document
source must have some way of determining that the text containing
only whitespace characters should be considered ignorable. For
example, the validator can determine if a length of whitespace
characters in the document are ignorable based on the element
content model.
- ignorableWhitespace in interface org.apache.xerces.xni.XMLDocumentHandler
text
- The ignorable whitespace.augs
- Additional information that may include infoset augmentations
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
ignoredCharacters
public void ignoredCharacters(org.apache.xerces.xni.XMLString text,
org.apache.xerces.xni.Augmentations augs)
throws org.apache.xerces.xni.XNIException
Characters within an IGNORE conditional section.
- ignoredCharacters in interface org.apache.xerces.xni.XMLDTDHandler
text
- The ignored text.augs
- Additional information that may include infoset
augmentations.
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
internalEntityDecl
public void internalEntityDecl(String name,
org.apache.xerces.xni.XMLString text,
org.apache.xerces.xni.XMLString nonNormalizedText,
org.apache.xerces.xni.Augmentations augs)
throws org.apache.xerces.xni.XNIException
An internal entity declaration.
- internalEntityDecl in interface org.apache.xerces.xni.XMLDTDHandler
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.augs
- Additional information that may include infoset
augmentations.
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
notationDecl
public void notationDecl(String name,
org.apache.xerces.xni.XMLResourceIdentifier identifier,
org.apache.xerces.xni.Augmentations augs)
throws org.apache.xerces.xni.XNIException
A notation declaration
- notationDecl in interface org.apache.xerces.xni.XMLDTDHandler
name
- The name of the notation.identifier
- An object containing all location information
pertinent to this notation.augs
- Additional information that may include infoset
augmentations.
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
occurrence
public void occurrence(short occurrence,
org.apache.xerces.xni.Augmentations augs)
throws org.apache.xerces.xni.XNIException
The occurrence count for a child in a children content model or
for the mixed content model group.
- occurrence in interface org.apache.xerces.xni.XMLDTDContentModelHandler
occurrence
- The occurrence count for the last element
or group.augs
- Additional information that may include infoset
augmentations.
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
pcdata
public void pcdata(org.apache.xerces.xni.Augmentations augs)
throws org.apache.xerces.xni.XNIException
The appearance of "#PCDATA" within a group signifying a
mixed content model. This method will be the first called
following the content model's startGroup()
.
- pcdata in interface org.apache.xerces.xni.XMLDTDContentModelHandler
augs
- Additional information that may include infoset
augmentations.
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
processingInstruction
public void processingInstruction(String target,
org.apache.xerces.xni.XMLString data,
org.apache.xerces.xni.Augmentations augs)
throws org.apache.xerces.xni.XNIException
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.
- processingInstruction in interface org.apache.xerces.xni.XMLDocumentHandler
- processingInstruction in interface org.apache.xerces.xni.XMLDTDHandler
target
- The target.data
- The data or null if none specified.augs
- Additional information that may include infoset augmentations
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
reset
protected void reset()
throws org.apache.xerces.xni.XNIException
reset all components before parsing
- reset in interface XMLParser
separator
public void separator(short separator,
org.apache.xerces.xni.Augmentations augs)
throws org.apache.xerces.xni.XNIException
The separator between choices or sequences of a mixed or children
content model.
- separator in interface org.apache.xerces.xni.XMLDTDContentModelHandler
separator
- The type of children separator.augs
- Additional information that may include infoset
augmentations.
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
setDTDContentModelSource
public void setDTDContentModelSource(org.apache.xerces.xni.parser.XMLDTDContentModelSource source)
- setDTDContentModelSource in interface org.apache.xerces.xni.XMLDTDContentModelHandler
setDTDSource
public void setDTDSource(org.apache.xerces.xni.parser.XMLDTDSource source)
- setDTDSource in interface org.apache.xerces.xni.XMLDTDHandler
setDocumentSource
public void setDocumentSource(org.apache.xerces.xni.parser.XMLDocumentSource source)
Sets the document source
- setDocumentSource in interface org.apache.xerces.xni.XMLDocumentHandler
startAttlist
public void startAttlist(String elementName,
org.apache.xerces.xni.Augmentations augs)
throws org.apache.xerces.xni.XNIException
The start of an attribute list.
- startAttlist in interface org.apache.xerces.xni.XMLDTDHandler
elementName
- The name of the element that this attribute
list is associated with.augs
- Additional information that may include infoset
augmentations.
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
startCDATA
public void startCDATA(org.apache.xerces.xni.Augmentations augs)
throws org.apache.xerces.xni.XNIException
The start of a CDATA section.
- startCDATA in interface org.apache.xerces.xni.XMLDocumentHandler
augs
- Additional information that may include infoset augmentations
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
startConditional
public void startConditional(short type,
org.apache.xerces.xni.Augmentations augs)
throws org.apache.xerces.xni.XNIException
The start of a conditional section.
- startConditional in interface org.apache.xerces.xni.XMLDTDHandler
type
- The type of the conditional section. This value will
either be CONDITIONAL_INCLUDE or CONDITIONAL_IGNORE.augs
- Additional information that may include infoset
augmentations.
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
startContentModel
public void startContentModel(String elementName,
org.apache.xerces.xni.Augmentations augs)
throws org.apache.xerces.xni.XNIException
The start of a content model. Depending on the type of the content
model, specific methods may be called between the call to the
startContentModel method and the call to the endContentModel method.
- startContentModel in interface org.apache.xerces.xni.XMLDTDContentModelHandler
elementName
- The name of the element.augs
- Additional information that may include infoset
augmentations.
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
startDTD
public void startDTD(org.apache.xerces.xni.XMLLocator locator,
org.apache.xerces.xni.Augmentations augs)
throws org.apache.xerces.xni.XNIException
The start of the DTD.
- startDTD in interface org.apache.xerces.xni.XMLDTDHandler
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.augs
- Additional information that may include infoset
augmentations.
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
startDocument
public void startDocument(org.apache.xerces.xni.XMLLocator locator,
String encoding,
org.apache.xerces.xni.NamespaceContext namespaceContext,
org.apache.xerces.xni.Augmentations augs)
throws org.apache.xerces.xni.XNIException
The start of the document.
- startDocument in interface org.apache.xerces.xni.XMLDocumentHandler
locator
- The 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 entities or a document entity that is
parsed from a java.io.Reader).namespaceContext
- The namespace context in effect at the
start of this document.
This object represents the current context.
Implementors of this class are responsible
for copying the namespace bindings from the
the current context (and its parent contexts)
if that information is important.augs
- Additional information that may include infoset augmentations
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
startElement
public void startElement(org.apache.xerces.xni.QName element,
org.apache.xerces.xni.XMLAttributes attributes,
org.apache.xerces.xni.Augmentations augs)
throws org.apache.xerces.xni.XNIException
The start of an element. If the document specifies the start element
by using an empty tag, then the startElement method will immediately
be followed by the endElement method, with no intervening methods.
- startElement in interface org.apache.xerces.xni.XMLDocumentHandler
element
- The name of the element.attributes
- The element attributes.augs
- Additional information that may include infoset augmentations
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
startExternalSubset
public void startExternalSubset(org.apache.xerces.xni.XMLResourceIdentifier identifier,
org.apache.xerces.xni.Augmentations augmentations)
throws org.apache.xerces.xni.XNIException
The start of the DTD external subset.
- startExternalSubset in interface org.apache.xerces.xni.XMLDTDHandler
augmentations
- Additional information that may include infoset
augmentations.
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
startGeneralEntity
public void startGeneralEntity(String name,
org.apache.xerces.xni.XMLResourceIdentifier identifier,
String encoding,
org.apache.xerces.xni.Augmentations augs)
throws org.apache.xerces.xni.XNIException
This method notifies the start of an entity.
Note: This method is not called for entity references
appearing as part of attribute values.
- startGeneralEntity in interface org.apache.xerces.xni.XMLDocumentHandler
name
- The name of the entity.identifier
- The resource identifier.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 entities or a document entity that is
parsed from a java.io.Reader).augs
- Additional information that may include infoset augmentations
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
startGroup
public void startGroup(org.apache.xerces.xni.Augmentations augs)
throws org.apache.xerces.xni.XNIException
A start of either a mixed or children content model. A mixed
content model will immediately be followed by a call to the
pcdata()
method. A children content model will
contain additional groups and/or elements.
- startGroup in interface org.apache.xerces.xni.XMLDTDContentModelHandler
augs
- Additional information that may include infoset
augmentations.
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
startParameterEntity
public void startParameterEntity(String name,
org.apache.xerces.xni.XMLResourceIdentifier identifier,
String encoding,
org.apache.xerces.xni.Augmentations augs)
throws org.apache.xerces.xni.XNIException
This method notifies the start of an entity.
Note: This method is not called for entity references
appearing as part of attribute values.
- startParameterEntity in interface org.apache.xerces.xni.XMLDTDHandler
name
- The name of the entity.identifier
- The resource identifier.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 entities or a document entity that is
parsed from a java.io.Reader).augs
- Additional information that may include infoset augmentations
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
textDecl
public void textDecl(String version,
String encoding,
org.apache.xerces.xni.Augmentations augs)
throws org.apache.xerces.xni.XNIException
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 will never be called for the
document entity; it is only called for external general entities
referenced in document content.
Note: This method is not called for entity references
appearing as part of attribute values.
- textDecl in interface org.apache.xerces.xni.XMLDocumentHandler
- textDecl in interface org.apache.xerces.xni.XMLDTDHandler
version
- The XML version, or null if not specified.encoding
- The IANA encoding name of the entity.augs
- Additional information that may include infoset augmentations
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
unparsedEntityDecl
public void unparsedEntityDecl(String name,
org.apache.xerces.xni.XMLResourceIdentifier identifier,
String notation,
org.apache.xerces.xni.Augmentations augs)
throws org.apache.xerces.xni.XNIException
An unparsed entity declaration.
- unparsedEntityDecl in interface org.apache.xerces.xni.XMLDTDHandler
name
- The name of the entity.identifier
- An object containing all location information
pertinent to this entity.notation
- The name of the notation.augs
- Additional information that may include infoset
augmentations.
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
xmlDecl
public void xmlDecl(String version,
String encoding,
String standalone,
org.apache.xerces.xni.Augmentations augs)
throws org.apache.xerces.xni.XNIException
Notifies of the presence of an XMLDecl line in the document. If
present, this method will be called immediately following the
startDocument call.
- xmlDecl in interface org.apache.xerces.xni.XMLDocumentHandler
version
- The XML version.encoding
- The IANA encoding name of the document, or null if
not specified.standalone
- The standalone value, or null if not specified.augs
- Additional information that may include infoset augmentations
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.