com.goldencode.p2j.util

Class AbstractParameter

java.lang.Object

com.goldencode.p2j.util.AbstractParameter

Direct Known Subclasses:

AbstractExtentParameter, AbstractSimpleParameter

public abstract class AbstractParameter
extends java.lang.Object

Base class for all types of parameters. The hierarchy looks like this: AbstractParameter

• AbstractSimpleParameter
  • VariableAssigner
  • FieldAssigner
• AbstractExtentParameter
  • OutputExtentParameter
    • ExtentExprN1 (generated-code)
    • OutputExtentField
  • InputOutputExtentParameter
    • ExtentExprN2 (generated-code)
    • InputOutputExtentField

The class does the managements of scopes of for called procedures for both simple and extent parameters, using a ContextLocal WorkArea.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractParameter.Scope One instance of this class is created for each block scope which the currently executing program enters.
protected static class	AbstractParameter.WorkArea Object which manages the context local state of field assigners.

Field Summary

Fields

Modifier and Type	Field and Description
protected static ContextLocal<AbstractParameter.WorkArea>	context Object which manages all instances of this class by context.
protected static CentralLogger	LOG Logger

Constructor Summary

Constructors

Constructor and Description
AbstractParameter() Default constructor - register the scopeable instance as pending for the next started block.

Method Summary

Modifier and Type	Method and Description
protected boolean	canRelease(BaseDataType bdt) Check if the parameter can release its resources.
static AbstractParameter.Scope	getCurrentScope() Obtain the current scope from the current context.
protected BaseDataType	getLocalParam() Get the variable container used as parameter inside the procedure body.
static Scopeable	getScopeable() Retrieve a Scopeable for the current context.
protected static boolean	isExtentParameter(BaseDataType[] key) Check if the given array reference was passed as a parameter, by looking into all scopes.
protected static boolean	isParameter(BaseDataType key) Check if the BaseDataType passed as parameter is used for lookup of an OUTPUT parameter.
protected boolean	isTableField() Check if this parameter is associated with a table field, so a batch assign is required on output parameter processing.
protected static BaseDataType	postProcessOutput(AbstractSimpleParameter origAssigner, BaseDataType var) Post-process the OUTPUT parameter - if a conversion constructor was registered, then create a VariableAssigner.
protected abstract void	release() Release all the callee's resources for this parameter, after assignment has taken place.
protected static void	replaceParameter(BaseDataType[] old, BaseDataType[] other) Replace the extent array parameter reference (not the original argument) with the new one.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOG

protected static final CentralLogger LOG

Logger

context

protected static final ContextLocal<AbstractParameter.WorkArea> context

Object which manages all instances of this class by context.

Constructor Detail

AbstractParameter

public AbstractParameter()

Default constructor - register the scopeable instance as pending for the next started block.

Method Detail

release

protected abstract void release()

Release all the callee's resources for this parameter, after assignment has taken place.

getScopeable

public static Scopeable getScopeable()

Retrieve a Scopeable for the current context. This allows an external object to notify this class' current context of scope open and close events.

Returns:

Context local Scopeable.

getCurrentScope

public static AbstractParameter.Scope getCurrentScope()

Obtain the current scope from the current context.

Returns:

current scope from the current context

postProcessOutput

protected static BaseDataType postProcessOutput(AbstractSimpleParameter origAssigner,
                                                BaseDataType var)

Post-process the OUTPUT parameter - if a conversion constructor was registered, then create a VariableAssigner.

Also, normalize the AbstractSimpleParameter.outputValue so that the called method will use a real BDT sub-type, and not an anonymous class.

Parameters:

origAssigner - The assigner created bdt the BDT anonymous class.

var - The variable to be passed as parameter.

Returns:

The normalized instance to be used as a parameter at the method.

isParameter

protected static boolean isParameter(BaseDataType key)

Check if the BaseDataType passed as parameter is used for lookup of an OUTPUT parameter.

Parameters:

key - The variable for lookup in the current scope.

Returns:

true if the content of key will be assigned back on return with success.

isExtentParameter

protected static boolean isExtentParameter(BaseDataType[] key)

Check if the given array reference was passed as a parameter, by looking into all scopes.

Parameters:

key - The array reference.

Returns:

See above.

replaceParameter

protected static void replaceParameter(BaseDataType[] old,
                                       BaseDataType[] other)

Replace the extent array parameter reference (not the original argument) with the new one. This is required in cases when the parameter is resized by the top-level block.

Parameters:

old - The previous array parameter reference.

other - The new reference.

getLocalParam

protected BaseDataType getLocalParam()

Get the variable container used as parameter inside the procedure body. It makes sense only for simple parameters.

Returns:

null. Implementing classes will return the proper field.

canRelease

protected boolean canRelease(BaseDataType bdt)

Check if the parameter can release its resources.

Parameters:

bdt - The parameter instance.

Returns:

true if the parameter can be released.

isTableField

protected boolean isTableField()

Check if this parameter is associated with a table field, so a batch assign is required on output parameter processing.

Returns:

Always false.