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

FdoMySQLOvClassDefinition Class Reference

#include <MySqlOvClassDefinition.h>

Inherits FdoRdbmsOvClassDefinition.

Inheritance diagram for FdoMySQLOvClassDefinition:

[legend]
List of all members.

Detailed Description

Concrete class defining physical schema overrides for a class definition.

Definition at line 31 of file MySqlOvClassDefinition.h.


Public Member Functions

virtual void _writeXmlAttributes (FdoXmlWriter *xmlWriter, const FdoXmlFlags *flags)
 Serialize the XML attributes of this class:.
FDOMYSQL_OV_API FdoString * GetAutoIncrementPropertyName (void)
 Gets which FDO property corresponds to the single MySQL auto-increment column.
FDOMYSQL_OV_API FdoInt64 GetAutoIncrementSeed (void)
 The initial value to use for the first row in the auto-increment column, if any.
FDOMYSQL_OV_API FdoMySQLOvPropertyDefinitionCollectionGetProperties ()
 Gets a collection of MySQL property overrides.
FDOMYSQL_OV_API FdoMySQLOvTableGetTable ()
 Gets the MySQL table override for this class override.
virtual void InitFromXml (FdoXmlSaxContext *pContext, FdoXmlAttributeCollection *attrs)
 Initialize this element from its XML attributes.
FDOMYSQL_OV_API void SetAutoIncrementPropertyName (FdoString *autoIncrementPropertyName)
 Which FDO property maps to an MySQL auto-increment column, if any.
FDOMYSQL_OV_API void SetAutoIncrementSeed (FdoInt64 autoIncrementSeed)
 Sets the initial value to use for the first row in the auto-increment column, if any.
void SetParent (FdoPhysicalElementMapping *value)
 DOXYGEN-IGNORE Sets the parent of this object. Not part of the API.
FDOMYSQL_OV_API void SetTable (FdoMySQLOvTable *table)
 Sets the MySQL table override for this class override.

Static Public Member Functions

FDOMYSQL_OV_API FdoMySQLOvClassDefinitionCreate (FdoString *name)
 Constructs an instance of an FdoMySQLOvClassDefinition using the specified arguments.
FDOMYSQL_OV_API FdoMySQLOvClassDefinitionCreate ()
 Constructs a default of an FdoMySQLOvClassDefinition.

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 ()
 FdoMySQLOvClassDefinition (FdoString *name)
 FdoMySQLOvClassDefinition ()
 
void Init ()
virtual void SetTable (FdoXmlSaxContext *context, FdoXmlAttributeCollection *atts)
 Create table override from XML attributes.
virtual ~FdoMySQLOvClassDefinition ()

Constructor & Destructor Documentation

FdoMySQLOvClassDefinition::FdoMySQLOvClassDefinition  )  [protected]
 

FdoMySQLOvClassDefinition::FdoMySQLOvClassDefinition FdoString *  name  )  [protected]
 

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


Member Function Documentation

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

Serialize the XML attributes of this class:.

Reimplemented from FdoRdbmsOvClassDefinition.

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

Add the given property override to this class override.

Implements FdoRdbmsOvClassDefinition.

FDOMYSQL_OV_API FdoMySQLOvClassDefinition* FdoMySQLOvClassDefinition::Create FdoString *  name  )  [static]
 

Constructs an instance of an FdoMySQLOvClassDefinition using the specified arguments.

Parameters:
name Input name
Returns:
Returns FdoMySQLOvClassDefinition

FDOMYSQL_OV_API FdoMySQLOvClassDefinition* FdoMySQLOvClassDefinition::Create  )  [static]
 

Constructs a default of an FdoMySQLOvClassDefinition.

Returns:
Returns FdoMySQLOvClassDefinition

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

Create data property override from XML attributes.

Reimplemented from FdoRdbmsOvClassDefinition.

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

Create geometric property override from XML attributes.

Reimplemented from FdoRdbmsOvClassDefinition.

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

Create object property override from XML attributes.

Reimplemented from FdoRdbmsOvClassDefinition.

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

FDOMYSQL_OV_API FdoString* FdoMySQLOvClassDefinition::GetAutoIncrementPropertyName void   ) 
 

Gets which FDO property corresponds to the single MySQL auto-increment column.

Returns:
Returns the FDO property corresponding to the single MySQL auto-increment column, or an empty string if there is no such property

FDOMYSQL_OV_API FdoInt64 FdoMySQLOvClassDefinition::GetAutoIncrementSeed void   ) 
 

The initial value to use for the first row in the auto-increment column, if any.

Remarks:
This override is only valid if the AutoIncrementProperty override is set to a non-empty string. This works only for the following storage engine types: MyISAM, MEMORY as of MySQL 4.1, and InnoDB as of MySQL 5.0.3. This override is ignored on ApplySchema if this table is an existing table in a foreign database.
Returns:
Returns the initial value to use for the first row in the auto-increment column

FDOMYSQL_OV_API FdoMySQLOvPropertyDefinitionCollection* FdoMySQLOvClassDefinition::GetProperties  ) 
 

Gets a collection of MySQL property overrides.

Returns:
Returns the collection of MySQL property overrides

Reimplemented from FdoRdbmsOvClassDefinition.

FDOMYSQL_OV_API FdoMySQLOvTable* FdoMySQLOvClassDefinition::GetTable  ) 
 

Gets the MySQL table override for this class override.

Returns:
Returns FdoMySQLOvTable

Reimplemented from FdoRdbmsOvClassDefinition.

void FdoMySQLOvClassDefinition::Init  )  [protected]
 

Reimplemented from FdoRdbmsOvClassDefinition.

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

Initialize this element from its XML attributes.

Reimplemented from FdoRdbmsOvClassDefinition.

FDOMYSQL_OV_API void FdoMySQLOvClassDefinition::SetAutoIncrementPropertyName FdoString *  autoIncrementPropertyName  ) 
 

Which FDO property maps to an MySQL auto-increment column, if any.

Returns:
Returns nothing

FDOMYSQL_OV_API void FdoMySQLOvClassDefinition::SetAutoIncrementSeed FdoInt64  autoIncrementSeed  ) 
 

Sets the initial value to use for the first row in the auto-increment column, if any.

Returns:
Returns nothing

void FdoMySQLOvClassDefinition::SetParent FdoPhysicalElementMapping *  value  ) 
 

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

Reimplemented from FdoRdbmsOvClassDefinition.

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

Create table override from XML attributes.

Reimplemented from FdoRdbmsOvClassDefinition.

FDOMYSQL_OV_API void FdoMySQLOvClassDefinition::SetTable FdoMySQLOvTable table  ) 
 

Sets the MySQL table override for this class override.

Parameters:
name Input MySQL table override
Returns:
Returns nothing

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