Namespace: Consultingwerk.BusinessEntityDesigner.Plugins.StaticDataAccessQuery
Class 
StaticDataAccessQueryPlugin Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.BusinessEntityDesigner.Plugins.StaticDataAccessQuery.StaticDataAccessQueryPlugin

Inherits: Progress.Lang.Object
Implements: Consultingwerk.BusinessEntityDesigner.IBusinessEntityDesignerPlugin


Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
# AfterGenerateSourceHandler (Object, EventArgs) Event handler for the AfterGenerateSource event of the BusinessEntityDatasetController
# CHARACTER FindOutputFolder () Returns the output folder (source code folder for business logic)
# GenerateDataAccessQueries () Generates the DataAccess Fetch include and parameter classes
+ GenerateDataAccessQueries (dataset) Generates the Constants include file
# CHARACTER GetFieldMapping (character, character) Returns the field mapping pairs for the named temp-table, for a db buffer
# CHARACTER GetTemplatePath (character) Returns the absolute path of a template file
# CHARACTER PrettifyName (character) Removes any "-" or "_" characters from a table or field name, and CamelCases the result; so "order-master" becomes "OrderMaster"
+ Shutdown () Method called when the Business Entity Designer will get closed
# CHARACTER SourceDefaultQuery (character) Builds the "default" SourceDefaultQuery for a Business Entity temp-table
+ Startup (dataset, BusinessEntityDatasetController, BusinessEntityDesignerForm, UltraToolbarsManager) Method called when the Business Entity Designer is starting and has loaded the plugin.
# LONGCHAR UpdateDataAccess (character, character, character, character, character, CharacterDictionary) Adds the static query include to the DataAccess class, if needed
- WriteFile (character, character, longchar) Writes a file to disk after publishing a BusinessEntityGenerator event


Method Detail
Top

PROTECTED AfterGenerateSourceHandler (Object, EventArgs)
Purpose: Event handler for the AfterGenerateSource event of the
BusinessEntityDatasetController
Notes:

Parameters:
sender Progress.Lang.Object
The reference to the object that raised the event
e Consultingwerk.EventArgs
The Consultingwerk.EventArgs with the data for this event
Top

PROTECTED CHARACTER FindOutputFolder ()
Purpose: Returns the output folder (source code folder for business logic)
Notes:

Returns CHARACTER
The output folder, without any trailing path-separator
Top

PROTECTED GenerateDataAccessQueries ()
Purpose: Generates the DataAccess Fetch include and parameter classes
Notes:

Top

PUBLIC GenerateDataAccessQueries (dataset)
Purpose: Generates the Constants include file
Notes: This routine is intended to be used from outside of the Business Entity
designer (automatic source code generation, unit testing)

Parameters:
dsBusinessEntity DATASET dsBusinessEntity
Business Entity with the Design dataset, called with the BY-REFERENCE keyword
Top

PROTECTED CHARACTER GetFieldMapping (character, character)
Purpose: Returns the field mapping pairs for the named temp-table, for a db buffer
Notes:

Parameters:
pcTempTableName CHARACTER
The name of the temp-table to return the field mappings for
pcBufferName CHARACTER
The db table
Returns CHARACTER
The list of the field mappings
Top

PROTECTED CHARACTER GetTemplatePath (character)
Purpose: Returns the absolute path of a template file
Notes: Throws an error, when the template file cannot be found

Parameters:
pcFileName CHARACTER
The relative template file name
Returns CHARACTER
The absolute path to the template file
Top

PROTECTED CHARACTER PrettifyName (character)
Purpose: Removes any "-" or "_" characters from a table or field name, and CamelCases
the result; so "order-master" becomes "OrderMaster"
Notes:

Parameters:
pcName CHARACTER
The table, buffer or field name to prettify
Returns CHARACTER
The prettified name
Top

PUBLIC Shutdown ()
Purpose: Method called when the Business Entity Designer will get closed
Notes:

Top

PROTECTED CHARACTER SourceDefaultQuery (character)
Purpose: Builds the "default" SourceDefaultQuery for a Business Entity temp-table
Notes:

Parameters:
pcSourceBufferNames CHARACTER
The names of the temp-table's source buffers
Returns CHARACTER
The source default query string
Top

PUBLIC Startup (dataset, BusinessEntityDatasetController, BusinessEntityDesignerForm, UltraToolbarsManager)
Purpose: Method called when the Business Entity Designer is starting and
has loaded the plugin.
Notes: Passes references to some key components of the Designer to
the plugin, use this to initialize the plugin, subscribe to events

Parameters:
dsBusinessEntity DATASET dsBusinessEntity
Business Entity with the Design dataset, called with the BIND keyword
poController Consultingwerk.BusinessEntityDesigner.Services.BusinessEntityDatasetController
The BusinessEntityDatasetController
poForm Consultingwerk.BusinessEntityDesigner.UI.BusinessEntityDesignerForm
The main Form of the BusinessEntityDesigner
poToolbar Infragistics.Win.UltraWinToolbars.UltraToolbarsManager
The reference to the UltraToolbarsManager used by the BusinessEntityDesigner
Top

PROTECTED LONGCHAR UpdateDataAccess (character, character, character, character, character, CharacterDictionary)
Purpose: Adds the static query include to the DataAccess class, if needed
Notes: If the include name is in the DataAccess class, no changes are made to
the DataAccess code.

Parameters:
pcStaticQueryInclude CHARACTER
The filename of the static query include
pcDataAccessClass CHARACTER
The filename of the DataAccess class
pcMethodNames CHARACTER
A comma-separated list of the static query method names
pcDatasetIncludeName CHARACTER
The relatively-pathed dataset include name
pcSourceTableNames CHARACTER
The database source tables
poMethodQueryStrings Consultingwerk.Framework.Collections.CharacterDictionary
The query strings for each method
Returns LONGCHAR
The updated contents of the DataAccess class
Top

PRIVATE WriteFile (character, character, longchar)
Purpose: Writes a file to disk after publishing a BusinessEntityGenerator event
Notes:

Parameters:
pcDescription CHARACTER
Human-friendly description for events
pcFilename CHARACTER
The filename to write; an absolute path
plcData LONGCHAR
The file contents


ProDataset Detail

ProDataset dsBusinessEntity

Member tables: eBusinessEntity, eDataRelation, eDataRelationProperties, eTable, eField, eFieldProperties, eIndex, eIndexProperties, eTableProperties, eBusinessEntityProperties


Temp-Table Detail

Temp-Table eBusinessEntity

Defined in:

Temp-Table eBusinessEntityProperties

Defined in:

Temp-Table eDataRelation

Defined in:

Temp-Table eDataRelationProperties

Defined in:

Temp-Table eField

Defined in:

Temp-Table eFieldProperties

Defined in:

Temp-Table eIndex

Defined in:

Temp-Table eIndexProperties

Defined in:

Temp-Table eTable

Defined in:

Temp-Table eTableProperties

Defined in:


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