SqlCTypeMetadataFactory Class Reference

Constructs SqlCTypeMetadata*s and fills them in with default values for SQL C types. More...

List of all members.

Public Member Functions

AutoPtr< SqlCTypeMetadataCreateNewSqlCTypeMetadata (simba_int16 in_sqlCType)
 Initializes all values for a new SqlCTypeMetadata for the given SQL C type.
EncodingType GetCCharEncoding ()
 Returns the encoding for SQL_C_CHAR.
SqlCDataTypeUtilitiesGetSqlCDataTypeUtilities ()
 Get the current C data type utilities instance.
void ResetTypeDefaults (SqlCTypeMetadata *io_typeMetadata)
 Resets a SqlCTypeMetadata to the default values for its C Type. All fields including type flags (ie. IsTimeType()) must be reset.
void SetCCharEncoding (EncodingType in_CCharEncoding)
 Changes the encoding for SQL_C_CHAR.
void SetSqlCDataTypeUtilities (SqlCDataTypeUtilities *in_cTypeUtilities)
 Assign a custom C data type utilities instance.
 SqlCTypeMetadataFactory (SqlCDataTypeUtilities *in_cTypeUtilities)
 Constructor.
 SqlCTypeMetadataFactory ()
 Constructor DEPRECATED because it uses the global singleton SqlCDataTypeUtilities.
virtual ~SqlCTypeMetadataFactory ()
 Destructor.

Protected Member Functions

virtual AutoPtr< SqlCTypeMetadataCreateNewCustomSqlCTypeMetadata (simba_int16 in_sqlCType)
 Initializes all values for a new SqlCTypeMetadata for the given SQL C type. The new SqlCTypeMetadata must have TDW type of TDW_C_CUSTOM.
virtual bool ResetCustomTypeDefaults (SqlCTypeMetadata *io_typeMetadata)
 Resets a SqlCTypeMetadata to the default values for its C Type. All fields including type flags (ie. IsTimeType()) must be reset.

Detailed Description

Constructs SqlCTypeMetadata*s and fills them in with default values for SQL C types.


Constructor & Destructor Documentation

Constructor DEPRECATED because it uses the global singleton SqlCDataTypeUtilities.

SqlCTypeMetadataFactory ( SqlCDataTypeUtilities in_cTypeUtilities  ) 

Constructor.

Parameters:
in_cTypeUtilities Type utilities relating to this metadata factory (NOT OWNED)
virtual ~SqlCTypeMetadataFactory (  )  [virtual]

Destructor.


Member Function Documentation

virtual AutoPtr<SqlCTypeMetadata> CreateNewCustomSqlCTypeMetadata ( simba_int16  in_sqlCType  )  [protected, virtual]

Initializes all values for a new SqlCTypeMetadata for the given SQL C type. The new SqlCTypeMetadata must have TDW type of TDW_C_CUSTOM.

Default implementation throws exception because it will not be called unless SqlCTypeDataUtilities reports that in_sqlCType is supported.

Parameters:
in_sqlCType The SQL C type to set the type metadata up as.
Returns:
Returns the new SqlCTypeMetadata
AutoPtr<SqlCTypeMetadata> CreateNewSqlCTypeMetadata ( simba_int16  in_sqlCType  ) 

Initializes all values for a new SqlCTypeMetadata for the given SQL C type.

Parameters:
in_sqlCType The SQL C type to set the type metadata up as.
Returns:
Returns the new SqlCTypeMetadata
EncodingType GetCCharEncoding (  ) 

Returns the encoding for SQL_C_CHAR.

Returns:
Returns the encoding for SQL_C_CHAR.
SqlCDataTypeUtilities* GetSqlCDataTypeUtilities (  ) 

Get the current C data type utilities instance.

Returns:
Current utilities instance.
virtual bool ResetCustomTypeDefaults ( SqlCTypeMetadata io_typeMetadata  )  [protected, virtual]

Resets a SqlCTypeMetadata to the default values for its C Type. All fields including type flags (ie. IsTimeType()) must be reset.

Default implementation returns false.

Parameters:
io_typeMetadata The type metadata to reset. (NOT OWN)
Returns:
True if the type was handled, false otherwise.
void ResetTypeDefaults ( SqlCTypeMetadata io_typeMetadata  ) 

Resets a SqlCTypeMetadata to the default values for its C Type. All fields including type flags (ie. IsTimeType()) must be reset.

Parameters:
io_typeMetadata The type metadata to reset. (NOT OWN)
void SetCCharEncoding ( EncodingType  in_CCharEncoding  ) 

Changes the encoding for SQL_C_CHAR.

Parameters:
in_CCharEncoding The encoding for SQL_C_CHAR.
void SetSqlCDataTypeUtilities ( SqlCDataTypeUtilities in_cTypeUtilities  ) 

Assign a custom C data type utilities instance.

Parameters:
in_cTypeUtilities Custom instance.

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

Generated on Wed May 17 14:21:19 2017 for SimbaEngine 10.1.3.1011 by simba