Consultingwerk.BusinessEntityDesigner.Services.DatabaseSchemaDataAccess

Namespace:

Consultingwerk.BusinessEntityDesigner.Services

Class

DatabaseSchemaDataAccess

Parent classes:

Progress.Lang.Object

Consultingwerk.OERA.DataAccess

Consultingwerk.BusinessEntityDesigner.Services.DatabaseSchemaDataAccess

Inherits:

Consultingwerk.OERA.DataAccess

Implements:

Consultingwerk.OERA.IDataAccess, Consultingwerk.OERA.IDataAccessCanFind, Consultingwerk.OERA.IDataAccessCountRecords, IDSQueryStringSource

File:	DatabaseSchemaDataAccess
Purpose:	Retrieves Database Schema information for the Business
	Entity Designer
Author(s):	Mike Fechner / Consultingwerk Ltd.
Created:	Wed Oct 13 19:46:15 CEST 2010

Top Method Summary

	Options	Name	Purpose
		AttachDataSources ()	Attaches the DATA-SOURCE objects to the ProDataset Buffers
		BindDataset (dataset)	Do nothing, just receive the parameter and bind to the received Dataset reference
		DefineReadEvents ()	Subscribe to ProDataset Event Handlers using SET-CALLBACK as needed
		DetachDataSources ()	Detaches the DATA-SOURCE objects to the ProDataset Buffers
		FetchData (IFetchDataRequest)	Fetch data from the data source
		FetchMetaSchemaTables ()	Fetches the schema of the underscore tables of the DICTDB
		FetchSchema (character)	Fetches schema definition for the given database
		FetchTable (character, character)	Fetches schema definition for the given database table
		CHARACTER SourceColumn (character, character)	Returns the database field name matching a temp-table field name contained in a consumers query string (query string vs. temp-table definition)
		CHARACTER SourceDefaultQuery (character)	Returns the base query string used to retrieve data for the temp tables. This query string will be appended by the query provided by the consumer (FetchDataRequest object).

Top Constructor Summary

	Options	Name	Purpose
		DatabaseSchemaDataAccess (handle)	Constructor for the DatabaseSchemaDataAccess class

Method Detail

Top

AttachDataSources ()

Purpose:	Attaches the DATA-SOURCE objects to the ProDataset Buffers
Notes:	Overrides ABSTRACT method in Consultingwerk.OERA.DataAccess,
	Invoked in FetchData and SaveChanges

Top

BindDataset (dataset)

Purpose:	Do nothing, just receive the parameter and bind to the received
	Dataset reference
Notes:

Parameters:
dsDatabaseSchema	DATASET dsDatabaseSchema
	DATASET to bind to

Top

DefineReadEvents ()

Purpose:	Subscribe to ProDataset Event Handlers using SET-CALLBACK
	as needed
Notes:	Not used in this class

Top

DetachDataSources ()

Purpose:	Detaches the DATA-SOURCE objects to the ProDataset Buffers
Notes:	Not used in this class

Top

FetchData (IFetchDataRequest)

Purpose:	Fetch data from the data source
Notes:

Parameters:
poFetchDataRequest	Consultingwerk.OERA.IFetchDataRequest
	The IFetchDataRequest object with the parameters for this call

Top

FetchMetaSchemaTables ()

Purpose:	Fetches the schema of the underscore tables of the DICTDB
Notes:	Executed based on a Business Entity Designer option

Top

FetchSchema (character)

Purpose:	Fetches schema definition for the given database
Notes:

Parameters:
pcDatabase	CHARACTER
	The name of the database

Top

FetchTable (character, character)

Purpose:	Fetches schema definition for the given database table
Notes:

Parameters:
pcDatabase	CHARACTER
	The name of the database
pcFileName	CHARACTER
	The name of the database table

Top

CHARACTER SourceColumn (character, character)

Purpose:	Returns the database field name matching a temp-table field name
	contained in a consumers query string (query string vs. temp-table
	definition)
Notes:	Call-back used by Consultingwerk.OERA.Query.DSQueryString (part of
DataAccess:FetchData	FetchData () query preparation

Parameters:
pcTable	CHARACTER
	The temp table name to return the source (database table) field name for
pcColumn	CHARACTER
	The temp table column name to return the source (database table) field name for
Returns	CHARACTER
	The database field name mapped to the passed in temp-table field

Top

CHARACTER SourceDefaultQuery (character)

Purpose:	Returns the base query string used to retrieve data for the temp
	tables. This query string will be appended by the query provided by
	the consumer (FetchDataRequest object).
Notes:	Call-back used by Consultingwerk.OERA.Query.DSQueryString (part of
DataAccess:FetchData	FetchData () query preparation

Parameters:
pcTable	CHARACTER
	The temp table name to return the source default (database) query string for
Returns	CHARACTER
	The base query string used to retrieve data for the given temp-table