com.goldencode.p2j.persist

Interface DataSetInterface

All Known Subinterfaces:

HandleCommon

All Known Implementing Classes:

DataSet, StaticDataSet

public interface DataSetInterface

Declares the public methods and attributes of DataSets.

Method Summary

Modifier and Type	Method and Description
handle	addParentIdRelation(handle parentBuf, handle child) Adds a data-relation object for a pair of parent and child buffers that is based on the RECID of the parent buffer to this DataSet object.
handle	addParentIdRelation(handle parentBuf, handle child, Text parentIdField) Adds a data-relation object for a pair of parent and child buffers that is based on the RECID of the parent buffer to this DataSet object.
handle	addParentIdRelation(handle parentBuf, handle child, Text parentIdField, Text parentFieldsBefore) Adds a data-relation object for a pair of parent and child buffers that is based on the RECID of the parent buffer to this DataSet object.
handle	addParentIdRelation(handle parentBuf, handle child, Text parentIdField, Text parentFieldsBefore, Text parentFieldsAfter) Adds a data-relation object for a pair of parent and child buffers that is based on the RECID of the parent buffer to this DataSet object.
handle	addRelation(handle parentBuf, handle child, Text pairs) Adds a data-relation object for a pair of parent and child buffers to this DataSet object.
handle	addRelation(handle parentBuf, handle child, Text pairs, logical reposition) Adds a data-relation object for a pair of parent and child buffers to this DataSet object.
handle	addRelation(handle parentBuf, handle child, Text pairs, logical reposition, logical nested) Adds a data-relation object for a pair of parent and child buffers to this DataSet object.
handle	addRelation(handle parentBuf, handle child, Text pairs, logical reposition, logical nested, logical notActive) Adds a data-relation object for a pair of parent and child buffers to this DataSet object.
handle	addRelation(handle parentBuf, handle child, Text pairs, logical reposition, logical nested, logical notActive, logical recursive) Adds a data-relation object for a pair of parent and child buffers to this DataSet object.
handle	addRelation(handle parentBuf, handle child, Text pairs, logical reposition, logical nested, logical notActive, logical recursive, logical fkeyHidden) Adds a data-relation object for a pair of parent and child buffers to this DataSet object.
logical	areRelationsActive() Checks whether all data-relation objects in this DataSet object are active or inactive.
logical	copyDataset(handle srcDS) Copies a source DataSet object into this DataSet object.
logical	copyDataset(handle srcDS, logical append) Copies a source DataSet object into this DataSet object.
logical	copyDataset(handle srcDS, logical append, logical replace) Copies a source DataSet object into this DataSet object.
logical	copyDataset(handle srcDS, logical append, logical replace, logical looseCopy) Copies a source DataSet object into this DataSet object.
logical	copyDataset(handle srcDS, logical append, logical replace, logical looseCopy, Text pairList) Copies a source DataSet object into this DataSet object.
logical	copyDataset(handle srcDS, logical append, logical replace, logical looseCopy, Text pairList, logical currentOnly) Copies a source DataSet object into this DataSet object.
logical	copyDataset(handle srcDS, logical append, logical replace, logical looseCopy, Text pairList, logical currentOnly, Text prefix) Copies a source DataSet object into this DataSet object.
logical	emptyDataset() Empties this DataSet object of all records in its associated temp-tables.
integer	getNumRelations() Get the number of data-relation objects of this DataSet object.
integer	getNumTopBuffers() Obtain the number of top-level buffers in this DataSet object.
handle	getRelation() Gets the handle of the specified data-relation object.
handle	getRelation(long index) Gets the handle of the specified data-relation object.
handle	getRelation(NumberType index) Gets the handle of the specified data-relation object.
handle	getRelation(java.lang.String name) Gets the handle of the specified data-relation object.
handle	getRelation(Text name) Gets the handle of the specified data-relation object.
handle	getTopBuffer() Gets the top-level buffer of this DataSet object at the specified index position.
handle	getTopBuffer(long index) Gets the top-level buffer of this DataSet object at the specified index position.
handle	getTopBuffer(NumberType index) Gets the top-level buffer of this DataSet object at the specified index position.
handle	getTopNavQuery() Obtain default navigation query for a top-level buffer of this DataSet object.
handle	getTopNavQuery(long index) Obtain default navigation query for a top-level buffer of this DataSet object.
handle	getTopNavQuery(NumberType index) Obtain default navigation query for a top-level buffer of this DataSet object.
handle	getTopNavQuery(java.lang.String bufName) Obtain default navigation query for a top-level buffer of this DataSet object.
handle	getTopNavQuery(Text bufName) Obtain default navigation query for a top-level buffer of this DataSet object.
void	setRelationsActive(boolean active) Configures whether all data-relation objects in this DataSet object are active or inactive.
void	setRelationsActive(logical active) Configures whether all data-relation objects in this DataSet object are active or inactive.
void	setTopNavQuery(handle queryHandle) Configures the default navigation query for a top-level buffer of this DataSet object.
void	setTopNavQuery(long index, handle queryHandle) Configures the default navigation query for a top-level buffer of this DataSet object.
void	setTopNavQuery(NumberType index, handle queryHandle) Configures the default navigation query for a top-level buffer of this DataSet object.
void	setTopNavQuery(java.lang.String bufName, handle queryHandle) Configures the default navigation query for a top-level buffer of this DataSet object.
void	setTopNavQuery(Text bufName, handle queryHandle) Configures the default navigation query for a top-level buffer of this DataSet object.

Method Detail

emptyDataset

logical emptyDataset()

Empties this DataSet object of all records in its associated temp-tables.

Returns:

true on success.

getRelation

handle getRelation()

Gets the handle of the specified data-relation object.

Returns:

the handle of the specified data-relation object.

getRelation

handle getRelation(NumberType index)

Gets the handle of the specified data-relation object.

Parameters:

index - The index (1-based) of the data-relation to be returned.

Returns:

the handle of the specified data-relation object.

getRelation

handle getRelation(long index)

Gets the handle of the specified data-relation object.

Parameters:

index - The index (1-based) of the data-relation to be returned.

Returns:

the handle of the specified data-relation object.

getRelation

handle getRelation(Text name)

Gets the handle of the specified data-relation object.

Parameters:

name - The name of the data-relation to be returned.

Returns:

the handle of the specified data-relation object.

getRelation

handle getRelation(java.lang.String name)

Gets the handle of the specified data-relation object.

Parameters:

name - The name of the data-relation to be returned.

Returns:

the handle of the specified data-relation object.

getTopBuffer

handle getTopBuffer()

Gets the top-level buffer of this DataSet object at the specified index position.

Returns:

the top-level buffer at the position 1.

getTopBuffer

handle getTopBuffer(long index)

Gets the top-level buffer of this DataSet object at the specified index position.

Parameters:

index - The 1-based index of the top-level buffer.

Returns:

the top-level buffer at the specified index position.

getTopBuffer

handle getTopBuffer(NumberType index)

Gets the top-level buffer of this DataSet object at the specified index position.

Parameters:

index - The 1-based index of the top-level buffer.

Returns:

the top-level buffer at the specified index position.

getTopNavQuery

handle getTopNavQuery()

Obtain default navigation query for a top-level buffer of this DataSet object. This method correspond to the getter side of TOP-NAV-QUERY ABL attribute.

Returns:

default navigation query for a top-level buffer.

getTopNavQuery

handle getTopNavQuery(long index)

Obtain default navigation query for a top-level buffer of this DataSet object. This method correspond to the getter side of TOP-NAV-QUERY ABL attribute.

Parameters:

index - The 1-based index of the top-level buffer.

Returns:

the default navigation query for a top-level buffer.

getTopNavQuery

handle getTopNavQuery(NumberType index)

Obtain default navigation query for a top-level buffer of this DataSet object. This method correspond to the getter side of TOP-NAV-QUERY ABL attribute.

Parameters:

index - The 1-based index of the top-level buffer.

Returns:

the default navigation query for a top-level buffer.

getTopNavQuery

handle getTopNavQuery(java.lang.String bufName)

Obtain default navigation query for a top-level buffer of this DataSet object. This method correspond to the getter side of TOP-NAV-QUERY ABL attribute.

Parameters:

bufName - The name of the top-level buffer.

Returns:

the default navigation query for a top-level buffer.

getTopNavQuery

handle getTopNavQuery(Text bufName)

Obtain default navigation query for a top-level buffer of this DataSet object. This method correspond to the getter side of TOP-NAV-QUERY ABL attribute.

Parameters:

bufName - The name of the top-level buffer.

Returns:

the default navigation query for a top-level buffer.

setTopNavQuery

void setTopNavQuery(handle queryHandle)

Configures the default navigation query for a top-level buffer of this DataSet object. This method correspond to the setter side of TOP-NAV-QUERY ABL attribute.

Parameters:

queryHandle - The new default navigation query for a top-level buffer.

setTopNavQuery

void setTopNavQuery(long index,
                    handle queryHandle)

Configures the default navigation query for a top-level buffer of this DataSet object. This method correspond to the setter side of TOP-NAV-QUERY ABL attribute.

Parameters:

index - The 1-based index of the top-level buffer.

queryHandle - The new default navigation query for a top-level buffer.

setTopNavQuery

void setTopNavQuery(NumberType index,
                    handle queryHandle)

Configures the default navigation query for a top-level buffer of this DataSet object. This method correspond to the setter side of TOP-NAV-QUERY ABL attribute.

Parameters:

index - The 1-based index of the top-level buffer.

queryHandle - The new default navigation query for a top-level buffer.

setTopNavQuery

void setTopNavQuery(java.lang.String bufName,
                    handle queryHandle)

Configures the default navigation query for a top-level buffer of this DataSet object. This method correspond to the setter side of TOP-NAV-QUERY ABL attribute.

Parameters:

bufName - The name of the top-level buffer.

queryHandle - The new default navigation query for a top-level buffer.

setTopNavQuery

void setTopNavQuery(Text bufName,
                    handle queryHandle)

Configures the default navigation query for a top-level buffer of this DataSet object. This method correspond to the setter side of TOP-NAV-QUERY ABL attribute.

Parameters:

bufName - The name of the top-level buffer.

queryHandle - The new default navigation query for a top-level buffer.

areRelationsActive

logical areRelationsActive()

Checks whether all data-relation objects in this DataSet object are active or inactive. All data-relation objects in a DataSet object are active by default.

Returns:

true when all data-relation objects are active.

setRelationsActive

void setRelationsActive(logical active)

Configures whether all data-relation objects in this DataSet object are active or inactive. Setting this attribute to TRUE will activate all data-relation objects. Setting it to FALSE will deactivate all data-relation objects instead.

Parameters:

active - The new value for RELATIONS-ACTIVE attribute.

setRelationsActive

void setRelationsActive(boolean active)

Configures whether all data-relation objects in this DataSet object are active or inactive. Setting this attribute to TRUE will activate all data-relation objects. Setting it to FALSE will deactivate all data-relation objects instead.

Parameters:

active - The new value for RELATIONS-ACTIVE attribute.

getNumRelations

integer getNumRelations()

Get the number of data-relation objects of this DataSet object.

Returns:

the number of data-relation objects of this DataSet object.

getNumTopBuffers

integer getNumTopBuffers()

Obtain the number of top-level buffers in this DataSet object.

Returns:

the number of top-level buffers in this DataSet object.

addRelation

handle addRelation(handle parentBuf,
                   handle child,
                   Text pairs)

Adds a data-relation object for a pair of parent and child buffers to this DataSet object. This DataSet must be dynamically created.

Parameters:

parentBuf - The handle to the parent buffer in the data-relation object.

child - The handle to the child buffer in the data-relation object.

pairs - A comma-delimited list of parent-field, child-field pairs describing the relationship between parent and child buffers in the new data-relation object.

Returns:

A handle to the newly created DataRelation object.

addRelation

handle addRelation(handle parentBuf,
                   handle child,
                   Text pairs,
                   logical reposition)

Adds a data-relation object for a pair of parent and child buffers to this DataSet object. This DataSet must be dynamically created.

Parameters:

parentBuf - The handle to the parent buffer in the data-relation object.

child - The handle to the child buffer in the data-relation object.

pairs - A comma-delimited list of parent-field, child-field pairs describing the relationship between parent and child buffers in the new data-relation object.

reposition - The reposition mode. If TRUE, the relation mode is REPOSITION. Otherwise the relation mode is SELECTION. The default value is SELECTION.

Returns:

A handle to the newly created DataRelation object.

addRelation

handle addRelation(handle parentBuf,
                   handle child,
                   Text pairs,
                   logical reposition,
                   logical nested)

Adds a data-relation object for a pair of parent and child buffers to this DataSet object. This DataSet must be dynamically created.

Parameters:

parentBuf - The handle to the parent buffer in the data-relation object.

child - The handle to the child buffer in the data-relation object.

pairs - A comma-delimited list of parent-field, child-field pairs describing the relationship between parent and child buffers in the new data-relation object.

reposition - The reposition mode. If TRUE, the relation mode is REPOSITION. Otherwise the relation mode is SELECTION. The default value is SELECTION.

nested - Use TRUE to nest child rows of DataSet buffers within their parent rows when writing the XML representation of data. When FALSE is passed, all child rows are written after all parent rows are written. The default value is FALSE.

Returns:

A handle to the newly created DataRelation object.

addRelation

handle addRelation(handle parentBuf,
                   handle child,
                   Text pairs,
                   logical reposition,
                   logical nested,
                   logical notActive)

Adds a data-relation object for a pair of parent and child buffers to this DataSet object. This DataSet must be dynamically created.

Parameters:

parentBuf - The handle to the parent buffer in the data-relation object.

child - The handle to the child buffer in the data-relation object.

pairs - A comma-delimited list of parent-field, child-field pairs describing the relationship between parent and child buffers in the new data-relation object.

reposition - The reposition mode. If TRUE, the relation mode is REPOSITION. Otherwise the relation mode is SELECTION. The default value is SELECTION.

nested - Use TRUE to nest child rows of DataSet buffers within their parent rows when writing the XML representation of data. When FALSE is passed, all child rows are written after all parent rows are written. The default value is FALSE.

notActive - Use false to make the newly created relation inactive (yes, stupid manual).

Returns:

A handle to the newly created DataRelation object.

addRelation

handle addRelation(handle parentBuf,
                   handle child,
                   Text pairs,
                   logical reposition,
                   logical nested,
                   logical notActive,
                   logical recursive)

Adds a data-relation object for a pair of parent and child buffers to this DataSet object. This DataSet must be dynamically created.

Parameters:

parentBuf - The handle to the parent buffer in the data-relation object.

child - The handle to the child buffer in the data-relation object.

pairs - A comma-delimited list of parent-field, child-field pairs describing the relationship between parent and child buffers in the new data-relation object.

reposition - The reposition mode. If TRUE, the relation mode is REPOSITION. Otherwise the relation mode is SELECTION. The default value is SELECTION.

nested - Use TRUE to nest child rows of DataSet buffers within their parent rows when writing the XML representation of data. When FALSE is passed, all child rows are written after all parent rows are written. The default value is FALSE.

notActive - Use false to make the newly created relation inactive (yes, stupid manual).

recursive - Using TRUE till causes the data-relation to be filled recursively.

Returns:

A handle to the newly created DataRelation object.

addRelation

handle addRelation(handle parentBuf,
                   handle child,
                   Text pairs,
                   logical reposition,
                   logical nested,
                   logical notActive,
                   logical recursive,
                   logical fkeyHidden)

Adds a data-relation object for a pair of parent and child buffers to this DataSet object. This DataSet must be dynamically created.

Parameters:

parentBuf - The handle to the parent buffer in the data-relation object.

child - The handle to the child buffer in the data-relation object.

pairs - A comma-delimited list of parent-field, child-field pairs describing the relationship between parent and child buffers in the new data-relation object.

reposition - The reposition mode. If TRUE, the relation mode is REPOSITION. Otherwise the relation mode is SELECTION. The default value is SELECTION.

nested - Use TRUE to nest child rows of DataSet buffers within their parent rows when writing the XML representation of data. When FALSE is passed, all child rows are written after all parent rows are written. The default value is FALSE.

notActive - Use false to make the newly created relation inactive (yes, stupid manual).

recursive - Using TRUE till causes the data-relation to be filled recursively.

fkeyHidden - When set to TRUE the foreign key fields in nested data-relations will be omitted when writing the XML representation of data. If this option is used, the NESTED argument must be TRUE.

Returns:

A handle to the newly created DataRelation object.

addParentIdRelation

handle addParentIdRelation(handle parentBuf,
                           handle child)

Adds a data-relation object for a pair of parent and child buffers that is based on the RECID of the parent buffer to this DataSet object. This DataSet must be dynamically created. The newly created object will have the PARENT-ID-RELATION attribute set to TRUE.

Parameters:

parentBuf - The handle to the parent buffer in the data-relation object.

child - The handle to the child buffer in the data-relation object.

Returns:

A handle to the newly created DataRelation object.

addParentIdRelation

handle addParentIdRelation(handle parentBuf,
                           handle child,
                           Text parentIdField)

Adds a data-relation object for a pair of parent and child buffers that is based on the RECID of the parent buffer to this DataSet object. This DataSet must be dynamically created. The newly created object will have the PARENT-ID-RELATION attribute set to TRUE.

Parameters:

parentBuf - The handle to the parent buffer in the data-relation object.

child - The handle to the child buffer in the data-relation object.

parentIdField - Denotes the RECID field in child-buffer-handle on which this parent-id-relation object is based.

Returns:

A handle to the newly created DataRelation object.

addParentIdRelation

handle addParentIdRelation(handle parentBuf,
                           handle child,
                           Text parentIdField,
                           Text parentFieldsBefore)

Adds a data-relation object for a pair of parent and child buffers that is based on the RECID of the parent buffer to this DataSet object. This DataSet must be dynamically created. The newly created object will have the PARENT-ID-RELATION attribute set to TRUE.

Parameters:

parentBuf - The handle to the parent buffer in the data-relation object.

child - The handle to the child buffer in the data-relation object.

parentIdField - Denotes the RECID field in child-buffer-handle on which this parent-id-relation object is based.

parentFieldsBefore - A list of comma-separated fields from the parent record to be written to XML before any nested child-buffer-handle records.

Returns:

A handle to the newly created DataRelation object.

addParentIdRelation

handle addParentIdRelation(handle parentBuf,
                           handle child,
                           Text parentIdField,
                           Text parentFieldsBefore,
                           Text parentFieldsAfter)

Adds a data-relation object for a pair of parent and child buffers that is based on the RECID of the parent buffer to this DataSet object. This DataSet must be dynamically created. The newly created object will have the PARENT-ID-RELATION attribute set to TRUE.

Parameters:

parentBuf - The handle to the parent buffer in the data-relation object.

child - The handle to the child buffer in the data-relation object.

parentIdField - Denotes the RECID field in child-buffer-handle on which this parent-id-relation object is based.

parentFieldsBefore - A list of comma-separated fields from the parent record to be written to XML before any nested child-buffer-handle records.

parentFieldsAfter - A list of comma-separated fields from the parent record to be written to XML after all nested child-buffer-handle records.

Returns:

A handle to the newly created DataRelation object.

copyDataset

logical copyDataset(handle srcDS)

Copies a source DataSet object into this DataSet object.

Parameters:

srcDS - The source DataSet.

Returns:

true on success.

copyDataset

logical copyDataset(handle srcDS,
                    logical append)

Copies a source DataSet object into this DataSet object.

Parameters:

srcDS - The source DataSet.

append - When true the source temp-tables are appended to current temp-tables.

Returns:

true on success.

copyDataset

logical copyDataset(handle srcDS,
                    logical append,
                    logical replace)

Copies a source DataSet object into this DataSet object.

Parameters:

srcDS - The source DataSet.

append - When true the source temp-tables are appended to current temp-tables.

replace - When true the records in this temp-tables are replaced with records from the temp-tables of source DataSet.

Returns:

true on success.

copyDataset

logical copyDataset(handle srcDS,
                    logical append,
                    logical replace,
                    logical looseCopy)

Copies a source DataSet object into this DataSet object.

Parameters:

srcDS - The source DataSet.

append - When true the source temp-tables are appended to current temp-tables.

replace - When true the records in this temp-tables are replaced with records from the temp-tables of source DataSet.

looseCopy - When TRUE, each temp-table in the source DataSet object is copied to this DataSet object based on a field mapping between the source and target temp-table buffers.

Returns:

true on success.

copyDataset

logical copyDataset(handle srcDS,
                    logical append,
                    logical replace,
                    logical looseCopy,
                    Text pairList)

Copies a source DataSet object into this DataSet object.

Parameters:

srcDS - The source DataSet.

append - When true the source temp-tables are appended to current temp-tables.

replace - When true the records in this temp-tables are replaced with records from the temp-tables of source DataSet.

looseCopy - When TRUE, each temp-table in the source DataSet object is copied to this DataSet object based on a field mapping between the source and target temp-table buffers.

pairList - A list of the target and source temp-table PAIRS to be copied, comma-delimited.

Returns:

true on success.

copyDataset

logical copyDataset(handle srcDS,
                    logical append,
                    logical replace,
                    logical looseCopy,
                    Text pairList,
                    logical currentOnly)

Copies a source DataSet object into this DataSet object.

Parameters:

srcDS - The source DataSet.

append - When true the source temp-tables are appended to current temp-tables.

replace - When true the records in this temp-tables are replaced with records from the temp-tables of source DataSet.

looseCopy - When TRUE, each temp-table in the source DataSet object is copied to this DataSet object based on a field mapping between the source and target temp-table buffers.

pairList - A list of the target and source temp-table PAIRS to be copied, comma-delimited.

currentOnly - Use TRUE indicates that the AVM copy only the current record from each temp-table at each level in the source DataSet object to the target DataSet object. The default value is FALSE.

Returns:

true on success.

copyDataset

logical copyDataset(handle srcDS,
                    logical append,
                    logical replace,
                    logical looseCopy,
                    Text pairList,
                    logical currentOnly,
                    Text prefix)

Copies a source DataSet object into this DataSet object.

Parameters:

srcDS - The source DataSet.

append - When true the source temp-tables are appended to current temp-tables.

replace - When true the records in this temp-tables are replaced with records from the temp-tables of source DataSet.

looseCopy - When TRUE, each temp-table in the source DataSet object is copied to this DataSet object based on a field mapping between the source and target temp-table buffers.

pairList - A list of the target and source temp-table PAIRS to be copied, comma-delimited.

currentOnly - Use TRUE indicates that the AVM copy only the current record from each temp-table at each level in the source DataSet object to the target DataSet object. The default value is FALSE.

prefix - An expression used as the prefix for (re-)naming the target DataSet.

Returns:

true on success.