org.apache.xerces.parsers

Class AbstractXMLDocumentParser

public abstract class AbstractXMLDocumentParser extends XMLParser implements XMLDocumentHandler, XMLDTDHandler, XMLDTDContentModelHandler

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.

Version: $Id: AbstractXMLDocumentParser.java,v 1.18 2004/02/24 23:15:56 mrglavas Exp $

Author: Arnaud Le Hors, IBM Andy Clark, IBM

Field Summary
protected XMLDocumentSourcefDocumentSource
Document source
protected XMLDTDContentModelSourcefDTDContentModelSource
DTD content model source
protected XMLDTDSourcefDTDSource
DTD source
protected booleanfInDTD
True if inside DTD.
Constructor Summary
protected AbstractXMLDocumentParser(XMLParserConfiguration config)
Constructs a document parser using the default symbol table and grammar pool.
Method Summary
voidany(Augmentations augs)
A content model of ANY.
voidattributeDecl(String elementName, String attributeName, String type, String[] enumeration, String defaultType, XMLString defaultValue, XMLString nonNormalizedDefaultValue, Augmentations augs)
An attribute declaration.
voidcharacters(XMLString text, Augmentations augs)
Character content.
voidcomment(XMLString text, Augmentations augs)
A comment.
voiddoctypeDecl(String rootElement, String publicId, String systemId, Augmentations augs)
Notifies of the presence of the DOCTYPE line in the document.
voidelement(String elementName, Augmentations augs)
A referenced element in a mixed or children content model.
voidelementDecl(String name, String contentModel, Augmentations augs)
An element declaration.
voidempty(Augmentations augs)
A content model of EMPTY.
voidemptyElement(QName element, XMLAttributes attributes, Augmentations augs)
An empty element.
voidendAttlist(Augmentations augs)
The end of an attribute list.
voidendCDATA(Augmentations augs)
The end of a CDATA section.
voidendConditional(Augmentations augs)
The end of a conditional section.
voidendContentModel(Augmentations augs)
The end of a content model.
voidendDocument(Augmentations augs)
The end of the document.
voidendDTD(Augmentations augs)
The end of the DTD.
voidendElement(QName element, Augmentations augs)
The end of an element.
voidendExternalSubset(Augmentations augmentations)
The end of the DTD external subset.
voidendGeneralEntity(String name, Augmentations augs)
This method notifies the end of an entity.
voidendGroup(Augmentations augs)
The end of a group for mixed or children content models.
voidendParameterEntity(String name, Augmentations augs)
This method notifies the end of an entity.
voidexternalEntityDecl(String name, XMLResourceIdentifier identifier, Augmentations augs)
An external entity declaration.
XMLDocumentSourcegetDocumentSource()
Returns the document source
XMLDTDContentModelSourcegetDTDContentModelSource()
XMLDTDSourcegetDTDSource()
voidignorableWhitespace(XMLString text, Augmentations augs)
Ignorable whitespace.
voidignoredCharacters(XMLString text, Augmentations augs)
Characters within an IGNORE conditional section.
voidinternalEntityDecl(String name, XMLString text, XMLString nonNormalizedText, Augmentations augs)
An internal entity declaration.
voidnotationDecl(String name, XMLResourceIdentifier identifier, Augmentations augs)
A notation declaration
voidoccurrence(short occurrence, Augmentations augs)
The occurrence count for a child in a children content model or for the mixed content model group.
voidpcdata(Augmentations augs)
The appearance of "#PCDATA" within a group signifying a mixed content model.
voidprocessingInstruction(String target, XMLString data, Augmentations augs)
A processing instruction.
protected voidreset()
reset all components before parsing
voidseparator(short separator, Augmentations augs)
The separator between choices or sequences of a mixed or children content model.
voidsetDocumentSource(XMLDocumentSource source)
Sets the document source
voidsetDTDContentModelSource(XMLDTDContentModelSource source)
voidsetDTDSource(XMLDTDSource source)
voidstartAttlist(String elementName, Augmentations augs)
The start of an attribute list.
voidstartCDATA(Augmentations augs)
The start of a CDATA section.
voidstartConditional(short type, Augmentations augs)
The start of a conditional section.
voidstartContentModel(String elementName, Augmentations augs)
The start of a content model.
voidstartDocument(XMLLocator locator, String encoding, NamespaceContext namespaceContext, Augmentations augs)
The start of the document.
voidstartDTD(XMLLocator locator, Augmentations augs)
The start of the DTD.
voidstartElement(QName element, XMLAttributes attributes, Augmentations augs)
The start of an element.
voidstartExternalSubset(XMLResourceIdentifier identifier, Augmentations augmentations)
The start of the DTD external subset.
voidstartGeneralEntity(String name, XMLResourceIdentifier identifier, String encoding, Augmentations augs)
This method notifies the start of an entity.
voidstartGroup(Augmentations augs)
A start of either a mixed or children content model.
voidstartParameterEntity(String name, XMLResourceIdentifier identifier, String encoding, Augmentations augs)
This method notifies the start of an entity.
voidtextDecl(String version, String encoding, Augmentations augs)
Notifies of the presence of a TextDecl line in an entity.
voidunparsedEntityDecl(String name, XMLResourceIdentifier identifier, String notation, Augmentations augs)
An unparsed entity declaration.
voidxmlDecl(String version, String encoding, String standalone, Augmentations augs)
Notifies of the presence of an XMLDecl line in the document.

Field Detail

fDocumentSource

protected XMLDocumentSource fDocumentSource
Document source

fDTDContentModelSource

protected XMLDTDContentModelSource fDTDContentModelSource
DTD content model source

fDTDSource

protected XMLDTDSource fDTDSource
DTD source

fInDTD

protected boolean fInDTD
True if inside DTD.

Constructor Detail

AbstractXMLDocumentParser

protected AbstractXMLDocumentParser(XMLParserConfiguration config)
Constructs a document parser using the default symbol table and grammar pool.

Method Detail

any

public void any(Augmentations augs)
A content model of ANY.

Parameters: augs Additional information that may include infoset augmentations.

Throws: XNIException Thrown by handler to signal an error.

See Also: AbstractXMLDocumentParser AbstractXMLDocumentParser

attributeDecl

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 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.

Throws: XNIException Thrown by handler to signal an error.

characters

public void characters(XMLString text, Augmentations augs)
Character content.

Parameters: text The content. 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)
A comment.

Parameters: text The text in the comment. augs Additional information that may include infoset augmentations

Throws: XNIException Thrown by application to signal an error.

doctypeDecl

public void doctypeDecl(String rootElement, String publicId, String systemId, Augmentations augs)
Notifies of the presence of the DOCTYPE line in the document.

Parameters: 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, null augs Additional information that may include infoset augmentations otherwise.

Throws: XNIException Thrown by handler to signal an error.

element

public void element(String elementName, Augmentations augs)
A referenced element in a mixed or children content model.

Parameters: elementName The name of the referenced element. augs Additional information that may include infoset augmentations.

Throws: XNIException Thrown by handler to signal an error.

elementDecl

public void elementDecl(String name, String contentModel, Augmentations augs)
An element declaration.

Parameters: name The name of the element. contentModel The element content model. augs Additional information that may include infoset augmentations.

Throws: XNIException Thrown by handler to signal an error.

empty

public void empty(Augmentations augs)
A content model of EMPTY.

Parameters: augs Additional information that may include infoset augmentations.

Throws: XNIException Thrown by handler to signal an error.

See Also: AbstractXMLDocumentParser AbstractXMLDocumentParser

emptyElement

public void emptyElement(QName element, XMLAttributes attributes, Augmentations augs)
An empty element.

Parameters: element The name of the element. attributes The element attributes. augs Additional information that may include infoset augmentations

Throws: XNIException Thrown by handler to signal an error.

endAttlist

public void endAttlist(Augmentations augs)
The end of an attribute list.

Parameters: augs Additional information that may include infoset augmentations.

Throws: XNIException Thrown by handler to signal an error.

endCDATA

public void endCDATA(Augmentations augs)
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)
The end of a conditional section.

Parameters: augs Additional information that may include infoset augmentations.

Throws: XNIException Thrown by handler to signal an error.

endContentModel

public void endContentModel(Augmentations augs)
The end of a content model.

Parameters: augs Additional information that may include infoset augmentations.

Throws: XNIException Thrown by handler to signal an error.

endDocument

public void endDocument(Augmentations augs)
The end of the document.

Parameters: augs Additional information that may include infoset augmentations

Throws: XNIException Thrown by handler to signal an error.

endDTD

public void endDTD(Augmentations augs)
The end of the DTD.

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)
The end of an element.

Parameters: element The name of the element. augs Additional information that may include infoset augmentations

Throws: XNIException Thrown by handler to signal an error.

endExternalSubset

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

Parameters: augmentations Additional information that may include infoset augmentations.

Throws: XNIException Thrown by handler to signal an error.

endGeneralEntity

public void endGeneralEntity(String name, Augmentations augs)
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. augs Additional information that may include infoset augmentations

Throws: XNIException Thrown by handler to signal an error.

endGroup

public void endGroup(Augmentations augs)
The end of a group for mixed or children content models.

Parameters: augs Additional information that may include infoset augmentations.

Throws: XNIException Thrown by handler to signal an error.

endParameterEntity

public void endParameterEntity(String name, Augmentations augs)
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. augs Additional information that may include infoset augmentations

Throws: XNIException Thrown by handler to signal an error.

externalEntityDecl

public void externalEntityDecl(String name, XMLResourceIdentifier identifier, Augmentations augs)
An external 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. identifier An object containing all location information pertinent to this entity. augs Additional information that may include infoset augmentations.

Throws: XNIException Thrown by handler to signal an error.

getDocumentSource

public XMLDocumentSource getDocumentSource()
Returns the document source

getDTDContentModelSource

public XMLDTDContentModelSource getDTDContentModelSource()

getDTDSource

public XMLDTDSource getDTDSource()

ignorableWhitespace

public void ignorableWhitespace(XMLString text, Augmentations augs)
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. 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)
Characters within an IGNORE conditional section.

Parameters: text The ignored text. augs Additional information that may include infoset augmentations.

Throws: XNIException Thrown by handler to signal an error.

internalEntityDecl

public void internalEntityDecl(String name, XMLString text, XMLString nonNormalizedText, Augmentations augs)
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. 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.

Throws: XNIException Thrown by handler to signal an error.

notationDecl

public void notationDecl(String name, XMLResourceIdentifier identifier, Augmentations augs)
A notation declaration

Parameters: 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.

Throws: XNIException Thrown by handler to signal an error.

occurrence

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.

Parameters: occurrence The occurrence count for the last element or group. augs Additional information that may include infoset augmentations.

Throws: XNIException Thrown by handler to signal an error.

See Also: AbstractXMLDocumentParser AbstractXMLDocumentParser AbstractXMLDocumentParser

pcdata

public void pcdata(Augmentations augs)
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 infoset augmentations.

Throws: XNIException Thrown by handler to signal an error.

See Also: AbstractXMLDocumentParser

processingInstruction

public void processingInstruction(String target, XMLString data, Augmentations augs)
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. data The data or null if none specified. augs Additional information that may include infoset augmentations

Throws: XNIException Thrown by handler to signal an error.

reset

protected void reset()
reset all components before parsing

separator

public void separator(short separator, Augmentations augs)
The separator between choices or sequences of a mixed or children content model.

Parameters: separator The type of children separator. augs Additional information that may include infoset augmentations.

Throws: XNIException Thrown by handler to signal an error.

See Also: AbstractXMLDocumentParser AbstractXMLDocumentParser

setDocumentSource

public void setDocumentSource(XMLDocumentSource source)
Sets the document source

setDTDContentModelSource

public void setDTDContentModelSource(XMLDTDContentModelSource source)

setDTDSource

public void setDTDSource(XMLDTDSource source)

startAttlist

public void startAttlist(String elementName, Augmentations augs)
The start of an attribute list.

Parameters: elementName The name of the element that this attribute list is associated with. augs Additional information that may include infoset augmentations.

Throws: XNIException Thrown by handler to signal an error.

startCDATA

public void startCDATA(Augmentations augs)
The start of a CDATA section.

Parameters: augs Additional information that may include infoset augmentations

Throws: XNIException Thrown by handler to signal an error.

startConditional

public void startConditional(short type, Augmentations augs)
The start of a conditional section.

Parameters: 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.

Throws: XNIException Thrown by handler to signal an error.

See Also: AbstractXMLDocumentParser AbstractXMLDocumentParser

startContentModel

public void startContentModel(String elementName, Augmentations augs)
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. augs Additional information that may include infoset augmentations.

Throws: XNIException Thrown by handler to signal an error.

startDocument

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 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

Throws: XNIException Thrown by handler to signal an error.

startDTD

public void startDTD(XMLLocator locator, Augmentations augs)
The start of the DTD.

Parameters: 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.

Throws: XNIException Thrown by handler to signal an error.

startElement

public void startElement(QName element, XMLAttributes attributes, Augmentations augs)
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. attributes The element attributes. 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)
The start of the DTD external subset.

Parameters: augmentations Additional information that may include infoset augmentations.

Throws: XNIException Thrown by handler to signal an error.

startGeneralEntity

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. 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

Throws: XNIException Thrown by handler to signal an error.

startGroup

public void startGroup(Augmentations augs)
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.

Parameters: augs Additional information that may include infoset augmentations.

Throws: XNIException Thrown by handler to signal an error.

See Also: AbstractXMLDocumentParser AbstractXMLDocumentParser

startParameterEntity

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. 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

Throws: XNIException Thrown by handler to signal an error.

textDecl

public void textDecl(String version, String encoding, Augmentations augs)
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. encoding The IANA encoding name of the entity. augs Additional information that may include infoset augmentations

Throws: XNIException Thrown by handler to signal an error.

unparsedEntityDecl

public void unparsedEntityDecl(String name, XMLResourceIdentifier identifier, String notation, Augmentations augs)
An unparsed entity declaration.

Parameters: 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.

Throws: XNIException Thrown by handler to signal an error.

xmlDecl

public void xmlDecl(String version, String encoding, String standalone, Augmentations augs)
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. 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

Throws: XNIException Thrown by handler to signal an error.

Copyright B) 1999-2005 Apache XML Project. All Rights Reserved.