FDO API Reference

Feature Data Objects

FdoXmlNameCollectionHandler Class Reference

#include <NameCollectionHandler.h>

Inherits FdoDisposable, and FdoXmlSaxHandler.

Inheritance diagram for FdoXmlNameCollectionHandler:

[legend]List of all members.

---

Detailed Description

FdoXmlNameCollectionHandler is a class for serializing and deserializing fdo:NameCollectionType elements.

Definition at line 28 of file NameCollectionHandler.h.

Public Member Functions
virtual void	_writeXml (FdoXmlWriter *xmlWriter, const FdoXmlFlags *flags)
	XML Serialization functions, not part of supported API.
FDO_API FdoStringCollection *	GetNames ()
	Gets the collection of names.
virtual FdoBoolean	XmlEndElement (FdoXmlSaxContext *saxContext, FdoString *uri, FdoString *name, FdoString *qname)
	Default Sax callback that is called when the FdoXmlReader reads the end tag for an XML element in the document. Does nothing.
virtual FdoXmlSaxHandler *	XmlStartElement (FdoXmlSaxContext *saxContext, FdoString *uri, FdoString *name, FdoString *qname, FdoXmlAttributeCollection *atts)
	Default Sax callback that is called when the FdoXmlReader reads the start tag for an XML element in the document. Does nothing.
Static Public Member Functions
FDO_API FdoXmlNameCollectionHandler *	Create (FdoStringCollection *pNames=NULL)
	Constructs an Fdo XML Name Collection Handler.
Protected Member Functions
	FdoXmlNameCollectionHandler (FdoStringCollection *pNames)
	FdoXmlNameCollectionHandler ()
virtual	~FdoXmlNameCollectionHandler (void)

---

Constructor & Destructor Documentation

FdoXmlNameCollectionHandler::FdoXmlNameCollectionHandler (   )  [protected]

FdoXmlNameCollectionHandler::FdoXmlNameCollectionHandler (  FdoStringCollection *  pNames  )  [protected]

virtual FdoXmlNameCollectionHandler::~FdoXmlNameCollectionHandler (  void   )  [protected, virtual]

---

Member Function Documentation

virtual void FdoXmlNameCollectionHandler::_writeXml (  FdoXmlWriter *  xmlWriter, const FdoXmlFlags *  flags )  [virtual]

XML Serialization functions, not part of supported API. _writeXml serializes each name in the collection as a [Name] element.

FDO_API FdoXmlNameCollectionHandler* FdoXmlNameCollectionHandler::Create (  FdoStringCollection *  pNames = NULL  )  [static]

Constructs an Fdo XML Name Collection Handler. Parameters: pNames  Input the collection of names. Any names deserialized will be added to this collection. If NULL then an internal empty name collection is created. Returns: Returns FdoXmlNameCollectionHandler

FDO_API FdoStringCollection* FdoXmlNameCollectionHandler::GetNames (   )

Gets the collection of names. Returns: Returns the element content.

virtual FdoBoolean FdoXmlNameCollectionHandler::XmlEndElement (  FdoXmlSaxContext *  saxContext, FdoString *  uri, FdoString *  name, FdoString *  qname )  [virtual]

Default Sax callback that is called when the FdoXmlReader reads the end tag for an XML element in the document. Does nothing. Parameters: saxContext  Input caller specified contextual information uri  Input the element's Universal Resource Indicator name  Input the unqualified element name (doesn't include namespace) qname  Input the qualified element name (includes namespace) Returns: Returning true causes the current parse to stop. Returning false cause the parse to continue. Return value is ignored if the current parse is not an incremental parse ( see FdoXmlReader::Parse()) Reimplemented from FdoXmlSaxHandler.

virtual FdoXmlSaxHandler* FdoXmlNameCollectionHandler::XmlStartElement (  FdoXmlSaxContext *  saxContext, FdoString *  uri, FdoString *  name, FdoString *  qname, FdoXmlAttributeCollection *  atts )  [virtual]

Default Sax callback that is called when the FdoXmlReader reads the start tag for an XML element in the document. Does nothing. Parameters: saxContext  Input caller specified contextual information uri  Input the element's Universal Resource Indicator name  Input the unqualified element name (doesn't include namespace) qname  Input the qualified element name (includes namespace) atts  Input the attributes for the element. Returns: Returns the SAX Handler for the element's sub-elements. If NULL then this SAX handler will handle the sub-elements Reimplemented from FdoXmlSaxHandler.

---

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

• NameCollectionHandler.h

---

Comments or suggestions? Send us feedback.