Namespace: Consultingwerk.Studio.Proparse.ProcedureConverter.Converter
Class 
ProcedureConverter Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.Studio.Proparse.ProcedureConverter.Converter.ProcedureConverter

Inherits: Progress.Lang.Object


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



Top Method Summary
Options Name Purpose
LOGICAL ConfirmOverwrite (character) Asks the user for confirmation before an existing class file is overwritten
FillUsing (JPNode, table) Fills an eUsing temp-table
CHARACTER Generate (RoutineDetails) Generates Parameter and Response objects then returns the method-signature of a given RoutienDetails
CHARACTER GenerateParameterObject (RoutineDetails) Generates a parameter object if neccessary
CHARACTER GenerateReturnObject (RoutineDetails) Generates a response object if neccessary
LONGCHAR GetClassStatement (character) Returns a CLASS statement for a given classname
CHARACTER GetConstructor (character) Returns the default constructor for a generated parameter or response object
Consultingwerk.Studio.Proparse.ProcedureConverter.Converter.RoutineDetails GetDetails (JPNode) Returns a RoutineDetails object if the given node is of type PROCEDURE or FUNCTION
CHARACTER GetErrorHandlingStatement () Returns a default error-handling statement
org.prorefactor.core.JPNode GetFlatNodes (JPNode) Helper method that returns a flat array of the nodes in a given nodes ParseUnit
GetFlatNodes (JPNode, JPNode[], integer) Worker method that recursively iterates JPNodes to fill a flat extent
Consultingwerk.Studio.Proparse.ProcedureConverter.Converter.ParameterDetails GetFunctionParameter (JPNode) Returns ParameterDetails for a function parameter
Consultingwerk.Studio.Proparse.ProcedureConverter.Converter.TypeDetails GetFunctionReturnType (JPNode) Returns TypeDetails for a given functions return value
LONGCHAR GetGeneratedClassCode (character, longchar) Assembles the source code of a generated parameter or response object
CHARACTER GetHeaderComment (character) Returns a string with a file-header comment
INTEGER GetNodeCount (JPNode) Helper method that counts the nodes ina given nodes ParseUnit
GetNodeCount (JPNode, integer) Worker method that recursively iterates nodes to count them
INTEGER GetNodeIndex (JPNode, JPNode[]) Searches for a node in an extent and returns its index
LONGCHAR GetParameterProperties (ParameterDetails[]) Returns a string with DEFINE PROPERTY statements for a parameter object
Consultingwerk.Studio.Proparse.ProcedureConverter.Converter.ParameterDetails GetParameters (JPNode, JPNode[]) Returns an extent filled with the ParameterDetails of a routine referenced by a given node
Consultingwerk.Studio.Proparse.ProcedureConverter.Converter.ParameterDetails GetParamExtent (JPNode) Initializes an extent to the number of parameters
Consultingwerk.Studio.Proparse.ProcedureConverter.Converter.ParameterDetails GetProcedureParameter (JPNode) Returns ParameterDetails for a procedure parameter
Consultingwerk.Studio.Proparse.ProcedureConverter.Converter.TypeDetails GetProcedureReturnType (JPNode, JPNode[]) Returns TypeDetails for a given procedures return value
LONGCHAR GetReturnProperties (RoutineDetails) Returns a string with DEFINE PROPERTY statements for a response object
Consultingwerk.Studio.Proparse.ProcedureConverter.Converter.TypeDetails GetReturnType (JPNode, JPNode[]) Returns TypeDetails for a given routines return value
CHARACTER GetSignature (RoutineDetails, character, character) Returns the signature of the replacement method for a given routine
LOGICAL NeedsParameterObject (RoutineDetails) Returns whether the given RoutineDetails require a parameter object
LOGICAL NeedsReturnObject (RoutineDetails) Returns whether the given RoutineDetails require a response object
CHARACTER ToPropertyString (character, character) Returns a string with a DEFINE PROPERTY statement for a parameter


Method Detail
Top

LOGICAL ConfirmOverwrite (character)
Purpose: Asks the user for confirmation before an existing class file is overwritten
Notes: Returns TRUE when the file does not yet exist or the user confirms the overwrite

Parameters:
pcPath CHARACTER
The OS file name of the class file to be (over)written
Returns LOGICAL
Whether the generated class file may be written to pcPath
Top

FillUsing (JPNode, table)
Purpose: Fills an eUsing temp-table
Notes:

Parameters:
poNode org.prorefactor.core.JPNode
A JPNode of the ParseUnit whose USINGs are sought
eUsing TEMP-TABLE eUsing
The temp-table to fill
Top

CHARACTER Generate (RoutineDetails)
Purpose: Generates Parameter and Response objects then returns the method-signature of a given RoutienDetails
Notes:

Parameters:
poDetails Consultingwerk.Studio.Proparse.ProcedureConverter.Converter.RoutineDetails
The RoutineDetails object with information about a routine
Returns CHARACTER
The signature of the method of poDetails
Top

CHARACTER GenerateParameterObject (RoutineDetails)
Purpose: Generates a parameter object if neccessary
Notes:

Parameters:
poDetails Consultingwerk.Studio.Proparse.ProcedureConverter.Converter.RoutineDetails
The RoutineDetails to generate a parameter object for
Returns CHARACTER
The class name of the ParameterObject for poDetails
Top

CHARACTER GenerateReturnObject (RoutineDetails)
Purpose: Generates a response object if neccessary
Notes:

Parameters:
poDetails Consultingwerk.Studio.Proparse.ProcedureConverter.Converter.RoutineDetails
The RoutineDetails to generate a response object for
Returns CHARACTER
The class name of the ResponseObject for poDetails
Top

LONGCHAR GetClassStatement (character)
Purpose: Returns a CLASS statement for a given classname
Notes: The generated class is a serializable Consultingwerk.ParameterObject

Parameters:
pcClassName CHARACTER
The classname
Returns LONGCHAR
The CLASS statement for pcClassName
Top

CHARACTER GetConstructor (character)
Purpose: Returns the default constructor for a generated parameter or response object
Notes: The constructor registers the serializable properties via the
Consultingwerk.ParameterObject base class

Parameters:
pcClassName CHARACTER
The unqualified name of the generated class
Returns CHARACTER
The CONSTRUCTOR statement for pcClassName
Top

Consultingwerk.Studio.Proparse.ProcedureConverter.Converter.RoutineDetails GetDetails (JPNode)
Purpose: Returns a RoutineDetails object if the given node is of type PROCEDURE or FUNCTION
Notes:

Parameters:
poNode org.prorefactor.core.JPNode
JPNode of type PROCEDURE or FUNCTION
Returns Consultingwerk.Studio.Proparse.ProcedureConverter.Converter.RoutineDetails
RoutineDetails with information about the routine referenced by poNode
Top

CHARACTER GetErrorHandlingStatement ()
Purpose: Returns a default error-handling statement
Notes:

Returns CHARACTER
The defailt error-handling statement
Top

org.prorefactor.core.JPNode GetFlatNodes (JPNode)
Purpose: Helper method that returns a flat array of the nodes in a given nodes ParseUnit
Notes:

Parameters:
poNode org.prorefactor.core.JPNode
A node of the nodes that are flattened
Returns org.prorefactor.core.JPNode
An extent with flat nodes
Top

GetFlatNodes (JPNode, JPNode[], integer)
Purpose: Worker method that recursively iterates JPNodes to fill a flat extent
Notes:

Parameters:
poNode org.prorefactor.core.JPNode
Current JPNode
poNodes org.prorefactor.core.JPNode
The extent to fill
piNextIndex INTEGER
The next nodes index in the extent
Top

Consultingwerk.Studio.Proparse.ProcedureConverter.Converter.ParameterDetails GetFunctionParameter (JPNode)
Purpose: Returns ParameterDetails for a function parameter
Notes:

Parameters:
poNode org.prorefactor.core.JPNode
JPNode that is direct child of a Parameter_list node
Returns Consultingwerk.Studio.Proparse.ProcedureConverter.Converter.ParameterDetails
ParameterDetails for the parameter
Top

Consultingwerk.Studio.Proparse.ProcedureConverter.Converter.TypeDetails GetFunctionReturnType (JPNode)
Purpose: Returns TypeDetails for a given functions return value
Notes:

Parameters:
poNode org.prorefactor.core.JPNode
JPNode of type FUNCTION
Returns Consultingwerk.Studio.Proparse.ProcedureConverter.Converter.TypeDetails
The TypeDetails for the functions RETURNS type
Top

LONGCHAR GetGeneratedClassCode (character, longchar)
Purpose: Assembles the source code of a generated parameter or response object
Notes: The generated class is a serializable Consultingwerk.ParameterObject

Parameters:
pcClassName CHARACTER
The fully qualified name of the generated class
plcProperties LONGCHAR
The DEFINE PROPERTY statements of the generated class
Returns LONGCHAR
The source code of the generated class
Top

CHARACTER GetHeaderComment (character)
Purpose: Returns a string with a file-header comment
Notes:

Parameters:
pcFileName CHARACTER
The filename
Returns CHARACTER
The header-comment
Top

INTEGER GetNodeCount (JPNode)
Purpose: Helper method that counts the nodes ina given nodes ParseUnit
Notes:

Parameters:
poNode org.prorefactor.core.JPNode
The JPNode whose ParseUnits nodes are counted
Returns INTEGER
The node count
Top

GetNodeCount (JPNode, integer)
Purpose: Worker method that recursively iterates nodes to count them
Notes:

Parameters:
poNode org.prorefactor.core.JPNode
The current node
piCount INTEGER
The current count
Top

INTEGER GetNodeIndex (JPNode, JPNode[])
Purpose: Searches for a node in an extent and returns its index
Notes:

Parameters:
poNode org.prorefactor.core.JPNode
The node to search
poNodes org.prorefactor.core.JPNode
The extent
Returns INTEGER
The index of poNode in poNodes
Top

LONGCHAR GetParameterProperties (ParameterDetails[])
Purpose: Returns a string with DEFINE PROPERTY statements for a parameter object
Notes:

Parameters:
poParams Consultingwerk.Studio.Proparse.ProcedureConverter.Converter.ParameterDetails
:The Parameters for the parameter object
Returns LONGCHAR
A string with DEFINE PROPERTY statements
Top

Consultingwerk.Studio.Proparse.ProcedureConverter.Converter.ParameterDetails GetParameters (JPNode, JPNode[])
Purpose: Returns an extent filled with the ParameterDetails of a routine referenced by a given node
Notes:

Parameters:
poNode org.prorefactor.core.JPNode
JPNode of type PROCEDURE or FUNCTION
poNodes org.prorefactor.core.JPNode
The flat array of the nodes ParseUnit (see GetFlatNodes)
Returns Consultingwerk.Studio.Proparse.ProcedureConverter.Converter.ParameterDetails
An extent of ParameterDetails for poNodes routines parameters
Top

Consultingwerk.Studio.Proparse.ProcedureConverter.Converter.ParameterDetails GetParamExtent (JPNode)
Purpose: Initializes an extent to the number of parameters
Notes:

Parameters:
poNode org.prorefactor.core.JPNode
JPNode of type PROCEDURE or FUNCTION
Returns Consultingwerk.Studio.Proparse.ProcedureConverter.Converter.ParameterDetails
An extent for poNodes routines parameters
Top

Consultingwerk.Studio.Proparse.ProcedureConverter.Converter.ParameterDetails GetProcedureParameter (JPNode)
Purpose: Returns ParameterDetails for a procedure parameter
Notes:

Parameters:
poNode org.prorefactor.core.JPNode
JPNode of type DEFINE
Returns Consultingwerk.Studio.Proparse.ProcedureConverter.Converter.ParameterDetails
ParameterDetails for the defined parameter
Top

Consultingwerk.Studio.Proparse.ProcedureConverter.Converter.TypeDetails GetProcedureReturnType (JPNode, JPNode[])
Purpose: Returns TypeDetails for a given procedures return value
Notes:

Parameters:
poNode org.prorefactor.core.JPNode
JPNode of type PROCEDURE
poNodes org.prorefactor.core.JPNode
The flat array of the nodes ParseUnit (see GetFlatNodes)
Returns Consultingwerk.Studio.Proparse.ProcedureConverter.Converter.TypeDetails
TypeDetails for type CHARACTER or VOID
Top

LONGCHAR GetReturnProperties (RoutineDetails)
Purpose: Returns a string with DEFINE PROPERTY statements for a response object
Notes:

Parameters:
poDetails Consultingwerk.Studio.Proparse.ProcedureConverter.Converter.RoutineDetails
The Details to create property strings for
Returns LONGCHAR
A string with DEFINE PROPERTY statements
Top

Consultingwerk.Studio.Proparse.ProcedureConverter.Converter.TypeDetails GetReturnType (JPNode, JPNode[])
Purpose: Returns TypeDetails for a given routines return value
Notes:

Parameters:
poNode org.prorefactor.core.JPNode
JPNode of type PROCEDURE or FUNCTION
poNodes org.prorefactor.core.JPNode
The flat array of the nodes ParseUnit (see GetFlatNodes)
Returns Consultingwerk.Studio.Proparse.ProcedureConverter.Converter.TypeDetails
The TypeDetails for the routines return value
Top

CHARACTER GetSignature (RoutineDetails, character, character)
Purpose: Returns the signature of the replacement method for a given routine
Notes:

Parameters:
poDetails Consultingwerk.Studio.Proparse.ProcedureConverter.Converter.RoutineDetails
The RoutineDetails to create a signature for
pcParameterObject CHARACTER
The classname of the generated parameter-object
pcReturnObject CHARACTER
The classname of the generated response-object
Returns CHARACTER
The signature for poDetails
Top

LOGICAL NeedsParameterObject (RoutineDetails)
Purpose: Returns whether the given RoutineDetails require a parameter object
Notes:

Parameters:
poDetails Consultingwerk.Studio.Proparse.ProcedureConverter.Converter.RoutineDetails
RoutineDetails that may need a parameter object
Returns LOGICAL
Whether poDetails requires a parameter object
Top

LOGICAL NeedsReturnObject (RoutineDetails)
Purpose: Returns whether the given RoutineDetails require a response object
Notes:

Parameters:
poDetails Consultingwerk.Studio.Proparse.ProcedureConverter.Converter.RoutineDetails
RoutineDetails that may need a response object
Returns LOGICAL
Whether poDetails requires a response object
Top

CHARACTER ToPropertyString (character, character)
Purpose: Returns a string with a DEFINE PROPERTY statement for a parameter
Notes:

Parameters:
pcType CHARACTER
The properties data-type
pcName CHARACTER
The properties name
Returns CHARACTER
String with the DEFINE PROPERTY statement


Temp-Table Detail

Temp-Table eUsing

Defined in:


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       01.06.2026 09:18:35