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

FdoPhysicalSchemaMappingCollection Class Reference

#include <PhysicalSchemaMappingCollection.h>

Inherits FdoCollection< FdoPhysicalSchemaMapping, FdoCommandException >, FdoXmlDeserializable, and FdoXmlSerializable.

Inheritance diagram for FdoPhysicalSchemaMappingCollection:

[legend]
List of all members.

Detailed Description

FdoPhysicalSchemaMappingCollection defines a collection of Schema Override sets. This is a generic collection which can contain override sets for different FDO Providers.

Definition at line 40 of file PhysicalSchemaMappingCollection.h.


Public Member Functions

FDO_API FdoPhysicalSchemaMappingGetItem (FdoIConnection *connection, FdoString *schemaName)
 Gets the Schema Override set for the specified Feature Schema and the FDO provider for the specified connection. This function allows an application to retrieve the Schema Overrides for an active provider without knowing the provider name.
FDO_API FdoPhysicalSchemaMappingGetItem (FdoString *providerName, FdoString *schemaName)
 Gets the Schema Override set for the specified FDO provider and Feature Schema.
FDO_API FdoPhysicalSchemaMappingGetItem (FdoInt32 item)
 Gets the Schema Override set in the collection at the specified index. Throws an invalid argument exception if the index is out of range.
virtual FDO_API FdoXmlSaxContextGetSaxContext ()
 Gets the SAX context to pass to the FdoXmlSaxHandler callbacks. Classes derived from FdoXmlDeserializable can override this function to specify a SAX context with class-specific information.
virtual FDO_API void XmlEndDocument (FdoXmlSaxContext *context)
 DOXYGEN-IGNORE
virtual FDO_API FdoXmlSaxHandlerXmlStartElement (FdoXmlSaxContext *context, 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.

Static Public Member Functions

FDO_API FdoPhysicalSchemaMappingCollectionCreate ()
 Constructs an instance of an FdoPhysicalSchemaMappingCollection .

Protected Member Functions

virtual FDO_API void _writeXml (FdoXmlWriter *xmlWriter, const FdoXmlFlags *flags)
 FdoXmlSerializable override that serializes a Feature Schema collection to XML.
virtual FDO_API void Dispose ()
 Dispose this object.
FDO_API FdoPhysicalSchemaMappingCollection ()
virtual FDO_API ~FdoPhysicalSchemaMappingCollection ()

Constructor & Destructor Documentation

FDO_API FdoPhysicalSchemaMappingCollection::FdoPhysicalSchemaMappingCollection  )  [protected]
 

virtual FDO_API FdoPhysicalSchemaMappingCollection::~FdoPhysicalSchemaMappingCollection  )  [inline, protected, virtual]
 

Definition at line 127 of file PhysicalSchemaMappingCollection.h.

References FDO_API.


Member Function Documentation

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

FdoXmlSerializable override that serializes a Feature Schema collection to XML.

Implements FdoXmlSerializable.

FDO_API FdoPhysicalSchemaMappingCollection* FdoPhysicalSchemaMappingCollection::Create  )  [static]
 

Constructs an instance of an FdoPhysicalSchemaMappingCollection .

Returns:
Returns FdoPhysicalSchemaMappingCollection

virtual FDO_API void FdoPhysicalSchemaMappingCollection::Dispose  )  [inline, protected, virtual]
 

Dispose this object.

Returns:
Returns nothing

Implements FdoIDisposable.

Definition at line 131 of file PhysicalSchemaMappingCollection.h.

References FDO_API.

FDO_API FdoPhysicalSchemaMapping* FdoPhysicalSchemaMappingCollection::GetItem FdoIConnection connection,
FdoString schemaName
 

Gets the Schema Override set for the specified Feature Schema and the FDO provider for the specified connection. This function allows an application to retrieve the Schema Overrides for an active provider without knowing the provider name.

Parameters:
connection Input the FDO connection.
schemaName Input Feature Schema name.
Returns:
Returns the Schema Override set for the given Feature Schema and the FDO Provider for the given connection. NULL is return if the set was not found.

FDO_API FdoPhysicalSchemaMapping* FdoPhysicalSchemaMappingCollection::GetItem FdoString providerName,
FdoString schemaName
 

Gets the Schema Override set for the specified FDO provider and Feature Schema.

Parameters:
providerName Input FDO Provider name of the form "[Company].[Provider].[Version]".
schemaName Input Feature Schema name.
Returns:
the Schema Override set for the given FDO Provider and Feature Schema, where the [company] and [provider] parts of the set’s providerName and the given providerName match exactly. The set with the highest [version], that is less than or equal to the [version] of the given provider, is returned. NULL is return if a set was not found.

FDO_API FdoPhysicalSchemaMapping* FdoPhysicalSchemaMappingCollection::GetItem FdoInt32  item  ) 
 

Gets the Schema Override set in the collection at the specified index. Throws an invalid argument exception if the index is out of range.

Parameters:
item Input item
Returns:
Returns the Schema Override set at the specified index

virtual FDO_API FdoXmlSaxContext* FdoPhysicalSchemaMappingCollection::GetSaxContext  )  [virtual]
 

Gets the SAX context to pass to the FdoXmlSaxHandler callbacks. Classes derived from FdoXmlDeserializable can override this function to specify a SAX context with class-specific information.

Returns:
Returns NULL by default, the default FdoXmlSaxContext is used. The default provides basic error handling functionality.

Reimplemented from FdoXmlDeserializable.

virtual FDO_API void FdoPhysicalSchemaMappingCollection::XmlEndDocument FdoXmlSaxContext context  )  [virtual]
 

DOXYGEN-IGNORE

FdoXmlDeserializable overrides for deserializing a Schema Override set collection from XML. These are not exposed via the FDO API.

Reimplemented from FdoXmlSaxHandler.

virtual FDO_API FdoXmlSaxHandler* FdoPhysicalSchemaMappingCollection::XmlStartElement FdoXmlSaxContext context,
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 from FdoXmlSaxHandler.


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