gnu.xml.pipeline
Class DomConsumer.Handler
java.lang.Object
|
+--gnu.xml.pipeline.DomConsumer.Handler
All Implemented Interfaces:
ContentHandler, LexicalHandler, DTDHandler, DeclHandler
Class used to intercept various parsing events and use them to
populate a DOM document. Subclasses would typically know and use
backdoors into specific DOM implementations, used to implement
DTD-related functionality.
Note that if this ever throws a DOMException (runtime exception)
that will indicate a bug in the DOM (e.g. doesn't support something
per specification) or the parser (e.g. emitted an illegal name, or
accepted illegal input data).
void | attributeDecl(java.lang.String eName, java.lang.String aName, java.lang.String type, java.lang.String mode, java.lang.String value)
|
boolean | canPopulateEntityRefs()
|
void | characters(char ch[][] , int start, int length)
|
void | comment(char ch[][] , int start, int length)
|
org.w3c.dom.Text | createText(boolean isCDATA, char ch[][] , int start, int length)
|
void | elementDecl(java.lang.String name, java.lang.String model)
|
void | endCDATA()
|
void | endDTD()
|
void | endDocument()
|
void | endElement(java.lang.String uri, java.lang.String localName, java.lang.String qName)
|
void | endEntity(java.lang.String name)
|
void | endPrefixMapping(java.lang.String prefix)
|
void | externalEntityDecl(java.lang.String name, java.lang.String publicId, java.lang.String SystemId)
|
org.w3c.dom.Document | getDocument()
|
org.w3c.dom.Node | getTop()
|
void | ignorableWhitespace(char ch[][] , int start, int length)
|
void | internalEntityDecl(java.lang.String name, java.lang.String value)
|
void | notationDecl(java.lang.String name, java.lang.String publicId, java.lang.String SystemId)
|
void | processingInstruction(java.lang.String target, java.lang.String data)
|
void | setDocumentLocator(org.xml.sax.Locator locator)
|
void | skippedEntity(java.lang.String name)
|
void | startCDATA()
|
void | startDTD(java.lang.String name, java.lang.String publicId, java.lang.String SystemId)
|
void | startDocument()
|
void | startElement(java.lang.String uri, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes atts)
|
void | startEntity(java.lang.String name)
|
void | startPrefixMapping(java.lang.String prefix, java.lang.String uri)
|
void | unparsedEntityDecl(java.lang.String name, java.lang.String publicId, java.lang.String SystemId, java.lang.String notationName)
|
consumer
protected DomConsumer consumer
Class used to intercept various parsing events and use them to
populate a DOM document. Subclasses would typically know and use
backdoors into specific DOM implementations, used to implement
DTD-related functionality.
Note that if this ever throws a DOMException (runtime exception)
that will indicate a bug in the DOM (e.g. doesn't support something
per specification) or the parser (e.g. emitted an illegal name, or
accepted illegal input data).
Handler
protected Handler(gnu.xml.pipeline.DomConsumer consumer)
Subclasses may use SAX2 events to provide additional
behaviors in the resulting DOM.
Parameters:
attributeDecl
public void attributeDecl(java.lang.String eName, java.lang.String aName, java.lang.String type, java.lang.String mode, java.lang.String value)
Parameters:
canPopulateEntityRefs
public boolean canPopulateEntityRefs()
May be overridden by subclasses to return true, indicating
that entity reference nodes can be populated and then made
read-only.
characters
public void characters(char ch[][] , int start, int length)
Parameters:
comment
public void comment(char ch[][] , int start, int length)
Parameters:
createText
protected Text createText(boolean isCDATA, char ch[][] , int start, int length)
Subclasses may overrride this method to provide a more efficient
way to construct text nodes.
Typically, copying the text into a single character array will
be more efficient than doing that as well as allocating other
needed for a String, including an internal StringBuffer.
Those additional memory and CPU costs can be incurred later,
if ever needed.
Unfortunately the standard DOM factory APIs encourage those costs
to be incurred early.
Parameters:
elementDecl
public void elementDecl(java.lang.String name, java.lang.String model)
Parameters:
endCDATA
public void endCDATA()
endDTD
public void endDTD()
endDocument
public void endDocument()
endElement
public void endElement(java.lang.String uri, java.lang.String localName, java.lang.String qName)
Parameters:
endEntity
public void endEntity(java.lang.String name)
Parameters:
endPrefixMapping
public void endPrefixMapping(java.lang.String prefix)
Parameters:
externalEntityDecl
public void externalEntityDecl(java.lang.String name, java.lang.String publicId, java.lang.String SystemId)
Parameters:
getDocument
protected Document getDocument()
Returns the document under construction.
getTop
protected Node getTop()
Returns the current node being populated. This is usually
an Element or Document, but it might be an EntityReference
node if some implementation-specific code knows how to put
those into the result tree and later mark them as readonly.
ignorableWhitespace
public void ignorableWhitespace(char ch[][] , int start, int length)
Parameters:
internalEntityDecl
public void internalEntityDecl(java.lang.String name, java.lang.String value)
Parameters:
notationDecl
public void notationDecl(java.lang.String name, java.lang.String publicId, java.lang.String SystemId)
Parameters:
processingInstruction
public void processingInstruction(java.lang.String target, java.lang.String data)
Parameters:
setDocumentLocator
public void setDocumentLocator(org.xml.sax.Locator locator)
Parameters:
skippedEntity
public void skippedEntity(java.lang.String name)
Parameters:
startCDATA
public void startCDATA()
startDTD
public void startDTD(java.lang.String name, java.lang.String publicId, java.lang.String SystemId)
Parameters:
startDocument
public void startDocument()
startElement
public void startElement(java.lang.String uri, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes atts)
Parameters:
startEntity
public void startEntity(java.lang.String name)
Parameters:
startPrefixMapping
public void startPrefixMapping(java.lang.String prefix, java.lang.String uri)
Parameters:
unparsedEntityDecl
public void unparsedEntityDecl(java.lang.String name, java.lang.String publicId, java.lang.String SystemId, java.lang.String notationName)
Parameters:
Note that if this ever throws a DOMException (runtime exception) that will indicate a bug in the DOM (e.g. doesn't support something per specification) or the parser (e.g. emitted an illegal name, or accepted illegal input data).