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

FdoRdbmsOvSchemaAutoGeneration Class Reference

#include <RdbmsOvSchemaAutoGeneration.h>

List of all members.


Detailed Description

<summary> This class provides directives for reverse-engineering FDO Feature Schema elements from the physical schema of the currently connected datastore. /summary>

Definition at line 34 of file RdbmsOvSchemaAutoGeneration.h.


Public Member Functions

virtual void _writeXml (FdoXmlWriter *xmlWriter, const FdoXmlFlags *flags)
FDORDBMS_OV_API FdoStringCollection * GetGenTableList ()
FDORDBMS_OV_API FdoString * GetGenTablePrefix ()
FDORDBMS_OV_API FdoInt32 GetMaxSampleRows ()
FDORDBMS_OV_API FdoBoolean GetRemoveTablePrefix ()
virtual void InitFromXml (FdoXmlSaxContext *pContext, FdoXmlAttributeCollection *attrs)
FDORDBMS_OV_API void SetGenTablePrefix (FdoString *tablePrefix)
FDORDBMS_OV_API void SetMaxSampleRows (FdoInt32 maxRows)
FDORDBMS_OV_API void SetRemoveTablePrefix (FdoBoolean removeTablePrefix)
 <returns>Returns nothing</returns>

Static Public Member Functions

FDORDBMS_OV_API FdoRdbmsOvSchemaAutoGenerationCreate ()

Protected Member Functions

virtual void Dispose ()
 FdoRdbmsOvSchemaAutoGeneration ()
FdoXmlSaxHandler * XmlStartElement (FdoXmlSaxContext *context, FdoString *uri, FdoString *name, FdoString *qname, FdoXmlAttributeCollection *atts)
virtual ~FdoRdbmsOvSchemaAutoGeneration ()

Constructor & Destructor Documentation

FdoRdbmsOvSchemaAutoGeneration::FdoRdbmsOvSchemaAutoGeneration  )  [protected]
 

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


Member Function Documentation

virtual void FdoRdbmsOvSchemaAutoGeneration::_writeXml FdoXmlWriter *  xmlWriter,
const FdoXmlFlags *  flags
[virtual]
 

FDORDBMS_OV_API FdoRdbmsOvSchemaAutoGeneration* FdoRdbmsOvSchemaAutoGeneration::Create  )  [static]
 

summary>Gets the table prefix for autogenerating class definitions. When set, an FDO Class Definition is automatically generated for each table whose name begins with this prefix. Any table already referenced by a class definition is skipped. Each generated class is added to the Feature Schema for this Schema Mapping Set. /summary> returns>Returns the class autogeneration table name prefix</returns>

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

FDORDBMS_OV_API FdoStringCollection* FdoRdbmsOvSchemaAutoGeneration::GetGenTableList  ) 
 

summary>Gets the maximum number of rows to sample when table data must be examined to determine schema information. The situations where this must be done depend on the provider. For example, when a geometric property is generated from a geometric column, the geomety types might be determined by examining some of the geometry values in the column.

MaxSampleRows can be any positive integer or one of the following: 0: all rows in the table are sampled. (Not recommended for large datastores). -1: no rows are sampled.

/summary> returns>Returns FdoBoolean.</returns>

FDORDBMS_OV_API FdoString* FdoRdbmsOvSchemaAutoGeneration::GetGenTablePrefix  ) 
 

summary> Sets the table prefix for autogenerating class definitions. /summary> <param name="tablePrefix"> Input the table prefix. If L"" then no classes will be generated by table prefix. </param> returns>Returns nothing</returns>

FDORDBMS_OV_API FdoInt32 FdoRdbmsOvSchemaAutoGeneration::GetMaxSampleRows  ) 
 

summary>Sets the maximum number of rows to sample when determining schema from table data. Higher values give a more accurate result but lower values provide better performance.</summary> <param name="maxRows">Input the maximum number of rows to sample.</param> returns>Returns nothing</returns>

FDORDBMS_OV_API FdoBoolean FdoRdbmsOvSchemaAutoGeneration::GetRemoveTablePrefix  ) 
 

summary>Sets the "remove table prefix" setting.</summary> <param name="removeTablePrefix"> Input the "remove table prefix" setting.

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

FDORDBMS_OV_API void FdoRdbmsOvSchemaAutoGeneration::SetGenTablePrefix FdoString *  tablePrefix  ) 
 

summary>Gets the table prefix removal setting. This setting affects how classes, generated from tables matching the table prefix, are named: when true, the class name is the table name with prefix removed. true is the default setting. when false, the class name is the table name. /summary> returns>Returns FdoBoolean.</returns>

FDORDBMS_OV_API void FdoRdbmsOvSchemaAutoGeneration::SetMaxSampleRows FdoInt32  maxRows  ) 
 

FDORDBMS_OV_API void FdoRdbmsOvSchemaAutoGeneration::SetRemoveTablePrefix FdoBoolean  removeTablePrefix  ) 
 

<returns>Returns nothing</returns>

summary>Gets the list of tables or views for which class definitions will be autogenerated. Once retrieved, the caller can populate this list. When set, an FDO Class Definition is automatically generated for each table in this list. Any table already referenced by a class definition is skipped. Each generated class is added to the Feature Schema for this Schema Mapping Set.

Note: the only way to autogenerate a class definition from a view is to add the view name to this list. There is one caveat in that the generated class will not have identity properties. /summary> returns>Returns FdoStringCollection</returns>

FdoXmlSaxHandler* FdoRdbmsOvSchemaAutoGeneration::XmlStartElement FdoXmlSaxContext *  context,
FdoString *  uri,
FdoString *  name,
FdoString *  qname,
FdoXmlAttributeCollection *  atts
[protected]
 


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