com.goldencode.p2j.util

Class RcodeInfoOps

java.lang.Object

com.goldencode.p2j.util.RcodeInfoOps

public class RcodeInfoOps
extends java.lang.Object

Utility for working with RCODE-INFO system handle that lets you read information about r-code files.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	RcodeInfoOps.LegacyProgramInfo Details about the r-code information for a legacy program or class.
private static class	RcodeInfoOps.WorkArea Stores global data relating to the state of the current context.

Field Summary

Fields

Modifier and Type	Field and Description
private static ContextLocal<RcodeInfoOps.WorkArea>	local Stores context-local state variables.

Constructor Summary

Constructors

Constructor and Description
RcodeInfoOps()

Method Summary

Modifier and Type	Method and Description
static handle	asHandle() Get the RCODE-INFO system handle.
static character	getCodePage() Get the CODEPAGE attribute referenced by the target r-code file.
static character	getCrcVal() Get the cyclic redundancy check (CRC) value for an r-code file.
static character	getDbReferences() Get the list of the databases, referenced by the target r-code file.
static character	getFileName() Get the name of the target r-code file.
static character	getLanuages() Get a comma-separated list of all languages compiled into the r-code file.
static character	getMD5Val() Get the MD5 value stored in an r-code file.
static character	getRCodeDisplayType() Get the type of display for an r-code file.
static character	getTableCrcList() Get a comma-separated list of the CRC value for each table referenced in the r-code file
static character	getTableList() Get the list of the tables, referenced by the r-code file.
static character	getUndoThrowScope() Check if UNDO, THROW has been set as the default error handling directive at either the routine level or the block level
static java.lang.Long	id() Get this resource's ID.
static void	id(long id) Set this resource's ID.
static void	initFileInfo(character fileName) Set the name of the target r-code file.
static void	initFileInfo(java.lang.String fileName) Set the name of the target r-code file.
static logical	isClass() Definition of the IS-CLASS method.
static logical	isLabelsHaveColons() Check whether the r-code was compiled with the -nocolon startup parameter in effect.
static void	readOnlyError(java.lang.String attribute) API needed to implement read-only attribute assignment (a 4GL "feature").
static void	readOnlyError(java.lang.String attribute, java.lang.Object expr) API needed to implement read-only attribute assignment (a 4GL "feature").
(package private) static java.lang.String	resolveDbReferences(java.lang.Class<?> cls) Read the DatabaseReferences annotation from the Java class and get the list of the logical database names or aliases.
(package private) static boolean	resolveIsClass(java.lang.Class<?> cls) Check if the given Java class is compatible with legacy, converted classes - in other words, if it implements the _BaseObject_ interface.
(package private) static java.lang.String	resolveTableList(java.lang.Class<?> cls) Read the DatabaseReferences annotation from the Java class and get the list of tables.
static character	resourceType() Get the type of its associated handle.
static void	setCodePage(character cp) Attempt to set the CODEPAGE attribute referenced by the target r-code file.
static boolean	unknown() Implementation for the WrappedResource.unknown() API.
static boolean	valid() Implementation for the WrappedResource.valid() API.

Methods inherited from class java.lang.Object

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

Field Detail

local

private static ContextLocal<RcodeInfoOps.WorkArea> local

Stores context-local state variables.

Constructor Detail

RcodeInfoOps

public RcodeInfoOps()

Method Detail

asHandle

public static handle asHandle()

Get the RCODE-INFO system handle.

Returns:

RCODE-INFO system handle.

getFileName

public static character getFileName()

Get the name of the target r-code file.

Returns:

the name of the target r-code file.

initFileInfo

public static void initFileInfo(character fileName)

Set the name of the target r-code file.

Parameters:

fileName - The name of the target r-code file.

initFileInfo

public static void initFileInfo(java.lang.String fileName)

Set the name of the target r-code file.

Parameters:

fileName - The name of the target r-code file.

getDbReferences

public static character getDbReferences()

Get the list of the databases, referenced by the target r-code file.

Returns:

comma-separated list of the databases (in the form of logical database names or aliases), referenced by the target r-code file.

getTableList

public static character getTableList()

Get the list of the tables, referenced by the r-code file.

Returns:

comma-separated list of the tables (in the form of schema.table), referenced by the r-code file.

isClass

public static logical isClass()

Definition of the IS-CLASS method.

Returns:

true if the current program is a NEW-ly created object.

getCodePage

public static character getCodePage()

Get the CODEPAGE attribute referenced by the target r-code file.

Returns:

The current CODEPAGE attribute for handle referenced by the target r-code file.

getTableCrcList

public static character getTableCrcList()

Get a comma-separated list of the CRC value for each table referenced in the r-code file

Returns:

a comma-separated list of the CRC value for each table referenced in the r-code file

getCrcVal

public static character getCrcVal()

Get the cyclic redundancy check (CRC) value for an r-code file.

Returns:

the cyclic redundancy check (CRC) value for an r-code file/

getRCodeDisplayType

public static character getRCodeDisplayType()

Get the type of display for an r-code file.

Returns:

the type of display for an r-code file.

isLabelsHaveColons

public static logical isLabelsHaveColons()

Check whether the r-code was compiled with the -nocolon startup parameter in effect.

Returns:

true if the r-code was compiled with the -nocolon startup parameter in effect.

getLanuages

public static character getLanuages()

Get a comma-separated list of all languages compiled into the r-code file.

Returns:

a comma-separated list of all languages compiled into the r-code file.

getMD5Val

public static character getMD5Val()

Get the MD5 value stored in an r-code file.

Returns:

the MD5 value stored in an r-code file as a 32 character hexadecimal number.

getUndoThrowScope

public static character getUndoThrowScope()

Check if UNDO, THROW has been set as the default error handling directive at either the routine level or the block level

Returns:

"ROUTINE-LEVEL", or "BLOCK-LEVEL" to indicate which blocks are affected by UNDO, THROW error handling. It returns the empty string ("") when default error handling is in effect

setCodePage

public static void setCodePage(character cp)

Attempt to set the CODEPAGE attribute referenced by the target r-code file. This method always throws error 4052 because this attribute is readonly.

Parameters:

cp - The current CODEPAGE to be set.

readOnlyError

public static void readOnlyError(java.lang.String attribute)

API needed to implement read-only attribute assignment (a 4GL "feature").

Parameters:

attribute - The attribute's name.

See Also:

handle.readOnlyError(handle, String)

readOnlyError

public static void readOnlyError(java.lang.String attribute,
                                 java.lang.Object expr)

API needed to implement read-only attribute assignment (a 4GL "feature").

Parameters:

attribute - The attribute's name.

expr - The value which is attempted to be assigned to the read-only attribute.

See Also:

handle.readOnlyError(handle, String, Object)

resourceType

public static character resourceType()

Get the type of its associated handle.

Returns:

Always return the PSEUDO-WIDGET value.

valid

public static boolean valid()

Implementation for the WrappedResource.valid() API.

Returns:

Always true.

id

public static java.lang.Long id()

Get this resource's ID.

Returns:

The resource's ID.

id

public static void id(long id)

Set this resource's ID.

This is a no-op for system handles.

Parameters:

id - The resource's ID.

unknown

public static boolean unknown()

Implementation for the WrappedResource.unknown() API.

Returns:

Always false.

resolveIsClass

static boolean resolveIsClass(java.lang.Class<?> cls)

Check if the given Java class is compatible with legacy, converted classes - in other words, if it implements the _BaseObject_ interface.

Parameters:

cls - The type to check.

Returns:

See above.

resolveDbReferences

static java.lang.String resolveDbReferences(java.lang.Class<?> cls)

Read the DatabaseReferences annotation from the Java class and get the list of the logical database names or aliases. If the annotation does not exist, return the empty string.

Parameters:

cls - The Java class for a converted external program or legacy class.

Returns:

See above.

resolveTableList

static java.lang.String resolveTableList(java.lang.Class<?> cls)

Read the DatabaseReferences annotation from the Java class and get the list of tables. If the annotation does not exist, return the empty string.

Parameters:

cls - The Java class for a converted external program or legacy class.

Returns:

See above.