com.goldencode.p2j.util

Class TableParameter

java.lang.Object

com.goldencode.p2j.util.TableParameter

Direct Known Subclasses:

InputOutputTableHandle, InputOutputTableParameter, InputTableHandle, InputTableParameter, OutputTableHandle, OutputTableParameter

public class TableParameter
extends java.lang.Object

Represents a table or table-handle parameter, the mode (INPUT, INPUT-OUTPUT or OUTPUT) and any table parameter options (APPEND, BY-VALUE, BIND or BY-REFERENCE). Allows subclasses to specialize this behavior. A core feature is to implement interchangeability between TABLE and TABLE-HANDLE parameters (in the 4GL you can pass a TABLE parameter to a procedure that takes TABLE-HANDLE and vice versa).

The parameter mode can be implemented in this class or it can be overridden in a subclass. If it is implemented here, then the input and output flags must be passed to the constructor. If the subclass overrides the isInputMode() and isOutputMode() methods then the input and output boolean members will be ignored. This is sub-optimal but it was done deliberately to enable the base class to be used as a full replacement for any of the subclasses.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	input true if the parameter mode is INPUT or INPUT-OUTPUT.
private boolean	isTableHandle Flag indicating this is a TABLE-HANDLE argument.
private java.util.EnumSet<ParameterOption>	options Table parameter option (APPEND, BY-VALUE, BIND or BY-REFERENCE).
private boolean	output true if the parameter mode is OUTPUT or INPUT-OUTPUT.
private int	parameterIndex 1-based index of the table parameter (in declaration of the function).
private boolean	remoteParameter Determines if this is a remote (passed to appserver) parameter.
private TableWrapper	resultSet Calling- or called-side result set (for remote parameters).
private int	schemaMarshalLevel Table SCHEMA-MARSHAL attribute value encodes as int
private Temporary	table Buffer of the wrapped table.
private handle	tableHandle Table handle.

Constructor Summary

Constructors

Constructor and Description
TableParameter(handle tableHandle) Create an instance using a table handle.
TableParameter(handle tableHandle, java.util.EnumSet<ParameterOption> options) Create an instance using a table handle.
TableParameter(handle tableHandle, java.util.EnumSet<ParameterOption> options, boolean input, boolean output) Create an instance using a table handle.
TableParameter(handle tableHandle, ParameterOption option) Create an instance using a table handle.
TableParameter(handle tableHandle, ParameterOption option, boolean input, boolean output) Create an instance using a table handle.
TableParameter(TableWrapper resultSet) Create an instance using a result set (for remote parameters).
TableParameter(TableWrapper resultSet, java.util.EnumSet<ParameterOption> options, boolean input, boolean output) Create an instance using a result set (for remote parameters).
TableParameter(TableWrapper resultSet, ParameterOption option) Create an instance using a result set (for remote parameters).
TableParameter(TableWrapper resultSet, ParameterOption option, boolean input, boolean output) Create an instance using a result set (for remote parameters).
TableParameter(Temporary table) Create an instance using a buffer.
TableParameter(Temporary table, java.util.EnumSet<ParameterOption> options) Create an instance using a buffer.
TableParameter(Temporary table, java.util.EnumSet<ParameterOption> options, boolean input, boolean output) Create an instance using a buffer.
TableParameter(Temporary table, ParameterOption option) Create an instance using a buffer.
TableParameter(Temporary table, ParameterOption option, boolean input, boolean output) Create an instance using a buffer.

Method Summary

Modifier and Type	Method and Description
int	getParameterIndex() Get 1-based index of the table parameter (in declaration of the function).
java.util.EnumSet<ParameterOption>	getParameterOptions() Get the table parameter options for this argument.
TableWrapper	getResultSet() Get the result set (for remote parameters).
int	getSchemaMarshalLevel() Get encoded table SCHEMA-MARSHAL attribute value.
Temporary	getTable() Get the buffer of the wrapped table.
handle	getTableHandle() Get the table-handle which references the wrapped table.
boolean	isAppend() Determines if the APPEND option was specified on the calling side.
boolean	isBind() Determines if the BIND option was specified on the calling side.
boolean	isByReference() Determines if the BY-REFERENCE option was specified on the calling side.
boolean	isByValue() Determines if the BY-VALUE option was specified on the calling side.
boolean	isInputMode() Determines if this parameter is INPUT or INPUT-OUTPUT.
boolean	isOutputMode() Determines if this parameter is OUTPUT or INPUT-OUTPUT.
boolean	isRemoteParameter() Determines if this is a remote parameter.
boolean	isTableHandle() Get the state of the isTableHandle flag.
boolean	isValid() Return true if the table parameter is valid.
void	setInputMode(boolean input) Set the flag for whether this parameter is INPUT or INPUT-OUTPUT.
void	setOutputMode(boolean output) Set the flag for whether this parameter is OUTPUT or INPUT-OUTPUT.
void	setParameterIndex(int parameterIndex) Set 1-based index of the table parameter (in declaration of the function).
void	setParameterOptions(java.util.EnumSet<ParameterOption> options) Set the table parameter options for this argument.
void	setResultSet(TableWrapper resultSet) Set the result set (for remote parameters).
void	setTable(Temporary table) Set the parameter's table.

Methods inherited from class java.lang.Object

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

Field Detail

table

private Temporary table

Buffer of the wrapped table.

tableHandle

private final handle tableHandle

Table handle.

options

private java.util.EnumSet<ParameterOption> options

Table parameter option (APPEND, BY-VALUE, BIND or BY-REFERENCE).

resultSet

private TableWrapper resultSet

Calling- or called-side result set (for remote parameters).

remoteParameter

private boolean remoteParameter

Determines if this is a remote (passed to appserver) parameter.

input

private boolean input

true if the parameter mode is INPUT or INPUT-OUTPUT.

output

private boolean output

true if the parameter mode is OUTPUT or INPUT-OUTPUT.

schemaMarshalLevel

private int schemaMarshalLevel

Table SCHEMA-MARSHAL attribute value encodes as int

isTableHandle

private boolean isTableHandle

Flag indicating this is a TABLE-HANDLE argument.

parameterIndex

private int parameterIndex

1-based index of the table parameter (in declaration of the function). 0 if it is not defined.

Constructor Detail

TableParameter

public TableParameter(Temporary table)

Create an instance using a buffer.

Parameters:

table - Buffer of the wrapped table.

TableParameter

public TableParameter(Temporary table,
                      ParameterOption option)

Create an instance using a buffer.

Parameters:

table - Buffer of the wrapped table.

option - Table parameter option (APPEND, BY-VALUE, BIND or BY-REFERENCE).

TableParameter

public TableParameter(Temporary table,
                      java.util.EnumSet<ParameterOption> options)

Create an instance using a buffer.

Parameters:

table - Buffer of the wrapped table.

options - Table parameter options (APPEND, BY-VALUE, BIND or BY-REFERENCE).

TableParameter

public TableParameter(Temporary table,
                      ParameterOption option,
                      boolean input,
                      boolean output)

Create an instance using a buffer.

Parameters:

table - Buffer of the wrapped table.

option - Table parameter option (APPEND, BY-VALUE, BIND or BY-REFERENCE).

input - true if the parameter mode is INPUT or INPUT-OUTPUT.

output - true if the parameter mode is OUTPUT or INPUT-OUTPUT.

TableParameter

public TableParameter(Temporary table,
                      java.util.EnumSet<ParameterOption> options,
                      boolean input,
                      boolean output)

Create an instance using a buffer.

Parameters:

table - Buffer of the wrapped table.

options - Table parameter options (APPEND, BY-VALUE, BIND or BY-REFERENCE).

input - true if the parameter mode is INPUT or INPUT-OUTPUT.

output - true if the parameter mode is OUTPUT or INPUT-OUTPUT.

TableParameter

public TableParameter(handle tableHandle)

Create an instance using a table handle.

Parameters:

tableHandle - Handle to the wrapped table.

TableParameter

public TableParameter(handle tableHandle,
                      ParameterOption option)

Create an instance using a table handle.

Parameters:

tableHandle - Handle to the wrapped table.

option - Table parameter option (APPEND, BY-VALUE, BIND or BY-REFERENCE).

TableParameter

public TableParameter(handle tableHandle,
                      java.util.EnumSet<ParameterOption> options)

Create an instance using a table handle.

Parameters:

tableHandle - Handle to the wrapped table.

options - Table parameter options (APPEND, BY-VALUE, BIND or BY-REFERENCE).

TableParameter

public TableParameter(handle tableHandle,
                      ParameterOption option,
                      boolean input,
                      boolean output)

Create an instance using a table handle.

Parameters:

tableHandle - Handle to the wrapped table.

option - Table parameter option (APPEND, BY-VALUE, BIND or BY-REFERENCE).

input - true if the parameter mode is INPUT or INPUT-OUTPUT.

output - true if the parameter mode is OUTPUT or INPUT-OUTPUT.

TableParameter

public TableParameter(handle tableHandle,
                      java.util.EnumSet<ParameterOption> options,
                      boolean input,
                      boolean output)

Create an instance using a table handle.

Parameters:

tableHandle - Handle to the wrapped table.

options - Table parameter options (APPEND, BY-VALUE, BIND or BY-REFERENCE).

input - true if the parameter mode is INPUT or INPUT-OUTPUT.

output - true if the parameter mode is OUTPUT or INPUT-OUTPUT.

TableParameter

public TableParameter(TableWrapper resultSet)

Create an instance using a result set (for remote parameters).

Parameters:

resultSet - Result set containing input data.

TableParameter

public TableParameter(TableWrapper resultSet,
                      ParameterOption option)

Create an instance using a result set (for remote parameters).

Parameters:

resultSet - Result set containing input data.

option - Table parameter option (APPEND, BY-VALUE, BIND or BY-REFERENCE).

TableParameter

public TableParameter(TableWrapper resultSet,
                      ParameterOption option,
                      boolean input,
                      boolean output)

Create an instance using a result set (for remote parameters).

Parameters:

resultSet - Result set containing input data.

option - Table parameter option (APPEND, BY-VALUE, BIND or BY-REFERENCE).

input - true if the parameter mode is INPUT or INPUT-OUTPUT.

output - true if the parameter mode is OUTPUT or INPUT-OUTPUT.

TableParameter

public TableParameter(TableWrapper resultSet,
                      java.util.EnumSet<ParameterOption> options,
                      boolean input,
                      boolean output)

Create an instance using a result set (for remote parameters).

Parameters:

resultSet - Result set containing input data.

options - Table parameter options (APPEND, BY-VALUE, BIND or BY-REFERENCE).

input - true if the parameter mode is INPUT or INPUT-OUTPUT.

output - true if the parameter mode is OUTPUT or INPUT-OUTPUT.

Method Detail

isTableHandle

public boolean isTableHandle()

Get the state of the isTableHandle flag.

Returns:

See above.

isInputMode

public boolean isInputMode()

Determines if this parameter is INPUT or INPUT-OUTPUT.

Returns:

true if this is INPUT or INPUT-OUTPUT.

setInputMode

public void setInputMode(boolean input)

Set the flag for whether this parameter is INPUT or INPUT-OUTPUT.

Parameters:

input - true if this is INPUT or INPUT-OUTPUT.

isOutputMode

public boolean isOutputMode()

Determines if this parameter is OUTPUT or INPUT-OUTPUT.

Returns:

true if this is OUTPUT or INPUT-OUTPUT.

setOutputMode

public void setOutputMode(boolean output)

Set the flag for whether this parameter is OUTPUT or INPUT-OUTPUT.

Parameters:

output - true if this is OUTPUT or INPUT-OUTPUT.

isRemoteParameter

public boolean isRemoteParameter()

Determines if this is a remote parameter.

Returns:

true if this is a remote parameter, false if this is a local parameter.

getResultSet

public TableWrapper getResultSet()

Get the result set (for remote parameters).

Returns:

Result set.

setResultSet

public void setResultSet(TableWrapper resultSet)

Set the result set (for remote parameters).

Parameters:

resultSet - Result set, normally containing output data.

getTableHandle

public handle getTableHandle()

Get the table-handle which references the wrapped table.

Returns:

The table-handle (contains the wrapped table).

setTable

public void setTable(Temporary table)

Set the parameter's table.

Parameters:

table - The table

getTable

public Temporary getTable()

Get the buffer of the wrapped table.

Returns:

buffer of the wrapped table.

isAppend

public boolean isAppend()

Determines if the APPEND option was specified on the calling side.

Returns:

true if the APPEND option was specified on the calling side.

isByValue

public boolean isByValue()

Determines if the BY-VALUE option was specified on the calling side.

Returns:

true if the BY-VALUE option was specified on the calling side.

isBind

public boolean isBind()

Determines if the BIND option was specified on the calling side.

Returns:

true if the BIND option was specified on the calling side.

isByReference

public boolean isByReference()

Determines if the BY-REFERENCE option was specified on the calling side.

Returns:

true if the BY-REFERENCE option was specified on the calling side.

getParameterOptions

public java.util.EnumSet<ParameterOption> getParameterOptions()

Get the table parameter options for this argument.

Returns:

The table parameter options.

setParameterOptions

public void setParameterOptions(java.util.EnumSet<ParameterOption> options)

Set the table parameter options for this argument.

Parameters:

options - The table parameter options.

getParameterIndex

public int getParameterIndex()

Get 1-based index of the table parameter (in declaration of the function).

Returns:

1-based index of the table parameter or 0 if it is not defined.

getSchemaMarshalLevel

public int getSchemaMarshalLevel()

Get encoded table SCHEMA-MARSHAL attribute value.

Returns:

encoded table SCHEMA-MARSHAL attribute value.

setParameterIndex

public void setParameterIndex(int parameterIndex)

Set 1-based index of the table parameter (in declaration of the function).

Parameters:

parameterIndex - 1-based index of the table parameter.

isValid

public boolean isValid()

Return true if the table parameter is valid. It can be invalid, say, if an unknown table handle has been assigned to it.

Returns:

true if the table parameter is valid.