com.aurel.track.persist
Class BaseTDashboardPanelPeer

java.lang.Object
  BasePeer
      com.aurel.track.persist.BaseTDashboardPanelPeer

Direct Known Subclasses:

TDashboardPanelPeer

public abstract class BaseTDashboardPanelPeer
extends BasePeer

Field Summary

protected static java.lang.Class	CLASS_DEFAULT A class that can be returned by this peer.
protected static java.lang.String	CLASSNAME_DEFAULT A class that can be returned by this peer.
static java.lang.String	COLSNO the column name for the COLSNO field
static java.lang.String	DATABASE_NAME the default database name for this class
static java.lang.String	DESCRIPTION the column name for the DESCRIPTION field
static java.lang.String	LABEL the column name for the LABEL field
static java.lang.String	NAME the column name for the NAME field
static int	numColumns number of columns for this peer
static java.lang.String	OBJECTID the column name for the OBJECTID field
static java.lang.String	PARENT the column name for the PARENT field
static java.lang.String	ROWSNO the column name for the ROWSNO field
static java.lang.String	SORTORDER the column name for the SORTORDER field
static java.lang.String	TABLE_NAME the table name for this class

Constructor Summary

BaseTDashboardPanelPeer()

Method Summary

static void	addSelectColumns(Criteria criteria) Add all the columns needed to create a new object.
static Criteria	buildCriteria(ObjectKey pk) Build a Criteria object from an ObjectKey
static Criteria	buildSelectCriteria(TDashboardPanel obj) Build a Criteria object from the data object for this peer, skipping all binary columns
static void	correctBooleans(Criteria criteria) changes the boolean values in the criteria to the appropriate type, whenever a booleanchar or booleanint column is involved.
static void	doDelete(Criteria criteria) Method to do deletes.
static void	doDelete(Criteria criteria, java.sql.Connection con) Method to do deletes.
static ObjectKey	doInsert(Criteria criteria) Method to do inserts.
static ObjectKey	doInsert(Criteria criteria, java.sql.Connection con) Method to do inserts.
static java.util.List	doSelect(Criteria criteria) Method to do selects.
static java.util.List	doSelect(Criteria criteria, java.sql.Connection con) Method to do selects within a transaction.
protected static java.util.List	doSelectJoinTDashboardTab(Criteria criteria) selects a collection of TDashboardPanel objects pre-filled with their TDashboardTab objects.
protected static java.util.List	doSelectJoinTDashboardTab(Criteria criteria, java.sql.Connection conn) selects a collection of TDashboardPanel objects pre-filled with their TDashboardTab objects.
static java.util.List	doSelectVillageRecords(Criteria criteria) Grabs the raw Village records to be formed into objects.
static java.util.List	doSelectVillageRecords(Criteria criteria, java.sql.Connection con) Grabs the raw Village records to be formed into objects.
static void	doUpdate(Criteria criteria) Method to do updates.
static void	doUpdate(Criteria criteria, java.sql.Connection con) Method to do updates.
static MapBuilder	getMapBuilder() Deprecated. Torque.getMapBuilder(TDashboardPanelMapBuilder.CLASS_NAME) instead
static java.lang.Class	getOMClass() The class that the Peer will make instances of.
static TableMap	getTableMap() Returns the TableMap related to this peer.
static void	populateObject(Record row, int offset, TDashboardPanel obj) Populates an object from a resultset row starting from a specified offset.
static java.util.List	populateObjects(java.util.List records) The returned List will contain objects of the default type or objects that inherit from the default.
static java.util.List	resultSet2Objects(java.sql.ResultSet results) Get the list of objects for a ResultSet.
static TDashboardPanel	retrieveByPK(java.lang.Integer pk) Retrieve a single object by pk
static TDashboardPanel	retrieveByPK(java.lang.Integer pk, java.sql.Connection con) Retrieve a single object by pk
static java.util.List	retrieveByPKs(java.util.List pks) Retrieve a multiple objects by pk
static java.util.List	retrieveByPKs(java.util.List pks, java.sql.Connection dbcon) Retrieve a multiple objects by pk
static TDashboardPanel	row2Object(Record row, int offset, java.lang.Class cls) Create a new object of type cls from a resultset row starting from a specified offset.

Methods inherited from class java.lang.Object

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

Field Detail

DATABASE_NAME

public static final java.lang.String DATABASE_NAME

the default database name for this class

TABLE_NAME

public static final java.lang.String TABLE_NAME

the table name for this class

OBJECTID

public static final java.lang.String OBJECTID

the column name for the OBJECTID field

NAME

public static final java.lang.String NAME

the column name for the NAME field

LABEL

public static final java.lang.String LABEL

the column name for the LABEL field

DESCRIPTION

public static final java.lang.String DESCRIPTION

the column name for the DESCRIPTION field

SORTORDER

public static final java.lang.String SORTORDER

the column name for the SORTORDER field

ROWSNO

public static final java.lang.String ROWSNO

the column name for the ROWSNO field

COLSNO

public static final java.lang.String COLSNO

the column name for the COLSNO field

PARENT

public static final java.lang.String PARENT

the column name for the PARENT field

numColumns

public static final int numColumns

number of columns for this peer

See Also:

Constant Field Values

CLASSNAME_DEFAULT

protected static final java.lang.String CLASSNAME_DEFAULT

A class that can be returned by this peer.

See Also:

Constant Field Values

CLASS_DEFAULT

protected static final java.lang.Class CLASS_DEFAULT

A class that can be returned by this peer.

Constructor Detail

BaseTDashboardPanelPeer

public BaseTDashboardPanelPeer()

Method Detail

getMapBuilder

public static MapBuilder getMapBuilder()
                                throws TorqueException

Deprecated. Torque.getMapBuilder(TDashboardPanelMapBuilder.CLASS_NAME) instead

Returns:

the map builder for this peer

Throws:

TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

resultSet2Objects

public static java.util.List resultSet2Objects(java.sql.ResultSet results)
                                        throws TorqueException

Get the list of objects for a ResultSet. Please not that your resultset MUST return columns in the right order. You can use getFieldNames() in BaseObject to get the correct sequence.

Parameters:

results - the ResultSet

Returns:

the list of objects

Throws:

TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

doInsert

public static ObjectKey doInsert(Criteria criteria)
                          throws TorqueException

Method to do inserts.

Parameters:

criteria - object used to create the INSERT statement.

Throws:

TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

doInsert

public static ObjectKey doInsert(Criteria criteria,
                                 java.sql.Connection con)
                          throws TorqueException

Method to do inserts. This method is to be used during a transaction, otherwise use the doInsert(Criteria) method. It will take care of the connection details internally.

Parameters:

criteria - object used to create the INSERT statement.

con - the connection to use

Throws:

TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

addSelectColumns

public static void addSelectColumns(Criteria criteria)
                             throws TorqueException

Add all the columns needed to create a new object.

Parameters:

criteria - object containing the columns to add.

Throws:

TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

correctBooleans

public static void correctBooleans(Criteria criteria)
                            throws TorqueException

changes the boolean values in the criteria to the appropriate type, whenever a booleanchar or booleanint column is involved. This enables the user to create criteria using Boolean values for booleanchar or booleanint columns

Parameters:

criteria - the criteria in which the boolean values should be corrected

Throws:

TorqueException - if the database map for the criteria cannot be obtained.

row2Object

public static TDashboardPanel row2Object(Record row,
                                         int offset,
                                         java.lang.Class cls)
                                  throws TorqueException

Create a new object of type cls from a resultset row starting from a specified offset. This is done so that you can select other rows than just those needed for this object. You may for example want to create two objects from the same row.

Throws:

TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

populateObject

public static void populateObject(Record row,
                                  int offset,
                                  TDashboardPanel obj)
                           throws TorqueException

Populates an object from a resultset row starting from a specified offset. This is done so that you can select other rows than just those needed for this object. You may for example want to create two objects from the same row.

Throws:

TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

doSelect

public static java.util.List doSelect(Criteria criteria)
                               throws TorqueException

Method to do selects.

Parameters:

criteria - object used to create the SELECT statement.

Returns:

List of selected Objects

Throws:

TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

doSelect

public static java.util.List doSelect(Criteria criteria,
                                      java.sql.Connection con)
                               throws TorqueException

Method to do selects within a transaction.

Parameters:

criteria - object used to create the SELECT statement.

con - the connection to use

Returns:

List of selected Objects

Throws:

TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

doSelectVillageRecords

public static java.util.List doSelectVillageRecords(Criteria criteria)
                                             throws TorqueException

Grabs the raw Village records to be formed into objects. This method handles connections internally. The Record objects returned by this method should be considered readonly. Do not alter the data and call save(), your results may vary, but are certainly likely to result in hard to track MT bugs.

Throws:

TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

doSelectVillageRecords

public static java.util.List doSelectVillageRecords(Criteria criteria,
                                                    java.sql.Connection con)
                                             throws TorqueException

Grabs the raw Village records to be formed into objects. This method should be used for transactions

Parameters:

criteria - object used to create the SELECT statement.

con - the connection to use

Throws:

TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

populateObjects

public static java.util.List populateObjects(java.util.List records)
                                      throws TorqueException

The returned List will contain objects of the default type or objects that inherit from the default.

Throws:

TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

getOMClass

public static java.lang.Class getOMClass()
                                  throws TorqueException

The class that the Peer will make instances of. If the BO is abstract then you must implement this method in the BO.

Throws:

TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

doUpdate

public static void doUpdate(Criteria criteria)
                     throws TorqueException

Method to do updates.

Parameters:

criteria - object containing data that is used to create the UPDATE statement.

Throws:

TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

doUpdate

public static void doUpdate(Criteria criteria,
                            java.sql.Connection con)
                     throws TorqueException

Method to do updates. This method is to be used during a transaction, otherwise use the doUpdate(Criteria) method. It will take care of the connection details internally.

Parameters:

criteria - object containing data that is used to create the UPDATE statement.

con - the connection to use

Throws:

TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

doDelete

public static void doDelete(Criteria criteria)
                     throws TorqueException

Method to do deletes.

Parameters:

criteria - object containing data that is used DELETE from database.

Throws:

TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

doDelete

public static void doDelete(Criteria criteria,
                            java.sql.Connection con)
                     throws TorqueException

Method to do deletes. This method is to be used during a transaction, otherwise use the doDelete(Criteria) method. It will take care of the connection details internally.

Parameters:

criteria - object containing data that is used DELETE from database.

con - the connection to use

Throws:

TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

buildCriteria

public static Criteria buildCriteria(ObjectKey pk)

Build a Criteria object from an ObjectKey

buildSelectCriteria

public static Criteria buildSelectCriteria(TDashboardPanel obj)

Build a Criteria object from the data object for this peer, skipping all binary columns

retrieveByPK

public static TDashboardPanel retrieveByPK(java.lang.Integer pk)
                                    throws TorqueException,
                                           NoRowsException,
                                           TooManyRowsException

Retrieve a single object by pk

Parameters:

pk - the primary key

Throws:

TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

NoRowsException - Primary key was not found in database.

TooManyRowsException - Primary key was not found in database.

retrieveByPK

public static TDashboardPanel retrieveByPK(java.lang.Integer pk,
                                           java.sql.Connection con)
                                    throws TorqueException,
                                           NoRowsException,
                                           TooManyRowsException

Retrieve a single object by pk

Parameters:

pk - the primary key

con - the connection to use

Throws:

TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

NoRowsException - Primary key was not found in database.

TooManyRowsException - Primary key was not found in database.

retrieveByPKs

public static java.util.List retrieveByPKs(java.util.List pks)
                                    throws TorqueException

Retrieve a multiple objects by pk

Parameters:

pks - List of primary keys

Throws:

TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

retrieveByPKs

public static java.util.List retrieveByPKs(java.util.List pks,
                                           java.sql.Connection dbcon)
                                    throws TorqueException

Retrieve a multiple objects by pk

Parameters:

pks - List of primary keys

dbcon - the connection to use

Throws:

TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

doSelectJoinTDashboardTab

protected static java.util.List doSelectJoinTDashboardTab(Criteria criteria)
                                                   throws TorqueException

selects a collection of TDashboardPanel objects pre-filled with their TDashboardTab objects. This method is protected by default in order to keep the public api reasonable. You can provide public methods for those you actually need in TDashboardPanelPeer.

Throws:

TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

doSelectJoinTDashboardTab

protected static java.util.List doSelectJoinTDashboardTab(Criteria criteria,
                                                          java.sql.Connection conn)
                                                   throws TorqueException

selects a collection of TDashboardPanel objects pre-filled with their TDashboardTab objects. This method is protected by default in order to keep the public api reasonable. You can provide public methods for those you actually need in TDashboardPanelPeer.

Throws:

TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

getTableMap

public static TableMap getTableMap()
                            throws TorqueException

Returns the TableMap related to this peer.

Throws:

TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.