Consultingwerk.BusinessEntityDesigner.Plugins.TableQueryBuilderGeneratorPlugin

Namespace:

Consultingwerk.BusinessEntityDesigner.Plugins

Class

TableQueryBuilderGeneratorPlugin

Parent classes:

Progress.Lang.Object

Consultingwerk.BusinessEntityDesigner.Plugins.TableQueryBuilderGeneratorPlugin

Inherits:

Progress.Lang.Object

Implements:

Consultingwerk.BusinessEntityDesigner.IBusinessEntityDesignerPlugin

File:	TableQueryBuilderGeneratorPlugin
Purpose:	Business Entity Designer Plugin that integrates the
	Generator for Dataset/TableModel classes (DatasetModel,
	TableModel, TableFilter)
Description:	Plugin generates TableQuery classes and related code
	whenever the Business Entity is generated or regenerated.
	TableQuery code generation can be suspended by setting the
	"TableQueryBuilderGenerator.Disabled" custom property to "false"
Author(s):	Mike Fechner / Consultingwerk Ltd.
Created:	Mon Apr 02 22:03:43 CEST 2012

Top Method Summary

Options	Name	Purpose
#	AfterGenerateSourceHandler (Object, EventArgs)	Event handler for the AfterGenerateSource event of the BusinessEntityDatasetController
#	LOGICAL CheckDirectoriesExist ()	Validates that the target folders exists of prompts for create
#	CHARACTER CheckTemplatePath (character)	Verifies the path to a template file
#	CustomPropertiesUpdatedHandler (Object, CustomPropertiesUpdatedEventArgs)	Event handler for the CustomPropertiesUpdated event of the controller
#	CHARACTER FindOutputFolder ()	Returns the output folder (source code folder for shared code)
#	LONGCHAR GenerateConstructors (character)	Returns the code for the search constructors
#	GenerateFieldQueryPredicate (character, character, character, character, character, character)	Generates a single field query predicate class
#	GenerateQueryClasses ()	Generates the Query Classes
#	GetCustomPropertyNamesHandler (Object, GetCustomPropertyNamesEventArgs)	Event handler for the GetCustomPropertyNamesHandler event of the BusinessEntityDatasetController
#	GetCustomPropertyValuesHandler (Object, GetCustomPropertyValuesEventArgs)	Event handler for the GetCustomPropertyNamesHandler event of the BusinessEntityDatasetController
#	LOGICAL IsPluginActive ()	Returns if the Plugin is active (not disabled)
+	Shutdown ()	Method called when the Business Entity Designer will get closed
+	Startup (dataset, BusinessEntityDatasetController, BusinessEntityDesignerForm, UltraToolbarsManager)	Method called when the Business Entity Designer is starting and has loaded the plugin.
+	TableQueryBuilderClasses (dataset)	Generates the Table Query Builder Classes
#	ToggleActive ()	Toggles the .Disbaled property
#	ToolClickHandler (Object, ToolClickEventArgs)	Event handle the for the toolclick event of the UltraToolbarsController
#	ValidateSearchCodeIndexes ()	Validates that the indexes flagged with "Default Search Code Generation" do not cause constructors with duplicate signatures

Top Property Summary

	Options	Name	Purpose
	+	LOGICAL SilentMode
	#	CHARACTER SuffixTableQuery

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 LOGICAL CheckDirectoriesExist ()

Purpose:	Validates that the target folders exists of prompts for create
Notes:

Returns	LOGICAL
	Logical value indicating if the folders exists (true) or the generation should be cancelled

Top

PROTECTED CHARACTER CheckTemplatePath (character)

Purpose:	Verifies the path to 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 CustomPropertiesUpdatedHandler (Object, CustomPropertiesUpdatedEventArgs)

Purpose:	Event handler for the CustomPropertiesUpdated event of the controller
Notes:

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

Top

PROTECTED CHARACTER FindOutputFolder ()

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

Returns	CHARACTER
	The output folder

Top

PROTECTED LONGCHAR GenerateConstructors (character)

Purpose:	Returns the code for the search constructors
Notes:

Parameters:
pcTempTableName	CHARACTER
	The name of the current temp-table
Returns	LONGCHAR
	The source code for the search constructors

Top

PROTECTED GenerateFieldQueryPredicate (character, character, character, character, character, character)

Purpose:	Generates a single field query predicate class
Notes:

Parameters:
pcPackageName	CHARACTER
	The package for the table query class
pcTableQueryName	CHARACTER
	The name of the table query class
pcDataType	CHARACTER
	The Data Type used for the class name to generate
pcTemplateFileName	CHARACTER
	The file name of the template
pcBusinessEntityPackage	CHARACTER
	The name of the Business Entity Package
pcBusinessEntityName	CHARACTER
	The name of the Business Entity

Top

PROTECTED GenerateQueryClasses ()

Purpose:	Generates the Query Classes
Notes:

Top

PROTECTED GetCustomPropertyNamesHandler (Object, GetCustomPropertyNamesEventArgs)

Purpose:	Event handler for the GetCustomPropertyNamesHandler event of the
	BusinessEntityDatasetController
Notes:

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

Top

PROTECTED GetCustomPropertyValuesHandler (Object, GetCustomPropertyValuesEventArgs)

Purpose:	Event handler for the GetCustomPropertyNamesHandler event of the
	BusinessEntityDatasetController
Notes:

Parameters:
sender	Progress.Lang.Object
	The reference to the object that raised the event
e	Consultingwerk.BusinessEntityDesigner.Services.GetCustomPropertyValuesEventArgs
	The GetCustomPropertyNamesEventArgs with the data for this event

Top

PROTECTED LOGICAL IsPluginActive ()

Purpose:	Returns if the Plugin is active (not disabled)
Notes:

Returns	LOGICAL
	Logical value indicating if the Plugin is active (not disabled)

Top

PUBLIC Shutdown ()

Purpose:	Method called when the Business Entity Designer will get closed
Notes:

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

PUBLIC TableQueryBuilderClasses (dataset)

Purpose:	Generates the Table Query Builder Classes
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 ToggleActive ()

Purpose:	Toggles the .Disbaled property
Notes:

Top

PROTECTED ToolClickHandler (Object, ToolClickEventArgs)

Purpose:	Event handle the for the toolclick event of the UltraToolbarsController
Notes:

Parameters:
sender	System.Object
	The reference to the object that raised the event
e	Infragistics.Win.UltraWinToolbars.ToolClickEventArgs
	The ToolClickEventArgs with the data for this event