Consultingwerk.BusinessEntityDesigner.Plugins.DataSourceExtendedInfoPlugin

Namespace:

Class

DataSourceExtendedInfoPlugin

Parent classes:

Progress.Lang.Object

Consultingwerk.BusinessEntityDesigner.Plugins.DataSourceExtendedInfoPlugin

Inherits:

Progress.Lang.Object

Implements:

Consultingwerk.BusinessEntityDesigner.IBusinessEntityDesignerPlugin

File:	DataSourceExtendedInfoPlugin
Purpose:	Business Entity Designer Plugin that creates code which
	provides runtime-queryable (using DYNAMIC-PROPERTY) info
	about data-source buffers and field mappings.
Description:	Plugin manipulates the generated Data Access class after
	code has been generated or regenerated.
Author(s):	Mike Fechner / Consultingwerk Ltd.
Created:	Mon Feb 09 16:36:38 CET 2015
Notes:	Requires annotations in the DataAccess Class and Templates:
	@DefineDataSourceInformationStart.
	@DefineDataSourceInformationEnd.

Top Method Summary

	Options	Name	Purpose
		AfterGenerateSourceHandler (Object, EventArgs)	Event handler for the AfterGenerateSource and AfterReGenerateSource event of the BusinessEntityDatasetController
		CHARACTER FindOutputFolder ()	Returns the output folder (source code folder for business logic)
		GetAnnotationToFrom (character, character, character, character, integer, integer)	Locates the lines a start and end annotation are contained in a source code unit
		CHARACTER GetFieldMapping (character, integer)	Returns the field mapping pairs for the named temp-table
		Shutdown ()	Shuts down the plugin
		Startup (dataset, BusinessEntityDatasetController, BusinessEntityDesignerForm, UltraToolbarsManager)	Initializes the plugin
		UpdateDataAccessClass ()	Updates the Data Access class

Method Detail

Top

Purpose:	Event handler for the AfterGenerateSource and AfterReGenerateSource
	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

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

Returns	CHARACTER
	The output folder

Top

Purpose:	Locates the lines a start and end annotation are contained in a
	source code unit
Notes:

Parameters:
pcFileName	CHARACTER
	The file name to parse
pcStartAnnotation	CHARACTER
	The name of the start annotation
pcEndAnnotation	CHARACTER
	The name of the end annotation
pcAnnotationFileName	CHARACTER
	OUTPUT The file name containing the annotations
piStart	INTEGER
	The line number of the starting annotation
piEnd	INTEGER
	The line number of the ending annotation

Top

Purpose:	Returns the field mapping pairs for the named temp-table
Notes:

Parameters:
pcTempTableName	CHARACTER
	The name of the temp-table to return the field mappings for
piSpaces	INTEGER
	The number of SPACE Characters (CHR(32)) to prefix each entry with
Returns	CHARACTER
	The list of the field mappings

Top

Purpose:	Shuts down the plugin
Notes:

Top

Purpose:	Initializes the plugin
Notes:

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

Purpose:	Updates the Data Access class
Notes:

ProDataset Detail

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