All Frameworks Class Hierarchy This Framework Indexes Previous Next

XMLParserItf Interface CATISAXContentHandler

Usage: you can freely reimplement this interface.

interface CATISAXContentHandler

Interface to receive notification of the logical content of a document.

This is the main interface that most SAX applications implement: if the application needs to be informed of basic parsing events, it implements this interface and registers an instance with the SAX parser using the method. The parser uses the instance to report basic document-related events like the start and end of elements and character data.

The order of events in this interface is very important, and mirrors the order of information in the document itself. For example, all of an element content (character data, processing instructions, and/or subelements) will appear, in order, between the event and the corresponding event.

See also:: , ,

Method Index

o Characters(CATUnicodeString&): Receives notification of character data.
o EndDocument(): Receives notification of the end of a document.
o EndElement(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&): Receives notification of the end of an element.
o EndPrefixMapping(CATUnicodeString&): Receives notification of the end of the scope of a prefix-URI Namespace mapping.
o IgnorableWhiteSpace(CATUnicodeString&): Receives notification of ignorable whitespace in element content.
o ProcessingInstruction(CATUnicodeString&,CATUnicodeString&): Receives notification of a processing instruction.
o SetDocumentLocator(CATISAXLocator_var&): Receives an object for locating the origin of SAX content events.
o SkippedEntity(CATUnicodeString&): Receives notification of a skipped entity.
o StartDocument(): Receives notification of the beginning of a document.
o StartElement(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATISAXAttributes_var&): Receives notification of the beginning of an element.
o StartPrefixMapping(CATUnicodeString&,CATUnicodeString&): Receives notification of the beginning of the scope of a prefix-URI Namespace mapping.

Methods

o Characters

public virtual Characters( const iCharacters)

Receives notification of character data.

The will call this method to report each chunk of character data. SAX parsers may return all contiguous character data in a single chunk, or they may split it into several chunks; however, all of the characters in any single event must come from the same external entity, so that the provides useful information.

Note that some parsers will report whitespace using the method rather than this one (validating parsers must do so).

Parameters:

iCharacters: The characters from the XML document.

Errors Returned:

Error Class	Error Id	Description
	XMLParserERR_2000	The method can raise a CATSAXException
	XMLParserERR_2002	The method can raise a CATSAXParseException

See also:

o EndDocument

public virtual EndDocument(

)

Receives notification of the end of a document.

The SAX parser will invoke this method only once, and it will be the last method invoked during the parse. The parser shall not invoke this method until it has either abandoned parsing (because of an unrecoverable error) or reached the end of input.

Errors Returned:

Error Class	Error Id	Description
	XMLParserERR_2000	The method can raise a CATSAXException
	XMLParserERR_2002	The method can raise a CATSAXParseException

See also:

o EndElement

public virtual EndElement(	const	`iURI`,
	const	`iLocalName`,
	const	`iQualifiedName`)

Receives notification of the end of an element.

The SAX parser will invoke this method at the end of every element in the XML document; there will be a corresponding event for every event (even when the element is empty).

For information on the names, see .

Parameters:

iURI: The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.
iLocalName: The local name (without prefix), or the empty string if Namespace processing is not being performed.
iQualifiedName: The qualified name (with prefix), or the empty string if qualified names are not available.

Errors Returned:

Error Class	Error Id	Description
	XMLParserERR_2000	The method can raise a CATSAXException
	XMLParserERR_2002	The method can raise a CATSAXParseException

See also:

o EndPrefixMapping

public virtual EndPrefixMapping( const iPrefix)

Receives notification of the end of the scope of a prefix-URI Namespace mapping.

Parameters:

iPrefix: The prefix that was being mapped.

Errors Returned:

Error Class	Error Id	Description
	XMLParserERR_2000	The method can raise a CATSAXException
	XMLParserERR_2002	The method can raise a CATSAXParseException

See also:

o IgnorableWhiteSpace

public virtual IgnorableWhiteSpace( const iCharacters)

Receives notification of ignorable whitespace in element content.

Validating s must use this method to report each chunk of ignorable whitespace (see the W3C XML 1.0 recommendation, section 2.10): non-validating parsers may also use this method if they are capable of parsing and using content models.

SAX parsers may return all contiguous whitespace in a single chunk, or they may split it into several chunks; however, all of the characters in any single event must come from the same external entity, so that the provides useful information.

Parameters:

iCharacters: The characters from the XML document.

Errors Returned:

Error Class	Error Id	Description
	XMLParserERR_2000	The method can raise a CATSAXException
	XMLParserERR_2002	The method can raise a CATSAXParseException

See also:

o ProcessingInstruction

public virtual ProcessingInstruction(	const	`iTarget`,
	const	`iData`)

Receives notification of a processing instruction.

The will invoke this method once for each processing instruction found: note that processing instructions may occur before or after the main document element.

A SAX parser should never report an XML declaration (XML 1.0, section 2.8) or a text declaration (XML 1.0, section 4.3.1) using this method.

Parameters:

iTarget: The processing instruction target.
iData: The processing instruction data (can be an empty

Errors Returned:

Error Class	Error Id	Description
	XMLParserERR_2000	The method can raise a CATSAXException
	XMLParserERR_2002	The method can raise a CATSAXParseException

o SetDocumentLocator

public virtual SetDocumentLocator( const iLocator)

Receives an object for locating the origin of SAX content events.

SAX parsers are strongly encouraged (though not absolutely required) to supply a locator: if it does so, it must supply the locator to the application by invoking this method before invoking any of the other methods in the interface.

The locator allows the application to determine the end position of any document-related event, even if the parser is not reporting an error. Typically, the application will use this information for reporting its own errors (such as character content that does not match an application's business rules). The information returned by the locator is probably not sufficient for use with a search engine.

Note that the locator will return correct information only during the invocation of the events in this interface. The application should not attempt to use it at any other time.

Parameters:

iLocator: An object that can return the location of any SAX document event.

See also:

o SkippedEntity

public virtual SkippedEntity( const iName)

Receives notification of a skipped entity.

The will invoke this method once for each entity skipped. Non-validating processors may skip entities if they have not seen the declarations (because, for example, the entity was declared in an external DTD subset). All processors may skip external entities, depending on the values of the http://xml.org/sax/features/external-general-entities and the http://xml.org/sax/features/external-parameter-entities properties.

Parameters:

iName: The name of the skipped entity. If it is a parameter entity, the name will begin with '%', and if it is the external DTD subset, it will be the string "[dtd]".

Errors Returned:

Error Class	Error Id	Description
	XMLParserERR_2000	The method can raise a CATSAXException
	XMLParserERR_2002	The method can raise a CATSAXParseException

o StartDocument

public virtual StartDocument(

)

Receives notification of the beginning of a document.

The SAX parser will invoke this method only once, before any other methods in this interface or in (except for ).

Errors Returned:

Error Class	Error Id	Description
	XMLParserERR_2000	The method can raise a CATSAXException
	XMLParserERR_2002	The method can raise a CATSAXParseException

See also:

o StartElement

public virtual StartElement(	const	`iURI`,
	const	`iLocalName`,
	const	`iQualifiedName`,
	const	`iAttributes`)

Receives notification of the beginning of an element.

The Parser will invoke this method at the beginning of every element in the XML document; there will be a corresponding event for every event (even when the element is empty).

All of the element content will be reported, in order, before the corresponding event .

This event allows up to three name components for each element:

the Namespace URI;
the local name; and
the qualified (prefixed) name.

Any or all of these may be provided, depending on the values of the http://xml.org/sax/features/namespaces and the http://xml.org/sax/features/namespace-prefixes properties:

the Namespace URI and local name are required when the namespaces property is TRUE (the default), and are optional when the namespaces property is FALSE (if one is specified, both must be);
the qualified name is required when the namespace-prefixes property is TRUE, and is optional when the namespace-prefixes property is FALSE (the default).

Note that the attribute list provided will contain only attributes with explicit values (specified or defaulted): #IMPLIED attributes will be omitted. The attribute list will contain attributes used for Namespace declarations (xmlns* attributes) only if the http://xml.org/sax/features/namespace-prefixes property is TRUE (it is FALSE by default, and support for a TRUE value is optional).

Parameters:

iURI: The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.
iLocalName: The local name (without prefix), or the empty string if Namespace processing is not being performed.
iQualifiedName: The qualified name (with prefix), or the empty string if qualified names are not available.
iAttributes: The attributes attached to the element. If there are no attributes, it shall be an empty

Errors Returned:

Error Class	Error Id	Description
	XMLParserERR_2000	The method can raise a CATSAXException
	XMLParserERR_2002	The method can raise a CATSAXParseException

See also:

o StartPrefixMapping

public virtual StartPrefixMapping(	const	`iPrefix`,
	const	`iURI`)

Receives notification of the beginning of the scope of a prefix-URI Namespace mapping.

The information from this event is not necessary for normal Namespace processing: the will automatically replace prefixes for element and attribute names when the http://xml.org/sax/features/namespaces feature is TRUE (the default).

There are cases, however, when applications need to use prefixes in character data or in attribute values, where they cannot safely be expanded automatically; the / events supply the information to the application to expand prefixes in those contexts itself, if necessary.

Note that / events are not guaranteed to be properly nested relative to each-other: all events will occur before the corresponding event, and all events will occur after the corresponding event, but their order is not otherwise guaranteed.

There should never be / events for the "xml" prefix, since it is predeclared and immutable.

Parameters:

iPrefix: The Namespace prefix being declared.
iURI: The Namespace URI the prefix is mapped to.

Errors Returned:

Error Class	Error Id	Description
	XMLParserERR_2000	The method can raise a CATSAXException
	XMLParserERR_2002	The method can raise a CATSAXParseException

See also:

This object is included in the file: CATISAXContentHandler.h
If needed, your Imakefile.mk should include the module: CatXmlItfBase