Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.apache.james.mailboxmanager.torque.om
Class BaseMailboxRowPeer

java.lang.Object
  extended by org.apache.torque.util.BasePeer
      extended by org.apache.james.mailboxmanager.torque.om.BaseMailboxRowPeer
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
MailboxRowPeer
public abstract class BaseMailboxRowPeer
extends org.apache.torque.util.BasePeer

Mailbox Table This class was autogenerated by Torque on: [Sun Dec 09 17:45:09 GMT 2007]

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class org.apache.torque.util.BasePeer
org.apache.torque.util.BasePeer.ProcessCallback
 
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 DATABASE_NAME
          the default database name for this class
static java.lang.String LAST_UID
          the column name for the last_uid field
static java.lang.String MAILBOX_ID
          the column name for the mailbox_id field
static java.lang.String MESSAGE_COUNT
          the column name for the message_count 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 SIZE
          the column name for the size field
static java.lang.String TABLE_NAME
          the table name for this class
static java.lang.String UID_VALIDITY
          the column name for the uid_validity field
 
Fields inherited from class org.apache.torque.util.BasePeer
IGNORE_CASE, log, ORDER_BY
 
Constructor Summary
BaseMailboxRowPeer()
           
 
Method Summary
static void addSelectColumns(org.apache.torque.util.Criteria criteria)
          Add all the columns needed to create a new object.
static org.apache.torque.util.Criteria buildCriteria(MailboxRow obj)
          Build a Criteria object from the data object for this peer
static org.apache.torque.util.Criteria buildCriteria(org.apache.torque.om.ObjectKey pk)
          Build a Criteria object from an ObjectKey
static org.apache.torque.util.Criteria buildSelectCriteria(MailboxRow obj)
          Build a Criteria object from the data object for this peer, skipping all binary columns
static void correctBooleans(org.apache.torque.util.Criteria criteria)
          changes the boolean values in the criteria to the appropriate type, whenever a booleanchar or booleanint column is involved.
static void doDelete(org.apache.torque.util.Criteria criteria)
          Method to do deletes.
static void doDelete(org.apache.torque.util.Criteria criteria, java.sql.Connection con)
          Method to do deletes.
static void doDelete(MailboxRow obj)
           
static void doDelete(MailboxRow obj, java.sql.Connection con)
          Method to delete.
static void doDelete(org.apache.torque.om.ObjectKey pk)
          Method to do deletes.
static void doDelete(org.apache.torque.om.ObjectKey pk, java.sql.Connection con)
          Method to delete.
static org.apache.torque.om.ObjectKey doInsert(org.apache.torque.util.Criteria criteria)
          Method to do inserts.
static org.apache.torque.om.ObjectKey doInsert(org.apache.torque.util.Criteria criteria, java.sql.Connection con)
          Method to do inserts.
static void doInsert(MailboxRow obj)
          Method to do inserts
static void doInsert(MailboxRow obj, java.sql.Connection con)
          Method to do inserts.
static java.util.List doSelect(org.apache.torque.util.Criteria criteria)
          Method to do selects.
static java.util.List doSelect(org.apache.torque.util.Criteria criteria, java.sql.Connection con)
          Method to do selects within a transaction.
static java.util.List doSelect(MailboxRow obj)
          Method to do selects
static java.util.List doSelectVillageRecords(org.apache.torque.util.Criteria criteria)
          Grabs the raw Village records to be formed into objects.
static java.util.List doSelectVillageRecords(org.apache.torque.util.Criteria criteria, java.sql.Connection con)
          Grabs the raw Village records to be formed into objects.
static void doUpdate(org.apache.torque.util.Criteria criteria)
          Method to do updates.
static void doUpdate(org.apache.torque.util.Criteria criteria, java.sql.Connection con)
          Method to do updates.
static void doUpdate(MailboxRow obj)
           
static void doUpdate(MailboxRow obj, java.sql.Connection con)
          Method to do update.
static org.apache.torque.map.MapBuilder getMapBuilder()
          Deprecated. Torque.getMapBuilder(MailboxRowMapBuilder.CLASS_NAME) instead
static java.lang.Class getOMClass()
          The class that the Peer will make instances of.
static org.apache.torque.map.TableMap getTableMap()
          Returns the TableMap related to this peer.
static void populateObject(com.workingdogs.village.Record row, int offset, MailboxRow 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 MailboxRow retrieveByPK(long pk)
          Retrieve a single object by pk
static MailboxRow retrieveByPK(long pk, java.sql.Connection con)
          Retrieve a single object by pk
static MailboxRow retrieveByPK(org.apache.torque.om.ObjectKey pk)
          Retrieve a single object by pk
static MailboxRow retrieveByPK(org.apache.torque.om.ObjectKey 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 MailboxRow 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.torque.util.BasePeer
correctBooleans, createPreparedStatement, createQueryString, deleteAll, deleteAll, doPSSelect, doPSSelect, doUpdate, doUpdate, executeQuery, executeQuery, executeQuery, executeQuery, executeQuery, executeQuery, executeStatement, executeStatement, executeStatement, getMapBuilder, getSelectResults, getSelectResults, getSelectResults, getSelectResults, handleMultipleRecords, initColumnNames, initCriteriaKeys, initTableColumns, initTableSchema, initTableSchema
 
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

MAILBOX_ID

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

NAME

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

UID_VALIDITY

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

LAST_UID

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

MESSAGE_COUNT

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

SIZE

public static final java.lang.String SIZE
the column name for the size 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

BaseMailboxRowPeer

public BaseMailboxRowPeer()
Method Detail

getMapBuilder

public static org.apache.torque.map.MapBuilder getMapBuilder()
                                                      throws org.apache.torque.TorqueException
Deprecated. Torque.getMapBuilder(MailboxRowMapBuilder.CLASS_NAME) instead

Returns:
the map builder for this peer
Throws:
org.apache.torque.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 org.apache.torque.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:
org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

doInsert

public static org.apache.torque.om.ObjectKey doInsert(org.apache.torque.util.Criteria criteria)
                                               throws org.apache.torque.TorqueException
Method to do inserts.

Parameters:
criteria - object used to create the INSERT statement.
Throws:
org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

doInsert

public static org.apache.torque.om.ObjectKey doInsert(org.apache.torque.util.Criteria criteria,
                                                      java.sql.Connection con)
                                               throws org.apache.torque.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:
org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

addSelectColumns

public static void addSelectColumns(org.apache.torque.util.Criteria criteria)
                             throws org.apache.torque.TorqueException
Add all the columns needed to create a new object.

Parameters:
criteria - object containing the columns to add.
Throws:
org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

correctBooleans

public static void correctBooleans(org.apache.torque.util.Criteria criteria)
                            throws org.apache.torque.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:
org.apache.torque.TorqueException - if the database map for the criteria cannot be obtained.

row2Object

public static MailboxRow row2Object(com.workingdogs.village.Record row,
                                    int offset,
                                    java.lang.Class cls)
                             throws org.apache.torque.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:
org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

populateObject

public static void populateObject(com.workingdogs.village.Record row,
                                  int offset,
                                  MailboxRow obj)
                           throws org.apache.torque.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:
org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

doSelect

public static java.util.List doSelect(org.apache.torque.util.Criteria criteria)
                               throws org.apache.torque.TorqueException
Method to do selects.

Parameters:
criteria - object used to create the SELECT statement.
Returns:
List of selected Objects
Throws:
org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

doSelect

public static java.util.List doSelect(org.apache.torque.util.Criteria criteria,
                                      java.sql.Connection con)
                               throws org.apache.torque.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:
org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

doSelectVillageRecords

public static java.util.List doSelectVillageRecords(org.apache.torque.util.Criteria criteria)
                                             throws org.apache.torque.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:
org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

doSelectVillageRecords

public static java.util.List doSelectVillageRecords(org.apache.torque.util.Criteria criteria,
                                                    java.sql.Connection con)
                                             throws org.apache.torque.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:
org.apache.torque.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 org.apache.torque.TorqueException
The returned List will contain objects of the default type or objects that inherit from the default.

Throws:
org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

getOMClass

public static java.lang.Class getOMClass()
                                  throws org.apache.torque.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:
org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

doUpdate

public static void doUpdate(org.apache.torque.util.Criteria criteria)
                     throws org.apache.torque.TorqueException
Method to do updates.

Parameters:
criteria - object containing data that is used to create the UPDATE statement.
Throws:
org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

doUpdate

public static void doUpdate(org.apache.torque.util.Criteria criteria,
                            java.sql.Connection con)
                     throws org.apache.torque.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:
org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

doDelete

public static void doDelete(org.apache.torque.util.Criteria criteria)
                     throws org.apache.torque.TorqueException
Method to do deletes.

Parameters:
criteria - object containing data that is used DELETE from database.
Throws:
org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

doDelete

public static void doDelete(org.apache.torque.util.Criteria criteria,
                            java.sql.Connection con)
                     throws org.apache.torque.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:
org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

doSelect

public static java.util.List doSelect(MailboxRow obj)
                               throws org.apache.torque.TorqueException
Method to do selects

Throws:
org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

doInsert

public static void doInsert(MailboxRow obj)
                     throws org.apache.torque.TorqueException
Method to do inserts

Throws:
org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

doUpdate

public static void doUpdate(MailboxRow obj)
                     throws org.apache.torque.TorqueException
Parameters:
obj - the data object to update in the database.
Throws:
org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

doDelete

public static void doDelete(MailboxRow obj)
                     throws org.apache.torque.TorqueException
Parameters:
obj - the data object to delete in the database.
Throws:
org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

doInsert

public static void doInsert(MailboxRow obj,
                            java.sql.Connection con)
                     throws org.apache.torque.TorqueException
Method to do inserts. This method is to be used during a transaction, otherwise use the doInsert(MailboxRow) method. It will take care of the connection details internally.

Parameters:
obj - the data object to insert into the database.
con - the connection to use
Throws:
org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

doUpdate

public static void doUpdate(MailboxRow obj,
                            java.sql.Connection con)
                     throws org.apache.torque.TorqueException
Method to do update. This method is to be used during a transaction, otherwise use the doUpdate(MailboxRow) method. It will take care of the connection details internally.

Parameters:
obj - the data object to update in the database.
con - the connection to use
Throws:
org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

doDelete

public static void doDelete(MailboxRow obj,
                            java.sql.Connection con)
                     throws org.apache.torque.TorqueException
Method to delete. This method is to be used during a transaction, otherwise use the doDelete(MailboxRow) method. It will take care of the connection details internally.

Parameters:
obj - the data object to delete in the database.
con - the connection to use
Throws:
org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

doDelete

public static void doDelete(org.apache.torque.om.ObjectKey pk)
                     throws org.apache.torque.TorqueException
Method to do deletes.

Parameters:
pk - ObjectKey that is used DELETE from database.
Throws:
org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

doDelete

public static void doDelete(org.apache.torque.om.ObjectKey pk,
                            java.sql.Connection con)
                     throws org.apache.torque.TorqueException
Method to delete. This method is to be used during a transaction, otherwise use the doDelete(ObjectKey) method. It will take care of the connection details internally.

Parameters:
pk - the primary key for the object to delete in the database.
con - the connection to use
Throws:
org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

buildCriteria

public static org.apache.torque.util.Criteria buildCriteria(org.apache.torque.om.ObjectKey pk)
Build a Criteria object from an ObjectKey

buildCriteria

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

buildSelectCriteria

public static org.apache.torque.util.Criteria buildSelectCriteria(MailboxRow obj)
Build a Criteria object from the data object for this peer, skipping all binary columns

retrieveByPK

public static MailboxRow retrieveByPK(long pk)
                               throws org.apache.torque.TorqueException,
                                      org.apache.torque.NoRowsException,
                                      org.apache.torque.TooManyRowsException
Retrieve a single object by pk

Parameters:
pk - the primary key
Throws:
org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.
org.apache.torque.NoRowsException - Primary key was not found in database.
org.apache.torque.TooManyRowsException - Primary key was not found in database.

retrieveByPK

public static MailboxRow retrieveByPK(long pk,
                                      java.sql.Connection con)
                               throws org.apache.torque.TorqueException,
                                      org.apache.torque.NoRowsException,
                                      org.apache.torque.TooManyRowsException
Retrieve a single object by pk

Parameters:
pk - the primary key
con - the connection to use
Throws:
org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.
org.apache.torque.NoRowsException - Primary key was not found in database.
org.apache.torque.TooManyRowsException - Primary key was not found in database.

retrieveByPK

public static MailboxRow retrieveByPK(org.apache.torque.om.ObjectKey pk)
                               throws org.apache.torque.TorqueException,
                                      org.apache.torque.NoRowsException,
                                      org.apache.torque.TooManyRowsException
Retrieve a single object by pk

Parameters:
pk - the primary key
Throws:
org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.
org.apache.torque.NoRowsException - Primary key was not found in database.
org.apache.torque.TooManyRowsException - Primary key was not found in database.

retrieveByPK

public static MailboxRow retrieveByPK(org.apache.torque.om.ObjectKey pk,
                                      java.sql.Connection con)
                               throws org.apache.torque.TorqueException,
                                      org.apache.torque.NoRowsException,
                                      org.apache.torque.TooManyRowsException
Retrieve a single object by pk

Parameters:
pk - the primary key
con - the connection to use
Throws:
org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.
org.apache.torque.NoRowsException - Primary key was not found in database.
org.apache.torque.TooManyRowsException - Primary key was not found in database.

retrieveByPKs

public static java.util.List retrieveByPKs(java.util.List pks)
                                    throws org.apache.torque.TorqueException
Retrieve a multiple objects by pk

Parameters:
pks - List of primary keys
Throws:
org.apache.torque.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 org.apache.torque.TorqueException
Retrieve a multiple objects by pk

Parameters:
pks - List of primary keys
dbcon - the connection to use
Throws:
org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

getTableMap

public static org.apache.torque.map.TableMap getTableMap()
                                                  throws org.apache.torque.TorqueException
Returns the TableMap related to this peer.

Throws:
org.apache.torque.TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2002-2008 The Apache Software Foundation. All Rights Reserved.