com.goldencode.p2j.persist

Class DataSetParameter

java.lang.Object

com.goldencode.p2j.persist.DataSetParameter

Direct Known Subclasses:

InputDataSetHandle, InputDataSetParameter, InputOutputDataSetHandle, InputOutputDataSetParameter, OutputDataSetHandle, OutputDataSetParameter

public class DataSetParameter
extends java.lang.Object

Represents a dataset or dataset-handle parameter, the mode (INPUT, INPUT-OUTPUT or OUTPUT) and any parameter options (APPEND, BY-VALUE, BIND or BY-REFERENCE). Allows subclasses to specialize this behavior. A core feature is to implement interchangeability between DATASET and DATASET-HANDLE parameters (in the 4GL you can pass a DATASET parameter to a procedure that takes DATASET-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 handle	dataset Reference of the wrapped dataset.
private DatasetWrapper	datasetWrapper Calling- or called-side result set (for remote parameters).
private boolean	input true if the parameter mode is INPUT or INPUT-OUTPUT.
private boolean	isOriginalDataSetProxy true if the original dataset is a Proxy
private java.util.EnumSet<ParameterOption>	options Parameter passing mode APPEND, BY-VALUE, BIND or BY-REFERENCE option.
private DataSet	originalDataSet The original dataset passed as an argument.
private boolean	output true if the parameter mode is OUTPUT or INPUT-OUTPUT.
private int	parameterIndex 1-based index of the dataset parameter (in declaration of the function).
private boolean	remoteParameter Determines if this is a remote (passed to appserver) parameter.

Constructor Summary

Constructors

Constructor and Description
DataSetParameter(DataSet dataset) Create an instance using a dataset reference.
DataSetParameter(DataSet dataset, java.util.EnumSet<ParameterOption> options) Create an instance using a dataset reference.
DataSetParameter(DataSet dataset, java.util.EnumSet<ParameterOption> options, boolean input, boolean output) Create an instance using a dataset reference.
DataSetParameter(DataSetParameter dataset) Create an instance using a dataset reference.
DataSetParameter(DataSet dataset, ParameterOption option) Create an instance using a dataset reference.
DataSetParameter(DataSet dataset, ParameterOption option, boolean input, boolean output) Create an instance using a dataset reference.
DataSetParameter(DatasetWrapper wrapper) Create a new parameter for the REMOTE dataset.
DataSetParameter(handle dsHandle) Create an instance using a dataset handle.
DataSetParameter(handle dsHandle, java.util.EnumSet<ParameterOption> options) Create an instance using a dataset handle.
DataSetParameter(handle dsHandle, java.util.EnumSet<ParameterOption> options, boolean input, boolean output) Create an instance using a dataset handle.
DataSetParameter(handle dsHandle, ParameterOption option) Create an instance using a dataset handle.
DataSetParameter(handle dsHandle, ParameterOption option, boolean input, boolean output) Create an instance using a dataset handle.

Method Summary

Modifier and Type	Method and Description
void	createDataSet(DatasetWrapper wrapper) Create a new DATASET resource from the specified wrapper, and save it in the dataset handle.
handle	get() Obtain the DataSet handle.
DataSet	getDataset() Returns the unwrapped dataset instance.
handle	getDatasetHandle() Returns the wrapped dataset instance.
DatasetWrapper	getDatasetWrapper() Get the datasetWrapper.
DataSet	getOriginalDataSet() Get the original dataset, as passed by the caller.
int	getParameterIndex() Get 1-based index of the dataset parameter (in declaration of the function).
java.util.EnumSet<ParameterOption>	getParameterOptions() Get the table parameter option for this argument.
boolean	isAppend() Checks whether this parameter was passed with APPEND option.
boolean	isBind() Checks whether this parameter was passed with BIND option.
boolean	isByReference() Checks whether this parameter was passed with BY-REFERENCE option.
boolean	isByValue() Checks whether this parameter was passed with BY-VALUE option.
boolean	isInputMode() Determines if this parameter is INPUT or INPUT-OUTPUT.
boolean	isOriginalDataSetProxy()
boolean	isOutputMode() Determines if this parameter is OUTPUT or INPUT-OUTPUT.
boolean	isRemoteParameter() Checks whether this is a remote parameter.
void	setDatasetWrapper(DatasetWrapper datasetWrapper) Set the datasetWrapper.
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 dataset parameter (in declaration of the function).
void	setParameterOptions(java.util.EnumSet<ParameterOption> options) Set the table parameter option for this argument.
java.lang.String	toString() Get a string representation of this dataset.

Methods inherited from class java.lang.Object

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

Field Detail

dataset

private final handle dataset

Reference of the wrapped dataset.

options

private java.util.EnumSet<ParameterOption> options

Parameter passing mode APPEND, BY-VALUE, BIND or BY-REFERENCE option.

remoteParameter

private boolean remoteParameter

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

datasetWrapper

private DatasetWrapper datasetWrapper

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

(equivalent of TableWrapper resultSet in TableParameter).

parameterIndex

private int parameterIndex

1-based index of the dataset parameter (in declaration of the function). 0 when not defined.

originalDataSet

private DataSet originalDataSet

The original dataset passed as an argument.

isOriginalDataSetProxy

private boolean isOriginalDataSetProxy

true if the original dataset is a Proxy

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.

Constructor Detail

DataSetParameter

public DataSetParameter(DatasetWrapper wrapper)

Create a new parameter for the REMOTE dataset.

Parameters:

wrapper - The REMOTE dataset.

DataSetParameter

public DataSetParameter(DataSetParameter dataset)

Create an instance using a dataset reference.

Parameters:

dataset - Reference of the wrapped dataset.

DataSetParameter

public DataSetParameter(DataSet dataset)

Create an instance using a dataset reference.

Parameters:

dataset - Reference of the wrapped dataset.

DataSetParameter

public DataSetParameter(DataSet dataset,
                        ParameterOption option)

Create an instance using a dataset reference.

Parameters:

dataset - Reference of the wrapped dataset.

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

DataSetParameter

public DataSetParameter(DataSet dataset,
                        java.util.EnumSet<ParameterOption> options)

Create an instance using a dataset reference.

Parameters:

dataset - Reference of the wrapped dataset.

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

DataSetParameter

public DataSetParameter(DataSet dataset,
                        ParameterOption option,
                        boolean input,
                        boolean output)

Create an instance using a dataset reference.

Parameters:

dataset - Reference of the wrapped dataset.

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.

DataSetParameter

public DataSetParameter(DataSet dataset,
                        java.util.EnumSet<ParameterOption> options,
                        boolean input,
                        boolean output)

Create an instance using a dataset reference.

Parameters:

dataset - Reference of the wrapped dataset.

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.

DataSetParameter

public DataSetParameter(handle dsHandle)

Create an instance using a dataset handle.

Parameters:

dsHandle - Handle to the wrapped dataset.

DataSetParameter

public DataSetParameter(handle dsHandle,
                        ParameterOption option)

Create an instance using a dataset handle.

Parameters:

dsHandle - Handle to the wrapped dataset.

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

DataSetParameter

public DataSetParameter(handle dsHandle,
                        java.util.EnumSet<ParameterOption> options)

Create an instance using a dataset handle.

Parameters:

dsHandle - Handle to the wrapped dataset.

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

DataSetParameter

public DataSetParameter(handle dsHandle,
                        ParameterOption option,
                        boolean input,
                        boolean output)

Create an instance using a dataset handle.

Parameters:

dsHandle - Handle to the wrapped dataset.

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.

DataSetParameter

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

Create an instance using a dataset handle.

Parameters:

dsHandle - Handle to the wrapped dataset.

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

isOriginalDataSetProxy

public boolean isOriginalDataSetProxy()

Returns:

true is the original dataset is a Proxy

getParameterOptions

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

Get the table parameter option for this argument.

Returns:

The table parameter option.

setParameterOptions

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

Set the table parameter option for this argument.

Parameters:

options - The table parameter option.

get

public handle get()

Obtain the DataSet handle.

Returns:

a handle to the dataset passed as parameter.

getOriginalDataSet

public DataSet getOriginalDataSet()

Get the original dataset, as passed by the caller.

Returns:

The originalDataSet.

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.

getDataset

public DataSet getDataset()

Returns the unwrapped dataset instance.

Returns:

see above.

getDatasetHandle

public handle getDatasetHandle()

Returns the wrapped dataset instance.

Returns:

see above.

isAppend

public boolean isAppend()

Checks whether this parameter was passed with APPEND option.

Returns:

true if this parameter was passed with APPEND option.

isByReference

public boolean isByReference()

Checks whether this parameter was passed with BY-REFERENCE option.

Returns:

true if this parameter was passed with BY-REFERENCE option.

isByValue

public boolean isByValue()

Checks whether this parameter was passed with BY-VALUE option.

Returns:

true if this parameter was passed with BY-VALUE option.

isBind

public boolean isBind()

Checks whether this parameter was passed with BIND option.

Returns:

true if this parameter was passed with BIND option.

isRemoteParameter

public boolean isRemoteParameter()

Checks whether this is a remote parameter.

Returns:

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

getDatasetWrapper

public DatasetWrapper getDatasetWrapper()

Get the datasetWrapper.

Returns:

See above.

setDatasetWrapper

public void setDatasetWrapper(DatasetWrapper datasetWrapper)

Set the datasetWrapper.

Parameters:

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

getParameterIndex

public int getParameterIndex()

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

Returns:

1-based index of the dataset parameter or 0 when not defined.

setParameterIndex

public void setParameterIndex(int parameterIndex)

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

Parameters:

parameterIndex - 1-based index of the dataset parameter.

createDataSet

public void createDataSet(DatasetWrapper wrapper)

Create a new DATASET resource from the specified wrapper, and save it in the dataset handle.

Parameters:

wrapper - The dataset from the remote side.

toString

public java.lang.String toString()

Get a string representation of this dataset.

Overrides:

toString in class java.lang.Object

Returns:

See above.