API Reference OSGeo FDO Provider for MySQL
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members

FdoSqlServerOvClassDefinition Class Reference

#include <SqlServerOvClassDefinition.h>

Inherits FdoRdbmsOvClassDefinition.

Inheritance diagram for FdoSqlServerOvClassDefinition:

[legend]
List of all members.

Detailed Description

Concrete class defining physical schema overrides for a class definition.

Definition at line 32 of file SqlServerOvClassDefinition.h.


Public Member Functions

virtual void _writeXmlAttributes (FdoXmlWriter *xmlWriter, const FdoXmlFlags *flags)
 Serialize the XML attributes of this class:.
FDOSQLSERVER_OV_API FdoInt32 GetIdentityIncrement (void)
 Gets the increment value to use for the identity column, if there is one.
FDOSQLSERVER_OV_API bool GetIdentityIsGloballyUnique (void)
 Retrieves the identity column's type, whether it is a non-globally-unique identity column or a globally-unique identity column.
FDOSQLSERVER_OV_API FdoString * GetIdentityPropertyName (void)
 Gets which FDO property corresponds to the single SqlServer IDENTITY column.
FDOSQLSERVER_OV_API FdoInt32 GetIdentitySeed (void)
 Sets the first value to use for the identity column, if there is one.
FDOSQLSERVER_OV_API FdoSqlServerOvPropertyDefinitionCollectionGetProperties ()
 Gets a collection of SqlServer property overrides.
FDOSQLSERVER_OV_API FdoSqlServerOvTableGetTable ()
 Gets the SqlServer table override for this class override.
virtual void InitFromXml (FdoXmlSaxContext *pContext, FdoXmlAttributeCollection *attrs)
 Initialize this element from its XML attributes.
FDOSQLSERVER_OV_API void SetGeometryColumn (FdoSqlServerOvGeometricColumn *column)
 Sets the SqlServer geometry column override for this class override.
FDOSQLSERVER_OV_API void SetIdentityIncrement (FdoInt32 identityIncrement)
 Sets the increment value to use for the identity column, if there is one.
FDOSQLSERVER_OV_API void SetIdentityIsGloballyUnique (bool identityisGloballyUnique)
 Set the type of the single IDENTITY column, if it exists.
FDOSQLSERVER_OV_API void SetIdentityPropertyName (FdoString *identityPropertyName)
 Specifies which FDO property corresponds to the single SqlServer IDENTITY column. This property corresponds to the singleton IDENTITY column of the SQL Server table. This is not to be confused with the usual FDO identity properties, which instead correspond to the primary key of a SQL Server table.
FDOSQLSERVER_OV_API void SetIdentitySeed (FdoInt32 identitySeed)
 Gets the first value to use for the identity column, if there is one.
void SetParent (FdoPhysicalElementMapping *value)
 DOXYGEN-IGNORE Sets the parent of this object. Not part of the API.
FDOSQLSERVER_OV_API void SetTable (FdoSqlServerOvTable *table)
 Sets the SqlServer table override for this class override.

Static Public Member Functions

FDOSQLSERVER_OV_API FdoSqlServerOvClassDefinitionCreate (FdoString *name)
 Constructs an instance of an FdoSqlServerOvClassDefinition using the specified arguments.
FDOSQLSERVER_OV_API FdoSqlServerOvClassDefinitionCreate ()
 Constructs a default of an FdoSqlServerOvClassDefinition.

Protected Member Functions

virtual void AddProperty (FdoRdbmsOvPropertyDefinition *pProp)
 Add the given property override to this class override.
virtual FdoRdbmsOvDataPropertyDefinitionCreateDataProperty (FdoXmlSaxContext *context, FdoXmlAttributeCollection *propAtts, FdoXmlAttributeCollection *colAtts)
 Create data property override from XML attributes.
virtual FdoRdbmsOvGeometricPropertyDefinitionCreateGeometricProperty (FdoXmlSaxContext *context, FdoXmlAttributeCollection *propAtts, FdoXmlAttributeCollection *colAtts)
 Create geometric property override from XML attributes.
virtual FdoRdbmsOvObjectPropertyDefinitionCreateObjectProperty (FdoXmlSaxContext *context, FdoXmlAttributeCollection *propAtts, FdoString *mappingType, FdoXmlAttributeCollection *mappingAtts)
 Create object property override from XML attributes.
virtual void Dispose ()
 FdoSqlServerOvClassDefinition (FdoString *name)
 FdoSqlServerOvClassDefinition ()
 
void Init ()
virtual void SetTable (FdoXmlSaxContext *context, FdoXmlAttributeCollection *atts)
 Create table override from XML attributes.
virtual ~FdoSqlServerOvClassDefinition ()

Constructor & Destructor Documentation

FdoSqlServerOvClassDefinition::FdoSqlServerOvClassDefinition  )  [protected]
 

FdoSqlServerOvClassDefinition::FdoSqlServerOvClassDefinition FdoString *  name  )  [protected]
 

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


Member Function Documentation

virtual void FdoSqlServerOvClassDefinition::_writeXmlAttributes FdoXmlWriter *  xmlWriter,
const FdoXmlFlags *  flags
[virtual]
 

Serialize the XML attributes of this class:.

Reimplemented from FdoRdbmsOvClassDefinition.

virtual void FdoSqlServerOvClassDefinition::AddProperty FdoRdbmsOvPropertyDefinition pProp  )  [protected, virtual]
 

Add the given property override to this class override.

Implements FdoRdbmsOvClassDefinition.

FDOSQLSERVER_OV_API FdoSqlServerOvClassDefinition* FdoSqlServerOvClassDefinition::Create FdoString *  name  )  [static]
 

Constructs an instance of an FdoSqlServerOvClassDefinition using the specified arguments.

Parameters:
name Input name
Returns:
Returns FdoSqlServerOvClassDefinition

FDOSQLSERVER_OV_API FdoSqlServerOvClassDefinition* FdoSqlServerOvClassDefinition::Create  )  [static]
 

Constructs a default of an FdoSqlServerOvClassDefinition.

Returns:
Returns FdoSqlServerOvClassDefinition

virtual FdoRdbmsOvDataPropertyDefinition* FdoSqlServerOvClassDefinition::CreateDataProperty FdoXmlSaxContext *  context,
FdoXmlAttributeCollection *  propAtts,
FdoXmlAttributeCollection *  colAtts
[protected, virtual]
 

Create data property override from XML attributes.

Reimplemented from FdoRdbmsOvClassDefinition.

virtual FdoRdbmsOvGeometricPropertyDefinition* FdoSqlServerOvClassDefinition::CreateGeometricProperty FdoXmlSaxContext *  context,
FdoXmlAttributeCollection *  propAtts,
FdoXmlAttributeCollection *  colAtts
[protected, virtual]
 

Create geometric property override from XML attributes.

Reimplemented from FdoRdbmsOvClassDefinition.

virtual FdoRdbmsOvObjectPropertyDefinition* FdoSqlServerOvClassDefinition::CreateObjectProperty FdoXmlSaxContext *  context,
FdoXmlAttributeCollection *  propAtts,
FdoString *  mappingType,
FdoXmlAttributeCollection *  mappingAtts
[protected, virtual]
 

Create object property override from XML attributes.

Reimplemented from FdoRdbmsOvClassDefinition.

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

FDOSQLSERVER_OV_API FdoInt32 FdoSqlServerOvClassDefinition::GetIdentityIncrement void   ) 
 

Gets the increment value to use for the identity column, if there is one.

Remarks:
This override defaults to 1. This override is ignored on ApplySchema if this column belongs to an existing table in a foreign database. This override is also ignored if IdentityPropertyName is not specified.
Returns:
Returns the increment value to use for the identity column

FDOSQLSERVER_OV_API bool FdoSqlServerOvClassDefinition::GetIdentityIsGloballyUnique void   ) 
 

Retrieves the identity column's type, whether it is a non-globally-unique identity column or a globally-unique identity column.

Remarks:
Non-globally-unique identity columns have their value automatically populated by SQL Server on insert; the first value is set to the specified IdentitySeed, and all subsequent values are set using the specified IdentityIncrement. If defining such a column during ApplySchema, it must be one of the following SQL Server native data types: decimal, int, numeric, smallint, bigint, or tinyint. Note that the “not for replication” identity column flag is not exposed. Also note that the identifier column must not be nullable and must not contain a default value. Globally-unique identity columns do not have their value automatically populated by SQL Server. Instead SQL Server relies on the default value or the user to populate this value. To have this value populated automatically on insert, the user should set the default value to use the NEWID() function to obtain a globally-unique identity value. This override is ignored on ApplySchema if this column belongs to an existing table in a foreign database. This override is also ignored if IdentityPropertyName is not specified.
Returns:
Returns the type of the single IDENTITY column, if it exists

FDOSQLSERVER_OV_API FdoString* FdoSqlServerOvClassDefinition::GetIdentityPropertyName void   ) 
 

Gets which FDO property corresponds to the single SqlServer IDENTITY column.

Returns:
Returns the FDO property corresponding to the single SqlServer IDENTITY column, or an empty string if there is no such property

FDOSQLSERVER_OV_API FdoInt32 FdoSqlServerOvClassDefinition::GetIdentitySeed void   ) 
 

Sets the first value to use for the identity column, if there is one.

Remarks:
This override defaults to 1. This override is ignored on ApplySchema if this column belongs to an existing table in a foreign database. This override is also ignored if IdentityPropertyName is not specified.
Returns:
Returns the first value to use for the identity column

FDOSQLSERVER_OV_API FdoSqlServerOvPropertyDefinitionCollection* FdoSqlServerOvClassDefinition::GetProperties  ) 
 

Gets a collection of SqlServer property overrides.

Returns:
Returns the collection of SqlServer property overrides

Reimplemented from FdoRdbmsOvClassDefinition.

FDOSQLSERVER_OV_API FdoSqlServerOvTable* FdoSqlServerOvClassDefinition::GetTable  ) 
 

Gets the SqlServer table override for this class override.

Returns:
Returns FdoSqlServerOvTable

Reimplemented from FdoRdbmsOvClassDefinition.

void FdoSqlServerOvClassDefinition::Init  )  [protected]
 

Reimplemented from FdoRdbmsOvClassDefinition.

virtual void FdoSqlServerOvClassDefinition::InitFromXml FdoXmlSaxContext *  pContext,
FdoXmlAttributeCollection *  attrs
[virtual]
 

Initialize this element from its XML attributes.

Reimplemented from FdoRdbmsOvClassDefinition.

FDOSQLSERVER_OV_API void FdoSqlServerOvClassDefinition::SetGeometryColumn FdoSqlServerOvGeometricColumn column  ) 
 

Sets the SqlServer geometry column override for this class override.

Parameters:
column Input SqlServer Geometric Column override
Returns:
Returns nothing

FDOSQLSERVER_OV_API void FdoSqlServerOvClassDefinition::SetIdentityIncrement FdoInt32  identityIncrement  ) 
 

Sets the increment value to use for the identity column, if there is one.

Returns:
Returns nothing

FDOSQLSERVER_OV_API void FdoSqlServerOvClassDefinition::SetIdentityIsGloballyUnique bool  identityisGloballyUnique  ) 
 

Set the type of the single IDENTITY column, if it exists.

Returns:
Returns nothing

FDOSQLSERVER_OV_API void FdoSqlServerOvClassDefinition::SetIdentityPropertyName FdoString *  identityPropertyName  ) 
 

Specifies which FDO property corresponds to the single SqlServer IDENTITY column. This property corresponds to the singleton IDENTITY column of the SQL Server table. This is not to be confused with the usual FDO identity properties, which instead correspond to the primary key of a SQL Server table.

Parameters:
name Input SqlServer identity property name override. An empty string means there is no identity column for this class.
Returns:
Returns nothing

FDOSQLSERVER_OV_API void FdoSqlServerOvClassDefinition::SetIdentitySeed FdoInt32  identitySeed  ) 
 

Gets the first value to use for the identity column, if there is one.

Returns:
Returns nothing

void FdoSqlServerOvClassDefinition::SetParent FdoPhysicalElementMapping *  value  ) 
 

DOXYGEN-IGNORE Sets the parent of this object. Not part of the API.

Reimplemented from FdoRdbmsOvClassDefinition.

virtual void FdoSqlServerOvClassDefinition::SetTable FdoXmlSaxContext *  context,
FdoXmlAttributeCollection *  atts
[protected, virtual]
 

Create table override from XML attributes.

Reimplemented from FdoRdbmsOvClassDefinition.

FDOSQLSERVER_OV_API void FdoSqlServerOvClassDefinition::SetTable FdoSqlServerOvTable table  ) 
 

Sets the SqlServer table override for this class override.

Parameters:
name Input SqlServer table override
Returns:
Returns nothing

The documentation for this class was generated from the following file:
Comments?