DatasetWrapper (P2J - Progress 4GL to Java Conversion and Runtime)

java.lang.Object
- com.goldencode.p2j.persist.DatasetWrapper

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable
```
public class DatasetWrapper
extends java.lang.Object
implements java.io.Externalizable
```
This wrapper groups multiple DsTableDefinition and DsRelationDefinition the components of the DataSet instance before sending them to a remote side.
This class is intended to be used only by FWD runtime.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`private boolean`	`append` Flag indicating this dataset is sent in APPEND mode.
`private boolean`	`asXml` Flag indicating if the transfer is made via XML.
`private boolean`	`dsHandle` Determines if this wrapper wraps data from a DATASET-HANDLE parameter.
`private java.lang.String`	`dsName` The name of the DataSet.
`private boolean`	`fromJson` Flag indicating if the source is a JSON dataset.
`private boolean`	`hasError` The `ERROR` attribute of the dataset.
`private boolean`	`input` Flag indicating this dataset is sent in INPUT or INPUT-OUTPUT mode.
`private boolean`	`output` Flag indicating this dataset is sent in OUTPUT or INPUT-OUTPUT mode.
`private java.util.List<DsRelationDefinition>`	`relationsDefs` The relations definitions to be read for the dataset.
`private DataSetContainer`	`resource` The result set to be sent to the remote side.
`private static long`	`serialVersionUID` A static serialization ID - required when enabling AOP method tracing (see `MethodTraceAspect`.
`private java.util.List<DsTableDefinition>`	`tableDefs` The tables definitions to be read for the dataset.
`private boolean`	`useBeforeImage` Flag indicating if the before-table must be interpreted, too.
`private boolean`	`valid` Flag indicating if this container holds a valid dataset.
`private java.lang.String`	`xmlDataset` For SOAP web services, the DATASET is sent (and received) serialized as XML, as the requester can't (de)serialize it properly (the relations have dependencies on executing a query to determine the related child-table rows).
`private java.lang.String`	`xmlNodeName` The XML-NODE-NAME attribute for this dataset.
`private java.lang.String`	`xmlns` The XML namespace for this dataset.
`private java.lang.String`	`xmlPrefix` The XML prefix for this dataset.

Constructor Summary

Constructors
Constructor and Description
`DatasetWrapper()` Default c'tor, explicitly added to allow instances of this class to be created on deserialization.
`DatasetWrapper(boolean input, boolean output, boolean dsHandle)` Create a new wrapper.
`DatasetWrapper(boolean fromJson, DataSetContainer resource)` Wrap a custom result set in a class known to FWD, so the remote side can deserialize it.
`DatasetWrapper(DataSetContainer resource)` Wrap a custom result set in a class known to FWD, so the remote side can deserialize it.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getDatasetName()` Obtain the dataset name.
`java.util.List<DsRelationDefinition>`	`getRelationsDefs()` Returns the list of relations definitions between the temp-tables from this `DataSet`.
`DataSetContainer`	`getResource()` Get the dataset container resource.
`java.util.List<DsTableDefinition>`	`getTableDefs()` Returns the list of table definitions for the temp-tables from this `DataSet`.
`TableWrapper`	`getTableWrapper(int k)` Obtain a `TableWrapper` for a specific table of this `DataSet`.
`java.lang.String`	`getXmlDataset()` Get the `xmlDataset`.
`java.lang.String`	`getXmlNodeName()` Get the XML node name of the DATASET.
`boolean`	`hasError()` Get the ERROR attribute of the DATASET.
`boolean`	`isAppend()` Check if this dataset is in APPEND mode.
`boolean`	`isAsXml()` Get the `asXml` flag.
`boolean`	`isDatasetHandle()` Determines if this wrapper wraps data from a DATASET-HANDLE parameter.
`boolean`	`isFromJson()` Check if the source is a JSON.
`boolean`	`isInput()` Check if this dataset is in INPUT or INPUT-OUTPUT mode.
`boolean`	`isOutput()` Check if this dataset is in OUTPUT or INPUT-OUTPUT mode.
`boolean`	`isUseBeforeImage()` Get the `useBeforeImage` flag.
`boolean`	`isValid()` Get the `valid` flag.
`java.lang.String`	`namespacePrefix()` Get the XML prefix of the DATASET.
`java.lang.String`	`namespaceURI()` Get the XML namespace of the DATASET.
`void`	`readExternal(java.io.ObjectInput in)` Read the result set (metadata and rows) from the specified input source.
`void`	`setAsXml(boolean asXml)` Set the `asXml` flag.
`void`	`setDatasetHandle(boolean datasetHandle)` Set if this wrapper wraps data from a DATASET-HANDLE parameter.
`void`	`setDatasetName(java.lang.String dsName)` Sets the dataset name.
`void`	`setUseBeforeImage(boolean useBeforeImage)` Set the `useBeforeImage` flag.
`void`	`setXmlDataset(java.lang.String xmlDataset)` Set the `xmlDataset`.
`java.lang.String`	`toString()` Get a string representation of this dataset.
`void`	`writeExternal(java.io.ObjectOutput out)` Send the result set (metadata and rows) to the specified output destination.

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

- Field Detail
  - serialVersionUID
```
private static final long serialVersionUID
```
    A static serialization ID - required when enabling AOP method tracing (see MethodTraceAspect.
    
    See Also:
    
    Constant Field Values
  - resource
```
private DataSetContainer resource
```
    The result set to be sent to the remote side.
  - input
```
private boolean input
```
    Flag indicating this dataset is sent in INPUT or INPUT-OUTPUT mode.
  - output
```
private boolean output
```
    Flag indicating this dataset is sent in OUTPUT or INPUT-OUTPUT mode.
  - append
```
private boolean append
```
    Flag indicating this dataset is sent in APPEND mode.
  - tableDefs
```
private java.util.List<DsTableDefinition> tableDefs
```
    The tables definitions to be read for the dataset.
  - relationsDefs
```
private java.util.List<DsRelationDefinition> relationsDefs
```
    The relations definitions to be read for the dataset.
  - dsHandle
```
private boolean dsHandle
```
    Determines if this wrapper wraps data from a DATASET-HANDLE parameter. Necessary because of quirks in error handling: calling side needs to know if it is a DATASET-HANDLE parameter (not a DATASET parameter) on the called side.
  - dsName
```
private java.lang.String dsName
```
    The name of the DataSet.
  - xmlns
```
private java.lang.String xmlns
```
    The XML namespace for this dataset.
  - xmlPrefix
```
private java.lang.String xmlPrefix
```
    The XML prefix for this dataset.
  - hasError
```
private boolean hasError
```
    The ERROR attribute of the dataset.
  - xmlNodeName
```
private java.lang.String xmlNodeName
```
    The XML-NODE-NAME attribute for this dataset.
  - fromJson
```
private boolean fromJson
```
    Flag indicating if the source is a JSON dataset.
  - xmlDataset
```
private java.lang.String xmlDataset
```
    For SOAP web services, the DATASET is sent (and received) serialized as XML, as the requester can't (de)serialize it properly (the relations have dependencies on executing a query to determine the related child-table rows). This includes the schema, also, for DATASET-HANDLE.
  - asXml
```
private boolean asXml
```
    Flag indicating if the transfer is made via XML.
  - useBeforeImage
```
private boolean useBeforeImage
```
    Flag indicating if the before-table must be interpreted, too.
  - valid
```
private boolean valid
```
    Flag indicating if this container holds a valid dataset.
- Constructor Detail
  - DatasetWrapper
```
public DatasetWrapper()
```
    Default c'tor, explicitly added to allow instances of this class to be created on deserialization. Not for public use.
  - DatasetWrapper
```
public DatasetWrapper(boolean input,
                      boolean output,
                      boolean dsHandle)
```
    Create a new wrapper.
    
    Parameters:
    
    input - Flag indicating the wrapper is in INPUT mode.
    
    output - Flag indicating the wrapper is in OUTPUT mode.
    
    dsHandle - Flag indicating the wrapper is for a DATASET-HANDLE.
  - DatasetWrapper
```
public DatasetWrapper(DataSetContainer resource)
```
    Wrap a custom result set in a class known to FWD, so the remote side can deserialize it.
    
    Parameters:
    
    resource - The resource, which is a (subclass of) DataSet.
  - DatasetWrapper
```
public DatasetWrapper(boolean fromJson,
                      DataSetContainer resource)
```
    Wrap a custom result set in a class known to FWD, so the remote side can deserialize it.
    
    Parameters:
    
    fromJson - Flag indicating if the dataset is from a JSON source.
    
    resource - The resource, which is a (subclass of) DataSet.
- Method Detail
  - isValid
```
public boolean isValid()
```
    Get the valid flag.
    
    Returns:
    
    true if this container is for a valid dataset.
  - setUseBeforeImage
```
public void setUseBeforeImage(boolean useBeforeImage)
```
    Set the useBeforeImage flag.
    
    Parameters:
    
    useBeforeImage - Flag indicating that the before-image for the dataset is used.
  - isUseBeforeImage
```
public boolean isUseBeforeImage()
```
    Get the useBeforeImage flag.
    
    Returns:
    
    See above.
  - setXmlDataset
```
public void setXmlDataset(java.lang.String xmlDataset)
```
    Set the xmlDataset.
    
    Parameters:
    
    xmlDataset - The XML representation of the dataset.
  - getXmlDataset
```
public java.lang.String getXmlDataset()
```
    Get the xmlDataset.
    
    Returns:
    
    See above.
  - isAsXml
```
public boolean isAsXml()
```
    Get the asXml flag.
    
    Returns:
    
    See above.
  - setAsXml
```
public void setAsXml(boolean asXml)
```
    Set the asXml flag.
    
    Parameters:
    
    asXml - When true, the dataset is transferred via its XML representation.
  - getResource
```
public DataSetContainer getResource()
```
    Get the dataset container resource.
    
    Returns:
    
    The resource.
  - namespaceURI
```
public java.lang.String namespaceURI()
```
    Get the XML namespace of the DATASET.
    
    Returns:
    
    XML namespace of the DATASET
  - namespacePrefix
```
public java.lang.String namespacePrefix()
```
    Get the XML prefix of the DATASET.
    
    Returns:
    
    XML prefix of the DATASET
  - getXmlNodeName
```
public java.lang.String getXmlNodeName()
```
    Get the XML node name of the DATASET.
    
    Returns:
    
    XML node name of the DATASET
  - hasError
```
public boolean hasError()
```
    Get the ERROR attribute of the DATASET.
    
    Returns:
    
    the ERROR attribute.
  - getTableDefs
```
public java.util.List<DsTableDefinition> getTableDefs()
```
    Returns the list of table definitions for the temp-tables from this DataSet.
    
    Returns:
    
    the list of table definitions from this DataSet.
  - getRelationsDefs
```
public java.util.List<DsRelationDefinition> getRelationsDefs()
```
    Returns the list of relations definitions between the temp-tables from this DataSet. All relations are returned, whether they are active or not.
    
    Returns:
    
    the list of relations definitions from this DataSet.
  - isInput
```
public boolean isInput()
```
    Check if this dataset is in INPUT or INPUT-OUTPUT mode. This is used to access the data sent by a remote side, via readExternal(java.io.ObjectInput). Must not be called when resource is set.
    
    Returns:
    
    The input flag.
  - isOutput
```
public boolean isOutput()
```
    Check if this dataset is in OUTPUT or INPUT-OUTPUT mode. This is used to access the data sent by a remote side, via readExternal(java.io.ObjectInput). Must not be called when resource is set.
    
    Returns:
    
    The output flag.
  - isAppend
```
public boolean isAppend()
```
    Check if this dataset is in APPEND mode. This is used to access the data sent by a remote side, via readExternal(java.io.ObjectInput). Must not be called when resource is set.
    
    Returns:
    
    The append flag.
  - isDatasetHandle
```
public boolean isDatasetHandle()
```
    Determines if this wrapper wraps data from a DATASET-HANDLE parameter.
    
    Returns:
    
    true if this wrapper wraps data from a DATASET-HANDLE parameter.
  - isFromJson
```
public boolean isFromJson()
```
    Check if the source is a JSON.
    
    Returns:
    
    The fromJson flag.
  - setDatasetHandle
```
public void setDatasetHandle(boolean datasetHandle)
```
    Set if this wrapper wraps data from a DATASET-HANDLE parameter.
    
    Parameters:
    
    datasetHandle - true if this wrapper wraps data from a DATASET-HANDLE parameter.
  - getDatasetName
```
public java.lang.String getDatasetName()
```
    Obtain the dataset name.
    
    Returns:
    
    the dataset name.
  - setDatasetName
```
public void setDatasetName(java.lang.String dsName)
```
    Sets the dataset name.
    
    Parameters:
    
    dsName - The (new) dataset name.
  - writeExternal
```
public final void writeExternal(java.io.ObjectOutput out)
                         throws java.io.IOException
```
    Send the result set (metadata and rows) to the specified output destination.
    
    Specified by:
    
    writeExternal in interface java.io.Externalizable
    
    Parameters:
    
    out - The output destination to which the result set will be sent.
    
    Throws:
    
    java.io.IOException - In case of I/O errors.
  - readExternal
```
public final void readExternal(java.io.ObjectInput in)
                        throws java.io.IOException,
                               java.lang.ClassNotFoundException
```
    Read the result set (metadata and rows) from the specified input source.
    
    Specified by:
    
    readExternal in interface java.io.Externalizable
    
    Parameters:
    
    in - The input source from which the result set will be read.
    
    Throws:
    
    java.io.IOException - In case of I/O errors.
    
    java.lang.ClassNotFoundException - If a class load operation fails.
  - getTableWrapper
```
public TableWrapper getTableWrapper(int k)
```
    Obtain a TableWrapper for a specific table of this DataSet. The table is identified by its index in the buffer list.
    
    Parameters:
    
    k - The index of the table whose TableWrapper will be returned.
    
    Returns:
    
    the table wrapper for the target table.
  - toString
```
public java.lang.String toString()
```
    Get a string representation of this dataset.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    See above.

Class DatasetWrapper

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

serialVersionUID

resource

input

output

append

tableDefs

relationsDefs

dsHandle

dsName

xmlns

xmlPrefix

hasError

xmlNodeName

fromJson

xmlDataset

asXml

useBeforeImage

valid

Constructor Detail

DatasetWrapper

DatasetWrapper

DatasetWrapper

DatasetWrapper

Method Detail

isValid

setUseBeforeImage

isUseBeforeImage

setXmlDataset

getXmlDataset

isAsXml

setAsXml

getResource

namespaceURI

namespacePrefix

getXmlNodeName

hasError

getTableDefs

getRelationsDefs

isInput

isOutput

isAppend

isDatasetHandle

isFromJson

setDatasetHandle

getDatasetName

setDatasetName

writeExternal

readExternal

getTableWrapper

toString