|
| |
|
| org.tigris.scarab.om.BaseAttributePeer
All known Subclasses: org.tigris.scarab.om.AttributePeer,
| BaseAttributePeer | | abstract public class BaseAttributePeer extends BasePeer (Code) | | |
| Method Summary | |
| public static void | addSelectColumns(Criteria criteria)
Add all the columns needed to create a new object. | | public static Criteria | buildCriteria(ObjectKey pk)
| | public static Criteria | buildCriteria(Attribute obj)
| | public static Criteria | buildSelectCriteria(Attribute obj)
| | public static void | correctBooleans(Criteria criteria)
changes the boolean values in the criteria to the appropriate type,
whenever a booleanchar or booleanint column is involved. | | public static void | doDelete(Criteria criteria)
Method to do deletes. | | public static void | doDelete(Criteria criteria, Connection con)
Method to do deletes. | | public static void | doDelete(Attribute obj)
| | public static void | doDelete(Attribute obj, Connection con)
Method to delete. | | public static void | doDelete(ObjectKey pk)
Method to do deletes. | | public static void | doDelete(ObjectKey pk, Connection con)
Method to delete. | | public static ObjectKey | doInsert(Criteria criteria)
Method to do inserts. | | public static ObjectKey | doInsert(Criteria criteria, Connection con)
Method to do inserts. | | public static void | doInsert(Attribute obj)
| | public static void | doInsert(Attribute obj, Connection con)
Method to do inserts. | | public static List | doSelect(Criteria criteria)
Method to do selects.
Parameters:
criteria - object used to create the SELECT statement. | | public static List | doSelect(Criteria criteria, Connection con)
Method to do selects within a transaction. | | public static List | doSelect(Attribute obj)
| | protected static List | doSelectJoinAllExceptAttributeOption(Criteria criteria)
selects a collection of Attribute objects pre-filled with
all related objects.
This method is protected by default in order to keep the public
api reasonable. | | protected static List | doSelectJoinAllExceptAttributeOption(Criteria criteria, Connection conn)
selects a collection of Attribute objects pre-filled with
all related objects.
This method is protected by default in order to keep the public
api reasonable. | | protected static List | doSelectJoinAllExceptAttributeType(Criteria criteria)
selects a collection of Attribute objects pre-filled with
all related objects.
This method is protected by default in order to keep the public
api reasonable. | | protected static List | doSelectJoinAllExceptAttributeType(Criteria criteria, Connection conn)
selects a collection of Attribute objects pre-filled with
all related objects.
This method is protected by default in order to keep the public
api reasonable. | | protected static List | doSelectJoinAllExceptScarabUserImpl(Criteria criteria)
selects a collection of Attribute objects pre-filled with
all related objects.
This method is protected by default in order to keep the public
api reasonable. | | protected static List | doSelectJoinAllExceptScarabUserImpl(Criteria criteria, Connection conn)
selects a collection of Attribute objects pre-filled with
all related objects.
This method is protected by default in order to keep the public
api reasonable. | | protected static List | doSelectJoinAttributeOption(Criteria criteria)
selects a collection of Attribute objects pre-filled with their
AttributeOption objects.
This method is protected by default in order to keep the public
api reasonable. | | protected static List | doSelectJoinAttributeOption(Criteria criteria, Connection conn)
selects a collection of Attribute objects pre-filled with their
AttributeOption objects.
This method is protected by default in order to keep the public
api reasonable. | | protected static List | doSelectJoinAttributeType(Criteria criteria)
selects a collection of Attribute objects pre-filled with their
AttributeType objects.
This method is protected by default in order to keep the public
api reasonable. | | protected static List | doSelectJoinAttributeType(Criteria criteria, Connection conn)
selects a collection of Attribute objects pre-filled with their
AttributeType objects.
This method is protected by default in order to keep the public
api reasonable. | | protected static List | doSelectJoinScarabUserImpl(Criteria criteria)
selects a collection of Attribute objects pre-filled with their
ScarabUserImpl objects.
This method is protected by default in order to keep the public
api reasonable. | | protected static List | doSelectJoinScarabUserImpl(Criteria criteria, Connection conn)
selects a collection of Attribute objects pre-filled with their
ScarabUserImpl objects.
This method is protected by default in order to keep the public
api reasonable. | | public static List | doSelectVillageRecords(Criteria criteria)
Grabs the raw Village records to be formed into objects.
This method handles connections internally. | | public static List | doSelectVillageRecords(Criteria criteria, Connection con)
Grabs the raw Village records to be formed into objects. | | public static void | doUpdate(Criteria criteria)
Method to do updates. | | public static void | doUpdate(Criteria criteria, Connection con)
Method to do updates. | | public static void | doUpdate(Attribute obj)
| | public static void | doUpdate(Attribute obj, Connection con)
Method to do update. | | public static MapBuilder | getMapBuilder()
| | public static Class | getOMClass()
The class that the Peer will make instances of. | | protected static TableMap | getTableMap()
Returns the TableMap related to this peer. | | public static void | populateObject(Record row, int offset, Attribute obj)
Populates an object from a resultset row starting
from a specified offset. | | public static List | populateObjects(List records)
The returned List will contain objects of the default type or
objects that inherit from the default. | | public static List | resultSet2Objects(java.sql.ResultSet results)
Get the list of objects for a ResultSet. | | public static Attribute | retrieveByPK(Integer pk)
| | public static Attribute | retrieveByPK(Integer pk, Connection con)
| | public static Attribute | retrieveByPK(ObjectKey pk)
| | public static Attribute | retrieveByPK(ObjectKey pk, Connection con)
| | public static List | retrieveByPKs(List pks)
| | public static List | retrieveByPKs(List pks, Connection dbcon)
| | public static Attribute | row2Object(Record row, int offset, Class cls)
Create a new object of type cls from a resultset row starting
from a specified offset. |
| ACTION | | final public static String ACTION(Code) | | the column name for the ACTION field
|
| ATTRIBUTE_ID | | final public static String ATTRIBUTE_ID(Code) | | the column name for the ATTRIBUTE_ID field
|
| ATTRIBUTE_NAME | | final public static String ATTRIBUTE_NAME(Code) | | the column name for the ATTRIBUTE_NAME field
|
| ATTRIBUTE_TYPE_ID | | final public static String ATTRIBUTE_TYPE_ID(Code) | | the column name for the ATTRIBUTE_TYPE_ID field
|
| CLASSNAME_DEFAULT | | final protected static String CLASSNAME_DEFAULT(Code) | | A class that can be returned by this peer.
|
| CLASS_DEFAULT | | final protected static Class CLASS_DEFAULT(Code) | | A class that can be returned by this peer.
|
| CREATED_BY | | final public static String CREATED_BY(Code) | | the column name for the CREATED_BY field
|
| CREATED_DATE | | final public static String CREATED_DATE(Code) | | the column name for the CREATED_DATE field
|
| DATABASE_NAME | | final public static String DATABASE_NAME(Code) | | the default database name for this class
|
| DELETED | | final public static String DELETED(Code) | | the column name for the DELETED field
|
| DESCRIPTION | | final public static String DESCRIPTION(Code) | | the column name for the DESCRIPTION field
|
| PERMISSION | | final public static String PERMISSION(Code) | | the column name for the PERMISSION field
|
| REQUIRED_OPTION_ID | | final public static String REQUIRED_OPTION_ID(Code) | | the column name for the REQUIRED_OPTION_ID field
|
| TABLE_NAME | | final public static String TABLE_NAME(Code) | | the table name for this class
|
| numColumns | | final public static int numColumns(Code) | | number of columns for this peer
|
| addSelectColumns | | public static void addSelectColumns(Criteria criteria) throws TorqueException(Code) | | 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 berethrown wrapped into a TorqueException. |
| buildCriteria | | public static Criteria buildCriteria(ObjectKey pk)(Code) | | Build a Criteria object from an ObjectKey
|
| buildCriteria | | public static Criteria buildCriteria(Attribute obj)(Code) | | Build a Criteria object from the data object for this peer
|
| buildSelectCriteria | | public static Criteria buildSelectCriteria(Attribute obj)(Code) | | Build a Criteria object from the data object for this peer, skipping all binary columns
|
| correctBooleans | | public static void correctBooleans(Criteria criteria)(Code) | | 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 |
| doDelete | | public static void doDelete(Criteria criteria) throws TorqueException(Code) | | Method to do deletes.
Parameters:
criteria - object containing data that is used DELETE from database.
throws:
TorqueException - Any exceptions caught during processing will berethrown wrapped into a TorqueException. |
| doDelete | | public static void doDelete(Criteria criteria, Connection con) throws TorqueException(Code) | | 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.
Parameters:
con - the connection to use
throws:
TorqueException - Any exceptions caught during processing will berethrown wrapped into a TorqueException. |
| doDelete | | public static void doDelete(Attribute obj) throws TorqueException(Code) | |
Parameters:
obj - the data object to delete in the database.
throws:
TorqueException - Any exceptions caught during processing will berethrown wrapped into a TorqueException. |
| doDelete | | public static void doDelete(Attribute obj, Connection con) throws TorqueException(Code) | | Method to delete. This method is to be used during a transaction,
otherwise use the doDelete(Attribute) method. It will take
care of the connection details internally.
Parameters:
obj - the data object to delete in the database.
Parameters:
con - the connection to use
throws:
TorqueException - Any exceptions caught during processing will berethrown wrapped into a TorqueException. |
| doDelete | | public static void doDelete(ObjectKey pk) throws TorqueException(Code) | | Method to do deletes.
Parameters:
pk - ObjectKey that is used DELETE from database.
throws:
TorqueException - Any exceptions caught during processing will berethrown wrapped into a TorqueException. |
| doDelete | | public static void doDelete(ObjectKey pk, Connection con) throws TorqueException(Code) | | 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.
Parameters:
con - the connection to use
throws:
TorqueException - Any exceptions caught during processing will berethrown wrapped into a TorqueException. |
| doInsert | | public static ObjectKey doInsert(Criteria criteria) throws TorqueException(Code) | | Method to do inserts.
Parameters:
criteria - object used to create the INSERT statement.
throws:
TorqueException - Any exceptions caught during processing will berethrown wrapped into a TorqueException. |
| doInsert | | public static ObjectKey doInsert(Criteria criteria, Connection con) throws TorqueException(Code) | | 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.
Parameters:
con - the connection to use
throws:
TorqueException - Any exceptions caught during processing will berethrown wrapped into a TorqueException. |
| doInsert | | public static void doInsert(Attribute obj) throws TorqueException(Code) | | Method to do inserts
throws:
TorqueException - Any exceptions caught during processing will berethrown wrapped into a TorqueException. |
| doInsert | | public static void doInsert(Attribute obj, Connection con) throws TorqueException(Code) | | Method to do inserts. This method is to be used during a transaction,
otherwise use the doInsert(Attribute) method. It will take
care of the connection details internally.
Parameters:
obj - the data object to insert into the database.
Parameters:
con - the connection to use
throws:
TorqueException - Any exceptions caught during processing will berethrown wrapped into a TorqueException. |
| doSelect | | public static List doSelect(Criteria criteria) throws TorqueException(Code) | | Method to do selects.
Parameters:
criteria - object used to create the SELECT statement. List of selected Objects
throws:
TorqueException - Any exceptions caught during processing will berethrown wrapped into a TorqueException. |
| doSelect | | public static List doSelect(Criteria criteria, Connection con) throws TorqueException(Code) | | Method to do selects within a transaction.
Parameters:
criteria - object used to create the SELECT statement.
Parameters:
con - the connection to use List of selected Objects
throws:
TorqueException - Any exceptions caught during processing will berethrown wrapped into a TorqueException. |
| doSelect | | public static List doSelect(Attribute obj) throws TorqueException(Code) | | Method to do selects
throws:
TorqueException - Any exceptions caught during processing will berethrown wrapped into a TorqueException. |
| doSelectJoinAllExceptAttributeOption | | protected static List doSelectJoinAllExceptAttributeOption(Criteria criteria) throws TorqueException(Code) | | selects a collection of Attribute objects pre-filled with
all related 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 AttributePeer.
throws:
TorqueException - Any exceptions caught during processing will berethrown wrapped into a TorqueException. |
| doSelectJoinAllExceptAttributeOption | | protected static List doSelectJoinAllExceptAttributeOption(Criteria criteria, Connection conn) throws TorqueException(Code) | | selects a collection of Attribute objects pre-filled with
all related 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 AttributePeer.
throws:
TorqueException - Any exceptions caught during processing will berethrown wrapped into a TorqueException. |
| doSelectJoinAllExceptAttributeType | | protected static List doSelectJoinAllExceptAttributeType(Criteria criteria) throws TorqueException(Code) | | selects a collection of Attribute objects pre-filled with
all related 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 AttributePeer.
throws:
TorqueException - Any exceptions caught during processing will berethrown wrapped into a TorqueException. |
| doSelectJoinAllExceptAttributeType | | protected static List doSelectJoinAllExceptAttributeType(Criteria criteria, Connection conn) throws TorqueException(Code) | | selects a collection of Attribute objects pre-filled with
all related 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 AttributePeer.
throws:
TorqueException - Any exceptions caught during processing will berethrown wrapped into a TorqueException. |
| doSelectJoinAllExceptScarabUserImpl | | protected static List doSelectJoinAllExceptScarabUserImpl(Criteria criteria) throws TorqueException(Code) | | selects a collection of Attribute objects pre-filled with
all related 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 AttributePeer.
throws:
TorqueException - Any exceptions caught during processing will berethrown wrapped into a TorqueException. |
| doSelectJoinAllExceptScarabUserImpl | | protected static List doSelectJoinAllExceptScarabUserImpl(Criteria criteria, Connection conn) throws TorqueException(Code) | | selects a collection of Attribute objects pre-filled with
all related 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 AttributePeer.
throws:
TorqueException - Any exceptions caught during processing will berethrown wrapped into a TorqueException. |
| doSelectJoinAttributeOption | | protected static List doSelectJoinAttributeOption(Criteria criteria) throws TorqueException(Code) | | selects a collection of Attribute objects pre-filled with their
AttributeOption 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 AttributePeer.
throws:
TorqueException - Any exceptions caught during processing will berethrown wrapped into a TorqueException. |
| doSelectJoinAttributeOption | | protected static List doSelectJoinAttributeOption(Criteria criteria, Connection conn) throws TorqueException(Code) | | selects a collection of Attribute objects pre-filled with their
AttributeOption 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 AttributePeer.
throws:
TorqueException - Any exceptions caught during processing will berethrown wrapped into a TorqueException. |
| doSelectJoinAttributeType | | protected static List doSelectJoinAttributeType(Criteria criteria) throws TorqueException(Code) | | selects a collection of Attribute objects pre-filled with their
AttributeType 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 AttributePeer.
throws:
TorqueException - Any exceptions caught during processing will berethrown wrapped into a TorqueException. |
| doSelectJoinAttributeType | | protected static List doSelectJoinAttributeType(Criteria criteria, Connection conn) throws TorqueException(Code) | | selects a collection of Attribute objects pre-filled with their
AttributeType 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 AttributePeer.
throws:
TorqueException - Any exceptions caught during processing will berethrown wrapped into a TorqueException. |
| doSelectJoinScarabUserImpl | | protected static List doSelectJoinScarabUserImpl(Criteria criteria) throws TorqueException(Code) | | selects a collection of Attribute objects pre-filled with their
ScarabUserImpl 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 AttributePeer.
throws:
TorqueException - Any exceptions caught during processing will berethrown wrapped into a TorqueException. |
| doSelectJoinScarabUserImpl | | protected static List doSelectJoinScarabUserImpl(Criteria criteria, Connection conn) throws TorqueException(Code) | | selects a collection of Attribute objects pre-filled with their
ScarabUserImpl 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 AttributePeer.
throws:
TorqueException - Any exceptions caught during processing will berethrown wrapped into a TorqueException. |
| doSelectVillageRecords | | public static List doSelectVillageRecords(Criteria criteria) throws TorqueException(Code) | | 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 berethrown wrapped into a TorqueException. |
| doSelectVillageRecords | | public static List doSelectVillageRecords(Criteria criteria, Connection con) throws TorqueException(Code) | | 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.
Parameters:
con - the connection to use
throws:
TorqueException - Any exceptions caught during processing will berethrown wrapped into a TorqueException. |
| doUpdate | | public static void doUpdate(Criteria criteria) throws TorqueException(Code) | | Method to do updates.
Parameters:
criteria - object containing data that is used to create the UPDATEstatement.
throws:
TorqueException - Any exceptions caught during processing will berethrown wrapped into a TorqueException. |
| doUpdate | | public static void doUpdate(Criteria criteria, Connection con) throws TorqueException(Code) | | 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 UPDATEstatement.
Parameters:
con - the connection to use
throws:
TorqueException - Any exceptions caught during processing will berethrown wrapped into a TorqueException. |
| doUpdate | | public static void doUpdate(Attribute obj) throws TorqueException(Code) | |
Parameters:
obj - the data object to update in the database.
throws:
TorqueException - Any exceptions caught during processing will berethrown wrapped into a TorqueException. |
| doUpdate | | public static void doUpdate(Attribute obj, Connection con) throws TorqueException(Code) | | Method to do update. This method is to be used during a transaction,
otherwise use the doUpdate(Attribute) method. It will take
care of the connection details internally.
Parameters:
obj - the data object to update in the database.
Parameters:
con - the connection to use
throws:
TorqueException - Any exceptions caught during processing will berethrown wrapped into a TorqueException. |
| getMapBuilder | | public static MapBuilder getMapBuilder() throws TorqueException(Code) | | the map builder for this peer
throws:
TorqueException - Any exceptions caught during processing will berethrown wrapped into a TorqueException. |
| getOMClass | | public static Class getOMClass() throws TorqueException(Code) | | 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 berethrown wrapped into a TorqueException. |
| getTableMap | | protected static TableMap getTableMap() throws TorqueException(Code) | | Returns the TableMap related to this peer. This method is not
needed for general use but a specific application could have a need.
throws:
TorqueException - Any exceptions caught during processing will berethrown wrapped into a TorqueException. |
| populateObject | | public static void populateObject(Record row, int offset, Attribute obj) throws TorqueException(Code) | | 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 berethrown wrapped into a TorqueException. |
| populateObjects | | public static List populateObjects(List records) throws TorqueException(Code) | | 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 berethrown wrapped into a TorqueException. |
| resultSet2Objects | | public static List resultSet2Objects(java.sql.ResultSet results) throws TorqueException(Code) | | 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 the list of objects
throws:
TorqueException - Any exceptions caught during processing will berethrown wrapped into a TorqueException. |
| retrieveByPK | | public static Attribute retrieveByPK(Integer pk) throws TorqueException, NoRowsException, TooManyRowsException(Code) | | Retrieve a single object by pk
Parameters:
pk - the primary key
throws:
TorqueException - Any exceptions caught during processing will berethrown wrapped into a TorqueException.
throws:
NoRowsException - Primary key was not found in database.
throws:
TooManyRowsException - Primary key was not found in database. |
| retrieveByPK | | public static Attribute retrieveByPK(Integer pk, Connection con) throws TorqueException, NoRowsException, TooManyRowsException(Code) | | Retrieve a single object by pk
Parameters:
pk - the primary key
Parameters:
con - the connection to use
throws:
TorqueException - Any exceptions caught during processing will berethrown wrapped into a TorqueException.
throws:
NoRowsException - Primary key was not found in database.
throws:
TooManyRowsException - Primary key was not found in database. |
| retrieveByPK | | public static Attribute retrieveByPK(ObjectKey pk) throws TorqueException, NoRowsException, TooManyRowsException(Code) | | Retrieve a single object by pk
Parameters:
pk - the primary key
throws:
TorqueException - Any exceptions caught during processing will berethrown wrapped into a TorqueException.
throws:
NoRowsException - Primary key was not found in database.
throws:
TooManyRowsException - Primary key was not found in database. |
| retrieveByPK | | public static Attribute retrieveByPK(ObjectKey pk, Connection con) throws TorqueException, NoRowsException, TooManyRowsException(Code) | | Retrieve a single object by pk
Parameters:
pk - the primary key
Parameters:
con - the connection to use
throws:
TorqueException - Any exceptions caught during processing will berethrown wrapped into a TorqueException.
throws:
NoRowsException - Primary key was not found in database.
throws:
TooManyRowsException - Primary key was not found in database. |
| retrieveByPKs | | public static List retrieveByPKs(List pks) throws TorqueException(Code) | | Retrieve a multiple objects by pk
Parameters:
pks - List of primary keys
throws:
TorqueException - Any exceptions caught during processing will berethrown wrapped into a TorqueException. |
| retrieveByPKs | | public static List retrieveByPKs(List pks, Connection dbcon) throws TorqueException(Code) | | Retrieve a multiple objects by pk
Parameters:
pks - List of primary keys
Parameters:
dbcon - the connection to use
throws:
TorqueException - Any exceptions caught during processing will berethrown wrapped into a TorqueException. |
| row2Object | | public static Attribute row2Object(Record row, int offset, Class cls) throws TorqueException(Code) | | 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 berethrown wrapped into a TorqueException. |
|
|
|