xdev.vt

Class VirtualTable.VirtualTableRow

java.lang.Object

xdev.vt.VirtualTable.VirtualTableRow

All Implemented Interfaces:

Serializable

Enclosing class:

VirtualTable

public class VirtualTable.VirtualTableRow
extends Object
implements Serializable

Represents a single row within a VirtualTable.

Author:

XDEV Software Corp.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
void	delete(boolean synchronizeDB) Deletes a VirtualTable.VirtualTableRow from its VirtualTable.
boolean	equals(Object obj)
boolean	equalsValues(VirtualTable.VirtualTableRow other) Checks if the values of this row are the same as the values of an other row.
String	format(String str) Returns a formatted string, with this row used as StringUtils.ParameterProvider.
Object	get(int i) Returns the value at the specified column index.
Object	get(String name) Returns the value at the specified column.
<T> T	get(VirtualTableColumn<T> column) Returns the value at the specified column.
String	getFormattedValue(int col) Returns a formatted representation for the value at col.
PessimisticLock	getPessimisticLock() Returns a PessimisticLock related to this row.
PessimisticLock	getPessimisticLock(long lockTime) Returns a PessimisticLock related to this row, with the given locktime as lock duration.
VirtualTable.RowState	getRowState() Returns the state of this row
Object[]	getValues() Returns all values of this row as an array.
VirtualTable	getVirtualTable() Returns the surrounding VirtualTable of this VirtualTable.VirtualTableRow.
void	insert(Map<String,Object> data, boolean synchronizeDB) Inserts a VirtualTable.VirtualTableRow into its VirtualTable.
void	insert(Map<String,Object> data, boolean synchronizeDB, DBConnection connection) Inserts a VirtualTable.VirtualTableRow into its VirtualTable.
boolean	isNew() Checks if this VirtualTable.VirtualTableRow exists in the VirtualTable.
void	reload() Reloads the contents of this VirtualTable.VirtualTableRow from the database.
void	reload(DBDataSource dataSource) Reloads the contents of this VirtualTable.VirtualTableRow from the database.
void	reloadDefault() Reloads the contents of this VirtualTable.VirtualTableRow from the database with the default query.
void	reloadDefault(DBDataSource dataSource) Reloads the contents of this VirtualTable.VirtualTableRow from the database with the default query.
void	save(boolean synchronizeDB) Saves a VirtualTable.VirtualTableRow.
void	save(boolean synchronizeDB, DBConnection connection) Saves a VirtualTable.VirtualTableRow.
void	save(Map<String,Object> data, boolean synchronizeDB) Saves a VirtualTable.VirtualTableRow.
void	save(Map<String,Object> data, boolean synchronizeDB, DBConnection connection) Saves a VirtualTable.VirtualTableRow.
Object	set(int index, Object value) Sets a value for this VirtualTable.VirtualTableRow at the specified column index.
Object	set(String columnName, Object value) Sets a value for this VirtualTable.VirtualTableRow at the specified column index.
void	setRowState(VirtualTable.RowState rowState) Updates the state of this row.
int	size() Returns the number of columns of this VirtualTable.VirtualTableRow.
String[]	toFormattedStrings() Returns an array of formatted String representations for this VirtualTable.VirtualTableRow.
XdevList	toList() Returns all values of this row as a XdevList.
Map<String,Object>	toMap() Returns all values of this row as an Map.
String	toString() Custom toString Implementation for VirtualTable.VirtualTableRow.
void	update(Map<String,Object> data, boolean synchronizeDB) Updates a VirtualTable.VirtualTableRow.
void	update(Map<String,Object> data, boolean synchronizeDB, DBConnection connection) Updates a VirtualTable.VirtualTableRow.
void	updateKeys(Result generatedKeys) Updates the auto value columns with values from generatedKeys.

Methods inherited from class java.lang.Object

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

Method Detail

getPessimisticLock

public PessimisticLock getPessimisticLock(long lockTime)
                                   throws LockingException

Returns a PessimisticLock related to this row, with the given locktime as lock duration.

This should be used to create a PessimisticLock instance with the given lockTime.

To actually lock this VirtualTable.VirtualTableRow invoke PessimisticLock.getLock()

Parameters:

lockTime - the locks duration.

Returns:

a PessimisticLock instance for this particular row.

Throws:

LockingException

Since:

4.0

getPessimisticLock

public PessimisticLock getPessimisticLock()
                                   throws LockingException

Returns a PessimisticLock related to this row. If the lock does not already exist, a new PessimisticLock instance with its default timeout will be created in consequence.

To actually lock this VirtualTable.VirtualTableRow invoke PessimisticLock.getLock()

Returns:

a PessimisticLock instance for this particular row.

Throws:

LockingException

Since:

4.0

getVirtualTable

public VirtualTable getVirtualTable()

Returns the surrounding VirtualTable of this VirtualTable.VirtualTableRow.

Returns:

a VirtualTable

set

public Object set(String columnName,
                  Object value)
           throws VirtualTableException,
                  IllegalArgumentException

Sets a value for this VirtualTable.VirtualTableRow at the specified column index.

Parameters:

columnName - the name of the column

value - the new value of the column

Returns:

the new value

Throws:

VirtualTableException - if the value is not appropriate for the specified column

IllegalArgumentException - if the column columnName does not exist in this VirtualTable

set

public Object set(int index,
                  Object value)
           throws VirtualTableException

Sets a value for this VirtualTable.VirtualTableRow at the specified column index.

Parameters:

index - the index of the column to set

value - the new value of the column

Returns:

the new value

Throws:

VirtualTableException - if the value is not appropriate for the specified column

get

public Object get(int i)

Returns the value at the specified column index.

Parameters:

i - the index of the column

Returns:

a value

get

public Object get(String name)

Returns the value at the specified column.

Parameters:

name - the name of the column

Returns:

a value

Since:

3.2

get

public <T> T get(VirtualTableColumn<T> column)

Returns the value at the specified column.

Parameters:

column - VirtualTableColumn

Returns:

the value of the cell at the specified position.

getFormattedValue

public String getFormattedValue(int col)

Returns a formatted representation for the value at col. The TextFormat of the VirtualTableColumn at index col is used to format the value.

Parameters:

col - the index of the column (0-based)

Returns:

a formatted String representation of the specified value.

format

public String format(String str)

Returns a formatted string, with this row used as StringUtils.ParameterProvider.

Parameters:

str - the String to identify the value's in the StringUtils.ParameterProvider

Returns:

a formatted string

See Also:

StringUtils.format(String, ParameterProvider), VirtualTable.formatValue(Object, int)

size

public int size()

Returns the number of columns of this VirtualTable.VirtualTableRow.

Returns:

the number of columns

isNew

public boolean isNew()

Checks if this VirtualTable.VirtualTableRow exists in the VirtualTable.

Returns:

false if this VirtualTable.VirtualTableRow exists in the VirtualTable, true otherwise

save

public void save(boolean synchronizeDB)
          throws VirtualTableException,
                 DBException

Saves a VirtualTable.VirtualTableRow.

If the VirtualTable.VirtualTableRow is already part of a VirtualTable, an update is performed. Otherwise an insert will be done.

Parameters:

synchronizeDB - if set to true, changes will be propagated to the underlying data source.

Throws:

VirtualTableException

DBException - thrown if database access failed.

Since:

3.1

save

public void save(boolean synchronizeDB,
                 DBConnection connection)
          throws VirtualTableException,
                 DBException

Saves a VirtualTable.VirtualTableRow.

If the VirtualTable.VirtualTableRow is already part of a VirtualTable, an update is performed. Otherwise an insert will be done.

Parameters:

synchronizeDB - if set to true, changes will be propagated to the underlying data source.

connection - An already open connection, e.g. in a transaction, or null

Throws:

VirtualTableException

DBException - thrown if database access failed.

Since:

3.1

save

public void save(Map<String,Object> data,
                 boolean synchronizeDB)
          throws VirtualTableException,
                 DBException

Saves a VirtualTable.VirtualTableRow.

If the VirtualTable.VirtualTableRow is already part of a VirtualTable, an update is performed. Otherwise an insert will be done.

Parameters:

data - a Map of String keys and Object as values, containing the column names and values for the row.

synchronizeDB - if set to true, changes will be propagated to the underlying data source.

Throws:

VirtualTableException

DBException - thrown if database access failed.

save

public void save(Map<String,Object> data,
                 boolean synchronizeDB,
                 DBConnection connection)
          throws VirtualTableException,
                 DBException

Saves a VirtualTable.VirtualTableRow.

If the VirtualTable.VirtualTableRow is already part of a VirtualTable, an update is performed. Otherwise an insert will be done.

Parameters:

data - a Map of String keys and Object as values, containing the column names and values for the row.

synchronizeDB - if set to true, changes will be propagated to the underlying data source.

connection - An already open connection, e.g. in a transaction, or null

Throws:

VirtualTableException

DBException - thrown if database access failed.

update

public void update(Map<String,Object> data,
                   boolean synchronizeDB)
            throws VirtualTableException,
                   DBException

Updates a VirtualTable.VirtualTableRow.

Parameters:

data - a Map of String keys and Object as values, containing the column names and values for the row.

synchronizeDB - if set to true, changes will be propagated to database.

Throws:

VirtualTableException

DBException - thrown if database access failed.

update

public void update(Map<String,Object> data,
                   boolean synchronizeDB,
                   DBConnection connection)
            throws VirtualTableException,
                   DBException

Updates a VirtualTable.VirtualTableRow.

Parameters:

data - a Map of String keys and Object as values, containing the column names and values for the row.

synchronizeDB - if set to true, changes will be propagated to database.

connection - An already open connection, e.g. in a transaction, or null

Throws:

VirtualTableException

DBException - thrown if database access failed.

insert

public void insert(Map<String,Object> data,
                   boolean synchronizeDB)
            throws VirtualTableException,
                   DBException

Inserts a VirtualTable.VirtualTableRow into its VirtualTable.

Parameters:

data - a Map of String keys and Object as values, containing the column names and values for the row.

synchronizeDB - if set to true, changes will be propagated to database.

Throws:

VirtualTableException

DBException - thrown if database access failed.

insert

public void insert(Map<String,Object> data,
                   boolean synchronizeDB,
                   DBConnection connection)
            throws VirtualTableException,
                   DBException

Inserts a VirtualTable.VirtualTableRow into its VirtualTable.

Parameters:

data - a Map of String keys and Object as values, containing the column names and values for the row.

synchronizeDB - if set to true, changes will be propagated to database.

connection - An already open connection, e.g. in a transaction, or null

Throws:

VirtualTableException

DBException - thrown if database access failed.

delete

public void delete(boolean synchronizeDB)
            throws VirtualTableException,
                   DBException

Deletes a VirtualTable.VirtualTableRow from its VirtualTable.

Parameters:

synchronizeDB - if set to true, changes will be propagated to database.

Throws:

VirtualTableException

DBException - thrown if database access failed.

reload

public void reload()
            throws VirtualTableException,
                   DBException

Reloads the contents of this VirtualTable.VirtualTableRow from the database.

This is an alias for reload(DBDataSource).

Throws:

VirtualTableException

DBException - thrown if database access failed.

reload

public void reload(DBDataSource dataSource)
            throws VirtualTableException,
                   DBException

Reloads the contents of this VirtualTable.VirtualTableRow from the database.

Parameters:

dataSource - the DBDataSource to be used to do the reloads

Throws:

VirtualTableException

DBException - thrown if database access failed.

reloadDefault

public void reloadDefault()
                   throws VirtualTableException,
                          DBException

Reloads the contents of this VirtualTable.VirtualTableRow from the database with the default query.

This is an alias for reloadDefault(DBDataSource).

Parameters:

dataSource - the DBDataSource to be used to do the reloads

Throws:

VirtualTableException

DBException - thrown if database access failed.

Since:

5.0

reloadDefault

public void reloadDefault(DBDataSource dataSource)
                   throws VirtualTableException,
                          DBException

Reloads the contents of this VirtualTable.VirtualTableRow from the database with the default query.

Throws:

VirtualTableException

DBException - thrown if database access failed.

Since:

5.0

toString

public String toString()

Custom toString Implementation for VirtualTable.VirtualTableRow.

The String contains all elements of the VirtualTableRow in a comma separated list

Overrides:

toString in class Object

Returns:

a String representation of this VirtualTable.VirtualTableRow.

toFormattedStrings

public String[] toFormattedStrings()

Returns an array of formatted String representations for this VirtualTable.VirtualTableRow.

Returns:

an array of Strings

toMap

public Map<String,Object> toMap()

Returns all values of this row as an Map. The keys of the map are the column names, the entries are the values.

Returns:

all values of this row as an Map.

toList

public XdevList toList()

Returns all values of this row as a XdevList.

Returns:

all values of this row as a XdevList.

getValues

public Object[] getValues()

Returns all values of this row as an array.

Returns:

all values of this row as an array.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsValues

public boolean equalsValues(VirtualTable.VirtualTableRow other)

Checks if the values of this row are the same as the values of an other row.

Parameters:

other - The row to compare

Returns:

true if the values of both rows are equal, false otherwise

See Also:

VirtualTable.equals(Object, Object)

updateKeys

public void updateKeys(Result generatedKeys)
                throws DBException

Updates the auto value columns with values from generatedKeys.

This method gets called automatically after a row is inserted into the database.

Parameters:

generatedKeys - the generated key values

Throws:

DBException - if an database error occurs

getRowState

public VirtualTable.RowState getRowState()

Returns the state of this row

Returns:

the state of this row

Since:

3.1

setRowState

public void setRowState(VirtualTable.RowState rowState)

Updates the state of this row.

Parameters:

rowState - the new state

Since:

3.1