|
JDOM 1.1.1 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.xml.sax.helpers.DefaultHandler
org.jdom.input.SAXHandler
public class SAXHandler
A support class for SAXBuilder.
| Constructor Summary | |
|---|---|
SAXHandler()
This will create a new SAXHandler that listens to SAX
events and creates a JDOM Document. |
|
SAXHandler(JDOMFactory factory)
This will create a new SAXHandler that listens to SAX
events and creates a JDOM Document. |
|
| Method Summary | |
|---|---|
void |
attributeDecl(java.lang.String eName,
java.lang.String aName,
java.lang.String type,
java.lang.String valueDefault,
java.lang.String value)
This handles an attribute declaration in the internal subset. |
void |
characters(char[] ch,
int start,
int length)
This will report character data (within an element). |
void |
comment(char[] ch,
int start,
int length)
This reports that a comments is parsed. |
void |
elementDecl(java.lang.String name,
java.lang.String model)
Handle an element declaration in a DTD. |
void |
endCDATA()
Report a CDATA section |
void |
endDTD()
This signifies that the reading of the DTD is complete. |
void |
endElement(java.lang.String namespaceURI,
java.lang.String localName,
java.lang.String qName)
Indicates the end of an element ( </[element name]>) is reached. |
void |
endEntity(java.lang.String name)
|
void |
externalEntityDecl(java.lang.String name,
java.lang.String publicID,
java.lang.String systemID)
This is called when the parser encounters an external entity declaration. |
protected void |
flushCharacters()
This will flush any characters from SAX character calls we've been buffering. |
protected void |
flushCharacters(java.lang.String data)
Flush the given string into the document. |
Element |
getCurrentElement()
Returns the being-parsed element. |
Document |
getDocument()
Returns the document. |
org.xml.sax.Locator |
getDocumentLocator()
Provides access to the Locator object provided by the
SAX parser. |
boolean |
getExpandEntities()
Returns whether or not entities will be expanded during the build. |
JDOMFactory |
getFactory()
Returns the factory used for constructing objects. |
boolean |
getIgnoringBoundaryWhitespace()
Returns whether or not the parser will elminate element content containing only whitespace. |
boolean |
getIgnoringElementContentWhitespace()
Returns whether or not the parser will elminate whitespace in element content (sometimes known as "ignorable whitespace") when building the document. |
void |
ignorableWhitespace(char[] ch,
int start,
int length)
Capture ignorable whitespace as text. |
void |
internalEntityDecl(java.lang.String name,
java.lang.String value)
Handle an internal entity declaration in a DTD. |
void |
notationDecl(java.lang.String name,
java.lang.String publicID,
java.lang.String systemID)
Handle the declaration of a Notation in a DTD |
void |
processingInstruction(java.lang.String target,
java.lang.String data)
This will indicate that a processing instruction has been encountered. |
protected void |
pushElement(Element element)
Pushes an element onto the tree under construction. |
void |
setDocumentLocator(org.xml.sax.Locator locator)
Receives an object for locating the origin of SAX document events. |
void |
setExpandEntities(boolean expand)
This sets whether or not to expand entities during the build. |
void |
setIgnoringBoundaryWhitespace(boolean ignoringBoundaryWhite)
Specifies whether or not the parser should elminate text() nodes containing only whitespace when building the document. |
void |
setIgnoringElementContentWhitespace(boolean ignoringWhite)
Specifies whether or not the parser should elminate whitespace in element content (sometimes known as "ignorable whitespace") when building the document. |
void |
skippedEntity(java.lang.String name)
This indicates that an unresolvable entity reference has been encountered, normally because the external DTD subset has not been read. |
void |
startCDATA()
Report a CDATA section |
void |
startDocument()
|
void |
startDTD(java.lang.String name,
java.lang.String publicID,
java.lang.String systemID)
This will signify that a DTD is being parsed, and can be used to ensure that comments and other lexical structures in the DTD are not added to the JDOM Document
object. |
void |
startElement(java.lang.String namespaceURI,
java.lang.String localName,
java.lang.String qName,
org.xml.sax.Attributes atts)
This reports the occurrence of an actual element. |
void |
startEntity(java.lang.String name)
|
void |
startPrefixMapping(java.lang.String prefix,
java.lang.String uri)
This will add the prefix mapping to the JDOM Document object. |
void |
unparsedEntityDecl(java.lang.String name,
java.lang.String publicID,
java.lang.String systemID,
java.lang.String notationName)
Handler for unparsed entity declarations in the DTD |
| Methods inherited from class org.xml.sax.helpers.DefaultHandler |
|---|
endDocument, endPrefixMapping, error, fatalError, resolveEntity, warning |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public SAXHandler()
SAXHandler that listens to SAX
events and creates a JDOM Document. The objects will be constructed
using the default factory.
public SAXHandler(JDOMFactory factory)
SAXHandler that listens to SAX
events and creates a JDOM Document. The objects will be constructed
using the provided factory.
factory - JDOMFactory to be used for constructing
objects| Method Detail |
|---|
protected void pushElement(Element element)
element - root element under which content will be builtpublic Document getDocument()
Document - Document that was builtpublic JDOMFactory getFactory()
JDOMFactory - the factory used for
constructing objects.SAXHandler(org.jdom.JDOMFactory)public void setExpandEntities(boolean expand)
EntityRef objects. The
default is true.
expand - boolean indicating whether entity expansion
should occur.public boolean getExpandEntities()
boolean - whether entity expansion
will occur during build.setExpandEntities(boolean)public void setIgnoringElementContentWhitespace(boolean ignoringWhite)
false.
ignoringWhite - Whether to ignore ignorable whitespacepublic void setIgnoringBoundaryWhitespace(boolean ignoringBoundaryWhite)
SAXBuilder.setIgnoringBoundaryWhitespace(boolean).
ignoringBoundaryWhite - Whether to ignore only whitespace contentpublic boolean getIgnoringBoundaryWhitespace()
boolean - whether only whitespace content will
be ignored during build.setIgnoringBoundaryWhitespace(boolean)public boolean getIgnoringElementContentWhitespace()
boolean - whether ignorable whitespace will
be ignored during build.setIgnoringElementContentWhitespace(boolean)public void startDocument()
startDocument in interface org.xml.sax.ContentHandlerstartDocument in class org.xml.sax.helpers.DefaultHandler
public void externalEntityDecl(java.lang.String name,
java.lang.String publicID,
java.lang.String systemID)
throws org.xml.sax.SAXException
externalEntityDecl in interface org.xml.sax.ext.DeclHandlername - entity namepublicID - public idsystemID - system id
org.xml.sax.SAXException - when things go wrong
public void attributeDecl(java.lang.String eName,
java.lang.String aName,
java.lang.String type,
java.lang.String valueDefault,
java.lang.String value)
throws org.xml.sax.SAXException
attributeDecl in interface org.xml.sax.ext.DeclHandlereName - String element name of attributeaName - String attribute nametype - String attribute typevalueDefault - String default value of attributevalue - String value of attribute
org.xml.sax.SAXException
public void elementDecl(java.lang.String name,
java.lang.String model)
throws org.xml.sax.SAXException
elementDecl in interface org.xml.sax.ext.DeclHandlername - String name of elementmodel - String model of the element in DTD syntax
org.xml.sax.SAXException
public void internalEntityDecl(java.lang.String name,
java.lang.String value)
throws org.xml.sax.SAXException
internalEntityDecl in interface org.xml.sax.ext.DeclHandlername - String name of entityvalue - String value of the entity
org.xml.sax.SAXException
public void processingInstruction(java.lang.String target,
java.lang.String data)
throws org.xml.sax.SAXException
processingInstruction in interface org.xml.sax.ContentHandlerprocessingInstruction in class org.xml.sax.helpers.DefaultHandlertarget - String target of PIdata - String containing all data sent to the PI.
This typically looks like one or more attribute value
pairs.
org.xml.sax.SAXException - when things go wrong
public void skippedEntity(java.lang.String name)
throws org.xml.sax.SAXException
skippedEntity in interface org.xml.sax.ContentHandlerskippedEntity in class org.xml.sax.helpers.DefaultHandlername - String name of entity
org.xml.sax.SAXException - when things go wrong
public void startPrefixMapping(java.lang.String prefix,
java.lang.String uri)
throws org.xml.sax.SAXException
Document object.
startPrefixMapping in interface org.xml.sax.ContentHandlerstartPrefixMapping in class org.xml.sax.helpers.DefaultHandlerprefix - String namespace prefix.uri - String namespace URI.
org.xml.sax.SAXException
public void startElement(java.lang.String namespaceURI,
java.lang.String localName,
java.lang.String qName,
org.xml.sax.Attributes atts)
throws org.xml.sax.SAXException
xmlns:[namespace prefix] and
xsi:schemaLocation.
startElement in interface org.xml.sax.ContentHandlerstartElement in class org.xml.sax.helpers.DefaultHandlernamespaceURI - String namespace URI this element
is associated with, or an empty
StringlocalName - String name of element (with no
namespace prefix, if one is present)qName - String XML 1.0 version of element name:
[namespace prefix]:[localName]atts - Attributes list for this element
org.xml.sax.SAXException - when things go wrong
public void characters(char[] ch,
int start,
int length)
throws org.xml.sax.SAXException
characters in interface org.xml.sax.ContentHandlercharacters in class org.xml.sax.helpers.DefaultHandlerch - char[] character array with character datastart - int index in array where data starts.length - int length of data.
org.xml.sax.SAXException
public void ignorableWhitespace(char[] ch,
int start,
int length)
throws org.xml.sax.SAXException
ignorableWhitespace in interface org.xml.sax.ContentHandlerignorableWhitespace in class org.xml.sax.helpers.DefaultHandlerch - [] - char array of ignorable whitespacestart - int - starting position within arraylength - int - length of whitespace after start
org.xml.sax.SAXException - when things go wrong
protected void flushCharacters()
throws org.xml.sax.SAXException
org.xml.sax.SAXException - when things go wrong
protected void flushCharacters(java.lang.String data)
throws org.xml.sax.SAXException
data - string to flush
org.xml.sax.SAXException
public void endElement(java.lang.String namespaceURI,
java.lang.String localName,
java.lang.String qName)
throws org.xml.sax.SAXException
</[element name]>) is reached. Note that
the parser does not distinguish between empty
elements and non-empty elements, so this will occur uniformly.
endElement in interface org.xml.sax.ContentHandlerendElement in class org.xml.sax.helpers.DefaultHandlernamespaceURI - String URI of namespace this
element is associated withlocalName - String name of element without prefixqName - String name of element in XML 1.0 form
org.xml.sax.SAXException - when things go wrong
public void startDTD(java.lang.String name,
java.lang.String publicID,
java.lang.String systemID)
throws org.xml.sax.SAXException
Document
object.
startDTD in interface org.xml.sax.ext.LexicalHandlername - String name of element listed in DTDpublicID - String public ID of DTDsystemID - String system ID of DTD
org.xml.sax.SAXException
public void endDTD()
throws org.xml.sax.SAXException
endDTD in interface org.xml.sax.ext.LexicalHandlerorg.xml.sax.SAXException
public void startEntity(java.lang.String name)
throws org.xml.sax.SAXException
startEntity in interface org.xml.sax.ext.LexicalHandlerorg.xml.sax.SAXException
public void endEntity(java.lang.String name)
throws org.xml.sax.SAXException
endEntity in interface org.xml.sax.ext.LexicalHandlerorg.xml.sax.SAXException
public void startCDATA()
throws org.xml.sax.SAXException
startCDATA in interface org.xml.sax.ext.LexicalHandlerorg.xml.sax.SAXException
public void endCDATA()
throws org.xml.sax.SAXException
endCDATA in interface org.xml.sax.ext.LexicalHandlerorg.xml.sax.SAXException
public void comment(char[] ch,
int start,
int length)
throws org.xml.sax.SAXException
Element, or the Document itself
if at that level.
comment in interface org.xml.sax.ext.LexicalHandlerch - ch[] array of comment characters.start - int index to start reading from.length - int length of data.
org.xml.sax.SAXException
public void notationDecl(java.lang.String name,
java.lang.String publicID,
java.lang.String systemID)
throws org.xml.sax.SAXException
notationDecl in interface org.xml.sax.DTDHandlernotationDecl in class org.xml.sax.helpers.DefaultHandlername - name of the notationpublicID - the public ID of the notationsystemID - the system ID of the notation
org.xml.sax.SAXException
public void unparsedEntityDecl(java.lang.String name,
java.lang.String publicID,
java.lang.String systemID,
java.lang.String notationName)
throws org.xml.sax.SAXException
unparsedEntityDecl in interface org.xml.sax.DTDHandlerunparsedEntityDecl in class org.xml.sax.helpers.DefaultHandlername - String of the unparsed entity declpublicID - String of the unparsed entity declsystemID - String of the unparsed entity declnotationName - String of the unparsed entity decl
org.xml.sax.SAXException
public Element getCurrentElement()
throws org.xml.sax.SAXException
Element - element being built.
org.xml.sax.SAXExceptionpublic void setDocumentLocator(org.xml.sax.Locator locator)
JDOMFactory implementations can use the
getDocumentLocator() method to get access to the
Locator during parse.
setDocumentLocator in interface org.xml.sax.ContentHandlersetDocumentLocator in class org.xml.sax.helpers.DefaultHandlerlocator - Locator an object that can return
the location of any SAX document event.public org.xml.sax.Locator getDocumentLocator()
Locator object provided by the
SAX parser.
Locator an object that can return
the location of any SAX document event.
|
JDOM 1.1.1 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||