Changeset 29 for trunk/fmgVen/src/com/fmguler

Timestamp:

Feb 10, 2011, 10:06:10 PM (14 years ago)

Author:

fmguler

Message:

Refs #3 - Ven.list() is converted to the new format. Almost the same as Ven.get(). Added javadoc to Ven public methods. Added listing test, and made the sample domain object toString methods more readable.

Now, adding the criteria parameter to the operations is to be done.

File:

• trunk/fmgVen/src/com/fmguler/ven/Ven.java (modified) (4 diffs)

trunk/fmgVen/src/com/fmguler/ven/Ven.java

@@ -45 +45 @@
     }
 
-    public List list(Class objectClass) {
-        return null;
-    }
-
     public int count() {
         return 0;
     }
 
+    /**
+     * Get the object with the specified id, of the specified objectClass type.
+     * <p>
+     * By default none of the associations will be retrieved.
+     * To include the object associations (retrieve the object graph) joins should be specified, e.g.
+     * <code>SomeObject.anotherObject</code>
+     * 
+     * @param id the id of the object to be retrieved
+     * @param objectClass the class of the object to be retrieved
+     * @param joins the set of object graphs to be included with the object
+     * @return the retrieved object including specified associations
+     */
     public Object get(int id, Class objectClass, Set joins) {
         String query = generator.generateSelectQuery(objectClass, joins);
@@ -65 +73 @@
         if (result.size() > 1) System.out.println("Ven - WARNING >> get(id) returns more than one row");
         return result.get(0);
+    }
+
+    /**
+     * List the objects of the specified objectClass type.
+     * <p>
+     * By default none of the associations will be retrieved.
+     * To include the object associations (retrieve the object graph) joins should be specified, e.g.
+     * <code>SomeObject.anotherObject</code>
+     * 
+     * @param objectClass the class of the objects to be retrieved
+     * @param joins the set of object graphs to be included with objects
+     * @return the list of objects including specified associations
+     */
+    public List list(Class objectClass, Set joins) {
+        String query = generator.generateSelectQuery(objectClass, joins);
+
+        Map paramMap = new HashMap();
+        if (debug) System.out.println("Ven - SQL: " + query);
+
+        List result = mapper.list(query, paramMap, objectClass);
+        return result;
     }
 
@@ -124 +153 @@
     //--------------------------------------------------------------------------
     //SETTERS
+    /**
+     * Set the DataSource to be used to access to the database
+     */
     public void setDataSource(DataSource dataSource) {
         if (dataSource == null) throw new RuntimeException("fmgVen - DataSource cannot be null");
@@ -130 +162 @@
     }
 
+    /**
+     * Add the domain packages that have corresponding database tables.
+     * <p>
+     * The objects in these packages are considered persistable.
+     * @param domainPackage the package of the entity classes.
+     * @return this instance to allow chaining.
+     */
     public Ven addDomainPackage(String domainPackage) {
         generator.addDomainPackage(domainPackage);