Modules Namespace List Class Hierarchy Alphabetical List Compound List Namespace Members Compound Members Related Pages
org::xml::sax::HandlerBase Class Reference#include <HandlerBase.h>
Inheritance diagram for org::xml::sax::HandlerBase:
List of all members.
Detailed Description
Default base class for handlers.
This module, both source code and documentation, is in the Public Domain, and comes with NO WARRANTY. See http://www.saxproject.org for further information.
This class implements the default behaviour for four SAX1 interfaces: EntityResolver, DTDHandler, DocumentHandler, and ErrorHandler. It is now obsolete, but is included in SAX2 to support legacy SAX1 applications. SAX2 applications should use the DefaultHandler class instead.
Application writers can extend this class when they need to implement only part of an interface; parser writers can instantiate this class to provide default handlers when the application has not supplied its own.
Note that the use of this class is optional.
- Deprecated:
- This class works with the deprecated DocumentHandler interface. It has been replaced by the SAX2 DefaultHandler class.
- Since:
- SAX 1.0
- See also:
- org::xml::sax::EntityResolver
org::xml::sax::DTDHandler
org::xml::sax::DocumentHandler
org::xml::sax::ErrorHandler
|
Public Member Functions |
| | HandlerBase () |
| virtual RInputSource | resolveEntity (IN(RString) s, IN(RString) s1) throw ( RSAXException ) |
| | Resolve an external entity.
|
| virtual void | notationDecl (IN(RString) s, IN(RString) s1, IN(RString) s2) throw ( RSAXException ) |
| | Receive notification of a notation declaration.
|
| virtual void | unparsedEntityDecl (IN(RString) s, IN(RString) s1, IN(RString) s2, IN(RString) s3) throw ( RSAXException ) |
| | Receive notification of an unparsed entity declaration.
|
| virtual void | setDocumentLocator (IN(RLocator) locator) |
| | Receive a Locator object for document events.
|
| virtual void | startDocument () throw ( RSAXException ) |
| | Receive notification of the beginning of the document.
|
| virtual void | endDocument () throw ( RSAXException ) |
| | Receive notification of the end of the document.
|
| virtual void | startElement (IN(RString) s, IN(RAttributeList) attributelist) throw ( RSAXException ) |
| | Receive notification of the start of an element.
|
| virtual void | endElement (IN(RString) s) throw ( RSAXException ) |
| | Receive notification of the end of an element.
|
| virtual void | characters (IN(RString) ac, int i, int j) throw ( RSAXException ) |
| | Receive notification of character data inside an element.
|
| virtual void | ignorableWhitespace (IN(RString) ac, int i, int j) throw ( RSAXException ) |
| | Receive notification of ignorable whitespace in element content.
|
| virtual void | processingInstruction (IN(RString) s, IN(RString) s1) throw ( RSAXException ) |
| | Receive notification of a processing instruction.
|
| virtual void | warning (IN(RSAXParseException) saxparseexception) throw ( RSAXException ) |
| | Receive notification of a parser warning.
|
| virtual void | error (IN(RSAXParseException) saxparseexception) throw ( RSAXException ) |
| | Receive notification of a recoverable parser error.
|
| virtual void | fatalError (IN(RSAXParseException) saxparseexception) throw ( RSAXException ) |
| | Report a fatal XML parsing error.
|
Constructor & Destructor Documentation
| org::xml::sax::HandlerBase::HandlerBase |
( |
|
) |
[inline] |
|
Member Function Documentation
| virtual void org::xml::sax::HandlerBase::characters |
( |
IN(RString) |
ac, |
|
|
int |
i, |
|
|
int |
j |
|
) |
throw ( RSAXException ) [inline, virtual] |
|
|
|
Receive notification of character data inside an element.
By default, do nothing. Application writers may override this method to take specific actions for each chunk of character data (such as adding the data to a node or buffer, or printing it to a file).
- Parameters:
-
| ch | The characters. |
| start | The start position in the character array. |
| length | The number of characters to use from the character array. |
- Exceptions:
-
| org.xml.sax.SAXException | Any SAX exception, possibly wrapping another exception. |
- See also:
- org::xml::sax::DocumentHandler::characters
Implements org::xml::sax::DocumentHandler. |
| virtual void org::xml::sax::HandlerBase::endDocument |
( |
|
) |
throw ( RSAXException ) [inline, virtual] |
|
| virtual void org::xml::sax::HandlerBase::endElement |
( |
IN(RString) |
s |
) |
throw ( RSAXException ) [inline, virtual] |
|
|
|
Receive notification of the end of an element.
By default, do nothing. Application writers may override this method in a subclass to take specific actions at the end of each element (such as finalising a tree node or writing output to a file).
- Parameters:
-
| name | The element type name. |
| attributes | The specified or defaulted attributes. |
- Exceptions:
-
| org.xml.sax.SAXException | Any SAX exception, possibly wrapping another exception. |
- See also:
- org::xml::sax::DocumentHandler::endElement
|
|
|
Report a fatal XML parsing error.
The default implementation throws a SAXParseException. Application writers may override this method in a subclass if they need to take specific actions for each fatal error (such as collecting all of the errors into a single report): in any case, the application must stop all regular processing when this method is invoked, since the document is no longer reliable, and the parser may no longer report parsing events.
- Parameters:
-
| e | The error information encoded as an exception. |
- Exceptions:
-
| org.xml.sax.SAXException | Any SAX exception, possibly wrapping another exception. |
- See also:
- org::xml::sax::ErrorHandler::fatalError
org::xml::sax::SAXParseException
Implements org::xml::sax::ErrorHandler. |
| virtual void org::xml::sax::HandlerBase::ignorableWhitespace |
( |
IN(RString) |
ac, |
|
|
int |
i, |
|
|
int |
j |
|
) |
throw ( RSAXException ) [inline, virtual] |
|
|
|
Receive notification of ignorable whitespace in element content.
By default, do nothing. Application writers may override this method to take specific actions for each chunk of ignorable whitespace (such as adding data to a node or buffer, or printing it to a file).
- Parameters:
-
| ch | The whitespace characters. |
| start | The start position in the character array. |
| length | The number of characters to use from the character array. |
- Exceptions:
-
| org.xml.sax.SAXException | Any SAX exception, possibly wrapping another exception. |
- See also:
- org::xml::sax::DocumentHandler::ignorableWhitespace
Implements org::xml::sax::DocumentHandler. |
|
|
Receive notification of a notation declaration.
By default, do nothing. Application writers may override this method in a subclass if they wish to keep track of the notations declared in a document.
- Parameters:
-
| name | The notation name. |
| publicId | The notation public identifier, or null if not available. |
| systemId | The notation system identifier. |
- See also:
- org::xml::sax::DTDHandler::notationDecl
Implements org::xml::sax::DTDHandler. |
| virtual void org::xml::sax::HandlerBase::processingInstruction |
( |
IN(RString) |
s, |
|
|
IN(RString) |
s1 |
|
) |
throw ( RSAXException ) [inline, virtual] |
|
|
|
Receive notification of a processing instruction.
By default, do nothing. Application writers may override this method in a subclass to take specific actions for each processing instruction, such as setting status variables or invoking other methods.
- Parameters:
-
| target | The processing instruction target. |
| data | The processing instruction data, or null if none is supplied. |
- Exceptions:
-
| org.xml.sax.SAXException | Any SAX exception, possibly wrapping another exception. |
- See also:
- org::xml::sax::DocumentHandler::processingInstruction
Implements org::xml::sax::DocumentHandler. |
|
|
Resolve an external entity.
Always return null, so that the parser will use the system identifier provided in the XML document. This method implements the SAX default behaviour: application writers can override it in a subclass to do special translations such as catalog lookups or URI redirection.
- Parameters:
-
| publicId | The public identifer, or null if none is available. |
| systemId | The system identifier provided in the XML document. |
- Returns:
- The new input source, or null to require the default behaviour.
- Exceptions:
-
| org.xml.sax.SAXException | Any SAX exception, possibly wrapping another exception. |
- See also:
- org::xml::sax::EntityResolver::resolveEntity
|
| virtual void org::xml::sax::HandlerBase::setDocumentLocator |
( |
IN(RLocator) |
locator |
) |
[inline, virtual] |
|
| virtual void org::xml::sax::HandlerBase::startDocument |
( |
|
) |
throw ( RSAXException ) [inline, virtual] |
|
|
|
Receive notification of the start of an element.
By default, do nothing. Application writers may override this method in a subclass to take specific actions at the start of each element (such as allocating a new tree node or writing output to a file).
- Parameters:
-
| name | The element type name. |
| attributes | The specified or defaulted attributes. |
- Exceptions:
-
| org.xml.sax.SAXException | Any SAX exception, possibly wrapping another exception. |
- See also:
- org::xml::sax::DocumentHandler::startElement
|
|
|
Receive notification of an unparsed entity declaration.
By default, do nothing. Application writers may override this method in a subclass to keep track of the unparsed entities declared in a document.
- Parameters:
-
| name | The entity name. |
| publicId | The entity public identifier, or null if not available. |
| systemId | The entity system identifier. |
| notationName | The name of the associated notation. |
- See also:
- org::xml::sax::DTDHandler::unparsedEntityDecl
Implements org::xml::sax::DTDHandler. |
|
2005/5/9
HandlerBase
