| java.lang.Object
 org.apache.xerces.parsers.XMLParser
org.apache.xerces.parsers.AbstractXMLDocumentParser
All known Subclasses: org.apache.xerces.parsers.XMLDocumentParser, org.apache.xerces.parsers.AbstractSAXParser, org.apache.xerces.parsers.AbstractDOMParser,
| AbstractXMLDocumentParser | | abstract public class AbstractXMLDocumentParser extends XMLParser implements XMLDocumentHandler,XMLDTDHandler,XMLDTDContentModelHandler(Code) | | 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.
author:
Arnaud Le Hors, IBM
author:
Andy Clark, IBM
version:
$Id: AbstractXMLDocumentParser.java 447239 2006-09-18 05:08:26Z mrglavas $ |
| Method Summary | |
| public void | any(Augmentations augs)
A content model of ANY. | | public void | attributeDecl(String elementName, String attributeName, String type, String[] enumeration, String defaultType, XMLString defaultValue, XMLString nonNormalizedDefaultValue, Augmentations augs)
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 | characters(XMLString text, Augmentations augs)
Character content. | | public void | comment(XMLString text, Augmentations augs)
A comment. | | public void | doctypeDecl(String rootElement, String publicId, String systemId, Augmentations augs)
Notifies of the presence of the DOCTYPE line in the document. | | public void | element(String elementName, Augmentations augs)
A referenced element in a mixed or children content model. | | public void | elementDecl(String name, String contentModel, Augmentations augs)
An element declaration. | | public void | empty(Augmentations augs)
A content model of EMPTY. | | public void | emptyElement(QName element, XMLAttributes attributes, Augmentations augs)
An empty element. | | public void | endAttlist(Augmentations augs)
The end of an attribute list. | | public void | endCDATA(Augmentations augs)
The end of a CDATA section. | | public void | endConditional(Augmentations augs)
The end of a conditional section. | | public void | endContentModel(Augmentations augs)
The end of a content model. | | public void | endDTD(Augmentations augs)
The end of the DTD. | | public void | endDocument(Augmentations augs)
The end of the document. | | public void | endElement(QName element, Augmentations augs)
The end of an element. | | public void | endExternalSubset(Augmentations augmentations)
The end of the DTD external subset. | | public void | endGeneralEntity(String name, Augmentations augs)
This method notifies the end of an entity. | | public void | endGroup(Augmentations augs)
The end of a group for mixed or children content models. | | public void | endParameterEntity(String name, Augmentations augs)
This method notifies the end of an entity. | | public void | externalEntityDecl(String name, XMLResourceIdentifier identifier, Augmentations augs)
An external entity declaration.
Parameters:
name - The name of the entity. | | public XMLDTDContentModelSource | getDTDContentModelSource()
| | public XMLDTDSource | getDTDSource()
| | public XMLDocumentSource | getDocumentSource()
| | public void | ignorableWhitespace(XMLString text, Augmentations augs)
Ignorable whitespace. | | public void | ignoredCharacters(XMLString text, Augmentations augs)
Characters within an IGNORE conditional section. | | public void | internalEntityDecl(String name, XMLString text, XMLString nonNormalizedText, Augmentations augs)
An internal entity declaration.
Parameters:
name - The name of the entity. | | public void | notationDecl(String name, XMLResourceIdentifier identifier, Augmentations augs)
| | public void | occurrence(short occurrence, Augmentations augs)
The occurrence count for a child in a children content model or
for the mixed content model group. | | public void | pcdata(Augmentations augs)
The appearance of "#PCDATA" within a group signifying a
mixed content model. | | public void | processingInstruction(String target, XMLString data, Augmentations augs)
A processing instruction. | | protected void | reset()
| | public void | separator(short separator, Augmentations augs)
The separator between choices or sequences of a mixed or children
content model. | | public void | setDTDContentModelSource(XMLDTDContentModelSource source)
| | public void | setDTDSource(XMLDTDSource source)
| | public void | setDocumentSource(XMLDocumentSource source)
| | public void | startAttlist(String elementName, Augmentations augs)
The start of an attribute list. | | public void | startCDATA(Augmentations augs)
The start of a CDATA section. | | public void | startConditional(short type, Augmentations augs)
The start of a conditional section.
Parameters:
type - The type of the conditional section. | | public void | startContentModel(String elementName, Augmentations augs)
The start of a content model. | | public void | startDTD(XMLLocator locator, Augmentations augs)
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 | startDocument(XMLLocator locator, String encoding, NamespaceContext namespaceContext, Augmentations augs)
The start of the document.
Parameters:
locator - The system identifier of the entity if the entityis external, null otherwise.
Parameters:
encoding - The auto-detected IANA encoding name of the entitystream. | | public void | startElement(QName element, XMLAttributes attributes, Augmentations augs)
The start of an element. | | public void | startExternalSubset(XMLResourceIdentifier identifier, Augmentations augmentations)
The start of the DTD external subset. | | public void | startGeneralEntity(String name, XMLResourceIdentifier identifier, String encoding, Augmentations augs)
This method notifies the start of an entity.
Note: This method is not called for entity references
appearing as part of attribute values.
Parameters:
name - The name of the entity.
Parameters:
identifier - The resource identifier.
Parameters:
encoding - The auto-detected IANA encoding name of the entitystream. | | public void | startGroup(Augmentations augs)
A start of either a mixed or children content model. | | public void | startParameterEntity(String name, XMLResourceIdentifier identifier, String encoding, Augmentations augs)
This method notifies the start of an entity.
Note: This method is not called for entity references
appearing as part of attribute values.
Parameters:
name - The name of the entity.
Parameters:
identifier - The resource identifier.
Parameters:
encoding - The auto-detected IANA encoding name of the entitystream. | | public void | textDecl(String version, String encoding, Augmentations augs)
Notifies of the presence of a TextDecl line in an entity. | | public void | unparsedEntityDecl(String name, XMLResourceIdentifier identifier, String notation, Augmentations augs)
An unparsed entity declaration. | | public void | xmlDecl(String version, String encoding, String standalone, Augmentations augs)
Notifies of the presence of an XMLDecl line in the document. |
| fInDTD | | protected boolean fInDTD(Code) | | True if inside DTD.
|
| AbstractXMLDocumentParser | | protected AbstractXMLDocumentParser(XMLParserConfiguration config)(Code) | | Constructs a document parser using the default symbol table
and grammar pool.
|
| attributeDecl | | public void attributeDecl(String elementName, String attributeName, String type, String[] enumeration, String defaultType, XMLString defaultValue, XMLString nonNormalizedDefaultValue, Augmentations augs) 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:
augs - Additional information that may include infosetaugmentations.
throws:
XNIException - Thrown by handler to signal an error. |
| characters | | public void characters(XMLString text, Augmentations augs) throws XNIException(Code) | | Character content.
Parameters:
text - The content.
Parameters:
augs - Additional information that may include infoset augmentations
throws:
XNIException - Thrown by handler to signal an error. |
| comment | | public void comment(XMLString text, Augmentations augs) throws XNIException(Code) | | A comment.
Parameters:
text - The text in the comment.
Parameters:
augs - Additional information that may include infoset augmentations
exception:
XNIException - Thrown by application to signal an error. |
| doctypeDecl | | public void doctypeDecl(String rootElement, String publicId, String systemId, Augmentations augs) throws XNIException(Code) | | Notifies of the presence of the DOCTYPE line in the document.
Parameters:
rootElement - The name of the root element.
Parameters:
publicId - The public identifier if an external DTD or nullif the external DTD is specified using SYSTEM.
Parameters:
systemId - The system identifier if an external DTD, null
Parameters:
augs - Additional information that may include infoset augmentationsotherwise.
throws:
XNIException - Thrown by handler to signal an error. |
| element | | public void element(String elementName, Augmentations augs) throws XNIException(Code) | | A referenced element in a mixed or children content model.
Parameters:
elementName - The name of the referenced element.
Parameters:
augs - Additional information that may include infosetaugmentations.
throws:
XNIException - Thrown by handler to signal an error. |
| elementDecl | | public void elementDecl(String name, String contentModel, Augmentations augs) throws XNIException(Code) | | An element declaration.
Parameters:
name - The name of the element.
Parameters:
contentModel - The element content model.
Parameters:
augs - Additional information that may include infosetaugmentations.
throws:
XNIException - Thrown by handler to signal an error. |
| emptyElement | | public void emptyElement(QName element, XMLAttributes attributes, Augmentations augs) throws XNIException(Code) | | An empty element.
Parameters:
element - The name of the element.
Parameters:
attributes - The element attributes.
Parameters:
augs - Additional information that may include infoset augmentations
throws:
XNIException - Thrown by handler to signal an error. |
| endAttlist | | public void endAttlist(Augmentations augs) throws XNIException(Code) | | The end of an attribute list.
Parameters:
augs - Additional information that may include infosetaugmentations.
throws:
XNIException - Thrown by handler to signal an error. |
| endCDATA | | public void endCDATA(Augmentations augs) throws XNIException(Code) | | The end of a CDATA section.
Parameters:
augs - Additional information that may include infoset augmentations
throws:
XNIException - Thrown by handler to signal an error. |
| endConditional | | public void endConditional(Augmentations augs) throws XNIException(Code) | | The end of a conditional section.
Parameters:
augs - Additional information that may include infosetaugmentations.
throws:
XNIException - Thrown by handler to signal an error. |
| endContentModel | | public void endContentModel(Augmentations augs) throws XNIException(Code) | | The end of a content model.
Parameters:
augs - Additional information that may include infosetaugmentations.
throws:
XNIException - Thrown by handler to signal an error. |
| endDTD | | public void endDTD(Augmentations augs) throws XNIException(Code) | | The end of the DTD.
Parameters:
augs - Additional information that may include infosetaugmentations.
throws:
XNIException - Thrown by handler to signal an error. |
| endDocument | | public void endDocument(Augmentations augs) throws XNIException(Code) | | The end of the document.
Parameters:
augs - Additional information that may include infoset augmentations
throws:
XNIException - Thrown by handler to signal an error. |
| endElement | | public void endElement(QName element, Augmentations augs) throws XNIException(Code) | | The end of an element.
Parameters:
element - The name of the element.
Parameters:
augs - Additional information that may include infoset augmentations
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. |
| endGeneralEntity | | public void endGeneralEntity(String name, Augmentations augs) throws XNIException(Code) | | This method notifies the end of an entity.
Note: This method is not called for entity references
appearing as part of attribute values.
Parameters:
name - The name of the entity.
Parameters:
augs - Additional information that may include infoset augmentations
exception:
XNIException - Thrown by handler to signal an error. |
| endGroup | | public void endGroup(Augmentations augs) throws XNIException(Code) | | The end of a group for mixed or children content models.
Parameters:
augs - Additional information that may include infosetaugmentations.
throws:
XNIException - Thrown by handler to signal an error. |
| endParameterEntity | | public void endParameterEntity(String name, Augmentations augs) throws XNIException(Code) | | This method notifies the end of an entity.
Note: This method is not called for entity references
appearing as part of attribute values.
Parameters:
name - The name of the entity.
Parameters:
augs - Additional information that may include infoset augmentations
exception:
XNIException - Thrown by handler to signal an error. |
| externalEntityDecl | | public void externalEntityDecl(String name, XMLResourceIdentifier identifier, Augmentations augs) 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 entity.
Parameters:
augs - Additional information that may include infosetaugmentations.
throws:
XNIException - Thrown by handler to signal an error. |
| ignorableWhitespace | | public void ignorableWhitespace(XMLString text, Augmentations augs) throws XNIException(Code) | | 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.
Parameters:
text - The ignorable whitespace.
Parameters:
augs - Additional information that may include infoset augmentations
throws:
XNIException - Thrown by handler to signal an error. |
| ignoredCharacters | | public void ignoredCharacters(XMLString text, Augmentations augs) throws XNIException(Code) | | Characters within an IGNORE conditional section.
Parameters:
text - The ignored text.
Parameters:
augs - 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 augs) 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:
augs - Additional information that may include infosetaugmentations.
throws:
XNIException - Thrown by handler to signal an error. |
| notationDecl | | public void notationDecl(String name, XMLResourceIdentifier identifier, Augmentations augs) 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:
augs - Additional information that may include infosetaugmentations.
throws:
XNIException - Thrown by handler to signal an error. |
| pcdata | | public void pcdata(Augmentations augs) throws XNIException(Code) | | 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().
Parameters:
augs - Additional information that may include infosetaugmentations.
throws:
XNIException - Thrown by handler to signal an error.
See Also: AbstractXMLDocumentParser.startGroup |
| processingInstruction | | public void processingInstruction(String target, XMLString data, Augmentations augs) 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:
augs - Additional information that may include infoset augmentations
exception:
XNIException - Thrown by handler to signal an error. |
| startAttlist | | public void startAttlist(String elementName, Augmentations augs) throws XNIException(Code) | | The start of an attribute list.
Parameters:
elementName - The name of the element that this attributelist is associated with.
Parameters:
augs - Additional information that may include infosetaugmentations.
throws:
XNIException - Thrown by handler to signal an error. |
| startCDATA | | public void startCDATA(Augmentations augs) throws XNIException(Code) | | The start of a CDATA section.
Parameters:
augs - Additional information that may include infoset augmentations
throws:
XNIException - Thrown by handler to signal an error. |
| startContentModel | | public void startContentModel(String elementName, Augmentations augs) throws XNIException(Code) | | 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.
Parameters:
elementName - The name of the element.
Parameters:
augs - Additional information that may include infosetaugmentations.
throws:
XNIException - Thrown by handler to signal an error. |
| startDTD | | public void startDTD(XMLLocator locator, Augmentations augs) 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:
augs - Additional information that may include infosetaugmentations.
throws:
XNIException - Thrown by handler to signal an error. |
| startDocument | | public void startDocument(XMLLocator locator, String encoding, NamespaceContext namespaceContext, Augmentations augs) throws XNIException(Code) | | The start of the document.
Parameters:
locator - The system identifier of the entity if the entityis external, null otherwise.
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 entities or a document entity that isparsed from a java.io.Reader).
Parameters:
namespaceContext - The namespace context in effect at thestart of this document.This object represents the current context.Implementors of this class are responsiblefor copying the namespace bindings from thethe current context (and its parent contexts)if that information is important.
Parameters:
augs - Additional information that may include infoset augmentations
throws:
XNIException - Thrown by handler to signal an error. |
| startElement | | public void startElement(QName element, XMLAttributes attributes, Augmentations augs) throws XNIException(Code) | | 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.
Parameters:
element - The name of the element.
Parameters:
attributes - The element attributes.
Parameters:
augs - Additional information that may include infoset augmentations
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:
augmentations - Additional information that may include infosetaugmentations.
throws:
XNIException - Thrown by handler to signal an error. |
| startGeneralEntity | | public void startGeneralEntity(String name, XMLResourceIdentifier identifier, String encoding, Augmentations augs) throws XNIException(Code) | | This method notifies the start of an entity.
Note: This method is not called for entity references
appearing as part of attribute values.
Parameters:
name - The name of the 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 entities or a document entity that isparsed from a java.io.Reader).
Parameters:
augs - Additional information that may include infoset augmentations
exception:
XNIException - Thrown by handler to signal an error. |
| startParameterEntity | | public void startParameterEntity(String name, XMLResourceIdentifier identifier, String encoding, Augmentations augs) throws XNIException(Code) | | This method notifies the start of an entity.
Note: This method is not called for entity references
appearing as part of attribute values.
Parameters:
name - The name of the 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 entities or a document entity that isparsed from a java.io.Reader).
Parameters:
augs - Additional information that may include infoset augmentations
exception:
XNIException - Thrown by handler to signal an error. |
| textDecl | | public void textDecl(String version, String encoding, Augmentations augs) 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 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.
Parameters:
version - The XML version, or null if not specified.
Parameters:
encoding - The IANA encoding name of the entity.
Parameters:
augs - Additional information that may include infoset augmentations
exception:
XNIException - Thrown by handler to signal an error. |
| unparsedEntityDecl | | public void unparsedEntityDecl(String name, XMLResourceIdentifier identifier, String notation, Augmentations augs) 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 entity.
Parameters:
notation - The name of the notation.
Parameters:
augs - Additional information that may include infosetaugmentations.
throws:
XNIException - Thrown by handler to signal an error. |
| xmlDecl | | public void xmlDecl(String version, String encoding, String standalone, Augmentations augs) throws XNIException(Code) | | Notifies of the presence of an XMLDecl line in the document. If
present, this method will be called immediately following the
startDocument call.
Parameters:
version - The XML version.
Parameters:
encoding - The IANA encoding name of the document, or null ifnot specified.
Parameters:
standalone - The standalone value, or null if not specified.
Parameters:
augs - Additional information that may include infoset augmentations
throws:
XNIException - Thrown by handler to signal an error. |
|
|