Namespace: Consultingwerk.BusinessEntityDesigner.Batch
Class 
BatchGenerator Copy to Clipboard
Parent classes:
Inherits: Progress.Lang.Object

File:BatchGenerator
Purpose:Generates 1 Temp-Table Business Entities for a set
of database tables, useful in prototyping scenarios
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Thu Jun 02 16:06:20 CEST 2011



Top Method Summary
Options Name Purpose
# CHARACTER BuildBusinessEntityName (logical, character) Builds the name of a Business Entity
+ GenerateBusinessEntities (character, character, character, character, logical, character, character) Generates a list of Business Entities
+ GenerateBusinessEntities (character, logical, character, character, character, logical, character, character, logical) Generates a list of Business Entities
# GenerateBusinessEntity (handle, character, character, character, character, character, character, character, logical) Generates a single Business Entity
# CHARACTER GetIndexDataTypes (character, character) Returns a comma delimited list of data types of the index fields
# OnStatusChanged (ProcessingStatusChangedEventArgs) Raises the StatusChanged
# CHARACTER PathFromPackage (character) Translates a package name into a file path

Top Event Summary
Options Name Purpose
+ StatusChanged (Object, ProcessingStatusChangedEventArgs) Raised when the status of this component changes


Method Detail
Top

PROTECTED CHARACTER BuildBusinessEntityName (logical, character)

Purpose: Builds the name of a Business Entity
Notes:

Parameters:
plCamelcase LOGICAL
When true, the first letter of the table name will be forced to uppercase for the Business Entity Name
pcTableName CHARACTER
The name of the database table name
Returns CHARACTER
The base business Entity Name
Top

PUBLIC GenerateBusinessEntities (character, character, character, character, logical, character, character)

Purpose: Generates a list of Business Entities
Notes:

Parameters:
pcPackage CHARACTER
The source package for the generated business entities
pcBusinessEntityNamePattern CHARACTER
The name pattern for the Business Entity class name, using &1 for the Table name
pcDataAccessNamePattern CHARACTER
The name pattern for the Data Access class name, using &1 for the Table name
pcDatasetControllerNamePattern CHARACTER
The name pattern for the Dataset Controller class name, using &1 for the Table name
plCamelcase LOGICAL
When true, the first letter of the table name will be forced to uppercase for the Business Entity Name
pcDatabase CHARACTER
The database name to generate business entities for
pcTableNames CHARACTER
The name pattern (using the CAN-DO function) the database tables need to match for being generated
Top

PUBLIC GenerateBusinessEntities (character, logical, character, character, character, logical, character, character, logical)

Purpose: Generates a list of Business Entities
Notes:

Parameters:
pcPackage CHARACTER
The source package for the generated business entities
plCreateSubpackage LOGICAL
Create distinct sub-package per table
pcBusinessEntityNamePattern CHARACTER
The name pattern for the Business Entity class name, using &1 for the Table name
pcDataAccessNamePattern CHARACTER
The name pattern for the Data Access class name, using &1 for the Table name
pcDatasetControllerNamePattern CHARACTER
The name pattern for the Dataset Controller class name, using &1 for the Table name
plCamelcase LOGICAL
When true, the first letter of the table name will be forced to uppercase for the Business Entity Name
pcDatabase CHARACTER
The database name to generate business entities for
pcTableNames CHARACTER
The name pattern (using the CAN-DO function) the database tables need to match for being generated
plGenerateDatasetModel LOGICAL
Generate DatasetModel classes along with the Business Entity
Top

PROTECTED GenerateBusinessEntity (handle, character, character, character, character, character, character, character, logical)

Purpose: Generates a single Business Entity
Notes:

Parameters:
phDatasetDataset HANDLE
The handle to the database with the schema information
pcPackage CHARACTER
The source package for the generated business entities
pcBusinessEntityName CHARACTER
The base name for the Business Entity, Data Access and Dataset Controller class name
pcBusinessEntityNamePattern CHARACTER
The name pattern for the Business Entity class name, using &1 for the Table name
pcDataAccessNamePattern CHARACTER
The name pattern for the Data Access class name, using &1 for the Table name
pcDatasetControllerNamePattern CHARACTER
The name pattern for the Dataset Controller class name, using &1 for the Table name
pcDatabase CHARACTER
The database name to generate business entities for
pcTableName CHARACTER
The name of the database tables to be generated
plGenerateDatasetModel LOGICAL
Generate DatasetModel classes along with the Business Entity
Top

PROTECTED CHARACTER GetIndexDataTypes (character, character)

Purpose: Returns a comma delimited list of data types of the index fields
Notes:

Parameters:
pcTableName CHARACTER
The name of the temp-table
pcIndexFields CHARACTER
The comma delimited list of field names
Returns CHARACTER
The comma delimited list of data types
Top

PROTECTED OnStatusChanged (ProcessingStatusChangedEventArgs)

Purpose: Raises the StatusChanged
Notes:

Parameters:
e Consultingwerk.ProcessingStatusChangedEventArgs
The ProcessingStatusChangedEventArgs with the data for the event
Top

PROTECTED CHARACTER PathFromPackage (character)

Purpose: Translates a package name into a file path
Notes:

Parameters:
pcPackage CHARACTER
The Package to convert into a file path
Returns CHARACTER
The relative file path derived from the package namea


Event Detail
Top

PUBLIC StatusChanged (Object, ProcessingStatusChangedEventArgs)

Purpose: Raised when the status of this component changes
Notes:

Parameters:
sender Progress.Lang.Object
The object that raised the StatusChanged event
e Consultingwerk.ProcessingStatusChangedEventArgs
The ProcessingStatusChangedEventArgs with the data for the event


Temp-Table Detail


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       15.04.2024 05:48:50