SAXHandler Interface

Table 18-5 summarizes the methods of available through the SAXHandler interface.

CDATA

This event handles CDATA, as distinct from Text. The data will be in the data encoding, and the returned length is in characters, not bytes. This is an Oracle extension.

virtual void CDATA( 
   oratext* data,
   ub4 size) = 0;

data

size

XMLDecl

This event marks an XML declaration (XMLDecl). The startDocument event is always first; this event will be the second event. The encoding flag says whether an encoding was specified. For the standalone flag, -1 will be returned if it was not specified, otherwise 0 for FALSE, 1 for TRUE. This member function is an Oracle extension.

virtual void XMLDecl( 
   oratext* version,
   boolean is_encoding,
   sword standalone) = 0;

version

is_encoding

standalone

attributeDecl

This event marks an attribute declaration in the DTD. It is an Oracle extension; not in SAX standard

virtual void attributeDecl(
   oratext* attr_name,
   oratext *name, 
   oratext *content) = 0;

attr_name

name

content

characters

This event marks character data.

virtual void characters(
   oratext* ch,
   ub4 size) = 0;

ch

size

comment

This event marks a comment in the XML document. The comment's data will be in the data encoding. It is an Oracle extension, not in SAX standard.

virtual void comment(
   oratext* data) = 0;

data

elementDecl

This event marks an element declaration in the DTD. It is an Oracle extension; not in SAX standard.

virtual void elementDecl( 
   oratext *name, 
   oratext *content) = 0;

name

content

endDocument

Receive notification of the end of the document.

virtual void endDocument() = 0;

endElement

This event marks the end of an element. The name is the tagName of the element (which may be a qualified name for namespace-aware elements) and is in the data encoding.

virtual void endElement( oratext* name) = 0;

notationDecl

The even marks the declaration of a notation in the DTD. The notation's name, public ID, and system ID will all be in the data encoding. Both IDs are optional and may be NULL.

virtual void notationDecl(
   oratext* name,
   oratext* public_id,
   oratext* system_id) = 0;

name

public_id

sysem_id

parsedEntityDecl

Marks a parsed entity declaration in the DTD. The parsed entity's name, public ID, system ID, and notation name will all be in the data encoding. This is an Oracle extension.

virtual void parsedEntityDecl(
   oratext* name,
   oratext* value,
   oratext* public_id,
   oratext* system_id,
   boolean general) = 0;

name

value

public_id

sysem_id

general

processingInstruction

This event marks a processing instruction. The PI's target and data will be in the data encoding. There is always a target, but the data may be NULL.

virtual void processingInstruction( 
   oratext* target,
   oratext* data) = 0;

target

data

startDocument

Receive notification of the start of document.

virtual void startDocument() = 0;

startElement

This event marks the start of an element.

virtual void startElement( 
   oratext* name,
   NodeListRef< Node>* attrs_ptr) = 0;

name

attrs_ptr

startElementNS

This event marks the start of an element. Note this is the new SAX 2 namespace-aware version. The element's qualified name, local name, and namespace URI will be in the data encoding, as are all the attribute parts.

virtual void startElementNS(
   oratext* qname,
   oratext* local,
   oratext* ns_URI,
   NodeListRef< Node>* attrs_ptr) = 0;

qname

local

ns_URI

attrs_ref

unparsedEntityDecl

Marks an unparsed entity declaration in the DTD. The unparsed entity's name, public ID, system ID, and notation name will all be in the data encoding.

virtual void unparsedEntityDecl(
   oratext* name,
   oratext* public_id,
   oratext* system_id,
   oratext* notation_name) = 0;
};

name

public_id

sysem_id

notation_name

whitespace

This event marks ignorable whitespace data such as newlines, and indentation between lines.

virtual void whitespace(
   oratext* data,
   ub4 size) = 0;

data

size