ArrayAssigner.WorkArea (P2J - Progress 4GL to Java Conversion and Runtime)

java.lang.Object
- com.goldencode.p2j.util.ArrayAssigner.WorkArea

All Implemented Interfaces:

Scopeable

Enclosing class:

ArrayAssigner
```
private static class ArrayAssigner.WorkArea
extends java.lang.Object
implements Scopeable
```
Stores global data relating to the state of the current context.

Field Summary

Fields
Modifier and Type	Field and Description
`private java.util.Map<BaseDataType[],java.lang.Boolean>`	`dynamicArrayCaseSens` Map of text dynamic array case-sensitive.
`private java.util.Map<BaseDataType[],java.lang.Integer>`	`dynamicArrayPrecisions` Map of decimal dynamic array precisions.
`private java.util.Deque<java.util.Set<BaseDataType[]>>`	`dynamicArrays` Stack of dynamic-extent arrays, per each scope.
`private java.util.Map<object<? extends _BaseObject_>[],java.lang.Class<? extends _BaseObject_>>`	`dynamicArrayType` Mapping of the dynamic extent underlying 4GL class type - required when setting the size of this array.
`private java.util.Map<java.lang.Object,java.util.Deque<java.util.Map<BaseDataType[],java.lang.Integer>>>`	`dynamicUndoableArrays` Stack of undoable dynamic-extent arrays, per each scope and each external program.
`private java.util.Deque<java.util.Map<BaseDataType[],AbstractExtentParameter<?>>>`	`extentParameters` Map of extent parameter instances
`private java.util.Set<BaseDataType[]>`	`pendingDynamicArrays` The dynamic arrays declared before the next top-level block will start, to be registered with it.
`private java.util.Map<BaseDataType[],AbstractExtentParameter<?>>`	`pendingExtentParameters` The extent arguments to be passed to the next top-level block, to be registered with it.
`private java.util.Map<java.lang.Object,java.util.Set<BaseDataType[]>>`	`persistentProcDynArrays` Map of dynamic arrays created in a persistent program.
`private ProcedureManager.ProcedureHelper`	`pm` Helper to use the ProcedureManager without any context local lookups.
`private TransactionManager.TransactionHelper`	`tm` Helper to use the TM without any context local lookups.

Constructor Summary

Constructors
Constructor and Description

WorkArea()

Constructors
Constructor and Description
`WorkArea()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Boolean`	`getCaseSensitive(Text[] array)` Retrieve the case sensitivity of the supplied array or `null` if case sens was not previously set for the array argument.
`java.lang.Integer`	`getDecimalPrecision(decimal[] array)` Retrieve the decimal precision of the supplied array or `null` if precision was not previously set for the array argument.
`<T extends BaseDataType> AbstractExtentParameter<T>`	`getExtentParameter(BaseDataType[] array)` Returns a previously registered extent parameter instance, see `registerExtentParameter(AbstractExtentParameter)` for more info.
`ScopeId`	`getScopeId()` Get the `ScopeId` for the instance.
`boolean`	`isRegistered(BaseDataType[] array)` Returns `true` if the supplied array argument has been previously registered, `false` otherwise.
`void`	`register(BaseDataType[] array)` Register the given `array` as a dynamic-extent array.
`void`	`register(BaseDataType[] array, boolean pending)` Register the given `array` as a dynamic-extent array.
`void`	`registerDynamicUndoable(java.util.Set<BaseDataType[]> arrays, int transLevel)` Register the set of given arrays as dynamic extent.
`<T extends BaseDataType> void`	`registerExtentParameter(AbstractExtentParameter<T> extentParameter)` Registers an unfixed indeterminate extent parameter instance into the current scope.
`void`	`reRegister(BaseDataType[] oldArray, BaseDataType[] newArray, ArrayAssigner.WorkArea wa)` Deregisters `oldArray` and registers `newArray` into the scope previously occupied by `oldArray`.
`void`	`scopeDeleted()` Provides a notification that an external scope is about to be deleted.
`void`	`scopeFinished()` Provides a notification that a scope is about to be exited.
`void`	`scopeStart(BlockDefinition block)` Provides a notification that a new scope is about to be entered.
`void`	`setCaseSensitive(Text[] array, boolean caseSens)` Sets case sensitivity for the array argument.
`void`	`setDecimalPrecision(decimal[] array, int precision)` Sets decimal precision for the array argument.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - pm
```
private final ProcedureManager.ProcedureHelper pm
```
    Helper to use the ProcedureManager without any context local lookups.
  - tm
```
private TransactionManager.TransactionHelper tm
```
    Helper to use the TM without any context local lookups.
  - dynamicArrays
```
private java.util.Deque<java.util.Set<BaseDataType[]>> dynamicArrays
```
    Stack of dynamic-extent arrays, per each scope.
  - pendingDynamicArrays
```
private java.util.Set<BaseDataType[]> pendingDynamicArrays
```
    The dynamic arrays declared before the next top-level block will start, to be registered with it.
  - dynamicUndoableArrays
```
private java.util.Map<java.lang.Object,java.util.Deque<java.util.Map<BaseDataType[],java.lang.Integer>>> dynamicUndoableArrays
```
    Stack of undoable dynamic-extent arrays, per each scope and each external program.
  - dynamicArrayPrecisions
```
private java.util.Map<BaseDataType[],java.lang.Integer> dynamicArrayPrecisions
```
    Map of decimal dynamic array precisions.
  - dynamicArrayCaseSens
```
private java.util.Map<BaseDataType[],java.lang.Boolean> dynamicArrayCaseSens
```
    Map of text dynamic array case-sensitive.
  - pendingExtentParameters
```
private java.util.Map<BaseDataType[],AbstractExtentParameter<?>> pendingExtentParameters
```
    The extent arguments to be passed to the next top-level block, to be registered with it.
  - extentParameters
```
private java.util.Deque<java.util.Map<BaseDataType[],AbstractExtentParameter<?>>> extentParameters
```
    Map of extent parameter instances
  - dynamicArrayType
```
private java.util.Map<object<? extends _BaseObject_>[],java.lang.Class<? extends _BaseObject_>> dynamicArrayType
```
    Mapping of the dynamic extent underlying 4GL class type - required when setting the size of this array.
  - persistentProcDynArrays
```
private java.util.Map<java.lang.Object,java.util.Set<BaseDataType[]>> persistentProcDynArrays
```
    Map of dynamic arrays created in a persistent program.
- Constructor Detail
  - WorkArea
```
public WorkArea()
```
- Method Detail
  - scopeStart
```
public void scopeStart(BlockDefinition block)
```
    Description copied from interface: Scopeable
    
    Provides a notification that a new scope is about to be entered.
    
    Specified by:
    
    scopeStart in interface Scopeable
    
    Parameters:
    
    block - The explicit block definition which required this notification.
  - scopeDeleted
```
public void scopeDeleted()
```
    Description copied from interface: Scopeable
    
    Provides a notification that an external scope is about to be deleted.
    
    Specified by:
    
    scopeDeleted in interface Scopeable
  - scopeFinished
```
public void scopeFinished()
```
    Description copied from interface: Scopeable
    
    Provides a notification that a scope is about to be exited.
    
    Specified by:
    
    scopeFinished in interface Scopeable
  - getScopeId
```
public ScopeId getScopeId()
```
    Get the ScopeId for the instance.
    
    Specified by:
    
    getScopeId in interface Scopeable
    
    Returns:
    
    ScopeId.ARRAY_ASSIGNER.
  - isRegistered
```
public boolean isRegistered(BaseDataType[] array)
```
    Returns true if the supplied array argument has been previously registered, false otherwise.
    
    Parameters:
    
    array - A valid array instance.
    
    Returns:
    
    See above.
  - register
```
public void register(BaseDataType[] array)
```
    Register the given array as a dynamic-extent array. If the array is already registered the method doesn't register it again and simply returns.
    The registration of this array will be done in the current block - the API is executed only by legacy APIs which are executed within the top-level block.
    
    Parameters:
    
    array - The dynamic-extent array reference, must not be null.
  - register
```
public void register(BaseDataType[] array,
                     boolean pending)
```
    Register the given array as a dynamic-extent array. If the array is already registered the method doesn't register it again and simply returns.
    
    Parameters:
    
    array - The dynamic-extent array reference, must not be null.
    
    pending - Flag indicating if the copy is pending (as the call is made before the top-level block starts).
  - registerDynamicUndoable
```
public void registerDynamicUndoable(java.util.Set<BaseDataType[]> arrays,
                                    int transLevel)
```
    Register the set of given arrays as dynamic extent.
    
    Parameters:
    
    arrays - The set of dynamic arrays to register.
    
    transLevel - The transaction nesting level where this instance was created.
  - reRegister
```
public void reRegister(BaseDataType[] oldArray,
                       BaseDataType[] newArray,
                       ArrayAssigner.WorkArea wa)
```
    Deregisters oldArray and registers newArray into the scope previously occupied by oldArray.
    
    Parameters:
    
    oldArray - A valid array instance.
    
    newArray - A valid array instance.
    
    wa - The ArrayAssigner.WorkArea instance.
  - getDecimalPrecision
```
public java.lang.Integer getDecimalPrecision(decimal[] array)
```
    Retrieve the decimal precision of the supplied array or null if precision was not previously set for the array argument.
    
    Parameters:
    
    array - Array representing an extent variable.
    
    Returns:
    
    The decimal precision value or null, see above.
  - getCaseSensitive
```
public java.lang.Boolean getCaseSensitive(Text[] array)
```
    Retrieve the case sensitivity of the supplied array or null if case sens was not previously set for the array argument.
    
    Parameters:
    
    array - Array representing an extent variable.
    
    Returns:
    
    The case sensitivity value or null, see above.
  - setDecimalPrecision
```
public void setDecimalPrecision(decimal[] array,
                                int precision)
```
    Sets decimal precision for the array argument.
    
    Parameters:
    
    array - The array to be set with the supplied precision.
    
    precision - Decimal precision to be set for the supplied array.
  - setCaseSensitive
```
public void setCaseSensitive(Text[] array,
                             boolean caseSens)
```
    Sets case sensitivity for the array argument.
    
    Parameters:
    
    array - The array to be set with the supplied case sensitivity.
    
    caseSens - Case sensitivity to be set for the supplied array.
  - registerExtentParameter
```
public <T extends BaseDataType> void registerExtentParameter(AbstractExtentParameter<T> extentParameter)
```
    Registers an unfixed indeterminate extent parameter instance into the current scope. The registered instance will be automatically unregistered when the scope is finished. The method will use the return value of AbstractExtentParameter.getParameter() as the registration key. To get the registered instance back, use that reference in the call to getExtentParameter(BaseDataType[]).
    
    Parameters:
    
    extentParameter - An extent parameter instance.
  - getExtentParameter
```
public <T extends BaseDataType> AbstractExtentParameter<T> getExtentParameter(BaseDataType[] array)
```
    Returns a previously registered extent parameter instance, see registerExtentParameter(AbstractExtentParameter) for more info.
    
    Parameters:
    
    array - A valid dynamic array instance.
    
    Returns:
    
    An extent parameter instance.

Class ArrayAssigner.WorkArea

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

pm

tm

dynamicArrays

pendingDynamicArrays

dynamicUndoableArrays

dynamicArrayPrecisions

dynamicArrayCaseSens

pendingExtentParameters

extentParameters

dynamicArrayType

persistentProcDynArrays

Constructor Detail

WorkArea

Method Detail

scopeStart

scopeDeleted

scopeFinished

getScopeId

isRegistered

register

register

registerDynamicUndoable

reRegister

getDecimalPrecision

getCaseSensitive

setDecimalPrecision

setCaseSensitive

registerExtentParameter

getExtentParameter