com.datafoundations.onedata.hook

Class Rowset

java.lang.Object

com.datafoundations.onedata.hook.Rowset

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

ActionRowset, ShowableRowset

public class Rowset
extends java.lang.Object
implements java.io.Serializable

The Rowset class represents a collection of objects of type Row. An object of this class will represent information corresponding to one or more rows of a database table.

See Also:

Row, Serialized Form

Constructor Summary

Constructors

Constructor and Description
Rowset() Creates an empty rowset object.

Method Summary

Modifier and Type	Method and Description
void	addRow(Row row) Adds the given row to the rowset.
int	getObjectId() Returns the id of the data object to which the rowset corresponds.
java.lang.String	getObjectName() Returns the name of the data object to which the rowset corresponds.
int	getObjectType() Returns the object type of object corresponding to the rowset.
java.util.List	getRows() Returns collection of rows present in the rowset.
java.lang.String	getTableName() Returns the physical table name of the database table corresponding to the rowset.
void	setObjectId(int objectId) Sets the id of the data object to which the rowset corresponds.
void	setObjectName(java.lang.String objectName) Sets the name of the data object to which the rowset corresponds.
void	setObjectType(int objectType) Sets the object type of object corresponding to the rowset.
void	setRows(java.util.List rows) Sets a collection of rows in the rowset.
void	setTableName(java.lang.String tableName) Sets the physical table name of the rowset.

Methods inherited from class java.lang.Object

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

Constructor Detail

Rowset

public Rowset()

Creates an empty rowset object.

Method Detail

addRow

public void addRow(Row row)

Adds the given row to the rowset.

Parameters:

row - Parameter denoting the Row object

See Also:

Row

getRows

public java.util.List getRows()

Returns collection of rows present in the rowset.

Returns:

returns a list of rows present in the rowset. If no rows are present, it returns an empty list.

See Also:

Row

setRows

public void setRows(java.util.List rows)

Sets a collection of rows in the rowset.

Parameters:

rows - list of Row objects.

getTableName

public java.lang.String getTableName()

Returns the physical table name of the database table corresponding to the rowset.

Returns:

tableName - the physical table name of the database table corresponding to the rowset.

setTableName

public void setTableName(java.lang.String tableName)

Sets the physical table name of the rowset. This name would correspond to the name of the database table.

Parameters:

tableName - A String denoting tableName of the rowset.

getObjectName

public java.lang.String getObjectName()

Returns the name of the data object to which the rowset corresponds.

Returns:

objectName - the name of the data object to which the rowset corresponds.

setObjectName

public void setObjectName(java.lang.String objectName)

Sets the name of the data object to which the rowset corresponds.

Parameters:

objectName - A String denoting the name of the data object to which the rowset corresponds.

getObjectId

public int getObjectId()

Returns the id of the data object to which the rowset corresponds.

Returns:

id - the id of the data object to which the rowset corresponds.

setObjectId

public void setObjectId(int objectId)

Sets the id of the data object to which the rowset corresponds.

Parameters:

id - An int denoting the id of the data object to which the rowset corresponds.

getObjectType

public int getObjectType()

Returns the object type of object corresponding to the rowset.

Returns:

objectType - the object type of object corresponding to the rowset.
For more information on permissible values for objectType, refer to setObjectType(int)

setObjectType

public void setObjectType(int objectType)

Sets the object type of object corresponding to the rowset.

Parameters:

objectType -
1 : If tableName is used, then set objectType = 1
2 : If objectName is used, then set objectType = 2
3 : Used only when ShowableRowset instance is used. This would represent virtual row in the rowset (i.e.data object structure is present in OneData but data in the row is not present in database table).
4 : Used only when ShowableRowset instance is used and there is no corresponding OneData data object.