Class AbstractXMLDocumentParser
- All Implemented Interfaces:
org.apache.xerces.xni.XMLDocumentHandler
,org.apache.xerces.xni.XMLDTDContentModelHandler
,org.apache.xerces.xni.XMLDTDHandler
- Direct Known Subclasses:
AbstractDOMParser
,AbstractSAXParser
,XMLDocumentParser
- Version:
- $Id: AbstractXMLDocumentParser.java 447239 2006-09-18 05:08:26Z mrglavas $
- Author:
- Arnaud Le Hors, IBM, Andy Clark, IBM
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected org.apache.xerces.xni.parser.XMLDocumentSource
Document sourceprotected org.apache.xerces.xni.parser.XMLDTDContentModelSource
DTD content model sourceprotected org.apache.xerces.xni.parser.XMLDTDSource
DTD sourceprotected boolean
True if inside DTD.Fields inherited from class org.apache.xerces.parsers.XMLParser
ENTITY_RESOLVER, ERROR_HANDLER, fConfiguration
Fields inherited from interface org.apache.xerces.xni.XMLDTDContentModelHandler
OCCURS_ONE_OR_MORE, OCCURS_ZERO_OR_MORE, OCCURS_ZERO_OR_ONE, SEPARATOR_CHOICE, SEPARATOR_SEQUENCE
Fields inherited from interface org.apache.xerces.xni.XMLDTDHandler
CONDITIONAL_IGNORE, CONDITIONAL_INCLUDE
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
AbstractXMLDocumentParser
(org.apache.xerces.xni.parser.XMLParserConfiguration config) Constructs a document parser using the default symbol table and grammar pool. -
Method Summary
Modifier and TypeMethodDescriptionvoid
any
(org.apache.xerces.xni.Augmentations augs) A content model of ANY.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) An attribute declaration.void
characters
(org.apache.xerces.xni.XMLString text, org.apache.xerces.xni.Augmentations augs) Character content.void
comment
(org.apache.xerces.xni.XMLString text, org.apache.xerces.xni.Augmentations augs) A comment.void
doctypeDecl
(String rootElement, String publicId, String systemId, org.apache.xerces.xni.Augmentations augs) Notifies of the presence of the DOCTYPE line in the document.void
A referenced element in a mixed or children content model.void
elementDecl
(String name, String contentModel, org.apache.xerces.xni.Augmentations augs) An element declaration.void
empty
(org.apache.xerces.xni.Augmentations augs) A content model of EMPTY.void
emptyElement
(org.apache.xerces.xni.QName element, org.apache.xerces.xni.XMLAttributes attributes, org.apache.xerces.xni.Augmentations augs) An empty element.void
endAttlist
(org.apache.xerces.xni.Augmentations augs) The end of an attribute list.void
endCDATA
(org.apache.xerces.xni.Augmentations augs) The end of a CDATA section.void
endConditional
(org.apache.xerces.xni.Augmentations augs) The end of a conditional section.void
endContentModel
(org.apache.xerces.xni.Augmentations augs) The end of a content model.void
endDocument
(org.apache.xerces.xni.Augmentations augs) The end of the document.void
endDTD
(org.apache.xerces.xni.Augmentations augs) The end of the DTD.void
endElement
(org.apache.xerces.xni.QName element, org.apache.xerces.xni.Augmentations augs) The end of an element.void
endExternalSubset
(org.apache.xerces.xni.Augmentations augmentations) The end of the DTD external subset.void
endGeneralEntity
(String name, org.apache.xerces.xni.Augmentations augs) This method notifies the end of an entity.void
endGroup
(org.apache.xerces.xni.Augmentations augs) The end of a group for mixed or children content models.void
endParameterEntity
(String name, org.apache.xerces.xni.Augmentations augs) This method notifies the end of an entity.void
externalEntityDecl
(String name, org.apache.xerces.xni.XMLResourceIdentifier identifier, org.apache.xerces.xni.Augmentations augs) An external entity declaration.org.apache.xerces.xni.parser.XMLDocumentSource
Returns the document sourceorg.apache.xerces.xni.parser.XMLDTDContentModelSource
org.apache.xerces.xni.parser.XMLDTDSource
void
ignorableWhitespace
(org.apache.xerces.xni.XMLString text, org.apache.xerces.xni.Augmentations augs) Ignorable whitespace.void
ignoredCharacters
(org.apache.xerces.xni.XMLString text, org.apache.xerces.xni.Augmentations augs) Characters within an IGNORE conditional section.void
internalEntityDecl
(String name, org.apache.xerces.xni.XMLString text, org.apache.xerces.xni.XMLString nonNormalizedText, org.apache.xerces.xni.Augmentations augs) An internal entity declaration.void
notationDecl
(String name, org.apache.xerces.xni.XMLResourceIdentifier identifier, org.apache.xerces.xni.Augmentations augs) A notation declarationvoid
occurrence
(short occurrence, org.apache.xerces.xni.Augmentations augs) The occurrence count for a child in a children content model or for the mixed content model group.void
pcdata
(org.apache.xerces.xni.Augmentations augs) The appearance of "#PCDATA" within a group signifying a mixed content model.void
processingInstruction
(String target, org.apache.xerces.xni.XMLString data, org.apache.xerces.xni.Augmentations augs) A processing instruction.protected void
reset()
reset all components before parsingvoid
separator
(short separator, org.apache.xerces.xni.Augmentations augs) The separator between choices or sequences of a mixed or children content model.void
setDocumentSource
(org.apache.xerces.xni.parser.XMLDocumentSource source) Sets the document sourcevoid
setDTDContentModelSource
(org.apache.xerces.xni.parser.XMLDTDContentModelSource source) void
setDTDSource
(org.apache.xerces.xni.parser.XMLDTDSource source) void
startAttlist
(String elementName, org.apache.xerces.xni.Augmentations augs) The start of an attribute list.void
startCDATA
(org.apache.xerces.xni.Augmentations augs) The start of a CDATA section.void
startConditional
(short type, org.apache.xerces.xni.Augmentations augs) The start of a conditional section.void
startContentModel
(String elementName, org.apache.xerces.xni.Augmentations augs) The start of a content model.void
startDocument
(org.apache.xerces.xni.XMLLocator locator, String encoding, org.apache.xerces.xni.NamespaceContext namespaceContext, org.apache.xerces.xni.Augmentations augs) The start of the document.void
startDTD
(org.apache.xerces.xni.XMLLocator locator, org.apache.xerces.xni.Augmentations augs) The start of the DTD.void
startElement
(org.apache.xerces.xni.QName element, org.apache.xerces.xni.XMLAttributes attributes, org.apache.xerces.xni.Augmentations augs) The start of an element.void
startExternalSubset
(org.apache.xerces.xni.XMLResourceIdentifier identifier, org.apache.xerces.xni.Augmentations augmentations) The start of the DTD external subset.void
startGeneralEntity
(String name, org.apache.xerces.xni.XMLResourceIdentifier identifier, String encoding, org.apache.xerces.xni.Augmentations augs) This method notifies the start of an entity.void
startGroup
(org.apache.xerces.xni.Augmentations augs) A start of either a mixed or children content model.void
startParameterEntity
(String name, org.apache.xerces.xni.XMLResourceIdentifier identifier, String encoding, org.apache.xerces.xni.Augmentations augs) This method notifies the start of an entity.void
Notifies of the presence of a TextDecl line in an entity.void
unparsedEntityDecl
(String name, org.apache.xerces.xni.XMLResourceIdentifier identifier, String notation, org.apache.xerces.xni.Augmentations augs) An unparsed entity declaration.void
xmlDecl
(String version, String encoding, String standalone, org.apache.xerces.xni.Augmentations augs) Notifies of the presence of an XMLDecl line in the document.
-
Field Details
-
fInDTD
protected boolean fInDTDTrue if inside DTD. -
fDocumentSource
protected org.apache.xerces.xni.parser.XMLDocumentSource fDocumentSourceDocument source -
fDTDSource
protected org.apache.xerces.xni.parser.XMLDTDSource fDTDSourceDTD source -
fDTDContentModelSource
protected org.apache.xerces.xni.parser.XMLDTDContentModelSource fDTDContentModelSourceDTD content model source
-
-
Constructor Details
-
AbstractXMLDocumentParser
protected AbstractXMLDocumentParser(org.apache.xerces.xni.parser.XMLParserConfiguration config) Constructs a document parser using the default symbol table and grammar pool.
-
-
Method Details
-
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.- Specified by:
startDocument
in interfaceorg.apache.xerces.xni.XMLDocumentHandler
- 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:
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.- Specified by:
xmlDecl
in interfaceorg.apache.xerces.xni.XMLDocumentHandler
- 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:
org.apache.xerces.xni.XNIException
- Thrown by handler 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.- Specified by:
doctypeDecl
in interfaceorg.apache.xerces.xni.XMLDocumentHandler
- 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, nullaugs
- Additional information that may include infoset augmentations otherwise.- Throws:
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.- Specified by:
startElement
in interfaceorg.apache.xerces.xni.XMLDocumentHandler
- Parameters:
element
- The name of the element.attributes
- The element attributes.augs
- Additional information that may include infoset augmentations- Throws:
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.- Specified by:
emptyElement
in interfaceorg.apache.xerces.xni.XMLDocumentHandler
- Parameters:
element
- The name of the element.attributes
- The element attributes.augs
- Additional information that may include infoset augmentations- Throws:
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.- Specified by:
characters
in interfaceorg.apache.xerces.xni.XMLDocumentHandler
- Parameters:
text
- The content.augs
- Additional information that may include infoset augmentations- Throws:
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
-
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.- Specified by:
ignorableWhitespace
in interfaceorg.apache.xerces.xni.XMLDocumentHandler
- Parameters:
text
- The ignorable whitespace.augs
- Additional information that may include infoset augmentations- Throws:
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.- Specified by:
endElement
in interfaceorg.apache.xerces.xni.XMLDocumentHandler
- Parameters:
element
- The name of the element.augs
- Additional information that may include infoset augmentations- Throws:
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.- Specified by:
startCDATA
in interfaceorg.apache.xerces.xni.XMLDocumentHandler
- Parameters:
augs
- Additional information that may include infoset augmentations- Throws:
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.- Specified by:
endCDATA
in interfaceorg.apache.xerces.xni.XMLDocumentHandler
- Parameters:
augs
- Additional information that may include infoset augmentations- Throws:
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.- Specified by:
endDocument
in interfaceorg.apache.xerces.xni.XMLDocumentHandler
- Parameters:
augs
- Additional information that may include infoset augmentations- Throws:
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.
- Specified by:
startGeneralEntity
in interfaceorg.apache.xerces.xni.XMLDocumentHandler
- 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:
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.
- Specified by:
textDecl
in interfaceorg.apache.xerces.xni.XMLDocumentHandler
- Specified by:
textDecl
in interfaceorg.apache.xerces.xni.XMLDTDHandler
- 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:
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.
- Specified by:
endGeneralEntity
in interfaceorg.apache.xerces.xni.XMLDocumentHandler
- Parameters:
name
- The name of the entity.augs
- Additional information that may include infoset augmentations- Throws:
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.- Specified by:
comment
in interfaceorg.apache.xerces.xni.XMLDocumentHandler
- Specified by:
comment
in interfaceorg.apache.xerces.xni.XMLDTDHandler
- Parameters:
text
- The text in the comment.augs
- Additional information that may include infoset augmentations- Throws:
org.apache.xerces.xni.XNIException
- Thrown by application 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.
- Specified by:
processingInstruction
in interfaceorg.apache.xerces.xni.XMLDocumentHandler
- Specified by:
processingInstruction
in interfaceorg.apache.xerces.xni.XMLDTDHandler
- Parameters:
target
- The target.data
- The data or null if none specified.augs
- Additional information that may include infoset augmentations- Throws:
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
-
setDocumentSource
public void setDocumentSource(org.apache.xerces.xni.parser.XMLDocumentSource source) Sets the document source- Specified by:
setDocumentSource
in interfaceorg.apache.xerces.xni.XMLDocumentHandler
-
getDocumentSource
public org.apache.xerces.xni.parser.XMLDocumentSource getDocumentSource()Returns the document source- Specified by:
getDocumentSource
in interfaceorg.apache.xerces.xni.XMLDocumentHandler
-
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.- Specified by:
startDTD
in interfaceorg.apache.xerces.xni.XMLDTDHandler
- 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:
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.- Specified by:
startExternalSubset
in interfaceorg.apache.xerces.xni.XMLDTDHandler
- Parameters:
augmentations
- Additional information that may include infoset augmentations.identifier
- The resource identifier.- Throws:
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.- Specified by:
endExternalSubset
in interfaceorg.apache.xerces.xni.XMLDTDHandler
- Parameters:
augmentations
- Additional information that may include infoset augmentations.- Throws:
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.
- Specified by:
startParameterEntity
in interfaceorg.apache.xerces.xni.XMLDTDHandler
- 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:
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.
- Specified by:
endParameterEntity
in interfaceorg.apache.xerces.xni.XMLDTDHandler
- Parameters:
name
- The name of the entity.augs
- Additional information that may include infoset augmentations- Throws:
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.- Specified by:
ignoredCharacters
in interfaceorg.apache.xerces.xni.XMLDTDHandler
- Parameters:
text
- The ignored text.augs
- Additional information that may include infoset augmentations.- Throws:
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.- Specified by:
elementDecl
in interfaceorg.apache.xerces.xni.XMLDTDHandler
- Parameters:
name
- The name of the element.contentModel
- The element content model.augs
- Additional information that may include infoset augmentations.- Throws:
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
-
startAttlist
public void startAttlist(String elementName, org.apache.xerces.xni.Augmentations augs) throws org.apache.xerces.xni.XNIException The start of an attribute list.- Specified by:
startAttlist
in interfaceorg.apache.xerces.xni.XMLDTDHandler
- Parameters:
elementName
- The name of the element that this attribute list is associated with.augs
- Additional information that may include infoset augmentations.- Throws:
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.- Specified by:
attributeDecl
in interfaceorg.apache.xerces.xni.XMLDTDHandler
- 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:
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.- Specified by:
endAttlist
in interfaceorg.apache.xerces.xni.XMLDTDHandler
- Parameters:
augs
- Additional information that may include infoset augmentations.- Throws:
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.- Specified by:
internalEntityDecl
in interfaceorg.apache.xerces.xni.XMLDTDHandler
- 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:
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.- Specified by:
externalEntityDecl
in interfaceorg.apache.xerces.xni.XMLDTDHandler
- 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:
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.- Specified by:
unparsedEntityDecl
in interfaceorg.apache.xerces.xni.XMLDTDHandler
- 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:
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- Specified by:
notationDecl
in interfaceorg.apache.xerces.xni.XMLDTDHandler
- 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:
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.- Specified by:
startConditional
in interfaceorg.apache.xerces.xni.XMLDTDHandler
- 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:
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.- See Also:
-
XMLDTDHandler.CONDITIONAL_INCLUDE
XMLDTDHandler.CONDITIONAL_IGNORE
-
endConditional
public void endConditional(org.apache.xerces.xni.Augmentations augs) throws org.apache.xerces.xni.XNIException The end of a conditional section.- Specified by:
endConditional
in interfaceorg.apache.xerces.xni.XMLDTDHandler
- Parameters:
augs
- Additional information that may include infoset augmentations.- Throws:
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.- Specified by:
endDTD
in interfaceorg.apache.xerces.xni.XMLDTDHandler
- Parameters:
augs
- Additional information that may include infoset augmentations.- Throws:
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
-
setDTDSource
public void setDTDSource(org.apache.xerces.xni.parser.XMLDTDSource source) - Specified by:
setDTDSource
in interfaceorg.apache.xerces.xni.XMLDTDHandler
-
getDTDSource
public org.apache.xerces.xni.parser.XMLDTDSource getDTDSource()- Specified by:
getDTDSource
in interfaceorg.apache.xerces.xni.XMLDTDHandler
-
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.- Specified by:
startContentModel
in interfaceorg.apache.xerces.xni.XMLDTDContentModelHandler
- Parameters:
elementName
- The name of the element.augs
- Additional information that may include infoset augmentations.- Throws:
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
-
any
public void any(org.apache.xerces.xni.Augmentations augs) throws org.apache.xerces.xni.XNIException A content model of ANY.- Specified by:
any
in interfaceorg.apache.xerces.xni.XMLDTDContentModelHandler
- Parameters:
augs
- Additional information that may include infoset augmentations.- Throws:
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.- See Also:
-
empty
public void empty(org.apache.xerces.xni.Augmentations augs) throws org.apache.xerces.xni.XNIException A content model of EMPTY.- Specified by:
empty
in interfaceorg.apache.xerces.xni.XMLDTDContentModelHandler
- Parameters:
augs
- Additional information that may include infoset augmentations.- Throws:
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.- See Also:
-
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 thepcdata()
method. A children content model will contain additional groups and/or elements.- Specified by:
startGroup
in interfaceorg.apache.xerces.xni.XMLDTDContentModelHandler
- Parameters:
augs
- Additional information that may include infoset augmentations.- Throws:
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.- See Also:
-
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'sstartGroup()
.- Specified by:
pcdata
in interfaceorg.apache.xerces.xni.XMLDTDContentModelHandler
- Parameters:
augs
- Additional information that may include infoset augmentations.- Throws:
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.- See Also:
-
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.- Specified by:
element
in interfaceorg.apache.xerces.xni.XMLDTDContentModelHandler
- Parameters:
elementName
- The name of the referenced element.augs
- Additional information that may include infoset augmentations.- Throws:
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
-
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.- Specified by:
separator
in interfaceorg.apache.xerces.xni.XMLDTDContentModelHandler
- Parameters:
separator
- The type of children separator.augs
- Additional information that may include infoset augmentations.- Throws:
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.- See Also:
-
XMLDTDContentModelHandler.SEPARATOR_CHOICE
XMLDTDContentModelHandler.SEPARATOR_SEQUENCE
-
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.- Specified by:
occurrence
in interfaceorg.apache.xerces.xni.XMLDTDContentModelHandler
- Parameters:
occurrence
- The occurrence count for the last element or group.augs
- Additional information that may include infoset augmentations.- Throws:
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.- See Also:
-
XMLDTDContentModelHandler.OCCURS_ZERO_OR_ONE
XMLDTDContentModelHandler.OCCURS_ZERO_OR_MORE
XMLDTDContentModelHandler.OCCURS_ONE_OR_MORE
-
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.- Specified by:
endGroup
in interfaceorg.apache.xerces.xni.XMLDTDContentModelHandler
- Parameters:
augs
- Additional information that may include infoset augmentations.- Throws:
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.- Specified by:
endContentModel
in interfaceorg.apache.xerces.xni.XMLDTDContentModelHandler
- Parameters:
augs
- Additional information that may include infoset augmentations.- Throws:
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
-
setDTDContentModelSource
public void setDTDContentModelSource(org.apache.xerces.xni.parser.XMLDTDContentModelSource source) - Specified by:
setDTDContentModelSource
in interfaceorg.apache.xerces.xni.XMLDTDContentModelHandler
-
getDTDContentModelSource
public org.apache.xerces.xni.parser.XMLDTDContentModelSource getDTDContentModelSource()- Specified by:
getDTDContentModelSource
in interfaceorg.apache.xerces.xni.XMLDTDContentModelHandler
-
reset
protected void reset() throws org.apache.xerces.xni.XNIExceptionreset all components before parsing
-