You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tuscany.apache.org by lr...@apache.org on 2007/05/30 18:52:59 UTC

svn commit: r542876 - in /incubator/tuscany/java/das/rdb/src/main/java/org/apache/tuscany/das/rdb: ./ exception/ graphbuilder/impl/

Author: lresende
Date: Wed May 30 09:52:58 2007
New Revision: 542876

URL: http://svn.apache.org/viewvc?view=rev&rev=542876
Log:
Code cleanup and javadoc updates

Modified:
    incubator/tuscany/java/das/rdb/src/main/java/org/apache/tuscany/das/rdb/ConfigHelper.java
    incubator/tuscany/java/das/rdb/src/main/java/org/apache/tuscany/das/rdb/DASFactory.java
    incubator/tuscany/java/das/rdb/src/main/java/org/apache/tuscany/das/rdb/exception/DataSourceInitializationException.java
    incubator/tuscany/java/das/rdb/src/main/java/org/apache/tuscany/das/rdb/graphbuilder/impl/ResultMetadata.java
    incubator/tuscany/java/das/rdb/src/main/java/org/apache/tuscany/das/rdb/graphbuilder/impl/ResultSetProcessor.java
    incubator/tuscany/java/das/rdb/src/main/java/org/apache/tuscany/das/rdb/graphbuilder/impl/SingleTableRegistry.java
    incubator/tuscany/java/das/rdb/src/main/java/org/apache/tuscany/das/rdb/graphbuilder/impl/TableData.java
    incubator/tuscany/java/das/rdb/src/main/java/org/apache/tuscany/das/rdb/graphbuilder/impl/TableRegistry.java

Modified: incubator/tuscany/java/das/rdb/src/main/java/org/apache/tuscany/das/rdb/ConfigHelper.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/das/rdb/src/main/java/org/apache/tuscany/das/rdb/ConfigHelper.java?view=diff&rev=542876&r1=542875&r2=542876
==============================================================================
--- incubator/tuscany/java/das/rdb/src/main/java/org/apache/tuscany/das/rdb/ConfigHelper.java (original)
+++ incubator/tuscany/java/das/rdb/src/main/java/org/apache/tuscany/das/rdb/ConfigHelper.java Wed May 30 09:52:58 2007
@@ -42,85 +42,194 @@
 
     private ConfigFactory factory = ConfigFactory.INSTANCE;
 
+    /**
+     * Default constructor
+     */
     public ConfigHelper() {
         config = factory.createConfig();
         configWrapper = new MappingWrapper(config);
     }
 
+    /**
+     * Constructor that receives a Config object
+     * @param config The configuration object
+     */
     public ConfigHelper(Config config) {
         this.config = config;
         configWrapper = new MappingWrapper(config);
     }
 
+    /**
+     * Add PK information
+     * @param columnName The column to be taken as PK
+     */
     public void addPrimaryKey(String columnName) {
         configWrapper.addPrimaryKey(columnName);
     }
 
+    /**
+     * Add relationship information
+     * @param parentName
+     * @param childName
+     * @return
+     */
     public Relationship addRelationship(String parentName, String childName) {
         return configWrapper.addRelationship(parentName, childName);
     }
     
+    /**
+     * Add relationship information
+     * @param parentNames
+     * @param childNames
+     * @return
+     */
     public Relationship addRelationship(Vector parentNames, Vector childNames) {
         return configWrapper.addRelationship(parentNames, childNames);
     }
 
+    /**
+     * Add table information
+     * @param name
+     * @param typeName
+     * @return
+     */
     public Table addTable(String name, String typeName) {
         return configWrapper.addTable(name, typeName);
     }
+    
+    /**
+     * Add table information with schema information
+     * @param name
+     * @param schemaName
+     * @param typeName
+     * @return
+     */
     public Table addTable(String name, String schemaName, String typeName) {
         return configWrapper.addTable(name, schemaName, typeName);
     }
     
+    /**
+     * Add column information
+     * @param table
+     * @param columnName
+     * @param propertyName
+     * @return
+     */
     public Column addColumn(Table table, String columnName, String propertyName) {
         return configWrapper.addColumn(table, columnName, propertyName);
     }
 
+    /**
+     * Add an update statement for a given table
+     * @param table
+     * @param statement
+     * @param parameters
+     */
     public void addUpdateStatement(Table table, String statement, String parameters) {
         configWrapper.addUpdateStatement(table, statement, parameters);
     }
 
+    /**
+     * Add create statement for a given table
+     * @param table
+     * @param statement
+     * @param parameters
+     */
     public void addCreateStatement(Table table, String statement, String parameters) {
         configWrapper.addCreateStatement(table, statement, parameters);
     }
 
+    /**
+     * Add delete statement for a given table
+     * @param table
+     * @param statement
+     * @param parameters
+     */
     public void addDeleteStatement(Table table, String statement, String parameters) {
         configWrapper.addDeleteStatement(table, statement, parameters);
     }
 
-    //JIRA-948 support for driver manager connection
+    /**
+     * Add datasource connection information
+     * @param dataSourceName
+     */
     public void addConnectionInfo(String dataSourceName) {
         configWrapper.addConnectionInfo(dataSourceName, true);
     }
 
+    /**
+     * Add datasource connection information and flag about using managed transactions
+     * @param dataSourceName
+     * @param managedtx
+     */
     public void addConnectionInfo(String dataSourceName, boolean managedtx) {
         configWrapper.addConnectionInfo(dataSourceName, managedtx);
     }
 
+    /**
+     * Add driver manager connection information
+     * @param driverClass
+     * @param databaseURL
+     * @param user
+     * @param password
+     * @param loginTimeout
+     */
     public void addConnectionInfo(String driverClass, String databaseURL, String user, String password, int loginTimeout) {
         configWrapper.addConnectionInfo(driverClass, databaseURL, user, password, loginTimeout);
     }
-    //JIRA-948 end
 
+    /**
+     * Set the data object model
+     * @param dataObjectModel
+     */
     public void setDataObjectModel(String dataObjectModel) {
         configWrapper.getConfig().setDataObjectModel(dataObjectModel);
     }
 
+    /**
+     * Add a select command
+     * @param name
+     * @param sql
+     * @return
+     */
     public Command addSelectCommand(String name, String sql) {
         return configWrapper.addCommand(name, sql, "select");
     }
 
+    /**
+     * Add a update command
+     * @param name
+     * @param sql
+     * @return
+     */
     public Command addUpdateCommand(String name, String sql) {
         return configWrapper.addCommand(name, sql, "update");
     }
 
+    /**
+     * Add a insert command
+     * @param name
+     * @param sql
+     * @return
+     */
     public Command addInsertCommand(String name, String sql) {
         return configWrapper.addCommand(name, sql, "insert");
     }
 
+    /**
+     * Add a delete command
+     * @param name
+     * @param sql
+     * @return
+     */
     public Command addDeleteCommand(String name, String sql) {
         return configWrapper.addCommand(name, sql, "delete");
     }
 
+    /**
+     * Get a reference to the config object
+     * @return
+     */
     public Config getConfig() {
         return config;
     }

Modified: incubator/tuscany/java/das/rdb/src/main/java/org/apache/tuscany/das/rdb/DASFactory.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/das/rdb/src/main/java/org/apache/tuscany/das/rdb/DASFactory.java?view=diff&rev=542876&r1=542875&r2=542876
==============================================================================
--- incubator/tuscany/java/das/rdb/src/main/java/org/apache/tuscany/das/rdb/DASFactory.java (original)
+++ incubator/tuscany/java/das/rdb/src/main/java/org/apache/tuscany/das/rdb/DASFactory.java Wed May 30 09:52:58 2007
@@ -25,8 +25,6 @@
 
 /**
  * A DASFactory produces {@link DAS} instances.
- * 
- * 
  */
 public interface DASFactory {
 

Modified: incubator/tuscany/java/das/rdb/src/main/java/org/apache/tuscany/das/rdb/exception/DataSourceInitializationException.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/das/rdb/src/main/java/org/apache/tuscany/das/rdb/exception/DataSourceInitializationException.java?view=diff&rev=542876&r1=542875&r2=542876
==============================================================================
--- incubator/tuscany/java/das/rdb/src/main/java/org/apache/tuscany/das/rdb/exception/DataSourceInitializationException.java (original)
+++ incubator/tuscany/java/das/rdb/src/main/java/org/apache/tuscany/das/rdb/exception/DataSourceInitializationException.java Wed May 30 09:52:58 2007
@@ -19,9 +19,7 @@
 package org.apache.tuscany.das.rdb.exception;
 
 public class DataSourceInitializationException extends RuntimeException  {
-	/**
-     * 
-     */
+    
     private static final long serialVersionUID = 302160989411041041L;
 
     public DataSourceInitializationException(String string) {

Modified: incubator/tuscany/java/das/rdb/src/main/java/org/apache/tuscany/das/rdb/graphbuilder/impl/ResultMetadata.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/das/rdb/src/main/java/org/apache/tuscany/das/rdb/graphbuilder/impl/ResultMetadata.java?view=diff&rev=542876&r1=542875&r2=542876
==============================================================================
--- incubator/tuscany/java/das/rdb/src/main/java/org/apache/tuscany/das/rdb/graphbuilder/impl/ResultMetadata.java (original)
+++ incubator/tuscany/java/das/rdb/src/main/java/org/apache/tuscany/das/rdb/graphbuilder/impl/ResultMetadata.java Wed May 30 09:52:58 2007
@@ -286,7 +286,7 @@
 
     /**
      * @param i
-     * @return
+     * @return Type
      */
     public Type getDataType(int i) {
         return resultSetShape.getColumnType(i);
@@ -294,7 +294,7 @@
 
     /**
      * @param tableName
-     * @return
+     * @return Collection
      */
     public Collection getPropertyNames(String tableName) {
         return (Collection) tableToPropertyMap.get(tableName);

Modified: incubator/tuscany/java/das/rdb/src/main/java/org/apache/tuscany/das/rdb/graphbuilder/impl/ResultSetProcessor.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/das/rdb/src/main/java/org/apache/tuscany/das/rdb/graphbuilder/impl/ResultSetProcessor.java?view=diff&rev=542876&r1=542875&r2=542876
==============================================================================
--- incubator/tuscany/java/das/rdb/src/main/java/org/apache/tuscany/das/rdb/graphbuilder/impl/ResultSetProcessor.java (original)
+++ incubator/tuscany/java/das/rdb/src/main/java/org/apache/tuscany/das/rdb/graphbuilder/impl/ResultSetProcessor.java Wed May 30 09:52:58 2007
@@ -57,10 +57,6 @@
 
     }
 
-    // private void debug(Object output) {
-    // DebugUtil.debugln(getClass(), debug, output);
-    // }
-
     /**
      * Process the ResultSet. For each row in the ResultSet, a
      * 
@@ -69,8 +65,8 @@
      *       between each object in the
      * @link ResultSetRow.
      * 
-     * @param rs
-     *            The ResultSet
+     * @param start
+     * @param end
      */
     public void processResults(int start, int end) throws SQLException {
 

Modified: incubator/tuscany/java/das/rdb/src/main/java/org/apache/tuscany/das/rdb/graphbuilder/impl/SingleTableRegistry.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/das/rdb/src/main/java/org/apache/tuscany/das/rdb/graphbuilder/impl/SingleTableRegistry.java?view=diff&rev=542876&r1=542875&r2=542876
==============================================================================
--- incubator/tuscany/java/das/rdb/src/main/java/org/apache/tuscany/das/rdb/graphbuilder/impl/SingleTableRegistry.java (original)
+++ incubator/tuscany/java/das/rdb/src/main/java/org/apache/tuscany/das/rdb/graphbuilder/impl/SingleTableRegistry.java Wed May 30 09:52:58 2007
@@ -22,8 +22,6 @@
 
 import commonj.sdo.DataObject;
 
-/**
- */
 public class SingleTableRegistry implements TableRegistry {
 
 

Modified: incubator/tuscany/java/das/rdb/src/main/java/org/apache/tuscany/das/rdb/graphbuilder/impl/TableData.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/das/rdb/src/main/java/org/apache/tuscany/das/rdb/graphbuilder/impl/TableData.java?view=diff&rev=542876&r1=542875&r2=542876
==============================================================================
--- incubator/tuscany/java/das/rdb/src/main/java/org/apache/tuscany/das/rdb/graphbuilder/impl/TableData.java (original)
+++ incubator/tuscany/java/das/rdb/src/main/java/org/apache/tuscany/das/rdb/graphbuilder/impl/TableData.java Wed May 30 09:52:58 2007
@@ -26,9 +26,6 @@
 import org.apache.log4j.Logger;
 import org.apache.tuscany.das.rdb.util.LoggerFactory;
 
-/**
- * 
- */
 public class TableData {
     private final Logger logger = LoggerFactory.INSTANCE.getLogger(TableData.class);
 

Modified: incubator/tuscany/java/das/rdb/src/main/java/org/apache/tuscany/das/rdb/graphbuilder/impl/TableRegistry.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/das/rdb/src/main/java/org/apache/tuscany/das/rdb/graphbuilder/impl/TableRegistry.java?view=diff&rev=542876&r1=542875&r2=542876
==============================================================================
--- incubator/tuscany/java/das/rdb/src/main/java/org/apache/tuscany/das/rdb/graphbuilder/impl/TableRegistry.java (original)
+++ incubator/tuscany/java/das/rdb/src/main/java/org/apache/tuscany/das/rdb/graphbuilder/impl/TableRegistry.java Wed May 30 09:52:58 2007
@@ -22,8 +22,6 @@
 
 import commonj.sdo.DataObject;
 
-/**
- */
 public interface TableRegistry {
     /**
      * Get the table with the specified name and primary key



---------------------------------------------------------------------
To unsubscribe, e-mail: tuscany-commits-unsubscribe@ws.apache.org
For additional commands, e-mail: tuscany-commits-help@ws.apache.org