XPUSP - Home

br.usp.ime.xpusp.om
Class BaseSourcePeer

java.lang.Object
  |
  +--org.apache.turbine.om.peer.BasePeer
        |
        +--br.usp.ime.xpusp.om.BaseSourcePeer
Direct Known Subclasses:
SourcePeer

public abstract class BaseSourcePeer
extends org.apache.turbine.om.peer.BasePeer

This class was autogenerated by Torque.


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.
private static SourceMapBuilder mapBuilder
          the mapbuilder for this class
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 SOURCE_ID
          the column name for the SOURCE_ID field
static java.lang.String TABLE_NAME
          the table name for this class
 
Fields inherited from class org.apache.turbine.om.peer.BasePeer
DEFAULT_MAP_BUILDER, IGNORE_CASE, mapBuilders, ORDER_BY
 
Constructor Summary
BaseSourcePeer()
           
 
Method Summary
static void addSelectColumns(org.apache.turbine.util.db.Criteria criteria)
          Add all the columns needed to create a new object
static org.apache.turbine.util.db.Criteria buildCriteria(Source obj)
          Build a Criteria object from the data object for this peer
static void doDelete(org.apache.turbine.util.db.Criteria criteria)
          Method to do deletes.
static void doDelete(org.apache.turbine.util.db.Criteria criteria, org.apache.turbine.util.db.pool.DBConnection dbCon)
          Method to do deletes.
static void doDelete(Source obj)
           
static void doDelete(Source obj, org.apache.turbine.util.db.pool.DBConnection dbCon)
          Method to delete.
static org.apache.turbine.om.ObjectKey doInsert(org.apache.turbine.util.db.Criteria criteria)
          Method to do inserts
static org.apache.turbine.om.ObjectKey doInsert(org.apache.turbine.util.db.Criteria criteria, org.apache.turbine.util.db.pool.DBConnection dbCon)
          Method to do inserts.
static void doInsert(Source obj)
          Method to do inserts
static void doInsert(Source obj, org.apache.turbine.util.db.pool.DBConnection dbCon)
          Method to do inserts.
static java.util.Vector doSelect(org.apache.turbine.util.db.Criteria criteria)
          Method to do selects
static java.util.Vector doSelect(org.apache.turbine.util.db.Criteria criteria, org.apache.turbine.util.db.pool.DBConnection dbCon)
          Method to do selects within a transaction
static java.util.Vector doSelectVillageRecords(org.apache.turbine.util.db.Criteria criteria)
          Grabs the raw Village records to be formed into objects.
static java.util.Vector doSelectVillageRecords(org.apache.turbine.util.db.Criteria criteria, org.apache.turbine.util.db.pool.DBConnection dbCon)
          Grabs the raw Village records to be formed into objects.
static void doUpdate(org.apache.turbine.util.db.Criteria criteria)
          Method to do updates.
static void doUpdate(org.apache.turbine.util.db.Criteria criteria, org.apache.turbine.util.db.pool.DBConnection dbCon)
          Method to do updates.
static void doUpdate(Source obj)
           
static void doUpdate(Source obj, org.apache.turbine.util.db.pool.DBConnection dbCon)
          Method to do update.
static org.apache.turbine.util.db.map.MapBuilder getMapBuilder()
           
static java.lang.Class getOMClass()
          The class that the Peer will make instances of.
protected static org.apache.turbine.util.db.map.TableMap getTableMap()
          Returns the TableMap related to this peer.
private static java.lang.Class initClass()
          Initialization method for static CLASS_DEFAULT attribute
static void populateObject(com.workingdogs.village.Record row, int offset, Source obj)
          Populates an object from a resultset row starting from a specified offset.
static java.util.Vector populateObjects(java.util.Vector records)
          The returned vector will contain objects of the default type or objects that inherit from the default.
static java.util.Vector resultSet2Objects(java.sql.ResultSet results)
          Get the list of objects for a ResultSet.
static Source retrieveByPK(org.apache.turbine.om.ObjectKey pk)
          Retrieve a single object by pk
static Source retrieveByPK(org.apache.turbine.om.ObjectKey pk, org.apache.turbine.util.db.pool.DBConnection dbcon)
          Retrieve a single object by pk
static Source row2Object(com.workingdogs.village.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 org.apache.turbine.om.peer.BasePeer
, beginTransaction, commitTransaction, createPreparedStatement, createQueryString, deleteAll, deleteAll, doPSSelect, doPSSelect, doUpdate, doUpdate, executeQuery, executeQuery, executeQuery, executeQuery, executeQuery, executeQuery, executeStatement, executeStatement, executeStatement, getMapBuilder, getPrimaryKey, getSelectResults, getSelectResults, getSelectResults, getSelectResults, handleMultiple, handleMultipleRecords, hashtableToByteArray, initColumnNames, initCriteriaKeys, initTableColumns, initTableSchema, initTableSchema, insertOrUpdateRecord, rollBackTransaction
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait
 

Field Detail

mapBuilder

private static final SourceMapBuilder mapBuilder
the mapbuilder for this class

TABLE_NAME

public static final java.lang.String TABLE_NAME
the table name for this class

SOURCE_ID

public static final java.lang.String SOURCE_ID
the column name for the SOURCE_ID field

NAME

public static final java.lang.String NAME
the column name for the NAME field

numColumns

public static final int numColumns
number of columns for this peer

CLASSNAME_DEFAULT

protected static final java.lang.String CLASSNAME_DEFAULT
A class that can be returned by this peer.

CLASS_DEFAULT

protected static final java.lang.Class CLASS_DEFAULT
A class that can be returned by this peer.
Constructor Detail

BaseSourcePeer

public BaseSourcePeer()
Method Detail

getMapBuilder

public static org.apache.turbine.util.db.map.MapBuilder getMapBuilder()

initClass

private static java.lang.Class initClass()
Initialization method for static CLASS_DEFAULT attribute

resultSet2Objects

public static java.util.Vector resultSet2Objects(java.sql.ResultSet results)
                                          throws java.lang.Exception
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.

doInsert

public static org.apache.turbine.om.ObjectKey doInsert(org.apache.turbine.util.db.Criteria criteria)
                                                throws java.lang.Exception
Method to do inserts

doInsert

public static org.apache.turbine.om.ObjectKey doInsert(org.apache.turbine.util.db.Criteria criteria,
                                                       org.apache.turbine.util.db.pool.DBConnection dbCon)
                                                throws java.lang.Exception
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.

addSelectColumns

public static void addSelectColumns(org.apache.turbine.util.db.Criteria criteria)
                             throws java.lang.Exception
Add all the columns needed to create a new object

row2Object

public static Source row2Object(com.workingdogs.village.Record row,
                                int offset,
                                java.lang.Class cls)
                         throws java.lang.Exception
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.

populateObject

public static void populateObject(com.workingdogs.village.Record row,
                                  int offset,
                                  Source obj)
                           throws java.lang.Exception
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.

doSelect

public static java.util.Vector doSelect(org.apache.turbine.util.db.Criteria criteria)
                                 throws java.lang.Exception
Method to do selects

doSelect

public static java.util.Vector doSelect(org.apache.turbine.util.db.Criteria criteria,
                                        org.apache.turbine.util.db.pool.DBConnection dbCon)
                                 throws java.lang.Exception
Method to do selects within a transaction

doSelectVillageRecords

public static java.util.Vector doSelectVillageRecords(org.apache.turbine.util.db.Criteria criteria)
                                               throws java.lang.Exception
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.

doSelectVillageRecords

public static java.util.Vector doSelectVillageRecords(org.apache.turbine.util.db.Criteria criteria,
                                                      org.apache.turbine.util.db.pool.DBConnection dbCon)
                                               throws java.lang.Exception
Grabs the raw Village records to be formed into objects. This method should be used for transactions

populateObjects

public static java.util.Vector populateObjects(java.util.Vector records)
                                        throws java.lang.Exception
The returned vector will contain objects of the default type or objects that inherit from the default.

getOMClass

public static java.lang.Class getOMClass()
                                  throws java.lang.Exception
The class that the Peer will make instances of. If the BO is abstract then you must implement this method in the BO.

doUpdate

public static void doUpdate(org.apache.turbine.util.db.Criteria criteria)
                     throws java.lang.Exception
Method to do updates.
Parameters:
Criteria - object containing data that is used to create the UPDATE statement.

doUpdate

public static void doUpdate(org.apache.turbine.util.db.Criteria criteria,
                            org.apache.turbine.util.db.pool.DBConnection dbCon)
                     throws java.lang.Exception
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.

doDelete

public static void doDelete(org.apache.turbine.util.db.Criteria criteria)
                     throws java.lang.Exception
Method to do deletes.
Parameters:
Criteria - object containing data that is used DELETE from database.

doDelete

public static void doDelete(org.apache.turbine.util.db.Criteria criteria,
                            org.apache.turbine.util.db.pool.DBConnection dbCon)
                     throws java.lang.Exception
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.

doInsert

public static void doInsert(Source obj)
                     throws java.lang.Exception
Method to do inserts

doUpdate

public static void doUpdate(Source obj)
                     throws java.lang.Exception
Parameters:
obj - the data object to update in the database.

doDelete

public static void doDelete(Source obj)
                     throws java.lang.Exception
Parameters:
obj - the data object to delete in the database.

doInsert

public static void doInsert(Source obj,
                            org.apache.turbine.util.db.pool.DBConnection dbCon)
                     throws java.lang.Exception
Method to do inserts. This method is to be used during a transaction, otherwise use the doInsert(Source) method. It will take care of the connection details internally.
Parameters:
obj - the data object to insert into the database.

doUpdate

public static void doUpdate(Source obj,
                            org.apache.turbine.util.db.pool.DBConnection dbCon)
                     throws java.lang.Exception
Method to do update. This method is to be used during a transaction, otherwise use the doUpdate(Source) method. It will take care of the connection details internally.
Parameters:
obj - the data object to update in the database.

doDelete

public static void doDelete(Source obj,
                            org.apache.turbine.util.db.pool.DBConnection dbCon)
                     throws java.lang.Exception
Method to delete. This method is to be used during a transaction, otherwise use the doDelete(Source) method. It will take care of the connection details internally.
Parameters:
obj - the data object to delete in the database.

buildCriteria

public static org.apache.turbine.util.db.Criteria buildCriteria(Source obj)
Build a Criteria object from the data object for this peer

retrieveByPK

public static Source retrieveByPK(org.apache.turbine.om.ObjectKey pk)
                           throws java.lang.Exception
Retrieve a single object by pk
Parameters:
ObjectKey - pk

retrieveByPK

public static Source retrieveByPK(org.apache.turbine.om.ObjectKey pk,
                                  org.apache.turbine.util.db.pool.DBConnection dbcon)
                           throws java.lang.Exception
Retrieve a single object by pk
Parameters:
ObjectKey - pk
DBConnection - dbcon

getTableMap

protected static org.apache.turbine.util.db.map.TableMap getTableMap()
Returns the TableMap related to this peer. This method is not needed for general use but a specific application could have a need.

XPUSP - Home