Java Doc for BaseAttributeOptionPeer.java in  » Issue-Tracking » scarab-0.21 » org » tigris » scarab » om » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Issue Tracking » scarab 0.21 » org.tigris.scarab.om 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.tigris.scarab.om.BaseAttributeOptionPeer

All known Subclasses:   org.tigris.scarab.om.AttributeOptionPeer,
BaseAttributeOptionPeer
abstract public class BaseAttributeOptionPeer extends BasePeer (Code)


Field Summary
final public static  StringATTRIBUTE_ID
    
final protected static  StringCLASSNAME_DEFAULT
     A class that can be returned by this peer.
final protected static  ClassCLASS_DEFAULT
     A class that can be returned by this peer.
final public static  StringDATABASE_NAME
    
final public static  StringDELETED
    
final public static  StringOPTION_ID
    
final public static  StringOPTION_NAME
    
final public static  StringTABLE_NAME
    
final public static  intnumColumns
    


Method Summary
public static  voidaddSelectColumns(Criteria criteria)
     Add all the columns needed to create a new object.
public static  CriteriabuildCriteria(ObjectKey pk)
    
public static  CriteriabuildCriteria(AttributeOption obj)
    
public static  CriteriabuildSelectCriteria(AttributeOption obj)
    
public static  voidcorrectBooleans(Criteria criteria)
     changes the boolean values in the criteria to the appropriate type, whenever a booleanchar or booleanint column is involved.
public static  voiddoDelete(Criteria criteria)
     Method to do deletes.
public static  voiddoDelete(Criteria criteria, Connection con)
     Method to do deletes.
public static  voiddoDelete(AttributeOption obj)
    
public static  voiddoDelete(AttributeOption obj, Connection con)
     Method to delete.
public static  voiddoDelete(ObjectKey pk)
     Method to do deletes.
public static  voiddoDelete(ObjectKey pk, Connection con)
     Method to delete.
public static  ObjectKeydoInsert(Criteria criteria)
     Method to do inserts.
public static  ObjectKeydoInsert(Criteria criteria, Connection con)
     Method to do inserts.
public static  voiddoInsert(AttributeOption obj)
    
public static  voiddoInsert(AttributeOption obj, Connection con)
     Method to do inserts.
public static  ListdoSelect(Criteria criteria)
     Method to do selects.
Parameters:
  criteria - object used to create the SELECT statement.
public static  ListdoSelect(Criteria criteria, Connection con)
     Method to do selects within a transaction.
public static  ListdoSelect(AttributeOption obj)
    
protected static  ListdoSelectJoinAttribute(Criteria criteria)
     selects a collection of AttributeOption objects pre-filled with their Attribute objects. This method is protected by default in order to keep the public api reasonable.
protected static  ListdoSelectJoinAttribute(Criteria criteria, Connection conn)
     selects a collection of AttributeOption objects pre-filled with their Attribute objects. This method is protected by default in order to keep the public api reasonable.
public static  ListdoSelectVillageRecords(Criteria criteria)
     Grabs the raw Village records to be formed into objects. This method handles connections internally.
public static  ListdoSelectVillageRecords(Criteria criteria, Connection con)
     Grabs the raw Village records to be formed into objects.
public static  voiddoUpdate(Criteria criteria)
     Method to do updates.
public static  voiddoUpdate(Criteria criteria, Connection con)
     Method to do updates.
public static  voiddoUpdate(AttributeOption obj)
    
public static  voiddoUpdate(AttributeOption obj, Connection con)
     Method to do update.
public static  MapBuildergetMapBuilder()
    
public static  ClassgetOMClass()
     The class that the Peer will make instances of.
protected static  TableMapgetTableMap()
     Returns the TableMap related to this peer.
public static  voidpopulateObject(Record row, int offset, AttributeOption obj)
     Populates an object from a resultset row starting from a specified offset.
public static  ListpopulateObjects(List records)
     The returned List will contain objects of the default type or objects that inherit from the default.
public static  ListresultSet2Objects(java.sql.ResultSet results)
     Get the list of objects for a ResultSet.
public static  AttributeOptionretrieveByPK(Integer pk)
    
public static  AttributeOptionretrieveByPK(Integer pk, Connection con)
    
public static  AttributeOptionretrieveByPK(ObjectKey pk)
    
public static  AttributeOptionretrieveByPK(ObjectKey pk, Connection con)
    
public static  ListretrieveByPKs(List pks)
    
public static  ListretrieveByPKs(List pks, Connection dbcon)
    
public static  AttributeOptionrow2Object(Record row, int offset, Class cls)
     Create a new object of type cls from a resultset row starting from a specified offset.

Field Detail
ATTRIBUTE_ID
final public static String ATTRIBUTE_ID(Code)
the column name for the ATTRIBUTE_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.



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



OPTION_ID
final public static String OPTION_ID(Code)
the column name for the OPTION_ID field



OPTION_NAME
final public static String OPTION_NAME(Code)
the column name for the OPTION_NAME 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





Method Detail
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(AttributeOption obj)(Code)
Build a Criteria object from the data object for this peer



buildSelectCriteria
public static Criteria buildSelectCriteria(AttributeOption 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(AttributeOption 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(AttributeOption obj, Connection con) throws TorqueException(Code)
Method to delete. This method is to be used during a transaction, otherwise use the doDelete(AttributeOption) 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(AttributeOption 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(AttributeOption obj, Connection con) throws TorqueException(Code)
Method to do inserts. This method is to be used during a transaction, otherwise use the doInsert(AttributeOption) 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(AttributeOption obj) throws TorqueException(Code)
Method to do selects
throws:
  TorqueException - Any exceptions caught during processing will berethrown wrapped into a TorqueException.



doSelectJoinAttribute
protected static List doSelectJoinAttribute(Criteria criteria) throws TorqueException(Code)
selects a collection of AttributeOption objects pre-filled with their Attribute 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 AttributeOptionPeer.
throws:
  TorqueException - Any exceptions caught during processing will berethrown wrapped into a TorqueException.



doSelectJoinAttribute
protected static List doSelectJoinAttribute(Criteria criteria, Connection conn) throws TorqueException(Code)
selects a collection of AttributeOption objects pre-filled with their Attribute 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 AttributeOptionPeer.
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(AttributeOption 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(AttributeOption obj, Connection con) throws TorqueException(Code)
Method to do update. This method is to be used during a transaction, otherwise use the doUpdate(AttributeOption) 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, AttributeOption 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 AttributeOption 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 AttributeOption 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 AttributeOption 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 AttributeOption 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 AttributeOption 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.



www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.