ACEXML_XMLFilterImpl Class Reference

ACEXML_XMLFilterImpl. More...

#include <ACEXML/common/XMLFilterImpl.h>

Inheritance diagram for ACEXML_XMLFilterImpl:

[legend]

Collaboration diagram for ACEXML_XMLFilterImpl:

[legend]

List of all members.

Public Member Functions
	ACEXML_XMLFilterImpl (void)
	ACEXML_XMLFilterImpl (ACEXML_XMLReader *parent)
virtual	~ACEXML_XMLFilterImpl (void)
virtual int	getFeature (const ACEXML_Char *name ACEXML_ENV_ARG_DECL)
virtual void *	getProperty (const ACEXML_Char *name ACEXML_ENV_ARG_DECL)
virtual void	parse (ACEXML_InputSource *input ACEXML_ENV_ARG_DECL)
virtual void	parse (const ACEXML_Char *systemId ACEXML_ENV_ARG_DECL)
virtual void	setFeature (const ACEXML_Char *name, int boolean_value ACEXML_ENV_ARG_DECL)
virtual void	setProperty (const ACEXML_Char *name, void *value ACEXML_ENV_ARG_DECL)
virtual ACEXML_XMLReader *	getParent (void) const
virtual void	setParent (ACEXML_XMLReader *parent)
virtual ACEXML_DTDHandler *	getDTDHandler (void) const
virtual ACEXML_ContentHandler *	getContentHandler (void) const
virtual ACEXML_EntityResolver *	getEntityResolver (void) const
virtual ACEXML_ErrorHandler *	getErrorHandler (void) const
virtual void	setDTDHandler (ACEXML_DTDHandler *handler)
virtual void	setContentHandler (ACEXML_ContentHandler *handler)
virtual void	setEntityResolver (ACEXML_EntityResolver *handler)
virtual void	setErrorHandler (ACEXML_ErrorHandler *handler)
virtual void	characters (const ACEXML_Char *ch, size_t start, size_t length ACEXML_ENV_ARG_DECL)
virtual void	endDocument (ACEXML_ENV_SINGLE_ARG_DECL)
virtual void	endElement (const ACEXML_Char *namespaceURI, const ACEXML_Char *localName, const ACEXML_Char *qName ACEXML_ENV_ARG_DECL)
virtual void	endPrefixMapping (const ACEXML_Char *prefix ACEXML_ENV_ARG_DECL)
virtual void	ignorableWhitespace (const ACEXML_Char *ch, int start, int length ACEXML_ENV_ARG_DECL)
virtual void	processingInstruction (const ACEXML_Char *target, const ACEXML_Char *data ACEXML_ENV_ARG_DECL)
virtual void	setDocumentLocator (ACEXML_Locator *locator)
virtual void	skippedEntity (const ACEXML_Char *name ACEXML_ENV_ARG_DECL)
virtual void	startDocument (ACEXML_ENV_SINGLE_ARG_DECL)
virtual void	startElement (const ACEXML_Char *namespaceURI, const ACEXML_Char *localName, const ACEXML_Char *qName, ACEXML_Attributes *atts ACEXML_ENV_ARG_DECL)
virtual void	startPrefixMapping (const ACEXML_Char *prefix, const ACEXML_Char *uri ACEXML_ENV_ARG_DECL)
virtual void	notationDecl (const ACEXML_Char *name, const ACEXML_Char *publicId, const ACEXML_Char *systemId ACEXML_ENV_ARG_DECL)
virtual void	unparsedEntityDecl (const ACEXML_Char *name, const ACEXML_Char *publicId, const ACEXML_Char *systemId, const ACEXML_Char *notationName ACEXML_ENV_ARG_DECL)
virtual ACEXML_InputSource *	resolveEntity (const ACEXML_Char *publicId, const ACEXML_Char *systemId ACEXML_ENV_ARG_DECL)
virtual void	error (ACEXML_SAXParseException &exception ACEXML_ENV_ARG_DECL)
virtual void	fatalError (ACEXML_SAXParseException &exception ACEXML_ENV_ARG_DECL)
virtual void	warning (ACEXML_SAXParseException &exception ACEXML_ENV_ARG_DECL)
Protected Member Functions
int	setupParser (void)
Private Attributes
ACEXML_XMLReader *	parent_
ACEXML_Locator *	locator_
ACEXML_EntityResolver *	entityResolver_
ACEXML_DTDHandler *	dtdHandler_
ACEXML_ContentHandler *	contentHandler_
ACEXML_ErrorHandler *	errorHandler_

---

Detailed Description

ACEXML_XMLFilterImpl.

This class is designed to sit between an XMLReader and the client application's event handlers. By default, it does nothing but pass requests up to the reader and events on to the handlers unmodified, but subclasses can override specific methods to modify the event stream or the configuration requests as they pass through.

---

Constructor & Destructor Documentation

ACEXML_XMLFilterImpl::ACEXML_XMLFilterImpl

(

void

)

Default constructor. Create with no parent.

ACEXML_XMLFilterImpl::ACEXML_XMLFilterImpl

(

ACEXML_XMLReader *

parent

)

Construct an XML filter with the specified parent.

ACEXML_XMLFilterImpl::~ACEXML_XMLFilterImpl

(

void

)

[virtual]

Destructor.

---

Member Function Documentation

int ACEXML_XMLFilterImpl::getFeature

(

const ACEXML_Char *name

ACEXML_ENV_ARG_DECL

)

[virtual]

Look up the value of a feature. This method allows programmers to check whether a specific feature has been activated in the parser.

Implements ACEXML_XMLReader.

void * ACEXML_XMLFilterImpl::getProperty

(

const ACEXML_Char *name

ACEXML_ENV_ARG_DECL

)

[virtual]

Look up the value of a property.

Implements ACEXML_XMLReader.

void ACEXML_XMLFilterImpl::parse

(

ACEXML_InputSource *input

ACEXML_ENV_ARG_DECL

)

[virtual]

Parse an XML document.

Implements ACEXML_XMLReader.

void ACEXML_XMLFilterImpl::parse

(

const ACEXML_Char *systemId

ACEXML_ENV_ARG_DECL

)

[virtual]

Parse an XML document from a system identifier (URI).

Implements ACEXML_XMLReader.

void ACEXML_XMLFilterImpl::setFeature	(	const ACEXML_Char *	name,
		int boolean_value	ACEXML_ENV_ARG_DECL
	)			[virtual]

Activating or deactivating a feature.

Implements ACEXML_XMLReader.

void ACEXML_XMLFilterImpl::setProperty	(	const ACEXML_Char *	name,
		void *value	ACEXML_ENV_ARG_DECL
	)			[virtual]

Set the value of a property.

Implements ACEXML_XMLReader.

ACEXML_XMLReader * ACEXML_XMLFilterImpl::getParent

(

void

)

const [virtual]

Get the parent reader.

Implements ACEXML_XMLFilter.

void ACEXML_XMLFilterImpl::setParent

(

ACEXML_XMLReader *

parent

)

[virtual]

Set the parent reader.

Implements ACEXML_XMLFilter.

ACEXML_DTDHandler * ACEXML_XMLFilterImpl::getDTDHandler

(

void

)

const [virtual]

Return the current DTD handler.

Implements ACEXML_XMLReader.

ACEXML_ContentHandler * ACEXML_XMLFilterImpl::getContentHandler

(

void

)

const [virtual]

Return the current content handler.

Implements ACEXML_XMLReader.

ACEXML_EntityResolver * ACEXML_XMLFilterImpl::getEntityResolver

(

void

)

const [virtual]

Return the current entity resolver.

Implements ACEXML_XMLReader.

ACEXML_ErrorHandler * ACEXML_XMLFilterImpl::getErrorHandler

(

void

)

const [virtual]

Return the current error handler.

Implements ACEXML_XMLReader.

void ACEXML_XMLFilterImpl::setDTDHandler

(

ACEXML_DTDHandler *

handler

)

[virtual]

Allow an application to register a DTD event handler.

Implements ACEXML_XMLReader.

void ACEXML_XMLFilterImpl::setContentHandler

(

ACEXML_ContentHandler *

handler

)

[virtual]

Allow an application to register a content event handler.

Implements ACEXML_XMLReader.

void ACEXML_XMLFilterImpl::setEntityResolver

(

ACEXML_EntityResolver *

resolver

)

[virtual]

Allow an application to register an entity resolver.

Implements ACEXML_XMLReader.

void ACEXML_XMLFilterImpl::setErrorHandler

(

ACEXML_ErrorHandler *

handler

)

[virtual]

Allow an application to register an error event handler.

Implements ACEXML_XMLReader.

void ACEXML_XMLFilterImpl::characters	(	const ACEXML_Char *	ch,
		size_t	start,
		size_t length	ACEXML_ENV_ARG_DECL
	)			[virtual]

Receive notification of character data.

Implements ACEXML_ContentHandler.

void ACEXML_XMLFilterImpl::endDocument

(

ACEXML_ENV_SINGLE_ARG_DECL

)

[virtual]

Receive notification of the end of a document.

Implements ACEXML_ContentHandler.

void ACEXML_XMLFilterImpl::endElement	(	const ACEXML_Char *	namespaceURI,
		const ACEXML_Char *	localName,
		const ACEXML_Char *qName	ACEXML_ENV_ARG_DECL
	)			[virtual]

Receive notification of the end of an element.

Implements ACEXML_ContentHandler.

void ACEXML_XMLFilterImpl::endPrefixMapping

(

const ACEXML_Char *prefix

ACEXML_ENV_ARG_DECL

)

[virtual]

End the scope of a prefix-URI mapping.

Implements ACEXML_ContentHandler.

void ACEXML_XMLFilterImpl::ignorableWhitespace	(	const ACEXML_Char *	ch,
		int	start,
		int length	ACEXML_ENV_ARG_DECL
	)			[virtual]

Receive notification of ignorable whitespace in element content.

Implements ACEXML_ContentHandler.

void ACEXML_XMLFilterImpl::processingInstruction	(	const ACEXML_Char *	target,
		const ACEXML_Char *data	ACEXML_ENV_ARG_DECL
	)			[virtual]

Receive notification of a processing instruction.

Implements ACEXML_ContentHandler.

void ACEXML_XMLFilterImpl::setDocumentLocator

(

ACEXML_Locator *

locator

)

[virtual]

Receive an object for locating the origin of SAX document events.

Implements ACEXML_ContentHandler.

void ACEXML_XMLFilterImpl::skippedEntity

(

const ACEXML_Char *name

ACEXML_ENV_ARG_DECL

)

[virtual]

Receive notification of a skipped entity.

Implements ACEXML_ContentHandler.

void ACEXML_XMLFilterImpl::startDocument

(

ACEXML_ENV_SINGLE_ARG_DECL

)

[virtual]

Receive notification of the beginning of a document.

Implements ACEXML_ContentHandler.

void ACEXML_XMLFilterImpl::startElement	(	const ACEXML_Char *	namespaceURI,
		const ACEXML_Char *	localName,
		const ACEXML_Char *	qName,
		ACEXML_Attributes *atts	ACEXML_ENV_ARG_DECL
	)			[virtual]

Receive notification of the beginning of an element.

Implements ACEXML_ContentHandler.

void ACEXML_XMLFilterImpl::startPrefixMapping	(	const ACEXML_Char *	prefix,
		const ACEXML_Char *uri	ACEXML_ENV_ARG_DECL
	)			[virtual]

Begin the scope of a prefix-URI Namespace mapping.

Implements ACEXML_ContentHandler.

void ACEXML_XMLFilterImpl::notationDecl	(	const ACEXML_Char *	name,
		const ACEXML_Char *	publicId,
		const ACEXML_Char *systemId	ACEXML_ENV_ARG_DECL
	)			[virtual]

Receive notification of a notation declaration event.

Implements ACEXML_DTDHandler.

void ACEXML_XMLFilterImpl::unparsedEntityDecl	(	const ACEXML_Char *	name,
		const ACEXML_Char *	publicId,
		const ACEXML_Char *	systemId,
		const ACEXML_Char *notationName	ACEXML_ENV_ARG_DECL
	)			[virtual]

Receive notification of an unparsed entity declaration event.

Implements ACEXML_DTDHandler.

ACEXML_InputSource * ACEXML_XMLFilterImpl::resolveEntity	(	const ACEXML_Char *	publicId,
		const ACEXML_Char *systemId	ACEXML_ENV_ARG_DECL
	)			[virtual]

Allow the application to resolve external entities.

Implements ACEXML_EntityResolver.

void ACEXML_XMLFilterImpl::error

(

ACEXML_SAXParseException &exception

ACEXML_ENV_ARG_DECL

)

[virtual]

Receive notification of a recoverable error.

Implements ACEXML_ErrorHandler.

void ACEXML_XMLFilterImpl::fatalError

(

ACEXML_SAXParseException &exception

ACEXML_ENV_ARG_DECL

)

[virtual]

Receive notification of a non-recoverable error.

Implements ACEXML_ErrorHandler.

void ACEXML_XMLFilterImpl::warning

(

ACEXML_SAXParseException &exception

ACEXML_ENV_ARG_DECL

)

[virtual]

Receive notification of a warning.

Implements ACEXML_ErrorHandler.

ACEXML_INLINE int ACEXML_XMLFilterImpl::setupParser

(

void

)

[protected]

---

Member Data Documentation

ACEXML_XMLReader* ACEXML_XMLFilterImpl::parent_ [private]

ACEXML_Locator* ACEXML_XMLFilterImpl::locator_ [private]

ACEXML_EntityResolver* ACEXML_XMLFilterImpl::entityResolver_ [private]

ACEXML_DTDHandler* ACEXML_XMLFilterImpl::dtdHandler_ [private]

ACEXML_ContentHandler* ACEXML_XMLFilterImpl::contentHandler_ [private]

ACEXML_ErrorHandler* ACEXML_XMLFilterImpl::errorHandler_ [private]

---

The documentation for this class was generated from the following files:

• XMLFilterImpl.h
• XMLFilterImpl.cpp
• XMLFilterImpl.inl

---