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

FdoPhysicalSchemaMapping Class Reference

#include <PhysicalSchemaMapping.h>

Inherits FdoPhysicalElementMapping, and FdoXmlSerializable.

Inherited by FdoXmlSchemaMapping.

Inheritance diagram for FdoPhysicalSchemaMapping:

[legend]
List of all members.

Detailed Description

FdoPhysicalSchemaMapping is an abstract class that is the base class of all Schema Override sets. Each instance contains the overrides for a particular Feature Schema and FDO Provider. Each FDO Provider, that allows Schema Overrides, must create a sub-class of this class. This sub-class must implement the overrides that are specific to the provider. The Provider can also add support, for serializing to an XML document, by overriding the functions inherited from FdoXmlSerializable.

Definition at line 38 of file PhysicalSchemaMapping.h.


Public Member Functions

virtual FDO_API FdoStringGetProvider ()=0
 Gets the name of the applicable FDO provider.

Protected Member Functions

virtual FDO_API void _writeXml (FdoXmlWriter *xmlWriter, const FdoXmlFlags *flags)
 Writes this Schema Override set to XML. Called when this set is serialized to XML. This function converts (encodes) schema names to be valid XML element names. Can be extended to handle provider-specific attributes and sub-elements.
virtual FDO_API void InitFromXml (FdoXmlSaxContext *pContext, FdoXmlAttributeCollection *attrs)
 Initializes this Schema Override set from its XML attributes. Called when the set is deserialized from XML. This function decodes any encoded schema names (See _writeXml). Can be extended to handle particular XML attributes for derived classes.

Friends

class FdoPhysicalSchemaMappingCollection

Member Function Documentation

virtual FDO_API void FdoPhysicalSchemaMapping::_writeXml FdoXmlWriter xmlWriter,
const FdoXmlFlags flags
[protected, virtual]
 

Writes this Schema Override set to XML. Called when this set is serialized to XML. This function converts (encodes) schema names to be valid XML element names. Can be extended to handle provider-specific attributes and sub-elements.

Parameters:
xmlWriter Input write the Schema Override set to this XML writer
flags Input flags that control the writing of the Schema Override set.
Returns:
Returns nothing

Reimplemented from FdoPhysicalElementMapping.

Reimplemented in FdoXmlSchemaMapping.

virtual FDO_API FdoString* FdoPhysicalSchemaMapping::GetProvider  )  [pure virtual]
 

Gets the name of the applicable FDO provider.

Returns:
Returns the name of FDO provider to which this Schema Override set applies. The provider name must conform to the format: "[Company].[Provider].[Version]".

Implemented in FdoXmlSchemaMapping.

virtual FDO_API void FdoPhysicalSchemaMapping::InitFromXml FdoXmlSaxContext pContext,
FdoXmlAttributeCollection attrs
[protected, virtual]
 

Initializes this Schema Override set from its XML attributes. Called when the set is deserialized from XML. This function decodes any encoded schema names (See _writeXml). Can be extended to handle particular XML attributes for derived classes.

Parameters:
pContext Input context contain information about the current deserialization operation
attrs Input the XML attributes.
Returns:
Returns nothing

Reimplemented from FdoPhysicalElementMapping.

Reimplemented in FdoXmlSchemaMapping.


Friends And Related Function Documentation

friend class FdoPhysicalSchemaMappingCollection [friend]
 

Definition at line 42 of file PhysicalSchemaMapping.h.


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