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

FdoXmlSchemaMapping Class Reference

#include <SchemaMapping.h>

Inherits FdoPhysicalSchemaMapping.

Inheritance diagram for FdoXmlSchemaMapping:

[legend]
List of all members.

Detailed Description

FdoXmlSchemaMapping specifies overrides for translating a feature schema between FDO and GML.

Definition at line 33 of file SchemaMapping.h.


Public Member Functions

FDO_API FdoXmlClassMappingCollectionGetClassMappings ()
 Gets the mappings for FDO Classes.
FDO_API FdoXmlElementMappingCollectionGetElementMappings ()
 Gets the mappings between GML global elements and their types as Fdo Classes. These mappings are used in two circumstances:
  • when features are read from a GML Document, these mappings determine the Feature class of each feature, based on its element name. If the element name is not in these mappings then the class name defaults to the element name.
  • when the Feature Schema for these overrides is written to GML, a global element is created from each item in element mappings collection.
.
virtual FDO_API FdoStringGetProvider ()
 Gets the provider name.
FDO_API FdoStringGetTargetNamespace ()
 Gets the target namespace URI for the GML version of this schema.
FDO_API void SetTargetNamespace (FdoString *url)
 Sets the target namespace URI for the GML version of this schema. When the Feature Schema for these overrides is written to GML, its targetNamespace is set to this value.

Static Public Member Functions

FDO_API FdoXmlSchemaMappingCreate (FdoString *name)
 Creates an XML Schema Mapping Set.

Protected Member Functions

virtual void _writeXml (FdoXmlWriter *xmlWriter, const FdoXmlFlags *flags)
 Writes this XML Schema Mapping to XML. Called when the element is serialized to XML.
virtual void Dispose ()
 Dispose this object.
 FdoXmlSchemaMapping (FdoString *name)
 FdoXmlSchemaMapping ()
 DOXYGEN-IGNORE
virtual void InitFromXml (FdoXmlSaxContext *pContext, FdoXmlAttributeCollection *attrs)
 Functions for XML support Initializes this Xml Schema Mapping from its XML attributes. Called when the element is deserialized from XML.
virtual ~FdoXmlSchemaMapping ()

Constructor & Destructor Documentation

FdoXmlSchemaMapping::FdoXmlSchemaMapping  )  [inline, protected]
 

DOXYGEN-IGNORE

Definition at line 102 of file SchemaMapping.h.

FdoXmlSchemaMapping::FdoXmlSchemaMapping FdoString name  )  [protected]
 

virtual FdoXmlSchemaMapping::~FdoXmlSchemaMapping  )  [protected, virtual]
 


Member Function Documentation

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

Writes this XML Schema 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 FdoPhysicalSchemaMapping.

FDO_API FdoXmlSchemaMapping* FdoXmlSchemaMapping::Create FdoString name  )  [static]
 

Creates an XML Schema Mapping Set.

Returns:
FdoXmlSchemaMapping

virtual void FdoXmlSchemaMapping::Dispose  )  [protected, virtual]
 

Dispose this object.

Returns:
Returns nothing

Implements FdoIDisposable.

FDO_API FdoXmlClassMappingCollection* FdoXmlSchemaMapping::GetClassMappings  ) 
 

Gets the mappings for FDO Classes.

Returns:
Returns FdoXmlClassMappingCollection*

FDO_API FdoXmlElementMappingCollection* FdoXmlSchemaMapping::GetElementMappings  ) 
 

Gets the mappings between GML global elements and their types as Fdo Classes. These mappings are used in two circumstances:

  • when features are read from a GML Document, these mappings determine the Feature class of each feature, based on its element name. If the element name is not in these mappings then the class name defaults to the element name.
  • when the Feature Schema for these overrides is written to GML, a global element is created from each item in element mappings collection.
.

Returns:
Returns FdoXmlElementMappingCollection*

virtual FDO_API FdoString* FdoXmlSchemaMapping::GetProvider  )  [virtual]
 

Gets the provider name.

Returns:
Returns "OSGeo.GML.1.0".
Note:
This is the name given to this particular type of Schema Override set and is not the name of an actual FDO provider.

Implements FdoPhysicalSchemaMapping.

FDO_API FdoString* FdoXmlSchemaMapping::GetTargetNamespace  ) 
 

Gets the target namespace URI for the GML version of this schema.

Returns:
Returns the target namespace.

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

Functions for XML support Initializes this Xml Schema 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 FdoPhysicalSchemaMapping.

FDO_API void FdoXmlSchemaMapping::SetTargetNamespace FdoString url  ) 
 

Sets the target namespace URI for the GML version of this schema. When the Feature Schema for these overrides is written to GML, its targetNamespace is set to this value.

Parameters:
url Input the target namespace.

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