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

FdoPhysicalElementMapping Class Reference

#include <PhysicalElementMapping.h>

Inherits FdoIDisposable, and FdoXmlSaxHandler.

Inherited by FdoPhysicalClassMapping, FdoPhysicalPropertyMapping, FdoPhysicalSchemaMapping, and FdoXmlElementMapping.

Inheritance diagram for FdoPhysicalElementMapping:

[legend]
List of all members.

Detailed Description

FdoPhysicalElementMapping is an abstract class that acts as a base class for all Physical Schema Mapping Override classes. FDO also provides a number of sub-classes for particular types of Provider-specific override classes:.

Remarks:
Other types of schema override classes can be based directly on FdoPhysicalElementMapping.

Definition at line 46 of file PhysicalElementMapping.h.


Public Member Functions

virtual FDO_API void _writeXml (FdoXmlWriter *xmlWriter, const FdoXmlFlags *flags)
 Writes this Physical Mapping Element to XML. Called when the element is serialized to XML. Can be extended to handle particular XML attributes and sub-elements for derived classes.
virtual FDO_API FdoBoolean CanSetName ()
 DOXYGEN-IGNORE
FDO_API FdoXmlSaxHandlerChoiceSubElementError (FdoXmlSaxContext *pContext, FdoString *parentElement, FdoStringsP subElements)
FDO_API FdoXmlSaxHandlerDuplicateSubElementError (FdoXmlSaxContext *pContext, FdoString *parentElement, FdoString *subElement, FdoString *subElementName)
virtual FDO_API FdoStringGetName ()
 Gets the name of this element.
virtual FDO_API FdoPhysicalElementMappingGetParent ()
 Gets the parent of this FdoPhysicalElementMapping or null if this object has not been added to a parent object.
virtual FDO_API FdoStringP GetQualifiedName ()
 Gets the fully qualified name of this element.
virtual FDO_API FdoPhysicalSchemaMappingGetSchemaMapping ()
 Gets the FdoPhysicalSchemaMapping that this element is a part of. Returns null if this object has not been added to a feature schema.
virtual FDO_API void InitFromXml (FdoXmlSaxContext *pContext, FdoXmlAttributeCollection *attrs)
 Functions for XML support Initializes this Physical Element Mapping from its XML attributes. Called when the element is deserialized from XML. Can be extended to handle particular XML attributes for derived classes.
FDO_API FdoXmlSaxHandlerMultiSubElementError (FdoXmlSaxContext *pContext, FdoString *parentElement, FdoString *subElement)
virtual FDO_API void SetName (FdoString *value)
 Sets the name of this element.
FDO_API FdoXmlSaxHandlerSubElementError (FdoXmlSaxContext *pContext, FdoString *parentElement, FdoString *subElement)
 DOXYGEN-IGNORE

Protected Member Functions

FDO_API FdoPhysicalElementMapping (FdoString *name)
 Constructs an instance of an FdoPhysicalElementMapping using the specified arguments.
FDO_API FdoPhysicalElementMapping ()
 Constructs a default instance of an FdoPhysicalElementMapping.
FdoStringP GetProviderLocalName ()
FDO_API FdoXmlSaxHandlerGetSkipper ()
 DOXYGEN-IGNORE retrieves a FdoXmlSkipElementHandler for skipping an entire XML element
FDO_API void SetParent (FdoPhysicalElementMapping *value)
 Sets the parent of this Physical Element Mapping.
virtual FDO_API ~FdoPhysicalElementMapping ()
 FdoPhysicalElementMapping destructor.

Protected Attributes

FdoXmlCharDataHandlerP m_XmlContentHandler
 SAX Handler for reading simple sub-element contents.
FdoXmlSkipElementHandlerP m_XmlSkipper
 SAX Handler for skipping elements.

Friends

class FdoPhysicalElementMappingCollection

Constructor & Destructor Documentation

FDO_API FdoPhysicalElementMapping::FdoPhysicalElementMapping  )  [protected]
 

Constructs a default instance of an FdoPhysicalElementMapping.

FDO_API FdoPhysicalElementMapping::FdoPhysicalElementMapping FdoString name  )  [protected]
 

Constructs an instance of an FdoPhysicalElementMapping using the specified arguments.

Parameters:
name Input the element name

virtual FDO_API FdoPhysicalElementMapping::~FdoPhysicalElementMapping  )  [protected, virtual]
 

FdoPhysicalElementMapping destructor.


Member Function Documentation

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

Writes this Physical Mapping Element to XML. Called when the element is serialized to XML. Can be extended to handle particular XML attributes and sub-elements for derived classes.

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

Reimplemented in FdoPhysicalClassMapping, FdoPhysicalPropertyMapping, FdoPhysicalSchemaMapping, FdoXmlClassMapping, FdoXmlElementMapping, and FdoXmlSchemaMapping.

virtual FDO_API FdoBoolean FdoPhysicalElementMapping::CanSetName  )  [inline, virtual]
 

DOXYGEN-IGNORE

Definition at line 102 of file PhysicalElementMapping.h.

References FDO_API, and FdoBoolean.

FDO_API FdoXmlSaxHandler* FdoPhysicalElementMapping::ChoiceSubElementError FdoXmlSaxContext pContext,
FdoString parentElement,
FdoStringsP  subElements
 

FDO_API FdoXmlSaxHandler* FdoPhysicalElementMapping::DuplicateSubElementError FdoXmlSaxContext pContext,
FdoString parentElement,
FdoString subElement,
FdoString subElementName
 

virtual FDO_API FdoString* FdoPhysicalElementMapping::GetName  )  [virtual]
 

Gets the name of this element.

Returns:
Returns the name of this element.

virtual FDO_API FdoPhysicalElementMapping* FdoPhysicalElementMapping::GetParent  )  [virtual]
 

Gets the parent of this FdoPhysicalElementMapping or null if this object has not been added to a parent object.

Returns:
Returns FdoPhysicalElementMapping of parent

FdoStringP FdoPhysicalElementMapping::GetProviderLocalName  )  [protected]
 

Get the second token from the provider name for this elements schema mapping set.

virtual FDO_API FdoStringP FdoPhysicalElementMapping::GetQualifiedName  )  [virtual]
 

Gets the fully qualified name of this element.

Returns:
default implementation simply returns the element name

virtual FDO_API FdoPhysicalSchemaMapping* FdoPhysicalElementMapping::GetSchemaMapping  )  [virtual]
 

Gets the FdoPhysicalSchemaMapping that this element is a part of. Returns null if this object has not been added to a feature schema.

Returns:
Returns FdoPhysicalSchemaMapping this object is a part of

FDO_API FdoXmlSaxHandler* FdoPhysicalElementMapping::GetSkipper  )  [protected]
 

DOXYGEN-IGNORE retrieves a FdoXmlSkipElementHandler for skipping an entire XML element

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

Functions for XML support Initializes this Physical Element Mapping from its XML attributes. Called when the element is deserialized from XML. 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 in FdoPhysicalClassMapping, FdoPhysicalPropertyMapping, FdoPhysicalSchemaMapping, FdoXmlClassMapping, FdoXmlElementMapping, and FdoXmlSchemaMapping.

FDO_API FdoXmlSaxHandler* FdoPhysicalElementMapping::MultiSubElementError FdoXmlSaxContext pContext,
FdoString parentElement,
FdoString subElement
 

virtual FDO_API void FdoPhysicalElementMapping::SetName FdoString value  )  [virtual]
 

Sets the name of this element.

Parameters:
value Input the name of this element.
Returns:
Returns nothing

FDO_API void FdoPhysicalElementMapping::SetParent FdoPhysicalElementMapping value  )  [protected]
 

Sets the parent of this Physical Element Mapping.

Parameters:
value Input the parent

FDO_API FdoXmlSaxHandler* FdoPhysicalElementMapping::SubElementError FdoXmlSaxContext pContext,
FdoString parentElement,
FdoString subElement
 

DOXYGEN-IGNORE

Various error reporting functions that are not yet part of the supported FDO API. All of them return a FdoXmlSkipElementHandler, which can be used to skip over the element in error.


Friends And Related Function Documentation

friend class FdoPhysicalElementMappingCollection [friend]
 

Definition at line 50 of file PhysicalElementMapping.h.


Member Data Documentation

FdoXmlCharDataHandlerP FdoPhysicalElementMapping::m_XmlContentHandler [protected]
 

SAX Handler for reading simple sub-element contents.

Definition at line 214 of file PhysicalElementMapping.h.

FdoXmlSkipElementHandlerP FdoPhysicalElementMapping::m_XmlSkipper [protected]
 

SAX Handler for skipping elements.

Definition at line 217 of file PhysicalElementMapping.h.


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