Package org.apache.xerces.parsers
Class AbstractDOMParser
java.lang.Object
org.apache.xerces.parsers.XMLParser
org.apache.xerces.parsers.AbstractXMLDocumentParser
org.apache.xerces.parsers.AbstractDOMParser
- All Implemented Interfaces:
org.apache.xerces.xni.XMLDocumentHandler,org.apache.xerces.xni.XMLDTDContentModelHandler,org.apache.xerces.xni.XMLDTDHandler
- Direct Known Subclasses:
DOMParser,DOMParserImpl
This is the base class of all DOM parsers. It implements the XNI
callback methods to create the DOM tree. After a successful parse of
an XML document, the DOM Document object can be queried using the
getDocument method. The actual pipeline is defined in
parser configuration.- Version:
- $Id: AbstractDOMParser.java 782187 2009-06-06 04:21:12Z mrglavas $
- Author:
- Arnaud Le Hors, IBM, Andy Clark, IBM, Elena Litani, IBM
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected static final Stringprotected static final StringFeature id: create cdata nodes.protected static final StringFeature id: create entity ref nodes.protected static final Stringprotected static final StringDefault document class name.protected static final StringFeature id: defer node expansion.protected static final StringProperty id: document class name.protected final StackBase uri stackprotected booleanCreate cdata nodes.protected booleanCreate entity reference nodes.protected CDATASectionprotected intprotected EntityImplprotected NodeCurrent node.protected intprotected booleanprotected DeferredDocumentImplprotected intprotected DocumentThe document.protected StringThe document class name to use.protected CoreDocumentImplThe default Xerces document implementation, if used.protected intprotected DocumentTypeThe document type node.protected intprotected LSParserFilterprotected DOMErrorHandlerWrapperDOM L3 error handlerprotected booleanLSParserFilter: specifies that element with given QNAME and all its children must be rejectedprotected booleanTrue if saw the first chunk of charactersprotected booleanTrue if inside CDATA section.protected booleanInclude Comments.protected booleanInclude ignorable whitespace.protected booleanTrue if inside DTD.protected booleanTrue if inside DTD external subset.protected booleanLSParserFilter: true if inside entity referenceprotected StringBufferInternal subset buffer.protected booleanprotected intLSParserFilter: tracks the element depth within a rejected subtree.protected NodeRoot element node.protected StackLSParserFilter: store depth of skipped elementsprotected booleanWhether to store PSVI information in DOM tree.protected final StringBufferCharacter bufferprotected static final StringFeature id: include comments.protected static final StringFeature id: include ignorable whitespace.protected static final StringFeature id: namespace.protected static final StringFields inherited from class org.apache.xerces.parsers.AbstractXMLDocumentParser
fDocumentSource, fDTDContentModelSource, fDTDSourceFields inherited from class org.apache.xerces.parsers.XMLParser
ENTITY_RESOLVER, ERROR_HANDLER, fConfigurationFields inherited from interface org.apache.xerces.xni.XMLDTDContentModelHandler
OCCURS_ONE_OR_MORE, OCCURS_ZERO_OR_MORE, OCCURS_ZERO_OR_ONE, SEPARATOR_CHOICE, SEPARATOR_SEQUENCEFields inherited from interface org.apache.xerces.xni.XMLDTDHandler
CONDITIONAL_IGNORE, CONDITIONAL_INCLUDE -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedAbstractDOMParser(org.apache.xerces.xni.parser.XMLParserConfiguration config) Default constructor. -
Method Summary
Modifier and TypeMethodDescriptionvoidabort()voidattributeDecl(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.voidcharacters(org.apache.xerces.xni.XMLString text, org.apache.xerces.xni.Augmentations augs) Character content.voidcomment(org.apache.xerces.xni.XMLString text, org.apache.xerces.xni.Augmentations augs) A comment.protected AttrcreateAttrNode(org.apache.xerces.xni.QName attrQName) protected ElementcreateElementNode(org.apache.xerces.xni.QName element) voiddoctypeDecl(String rootElement, String publicId, String systemId, org.apache.xerces.xni.Augmentations augs) Notifies of the presence of the DOCTYPE line in the document.final voidDrops all references to the last DOM which was built by this parser.voidelementDecl(String name, String contentModel, org.apache.xerces.xni.Augmentations augs) An element declaration.voidemptyElement(org.apache.xerces.xni.QName element, org.apache.xerces.xni.XMLAttributes attributes, org.apache.xerces.xni.Augmentations augs) An empty element.voidendAttlist(org.apache.xerces.xni.Augmentations augs) The end of an attribute list.voidendCDATA(org.apache.xerces.xni.Augmentations augs) The end of a CDATA section.voidendConditional(org.apache.xerces.xni.Augmentations augs) The end of a conditional section.voidendDocument(org.apache.xerces.xni.Augmentations augs) The end of the document.voidendDTD(org.apache.xerces.xni.Augmentations augs) The end of the DTD.voidendElement(org.apache.xerces.xni.QName element, org.apache.xerces.xni.Augmentations augs) The end of an element.voidendExternalSubset(org.apache.xerces.xni.Augmentations augs) The end of the DTD external subset.voidendGeneralEntity(String name, org.apache.xerces.xni.Augmentations augs) This method notifies the end of a general entity.voidendParameterEntity(String name, org.apache.xerces.xni.Augmentations augs) This method notifies the end of a parameter entity.voidexternalEntityDecl(String name, org.apache.xerces.xni.XMLResourceIdentifier identifier, org.apache.xerces.xni.Augmentations augs) An external entity declaration.Returns the DOM document object.protected StringThis method retreives the name of current document class.protected final voidhandleBaseURI(int node) Record baseURI information for the Element (by adding xml:base attribute) or for the ProcessingInstruction (by setting a baseURI field) Deferred DOM.protected final voidhandleBaseURI(Node node) Record baseURI information for the Element (by adding xml:base attribute) or for the ProcessingInstruction (by setting a baseURI field) Non deferred DOM.voidignorableWhitespace(org.apache.xerces.xni.XMLString text, org.apache.xerces.xni.Augmentations augs) Ignorable whitespace.voidignoredCharacters(org.apache.xerces.xni.XMLString text, org.apache.xerces.xni.Augmentations augs) Characters within an IGNORE conditional section.voidinternalEntityDecl(String name, org.apache.xerces.xni.XMLString text, org.apache.xerces.xni.XMLString nonNormalizedText, org.apache.xerces.xni.Augmentations augs) An internal entity declaration.voidnotationDecl(String name, org.apache.xerces.xni.XMLResourceIdentifier identifier, org.apache.xerces.xni.Augmentations augs) A notation declarationvoidprocessingInstruction(String target, org.apache.xerces.xni.XMLString data, org.apache.xerces.xni.Augmentations augs) A processing instruction.voidreset()Resets the parser state.protected voidsetCharacterData(boolean sawChars) protected voidsetDocumentClassName(String documentClassName) This method allows the programmer to decide which document factory to use when constructing the DOM tree.voidSet the locale to use for messages.voidstartAttlist(String elementName, org.apache.xerces.xni.Augmentations augs) The start of an attribute list.voidstartCDATA(org.apache.xerces.xni.Augmentations augs) The start of a CDATA section.voidstartConditional(short type, org.apache.xerces.xni.Augmentations augs) The start of a conditional section.voidstartDocument(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.voidstartDTD(org.apache.xerces.xni.XMLLocator locator, org.apache.xerces.xni.Augmentations augs) The start of the DTD.voidstartElement(org.apache.xerces.xni.QName element, org.apache.xerces.xni.XMLAttributes attributes, org.apache.xerces.xni.Augmentations augs) The start of an element.voidstartExternalSubset(org.apache.xerces.xni.XMLResourceIdentifier identifier, org.apache.xerces.xni.Augmentations augs) The start of the DTD external subset.voidstartGeneralEntity(String name, org.apache.xerces.xni.XMLResourceIdentifier identifier, String encoding, org.apache.xerces.xni.Augmentations augs) This method notifies the start of a general entity.voidstartParameterEntity(String name, org.apache.xerces.xni.XMLResourceIdentifier identifier, String encoding, org.apache.xerces.xni.Augmentations augs) This method notifies of the start of a parameter entity.voidNotifies of the presence of a TextDecl line in an entity.voidunparsedEntityDecl(String name, org.apache.xerces.xni.XMLResourceIdentifier identifier, String notation, org.apache.xerces.xni.Augmentations augs) An unparsed entity declaration.voidxmlDecl(String version, String encoding, String standalone, org.apache.xerces.xni.Augmentations augs) Notifies of the presence of an XMLDecl line in the document.Methods inherited from class org.apache.xerces.parsers.AbstractXMLDocumentParser
any, element, empty, endContentModel, endGroup, getDocumentSource, getDTDContentModelSource, getDTDSource, occurrence, pcdata, separator, setDocumentSource, setDTDContentModelSource, setDTDSource, startContentModel, startGroup
-
Field Details
-
NAMESPACES
Feature id: namespace.- See Also:
-
CREATE_ENTITY_REF_NODES
Feature id: create entity ref nodes.- See Also:
-
INCLUDE_COMMENTS_FEATURE
Feature id: include comments.- See Also:
-
CREATE_CDATA_NODES_FEATURE
Feature id: create cdata nodes.- See Also:
-
INCLUDE_IGNORABLE_WHITESPACE
Feature id: include ignorable whitespace.- See Also:
-
DEFER_NODE_EXPANSION
Feature id: defer node expansion.- See Also:
-
DOCUMENT_CLASS_NAME
Property id: document class name.- See Also:
-
CURRENT_ELEMENT_NODE
- See Also:
-
DEFAULT_DOCUMENT_CLASS_NAME
Default document class name.- See Also:
-
CORE_DOCUMENT_CLASS_NAME
- See Also:
-
PSVI_DOCUMENT_CLASS_NAME
- See Also:
-
fErrorHandler
DOM L3 error handler -
fInDTD
protected boolean fInDTDTrue if inside DTD. -
fCreateEntityRefNodes
protected boolean fCreateEntityRefNodesCreate entity reference nodes. -
fIncludeIgnorableWhitespace
protected boolean fIncludeIgnorableWhitespaceInclude ignorable whitespace. -
fIncludeComments
protected boolean fIncludeCommentsInclude Comments. -
fCreateCDATANodes
protected boolean fCreateCDATANodesCreate cdata nodes. -
fDocument
The document. -
fDocumentImpl
The default Xerces document implementation, if used. -
fStorePSVI
protected boolean fStorePSVIWhether to store PSVI information in DOM tree. -
fDocumentClassName
The document class name to use. -
fDocumentType
The document type node. -
fCurrentNode
Current node. -
fCurrentCDATASection
-
fCurrentEntityDecl
-
fDeferredEntityDecl
protected int fDeferredEntityDecl -
fStringBuffer
Character buffer -
fInternalSubset
Internal subset buffer. -
fDeferNodeExpansion
protected boolean fDeferNodeExpansion -
fNamespaceAware
protected boolean fNamespaceAware -
fDeferredDocumentImpl
-
fDocumentIndex
protected int fDocumentIndex -
fDocumentTypeIndex
protected int fDocumentTypeIndex -
fCurrentNodeIndex
protected int fCurrentNodeIndex -
fCurrentCDATASectionIndex
protected int fCurrentCDATASectionIndex -
fInDTDExternalSubset
protected boolean fInDTDExternalSubsetTrue if inside DTD external subset. -
fRoot
Root element node. -
fInCDATASection
protected boolean fInCDATASectionTrue if inside CDATA section. -
fFirstChunk
protected boolean fFirstChunkTrue if saw the first chunk of characters -
fFilterReject
protected boolean fFilterRejectLSParserFilter: specifies that element with given QNAME and all its children must be rejected -
fBaseURIStack
Base uri stack -
fRejectedElementDepth
protected int fRejectedElementDepthLSParserFilter: tracks the element depth within a rejected subtree. -
fSkippedElemStack
LSParserFilter: store depth of skipped elements -
fInEntityRef
protected boolean fInEntityRefLSParserFilter: true if inside entity reference -
fDOMFilter
-
-
Constructor Details
-
AbstractDOMParser
protected AbstractDOMParser(org.apache.xerces.xni.parser.XMLParserConfiguration config) Default constructor.
-
-
Method Details
-
getDocumentClassName
This method retreives the name of current document class. -
setDocumentClassName
This method allows the programmer to decide which document factory to use when constructing the DOM tree. However, doing so will lose the functionality of the default factory. Also, a document class other than the default will lose the ability to defer node expansion on the DOM tree produced.- Parameters:
documentClassName- The fully qualified class name of the document factory to use when constructing the DOM tree.- See Also:
-
getDocument
Returns the DOM document object. -
dropDocumentReferences
public final void dropDocumentReferences()Drops all references to the last DOM which was built by this parser. -
reset
public void reset() throws org.apache.xerces.xni.XNIExceptionResets the parser state.- Overrides:
resetin classAbstractXMLDocumentParser- Throws:
SAXException- Thrown on initialization error.org.apache.xerces.xni.XNIException
-
setLocale
Set the locale to use for messages.- Parameters:
locale- The locale object to use for localization of messages.
-
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 a general entity.Note: This method is not called for entity references appearing as part of attribute values.
- Specified by:
startGeneralEntityin interfaceorg.apache.xerces.xni.XMLDocumentHandler- Overrides:
startGeneralEntityin classAbstractXMLDocumentParser- Parameters:
name- The name of the general 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:
textDeclin interfaceorg.apache.xerces.xni.XMLDocumentHandler- Specified by:
textDeclin interfaceorg.apache.xerces.xni.XMLDTDHandler- Overrides:
textDeclin classAbstractXMLDocumentParser- 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.
-
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:
commentin interfaceorg.apache.xerces.xni.XMLDocumentHandler- Specified by:
commentin interfaceorg.apache.xerces.xni.XMLDTDHandler- Overrides:
commentin classAbstractXMLDocumentParser- 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:
processingInstructionin interfaceorg.apache.xerces.xni.XMLDocumentHandler- Specified by:
processingInstructionin interfaceorg.apache.xerces.xni.XMLDTDHandler- Overrides:
processingInstructionin classAbstractXMLDocumentParser- 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.
-
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:
startDocumentin interfaceorg.apache.xerces.xni.XMLDocumentHandler- Overrides:
startDocumentin classAbstractXMLDocumentParser- 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:
xmlDeclin interfaceorg.apache.xerces.xni.XMLDocumentHandler- Overrides:
xmlDeclin classAbstractXMLDocumentParser- 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:
doctypeDeclin interfaceorg.apache.xerces.xni.XMLDocumentHandler- Overrides:
doctypeDeclin classAbstractXMLDocumentParser- 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 otherwise.augs- Additional information that may include infoset augmentations- 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:
startElementin interfaceorg.apache.xerces.xni.XMLDocumentHandler- Overrides:
startElementin classAbstractXMLDocumentParser- 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:
emptyElementin interfaceorg.apache.xerces.xni.XMLDocumentHandler- Overrides:
emptyElementin classAbstractXMLDocumentParser- 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:
charactersin interfaceorg.apache.xerces.xni.XMLDocumentHandler- Overrides:
charactersin classAbstractXMLDocumentParser- 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:
ignorableWhitespacein interfaceorg.apache.xerces.xni.XMLDocumentHandler- Overrides:
ignorableWhitespacein classAbstractXMLDocumentParser- 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:
endElementin interfaceorg.apache.xerces.xni.XMLDocumentHandler- Overrides:
endElementin classAbstractXMLDocumentParser- 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:
startCDATAin interfaceorg.apache.xerces.xni.XMLDocumentHandler- Overrides:
startCDATAin classAbstractXMLDocumentParser- 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:
endCDATAin interfaceorg.apache.xerces.xni.XMLDocumentHandler- Overrides:
endCDATAin classAbstractXMLDocumentParser- 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:
endDocumentin interfaceorg.apache.xerces.xni.XMLDocumentHandler- Overrides:
endDocumentin classAbstractXMLDocumentParser- Parameters:
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 a general entity.Note: This method is not called for entity references appearing as part of attribute values.
- Specified by:
endGeneralEntityin interfaceorg.apache.xerces.xni.XMLDocumentHandler- Overrides:
endGeneralEntityin classAbstractXMLDocumentParser- 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.
-
handleBaseURI
Record baseURI information for the Element (by adding xml:base attribute) or for the ProcessingInstruction (by setting a baseURI field) Non deferred DOM.- Parameters:
node-
-
handleBaseURI
protected final void handleBaseURI(int node) Record baseURI information for the Element (by adding xml:base attribute) or for the ProcessingInstruction (by setting a baseURI field) Deferred DOM.- Parameters:
node-
-
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:
startDTDin interfaceorg.apache.xerces.xni.XMLDTDHandler- Overrides:
startDTDin classAbstractXMLDocumentParser- 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.
-
endDTD
public void endDTD(org.apache.xerces.xni.Augmentations augs) throws org.apache.xerces.xni.XNIException The end of the DTD.- Specified by:
endDTDin interfaceorg.apache.xerces.xni.XMLDTDHandler- Overrides:
endDTDin classAbstractXMLDocumentParser- Parameters:
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:
startConditionalin interfaceorg.apache.xerces.xni.XMLDTDHandler- Overrides:
startConditionalin classAbstractXMLDocumentParser- 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:
-
endConditional
public void endConditional(org.apache.xerces.xni.Augmentations augs) throws org.apache.xerces.xni.XNIException The end of a conditional section.- Specified by:
endConditionalin interfaceorg.apache.xerces.xni.XMLDTDHandler- Overrides:
endConditionalin classAbstractXMLDocumentParser- Parameters:
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 augs) throws org.apache.xerces.xni.XNIException The start of the DTD external subset.- Specified by:
startExternalSubsetin interfaceorg.apache.xerces.xni.XMLDTDHandler- Overrides:
startExternalSubsetin classAbstractXMLDocumentParser- Parameters:
identifier- The resource identifier.augs- Additional information that may include infoset augmentations.- Throws:
org.apache.xerces.xni.XNIException- Thrown by handler to signal an error.
-
endExternalSubset
public void endExternalSubset(org.apache.xerces.xni.Augmentations augs) throws org.apache.xerces.xni.XNIException The end of the DTD external subset.- Specified by:
endExternalSubsetin interfaceorg.apache.xerces.xni.XMLDTDHandler- Overrides:
endExternalSubsetin classAbstractXMLDocumentParser- 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:
internalEntityDeclin interfaceorg.apache.xerces.xni.XMLDTDHandler- Overrides:
internalEntityDeclin classAbstractXMLDocumentParser- 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:
externalEntityDeclin interfaceorg.apache.xerces.xni.XMLDTDHandler- Overrides:
externalEntityDeclin classAbstractXMLDocumentParser- 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 notation.augs- 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 of the start of a parameter entity. The parameter entity name start with a '%' character.- Specified by:
startParameterEntityin interfaceorg.apache.xerces.xni.XMLDTDHandler- Overrides:
startParameterEntityin classAbstractXMLDocumentParser- Parameters:
name- The name of the parameter 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 parameter entities).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 a parameter entity. Parameter entity names begin with a '%' character.- Specified by:
endParameterEntityin interfaceorg.apache.xerces.xni.XMLDTDHandler- Overrides:
endParameterEntityin classAbstractXMLDocumentParser- Parameters:
name- The name of the parameter 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:
unparsedEntityDeclin interfaceorg.apache.xerces.xni.XMLDTDHandler- Overrides:
unparsedEntityDeclin classAbstractXMLDocumentParser- 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:
notationDeclin interfaceorg.apache.xerces.xni.XMLDTDHandler- Overrides:
notationDeclin classAbstractXMLDocumentParser- 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.
-
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:
ignoredCharactersin interfaceorg.apache.xerces.xni.XMLDTDHandler- Overrides:
ignoredCharactersin classAbstractXMLDocumentParser- 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:
elementDeclin interfaceorg.apache.xerces.xni.XMLDTDHandler- Overrides:
elementDeclin classAbstractXMLDocumentParser- 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.
-
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:
attributeDeclin interfaceorg.apache.xerces.xni.XMLDTDHandler- Overrides:
attributeDeclin classAbstractXMLDocumentParser- 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.
-
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:
startAttlistin interfaceorg.apache.xerces.xni.XMLDTDHandler- Overrides:
startAttlistin classAbstractXMLDocumentParser- 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.
-
endAttlist
public void endAttlist(org.apache.xerces.xni.Augmentations augs) throws org.apache.xerces.xni.XNIException The end of an attribute list.- Specified by:
endAttlistin interfaceorg.apache.xerces.xni.XMLDTDHandler- Overrides:
endAttlistin classAbstractXMLDocumentParser- Parameters:
augs- Additional information that may include infoset augmentations.- Throws:
org.apache.xerces.xni.XNIException- Thrown by handler to signal an error.
-
createElementNode
-
createAttrNode
-
setCharacterData
protected void setCharacterData(boolean sawChars) -
abort
public void abort()- See Also:
-