Main Page   Packages   Namespace List   Class Hierarchy   Compound List   Compound Members  

SAXHandler Class Reference

List of all members.

Public Methods

 SAXHandler () throws IOException
 SAXHandler (JDOMFactory factory) throws IOException
Document getDocument ()
JDOMFactory getFactory ()
void setExpandEntities (boolean expand)
boolean getExpandEntities ()
void setIgnoringElementContentWhitespace (boolean ignoringWhite)
boolean getIgnoringElementContentWhitespace ()
void externalEntityDecl (String name, String publicId, String systemId) throws SAXException
void attributeDecl (String eName, String aName, String type, String valueDefault, String value) throws SAXException
void elementDecl (String name, String model) throws SAXException
void internalEntityDecl (String name, String value) throws SAXException
void processingInstruction (String target, String data) throws SAXException
void skippedEntity (String name) throws SAXException
void startPrefixMapping (String prefix, String uri) throws SAXException
void endPrefixMapping (String prefix) throws SAXException
void startElement (String namespaceURI, String localName, String qName, Attributes atts) throws SAXException
void characters (char[] ch, int start, int length) throws SAXException
void ignorableWhitespace (char[] ch, int start, int length) throws SAXException
void endElement (String namespaceURI, String localName, String qName) throws SAXException
void startDTD (String name, String publicId, String systemId) throws SAXException
void endDTD () throws SAXException
void startEntity (String name) throws SAXException
void endEntity (String name) throws SAXException
void startCDATA () throws SAXException
void endCDATA () throws SAXException
void comment (char[] ch, int start, int length) throws SAXException
void notationDecl (String name, String publicID, String systemID) throws SAXException
void unparsedEntityDecl (String name, String publicId, String systemId, String notationName) throws SAXException
void setDocumentLocator (Locator locator)
Locator getDocumentLocator ()

Static Public Methods

 SAXHandler (Document document) throws IOException

Protected Methods

void flushCharacters () throws SAXException
Element getCurrentElement () throws SAXException

Protected Attributes

Stack stack
boolean atRoot
boolean inDTD = false
boolean inInternalSubset = false
boolean previousCDATA = false
boolean inCDATA = false
boolean suppress = false
LinkedList declaredNamespaces
LinkedList availableNamespaces

Detailed Description

SAXHandler supports SAXBuilder

Author:
Brett McLaughlin , Jason Hunter , Philip Nelson , Bradley S. Huffman , phil@triloggroup.com
Version:
Revision:
1.35
,
Date:
2002/02/07 02:10:21


Constructor & Destructor Documentation

SAXHandler::SAXHandler Document    document [inline, static]
 

This will set the Document to use.

Parameters:
document  Document being parsed.
Exceptions:
IOException  when errors occur.
Deprecated:
Deprecated in beta7, use SAXHandler() instead and let SAXHandler create the Document, then retrieve it with getDocument()

SAXHandler::SAXHandler   [inline]
 

This will create a new SAXHandler that listens to SAX events and creates a JDOM Document. The objects will be constructed using the default factory.

Exceptions:
IOException  when errors occur.

SAXHandler::SAXHandler JDOMFactory    factory [inline]
 

This will create a new SAXHandler that listens to SAX events and creates a JDOM Document. The objects will be constructed using the provided factory.

Parameters:
factory  JDOMFactory to be used for constructing objects
Exceptions:
IOException  when errors occur.


Member Function Documentation

void SAXHandler::attributeDecl String    eName,
String    aName,
String    type,
String    valueDefault,
String    value
[inline]
 

This handles an attribute declaration in the internal subset

Parameters:
eName  String element name of attribute
aName  String attribute name
type  String attribute type
valueDefault  String default value of attribute
value  String value of attribute

void SAXHandler::characters char    ch[],
int    start,
int    length
[inline]
 

This will report character data (within an element).

Parameters:
ch  char[] character array with character data
start  int index in array where data starts.
length  int length of data.

void SAXHandler::comment char    ch[],
int    start,
int    length
[inline]
 

This reports that a comments is parsed. If not in the DTD, this comment is added to the current JDOM Element, or the Document itself if at that level.

Parameters:
ch  ch[] array of comment characters.
start  int index to start reading from.
length  int length of data.

void SAXHandler::elementDecl String    name,
String    model
[inline]
 

Handle an element declaration in a DTD

Parameters:
name  String name of element
model  String model of the element in DTD syntax

void SAXHandler::endCDATA   [inline]
 

Report a CDATA section - ignored in SAXBuilder.

void SAXHandler::endDTD   [inline]
 

This signifies that the reading of the DTD is complete.

void SAXHandler::endElement String    namespaceURI,
String    localName,
String    qName
[inline]
 

Indicates the end of an element (</[element name]>) is reached. Note that the parser does not distinguish between empty elements and non-empty elements, so this will occur uniformly.

Parameters:
namespaceURI  String URI of namespace this element is associated with
localName  String name of element without prefix
qName  String name of element in XML 1.0 form
Exceptions:
SAXException  when things go wrong

void SAXHandler::endEntity String    name [inline]
 

if stack is empty, this entity belongs to an attribute in these cases, it is an error on the part of the parser to call startEntity but this will help in some cases. See org/xml/sax/ext/LexicalHandler.htmlstartEntity(java.lang.String) for more information

void SAXHandler::endPrefixMapping String    prefix [inline]
 

This will add the prefix mapping to the JDOM Document object.

Parameters:
prefix  String namespace prefix.
uri  String namespace URI.

void SAXHandler::externalEntityDecl String    name,
String    publicId,
String    systemId
[inline]
 

This is called when the parser encounters an external entity declaration.

Parameters:
name  entity name
publicId  public id
systemId  system id
Exceptions:
SAXException  when things go wrong

void SAXHandler::flushCharacters   [inline, protected]
 

This will flush any characters from SAX character calls we've been buffering.

Exceptions:
SAXException  when things go wrong

Element SAXHandler::getCurrentElement   [inline, protected]
 

Returns the being-parsed element.

Returns:
Element - element at the top of the stack.

Document SAXHandler::getDocument   [inline]
 

Returns the document. Should be called after parsing is complete.

Returns:
Document - Document that was built

Locator SAXHandler::getDocumentLocator   [inline]
 

Provides access to the Locator object provided by the SAX parser.

Returns:
Locator an object that can return the location of any SAX document event.

boolean SAXHandler::getExpandEntities   [inline]
 

Returns whether or not entities will be expanded during the build.

Returns:
boolean - whether entity expansion will occur during build.
See also:
setExpandEntities

JDOMFactory SAXHandler::getFactory   [inline]
 

Returns the factory used for constructing objects.

Returns:
JDOMFactory - the factory used for constructing objects.
See also:
SAXHandler(org.jdom.input.JDOMFactory)

boolean SAXHandler::getIgnoringElementContentWhitespace   [inline]
 

Returns whether or not the parser will elminate whitespace in element content (sometimes known as "ignorable whitespace") when building the document.

Returns:
boolean - whether ignorable whitespace will be ignored during build.
See also:
setIgnoringElementContentWhitespace

void SAXHandler::ignorableWhitespace char    ch[],
int    start,
int    length
[inline]
 

Capture ignorable whitespace as text. If setIgnoringElementContentWhitespace(true) has been called then this method does nothing.

Parameters:
ch  [] - char array of ignorable whitespace
start  int - starting position within array
length  int - length of whitespace after start
Exceptions:
SAXException  when things go wrong

void SAXHandler::internalEntityDecl String    name,
String    value
[inline]
 

Handle an internal entity declaration in a DTD.

Parameters:
name  String name of entity
value  String value of the entity

void SAXHandler::notationDecl String    name,
String    publicID,
String    systemID
[inline]
 

Handle the declaration of a Notation in a DTD

Parameters:
name  name of the notation
publicID  the public ID of the notation
systemID  the system ID of the notation

void SAXHandler::processingInstruction String    target,
String    data
[inline]
 

This will indicate that a processing instruction has been encountered. (The XML declaration is not a processing instruction and will not be reported.)

Parameters:
target  String target of PI
data  String containing all data sent to the PI. This typically looks like one or more attribute value pairs.
Exceptions:
SAXException  when things go wrong

void SAXHandler::setDocumentLocator Locator    locator [inline]
 

Receives an object for locating the origin of SAX document events. This method is invoked by the SAX parser.

JDOMFactory implementations can use the getDocumentLocator method to get access to the Locator during parse.

Parameters:
locator  Locator an object that can return the location of any SAX document event.

void SAXHandler::setExpandEntities boolean    expand [inline]
 

This sets whether or not to expand entities during the build. A true means to expand entities as normal content. A false means to leave entities unexpanded as EntityRef objects. The default is true.

Parameters:
expand  boolean indicating whether entity expansion should occur.

void SAXHandler::setIgnoringElementContentWhitespace boolean    ignoringWhite [inline]
 

Specifies whether or not the parser should elminate whitespace in element content (sometimes known as "ignorable whitespace") when building the document. Only whitespace which is contained within element content that has an element only content model will be eliminated (see XML Rec 3.2.1). For this setting to take effect requires that validation be turned on. The default value of this setting is false.

Parameters:
ignoringWhite  Whether to ignore ignorable whitespace

void SAXHandler::skippedEntity String    name [inline]
 

This indicates that an unresolvable entity reference has been encountered, normally because the external DTD subset has not been read.

Parameters:
name  String name of entity
Exceptions:
SAXException  when things go wrong

void SAXHandler::startCDATA   [inline]
 

Report a CDATA section - ignored in SAXBuilder.

void SAXHandler::startDTD String    name,
String    publicId,
String    systemId
[inline]
 

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.

Parameters:
name  String name of element listed in DTD
publicId  String public ID of DTD
systemId  String system ID of DTD

void SAXHandler::startElement String    namespaceURI,
String    localName,
String    qName,
Attributes    atts
[inline]
 

This reports the occurrence of an actual element. It will include the element's attributes, with the exception of XML vocabulary specific attributes, such as xmlns:[namespace prefix] and xsi:schemaLocation.

Parameters:
namespaceURI  String namespace URI this element is associated with, or an empty String
localName  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
Exceptions:
SAXException  when things go wrong

void SAXHandler::startPrefixMapping String    prefix,
String    uri
[inline]
 

This will add the prefix mapping to the JDOM Document object.

Parameters:
prefix  String namespace prefix.
uri  String namespace URI.

void SAXHandler::unparsedEntityDecl String    name,
String    publicId,
String    systemId,
String    notationName
[inline]
 

Handler for unparsed entity declarations in the DTD

Parameters:
name  String of the unparsed entity decl
publicId  String of the unparsed entity decl
systemId  String of the unparsed entity decl
notationName  String of the unparsed entity decl


Member Data Documentation

boolean SAXHandler::atRoot [protected]
 

Indicator of where in the document we are

LinkedList SAXHandler::availableNamespaces [protected]
 

The namespaces in scope and actually attached to an element

LinkedList SAXHandler::declaredNamespaces [protected]
 

Temporary holder for namespaces that have been declared with startPrefixMapping, but are not yet available on the element

boolean SAXHandler::inCDATA = false [protected]
 

Indicator of whether we are in a CDATA

boolean SAXHandler::inDTD = false [protected]
 

Indicator of whether we are in the DocType

boolean SAXHandler::inInternalSubset = false [protected]
 

Indicator of whether we are in the internal subset

boolean SAXHandler::previousCDATA = false [protected]
 

Indicator of whether we previously where in a CDATA

Stack SAXHandler::stack [protected]
 

Element stack

boolean SAXHandler::suppress = false [protected]
 

Indicator of whether we are actively suppressing (non-expanding) a current entity


The documentation for this class was generated from the following file:
Generated on Sat Mar 30 18:53:04 2002 for JDOM by doxygen1.2.12 written by Dimitri van Heesch, © 1997-2001