com.goldencode.p2j.persist

Class DataSetContainer

java.lang.Object

com.goldencode.p2j.persist.MassiveContainer

com.goldencode.p2j.persist.DataSetContainer

public class DataSetContainer
extends MassiveContainer

Provides the main mechanism of passing a dataset with its tables metadata and data. The remote side will use the sent table properties (and their other settings, as type and extent) to dynamically build the DMO interface, implementation class and .hbm.xml configuration file. The inter-table relations will also be available.

As transport, any instance of this class will be wrapped in a DatasetWrapper instance internally by P2J.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	hasError The ERROR attribute of the dataset.
private handle	oDSHandle The handle which will store the DATASET after the called method returns.
private java.util.List<DsRelationDefinition>	relationDefinitions The definitions for all relations between the tables in the dataset.
private java.util.List<DsTableDefinition>	tableDefinitions The definitions for all tables in the dataset.
private boolean	valid Flag indicating if this container holds a valid dataset.
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.

Fields inherited from class com.goldencode.p2j.persist.MassiveContainer

append, input, output, structureName

Constructor Summary

Constructors

Constructor and Description
DataSetContainer() Default c'tor, explicitly added to allow instances of this class to be created on deserialization.
DataSetContainer(boolean input, boolean output, boolean append) Create a new instance of this DataSet container.
DataSetContainer(DataSet ds, boolean input, boolean output, boolean append) Create a new instance of this DataSet container.
DataSetContainer(DataSet ds, boolean input, boolean output, boolean append, boolean copyRows) Create a new instance of this DataSet container.
DataSetContainer(handle dsHandle, boolean input, boolean output, boolean append) Constructor used for passing a DATASET-HANDLE parameter.

Method Summary

Modifier and Type	Method and Description
void	clearRows() Delete row data.
int	getRelationCount() Obtain the number of inter-table relations in the DataSet.
java.util.List<DsRelationDefinition>	getRelationDefinitions() Gets the list of relations definitions of this DataSet definition.
int	getTableCount() Obtain the number of tables in the DataSet.
java.util.List<DsTableDefinition>	getTableDefinitions() Gets the list of table definitions of this DataSet definition.
java.lang.String	getXmlNodeName() Get the XML node name of the DATASET.
boolean	hasError() Get the ERROR attribute of the DATASET.
private void	init(DataSet ds, boolean copyRows) Initialize the internal structure of this object using the DataSet provided.
boolean	isValid() Get the valid flag.
java.lang.String	namespacePrefix() Get the XML prefix of the DATASET.
void	namespacePrefix(java.lang.String xmlPrefix) Set the XML prefix of the DATASET.
java.lang.String	namespaceURI() Get the XML namespace of the DATASET.
void	namespaceUri(java.lang.String xmlns) Set the XML namespace of the DATASET.
void	setRelationDefinitions(java.util.List<DsRelationDefinition> relationDefinitions) Sets a new list of relations definitions of this DataSet definition.
void	setTableDefinitions(java.util.List<DsTableDefinition> tableDefinitions) Sets a new list of table definitions of this DataSet definition.
void	setValid(boolean valid) Set the valid flag.
void	setXmlNodeName(java.lang.String xmlNodeName) Set the XML node name of the DATASET.
java.lang.String	toString() Get a string representation of this dataset.

Methods inherited from class com.goldencode.p2j.persist.MassiveContainer

getStructureName, isAppend, isInput, isOutput, setStructureName

Methods inherited from class java.lang.Object

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

Field Detail

oDSHandle

private handle oDSHandle

The handle which will store the DATASET after the called method returns.

tableDefinitions

private java.util.List<DsTableDefinition> tableDefinitions

The definitions for all tables in the dataset.

relationDefinitions

private java.util.List<DsRelationDefinition> relationDefinitions

The definitions for all relations between the tables in 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.

xmlNodeName

private java.lang.String xmlNodeName

The XML-NODE-NAME attribute for this dataset.

hasError

private boolean hasError

The ERROR attribute of the dataset.

valid

private boolean valid

Flag indicating if this container holds a valid dataset.

Constructor Detail

DataSetContainer

public DataSetContainer()

Default c'tor, explicitly added to allow instances of this class to be created on deserialization. Not for public use.

DataSetContainer

public DataSetContainer(boolean input,
                        boolean output,
                        boolean append)

Create a new instance of this DataSet container.

Parameters:

input - Flag indicating this table is sent in INPUT or INPUT-OUTPUT mode.

output - Flag indicating this table is sent in OUTPUT or INPUT-OUTPUT mode.

append - Flag indicating this table is sent in APPEND mode.

DataSetContainer

public DataSetContainer(DataSet ds,
                        boolean input,
                        boolean output,
                        boolean append)

Create a new instance of this DataSet container.

Parameters:

ds - The DataSet to be serialized.

input - Flag indicating this table is sent in INPUT or INPUT-OUTPUT mode.

output - Flag indicating this table is sent in OUTPUT or INPUT-OUTPUT mode.

append - Flag indicating this table is sent in APPEND mode.

DataSetContainer

public DataSetContainer(DataSet ds,
                        boolean input,
                        boolean output,
                        boolean append,
                        boolean copyRows)

Create a new instance of this DataSet container.

Parameters:

ds - The DataSet to be serialized.

input - Flag indicating this table is sent in INPUT or INPUT-OUTPUT mode.

output - Flag indicating this table is sent in OUTPUT or INPUT-OUTPUT mode.

append - Flag indicating this table is sent in APPEND mode.

copyRows - true> to transfer rows in INPUT direction. false> to transfer only table definitions.

DataSetContainer

public DataSetContainer(handle dsHandle,
                        boolean input,
                        boolean output,
                        boolean append)

Constructor used for passing a DATASET-HANDLE parameter.

Parameters:

dsHandle - The handle which will store the DATASET after the called method returns.

input - Flag indicating this table is sent in INPUT or INPUT-OUTPUT mode.

output - Flag indicating this table is sent in OUTPUT or INPUT-OUTPUT mode.

append - Flag indicating this table is sent in APPEND mode.

Method Detail

setValid

public void setValid(boolean valid)

Set the valid flag.

Parameters:

valid - true if this container is for a valid dataset.

isValid

public boolean isValid()

Get the valid flag.

Returns:

true if this container is for a valid dataset.

getTableCount

public int getTableCount()

Obtain the number of tables in the DataSet.

Returns:

the number of tables in the DataSet.

getTableDefinitions

public java.util.List<DsTableDefinition> getTableDefinitions()

Gets the list of table definitions of this DataSet definition.

Returns:

the list of table definitions of this DataSet definition.

getRelationCount

public int getRelationCount()

Obtain the number of inter-table relations in the DataSet. The count of all relations is returned, whether thery are ACTIVE or not.

Returns:

the number of all relations in the DataSet.

getRelationDefinitions

public java.util.List<DsRelationDefinition> getRelationDefinitions()

Gets the list of relations definitions of this DataSet definition. All relations are returned, regardless they are active or not.

Returns:

the list of relations definitions of this DataSet definition.

setTableDefinitions

public void setTableDefinitions(java.util.List<DsTableDefinition> tableDefinitions)

Sets a new list of table definitions of this DataSet definition.

Parameters:

tableDefinitions - the (new) list of table definitions of this DataSet definition.

setRelationDefinitions

public void setRelationDefinitions(java.util.List<DsRelationDefinition> relationDefinitions)

Sets a new list of relations definitions of this DataSet definition.

Parameters:

relationDefinitions - the (new) list of relations definitions of this DataSet definition.

init

private void init(DataSet ds,
                  boolean copyRows)

Initialize the internal structure of this object using the DataSet provided.

Parameters:

ds - The DataSet used for initialization of internal data.

copyRows - true> to transfer rows in INPUT direction. false> to transfer only table definitions.

namespaceURI

public java.lang.String namespaceURI()

Get the XML namespace of the DATASET.

Returns:

XML namespace of the DATASET

namespaceUri

public void namespaceUri(java.lang.String xmlns)

Set the XML namespace of the DATASET.

Parameters:

xmlns - The XML namespace.

namespacePrefix

public java.lang.String namespacePrefix()

Get the XML prefix of the DATASET.

Returns:

XML prefix of the DATASET

namespacePrefix

public void namespacePrefix(java.lang.String xmlPrefix)

Set the XML prefix of the DATASET.

Parameters:

xmlPrefix - The XML prefix.

getXmlNodeName

public java.lang.String getXmlNodeName()

Get the XML node name of the DATASET.

Returns:

XML node name of the DATASET

setXmlNodeName

public void setXmlNodeName(java.lang.String xmlNodeName)

Set the XML node name of the DATASET.

Parameters:

xmlNodeName - The XML node name.

hasError

public boolean hasError()

Get the ERROR attribute of the DATASET.

Returns:

the ERROR attribute.

clearRows

public void clearRows()

Delete row data.

toString

public java.lang.String toString()

Get a string representation of this dataset.

Overrides:

toString in class java.lang.Object

Returns:

See above.