FDO API Reference Feature Data Objects
Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members

FdoXmlSaxHandler Class Reference

#include <SaxHandler.h>

Inherited by FdoPhysicalElementMapping [virtual], FdoSchemaAttributeDictionary [virtual], FdoSchemaElement [virtual], FdoXmlCharDataHandler, FdoXmlCopyHandler, FdoXmlDeserializable, FdoXmlFeaturePropertyReader, FdoXmlNameCollectionHandler, FdoXmlSkipElementHandler, and FdoXmlSpatialContextReader.

Inheritance diagram for FdoXmlSaxHandler:

[legend]
List of all members.

Detailed Description

FdoXmlSaxHandler defines the FDO SAX Handler callback interface. It is not an interface in the strict sense, since each function has a default implementation that does nothing. Implementors can override these callbacks to customize the handling of XML fragments parsed by FdoXmlReader.

Definition at line 29 of file SaxHandler.h.


Public Member Functions

virtual FDO_API_COMMON void XmlCharacters (FdoXmlSaxContext *saxContext, FdoString *chars)
 Default Sax callback that is called when the FdoXmlReader reads a chunk of simple content for the current element. Does nothing by default. This function may be called multiple times for the same element, if the the content is long. Applications must not make any assumptions about the chunk size or number of chunks for each element.
virtual FDO_API_COMMON void XmlEndDocument (FdoXmlSaxContext *saxContext)
 Default Sax callback that is called when the FdoXmlReader finishes reading an XML document. Does nothing.
virtual FDO_API_COMMON 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 FDO_API_COMMON FdoXmlSaxHandlerXmlStartDocument (FdoXmlSaxContext *saxContext)
 Default Sax callback that is called when the FdoXmlReader starts reading an XML document. Does nothing.
virtual FDO_API_COMMON FdoXmlSaxHandlerXmlStartElement (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.

Member Function Documentation

virtual FDO_API_COMMON void FdoXmlSaxHandler::XmlCharacters FdoXmlSaxContext saxContext,
FdoString chars
[virtual]
 

Default Sax callback that is called when the FdoXmlReader reads a chunk of simple content for the current element. Does nothing by default. This function may be called multiple times for the same element, if the the content is long. Applications must not make any assumptions about the chunk size or number of chunks for each element.

Parameters:
saxContext Input caller specified contextual information
chars Input the next chunk of simple content

Reimplemented in FdoXmlCharDataHandler, and FdoXmlCopyHandler.

virtual FDO_API_COMMON void FdoXmlSaxHandler::XmlEndDocument FdoXmlSaxContext saxContext  )  [virtual]
 

Default Sax callback that is called when the FdoXmlReader finishes reading an XML document. Does nothing.

Parameters:
saxContext Input caller specified contextual information

Reimplemented in FdoPhysicalSchemaMappingCollection, and FdoFeatureSchemaCollection.

virtual FDO_API_COMMON FdoBoolean FdoXmlSaxHandler::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 in FdoXmlCopyHandler, FdoAssociationPropertyDefinition, FdoClassDefinition, FdoDataPropertyDefinition, FdoGeometricPropertyDefinition, FdoNetworkFeatureClass, FdoNetworkLinkFeatureClass, FdoNetworkNodeFeatureClass, FdoSchemaAttributeDictionary, FdoSchemaElement, FdoTopoFeaturePropertyDefinition, FdoTopoGeometryPropertyDefinition, FdoXmlNameCollectionHandler, and FdoXmlSpatialContextReader.

virtual FDO_API_COMMON FdoXmlSaxHandler* FdoXmlSaxHandler::XmlStartDocument FdoXmlSaxContext saxContext  )  [virtual]
 

Default Sax callback that is called when the FdoXmlReader starts reading an XML document. Does nothing.

Parameters:
saxContext Input caller specified contextual information
Returns:
Returns the SAX Handler for the document's root element. If NULL then this SAX handler will handle the root element

Reimplemented in FdoXmlSpatialContextReader.

virtual FDO_API_COMMON FdoXmlSaxHandler* FdoXmlSaxHandler::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 in FdoXmlCopyHandler, FdoPhysicalSchemaMappingCollection, FdoAssociationPropertyDefinition, FdoClassDefinition, FdoDataPropertyDefinition, FdoFeatureSchema, FdoFeatureSchemaCollection, FdoGeometricPropertyDefinition, FdoNetworkFeatureClass, FdoNetworkLinkFeatureClass, FdoNetworkNodeFeatureClass, FdoSchemaAttributeDictionary, FdoSchemaElement, FdoTopoFeaturePropertyDefinition, FdoTopoGeometryPropertyDefinition, FdoXmlNameCollectionHandler, and FdoXmlSpatialContextReader.


The documentation for this class was generated from the following file:
Comments or suggestions? Send us feedback.