Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractStaticDataAccessQueryPlugin

Namespace:

Consultingwerk.BusinessEntityDesigner.Common.Plugins

Class

AbstractStaticDataAccessQueryPlugin

Parent classes:

Progress.Lang.Object

Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractStaticDataAccessQueryPlugin

Inherits:

Progress.Lang.Object

Inherited by:

Consultingwerk.BusinessEntityDesigner.Plugins.StaticDataAccessQuery.StaticDataAccessQueryPlugin Consultingwerk.BusinessEntityDesigner.Server.Plugins.StaticDataAccessQueryServerPlugin

ABSTRACT

Top Method Summary

	Options	Name	Purpose
		AfterGenerateSourceHandler (Object, EventArgs)	Event handler for the AfterGenerateSource event of the BusinessEntityDatasetController
		LONGCHAR BuildFillChildTableCall (character, character, integer)	Builds the calls to the child table fill methods
		DefineQueryAndBuffer (character, character[], character, character, character, character, character, character[], character[], integer, integer)	Defines the query and buffer names for a table
		DisplayStatus (character)	Displays a status message in the Business Entity Designer
		CHARACTER FindOutputFolder ()	Returns the output folder (source code folder for business logic)
		CHARACTER FixQueryCase (character)	Corrects the case of ABL keywords in a query string
		GenerateDataAccessQueries ()	Generates the DataAccess Fetch include and parameter classes
		GenerateDataAccessQueries (dataset)	Generates the Constants include file
		LONGCHAR GenerateFillChildTablesMethod (character, integer, integer)	Generates the Fill method for static query
		CHARACTER GetExcludeFields (character, character)	Returns the exclude field list for the named temp-table, for a db buffer
		CHARACTER GetFieldMapping (character, character)	Returns the field mapping pairs for the named temp-table, for a db buffer
		CHARACTER GetStaticQueryNames (character, character, ClassName)	Determines the method name and parameter object type/package used for the generated static data access query
		CHARACTER PrettifyName (character)	Removes any "-" or "_" characters from a table or field name, and CamelCases the result; so "order-master" becomes "OrderMaster"
		CHARACTER RelationTypeConversion (character, character, character)	Returns the ABL function required for the data-type conversion of the parent field to match the child field
		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 (IBusinessEntityDatasetController, IBusinessEntityDesignerPluginManager)	Method called when the Business Entity Designer is starting and has loaded the plugin.
		LONGCHAR UpdateDataAccess (character, character, character, character, character)	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

Top Constructor Summary

	Options	Name	Purpose
		AbstractStaticDataAccessQueryPlugin ()	Default constructor

Top Property Summary

	Options	Name	Purpose
		Consultingwerk.BusinessEntityDesigner.Common.IBusinessEntityDesignerPluginManager PluginManager

Method Detail

Top

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

LONGCHAR BuildFillChildTableCall (character, character, integer)

Purpose:	Builds the calls to the child table fill methods
Notes:

Parameters:
pcTableName	CHARACTER
	The name of the parent table
pcApplyCallbackCriteria	CHARACTER
	The criteria to apply to the callback
piSpaces	INTEGER
	The number of spaces to indent the code
Returns	LONGCHAR
	The generated code

Top

DefineQueryAndBuffer (character, character[], character, character, character, character, character, character[], character[], integer, integer)

Purpose:	Defines the query and buffer names for a table
Notes:

Parameters:
pcTableName	CHARACTER
	The name of the table
pcQueryStrings	CHARACTER
	The query strings
pcSourceTableNames	CHARACTER
	The source table names
pcSourceBufferNames	CHARACTER
	The source buffer names
pcQueryName	CHARACTER
	The name of the query
pcQuery	CHARACTER
	The query string
pcBufferCopy	CHARACTER
	The buffer copy
pcBufferName	CHARACTER
	The buffer name
pcBufferDefinition	CHARACTER
	The buffer definition
piBufferCount	INTEGER
	The buffer count
piQueryCount	INTEGER
	The query count

Top

DisplayStatus (character)

Purpose:	Displays a status message in the Business Entity Designer
Notes:

Parameters:
pcMessage	CHARACTER
	The message to display

Top

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

CHARACTER FixQueryCase (character)

Purpose:	Corrects the case of ABL keywords in a query string
Notes:

Parameters:
pcQuery	CHARACTER
	The query string
Returns	CHARACTER
	The correctly-cased query string

Top

GenerateDataAccessQueries ()

Purpose:	Generates the DataAccess Fetch include and parameter classes
Notes:

Top

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

LONGCHAR GenerateFillChildTablesMethod (character, integer, integer)

Purpose:	Generates the Fill method for static query
Notes:

Parameters:
pcParentTableName	CHARACTER
	The name of the parent table
piBufferCount	INTEGER
	The buffer count
piQueryCount	INTEGER
	The query count
Returns	LONGCHAR
	The generated code

Top

CHARACTER GetExcludeFields (character, character)

Purpose:	Returns the exclude field list 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 buffer name
Returns	CHARACTER
	The list of the exclude fields

Top

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 buffer name
Returns	CHARACTER
	The list of the field mappings

Top

CHARACTER GetStaticQueryNames (character, character, ClassName)

Purpose:	Determines the method name and parameter object type/package used for the generated static data access query
Notes:	Method separated out to be callable from other plugins (eg ModelClassGeneratorPlugin)

Parameters:
pcTempTableName	CHARACTER
	The temp-table name for which the static query name should be determined
pcIndexName	CHARACTER
	The index name for which the static query name should be determined
poParameterType	Consultingwerk.ClassName
	The parameter type type
Returns	CHARACTER
	The generated method name

Top

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

CHARACTER RelationTypeConversion (character, character, character)

Purpose:	Returns the ABL function required for the data-type
	conversion of the parent field to match the child field
Notes:

Parameters:
pcParentFieldDataType	CHARACTER
	The data type of the parent field
pcChildFieldDataType	CHARACTER
	The data type of the child field
pcChildFieldName	CHARACTER
	The name of the child field
Returns	CHARACTER
	The ABL function required for the data-type conversion of the parent field to match the child field

Top

Shutdown ()

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

Top

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

Startup (IBusinessEntityDatasetController, IBusinessEntityDesignerPluginManager)

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
	Do not check for the existence of any other plugins here since the order
	in which plugins are loaded is not guaranteed.

Parameters:
poController	Consultingwerk.BusinessEntityDesigner.Common.IBusinessEntityDatasetController
	The BusinessEntityDatasetController
poPluginManager	Consultingwerk.BusinessEntityDesigner.Common.IBusinessEntityDesignerPluginManager
	The reference to the PluginManager

Top

LONGCHAR UpdateDataAccess (character, character, character, character, character)

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
pcSourceBufferNames	CHARACTER
	The database source buffers
Returns	LONGCHAR
	The updated contents of the DataAccess class

Top

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