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

FdoXmlElementMapping Class Reference

#include <ElementMapping.h>

Inherits FdoPhysicalElementMapping.

Inheritance diagram for FdoXmlElementMapping:

[legend]
List of all members.

Detailed Description

FdoXmlElementMapping describes GML to FDO mappings for a particular GML Schema element. Only mappings that cannot be represented in FDO are described.

Definition at line 34 of file ElementMapping.h.


Public Member Functions

virtual void _writeXml (FdoXmlWriter *xmlWriter, const FdoXmlFlags *flags)
 Writes this XML Element Mapping to XML. Called when the element is serialized to XML.
virtual FdoStringCollection * GetAliasNames ()
virtual FdoString * GetChoiceName ()
FDO_API FdoXmlClassMapping * GetClassMapping ()
 Gets the class mapping for this element. The class mapping provides information about the FDO Class for this element's type.
FDO_API FdoString * GetClassName ()
 Gets the FDO Class name.
FDO_API FdoString * GetGmlLocalName ()
 Gets the URI for the referenced element.
FDO_API FdoString * GetGmlUri ()
 Gets the URI for the referenced element.
FDO_API FdoString * GetSchemaName ()
 Gets the Schema Name for the FDO Class.
virtual void InitFromXml (FdoXmlSaxContext *pContext, FdoXmlAttributeCollection *attrs)
 Functions for XML support DOXYGEN-IGNORE Initializes this Xml Element Mapping from its XML attributes. Called when the element is deserialized from XML.
virtual void SetAliasNames (FdoStringCollection *pAliasNames)
 
virtual void SetChoiceName (FdoString *pChoiceName)
FDO_API void SetClassMapping (FdoXmlClassMapping *classMapping)
 Sets the class mapping for this element. The class mapping provides information about the FDO Class for this element's type.
FDO_API void SetClassName (FdoString *className)
 Sets the element class name to a dangling reference. This function can be used to reference a class that has no FdoXmlClassMapping object.
FDO_API void SetGmlLocalName (FdoString *gmlLocalName=L"")
 Sets the local name for this element.
FDO_API void SetGmlUri (FdoString *gmlUri=L"")
 Sets the namespace URI for this element.
FDO_API void SetSchemaName (FdoString *schemaName=L"")
 Sets the schema name for a dangling reference to an element's class.

Static Public Member Functions

FDO_API FdoXmlElementMapping * Create (FdoString *name)
 Constructs an object describing the GML-FDO mappings for a GML element.

Protected Member Functions

virtual void Dispose ()
 Dispose this object.
 FdoXmlElementMapping (FdoString *name)
 FdoXmlElementMapping ()
 DOXYGEN-IGNORE
virtual ~FdoXmlElementMapping ()

Constructor & Destructor Documentation

FdoXmlElementMapping::FdoXmlElementMapping (   )  [inline, protected]
 

DOXYGEN-IGNORE

Definition at line 190 of file ElementMapping.h.

FdoXmlElementMapping::FdoXmlElementMapping (  FdoString *  name  )  [protected]
 

virtual FdoXmlElementMapping::~FdoXmlElementMapping (   )  [protected, virtual]
 

Member Function Documentation

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

Writes this XML Element Mapping to XML. Called when the element is serialized to XML.

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

Reimplemented from FdoPhysicalElementMapping.

FDO_API FdoXmlElementMapping* FdoXmlElementMapping::Create (  FdoString *  name  )  [static]
 

Constructs an object describing the GML-FDO mappings for a GML element.

Parameters:
name Input element name
Returns:
Returns FdoXmlElementMapping

virtual void FdoXmlElementMapping::Dispose (   )  [protected, virtual]
 

Dispose this object.

Returns:
Returns nothing

Implements FdoIDisposable.

virtual FdoStringCollection* FdoXmlElementMapping::GetAliasNames (   )  [inline, virtual]
 

Definition at line 183 of file ElementMapping.h.

References FDO_SAFE_ADDREF, and FdoPtr< T >::p.

virtual FdoString* FdoXmlElementMapping::GetChoiceName (   )  [inline, virtual]
 

Definition at line 186 of file ElementMapping.h.

References FdoString.

FDO_API FdoXmlClassMapping* FdoXmlElementMapping::GetClassMapping (   ) 
 

Gets the class mapping for this element. The class mapping provides information about the FDO Class for this element's type.

Returns:
Returns FdoXmlClassMapping.

FDO_API FdoString* FdoXmlElementMapping::GetClassName (   ) 
 

Gets the FDO Class name.

Returns:
Returns FdoString.

FDO_API FdoString* FdoXmlElementMapping::GetGmlLocalName (   ) 
 

Gets the URI for the referenced element.

Returns:
Returns FdoString. L"" if this element does not reference another element.

FDO_API FdoString* FdoXmlElementMapping::GetGmlUri (   ) 
 

Gets the URI for the referenced element.

Returns:
Returns FdoString.

FDO_API FdoString* FdoXmlElementMapping::GetSchemaName (   ) 
 

Gets the Schema Name for the FDO Class.

Returns:
Returns FdoString.

virtual void FdoXmlElementMapping::InitFromXml (  FdoXmlSaxContext *  pContext,
FdoXmlAttributeCollection *  attrs
)  [virtual]
 

Functions for XML support DOXYGEN-IGNORE Initializes this Xml Element Mapping from its XML attributes. Called when the element is deserialized from XML.

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

Reimplemented from FdoPhysicalElementMapping.

virtual void FdoXmlElementMapping::SetAliasNames (  FdoStringCollection *  pAliasNames  )  [inline, virtual]
 

Definition at line 182 of file ElementMapping.h.

References FDO_SAFE_ADDREF.

virtual void FdoXmlElementMapping::SetChoiceName (  FdoString *  pChoiceName  )  [inline, virtual]
 

Definition at line 185 of file ElementMapping.h.

FDO_API void FdoXmlElementMapping::SetClassMapping (  FdoXmlClassMapping *  classMapping  ) 
 

Sets the class mapping for this element. The class mapping provides information about the FDO Class for this element's type.

Parameters:
classMapping Input the class mapping

FDO_API void FdoXmlElementMapping::SetClassName (  FdoString *  className  ) 
 

Sets the element class name to a dangling reference. This function can be used to reference a class that has no FdoXmlClassMapping object.

Parameters:
className Input name of the FDO class corresponding to the element's type.

FDO_API void FdoXmlElementMapping::SetGmlLocalName (  FdoString *  gmlLocalName = L""  ) 
 

Sets the local name for this element.

Parameters:
gmlLocalName Input the local name (unprefixed name) of this element. Defaults to the element name.

FDO_API void FdoXmlElementMapping::SetGmlUri (  FdoString *  gmlUri = L""  ) 
 

Sets the namespace URI for this element.

Parameters:
gmlUri Input a URI. Defaults to the targetNamespace for the schema containing this element.

FDO_API void FdoXmlElementMapping::SetSchemaName (  FdoString *  schemaName = L""  ) 
 

Sets the schema name for a dangling reference to an element's class.

Parameters:
schemaName Input name of the Feature Schema containing the FDO class. If L"" then it defaults to the schema containing this element.
The documentation for this class was generated from the following file:
Comments or suggestions? Send us feedback.