db-torque-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From tfisc...@apache.org
Subject svn commit: r1479376 - in /db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/model: Database.java Domain.java
Date Sun, 05 May 2013 20:22:27 GMT
Author: tfischer
Date: Sun May  5 20:22:21 2013
New Revision: 1479376

URL: http://svn.apache.org/r1479376
Log:
javadoc

Modified:
    db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/model/Database.java
    db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/model/Domain.java

Modified: db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/model/Database.java
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/model/Database.java?rev=1479376&r1=1479375&r2=1479376&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/model/Database.java
(original)
+++ db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/model/Database.java
Sun May  5 20:22:21 2013
@@ -1,8 +1,5 @@
 package org.apache.torque.templates.model;
 
-import java.util.ArrayList;
-import java.util.List;
-
 /*
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
@@ -22,6 +19,9 @@ import java.util.List;
  * under the License.
  */
 
+import java.util.ArrayList;
+import java.util.List;
+
 /**
  * The model of the database tag in a Torque schema file.
  *
@@ -30,28 +30,57 @@ import java.util.List;
 public class Database
 {
     // properties from schema
-
+    /** The list of options for this database. */
     public List<Option> optionList = new ArrayList<Option>();
 
-    public List<IncludeSchema> includeSchemaList = new ArrayList<IncludeSchema>();
+    /** The list of included schemas for this database. */
+    public List<IncludeSchema> includeSchemaList
+            = new ArrayList<IncludeSchema>();
 
+    /** The list of external schemas for this database. */
     public List<ExternalSchema> externalSchemaList
         = new ArrayList<ExternalSchema>();
 
+    /** The List of domains for this database. */
     public List<Domain> domainList = new ArrayList<Domain>();
 
+    /**
+     * The list of tables for this database.
+     * This may include the tables from included schemas,
+     * depending on whether included schemas were already resolved,
+     * but never includes the tables from external schemas.
+     */
     public List<Table> tableList = new ArrayList<Table>();
 
+    /**
+     * The list of views for this database.
+     * This may include the views from included schemas,
+     * depending on whether included schemas were already resolved,
+     * but never includes the views from external schemas.
+     */
     public List<View> viewList = new ArrayList<View>();
 
+    /** The name of the database. */
     public String name;
 
+    /**
+     * Whether the columns in this database will use primitive types if
+     * possible ("primitive") or will always use object types ("object"). */
     public String defaultJavaType;
 
+    /**
+     * The default id method for this database. One of "native", "idbroker"
+     * or "none".
+     */
     public String defaultIdMethod;
 
     // general generation properties
 
+    /**
+     * The name of the root database. Either the name of of this database
+     * if this database was not included or referenced as external schema,
+     * or the name of the root inclusion or root external-schema database.
+     */
     public String rootDatabaseName;
 
     /**
@@ -70,6 +99,4 @@ public class Database
      * List of all schema names in the tables of the database.
      */
     public List<String> schemaNameList = new ArrayList<String>();
-
-
 }

Modified: db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/model/Domain.java
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/model/Domain.java?rev=1479376&r1=1479375&r2=1479376&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/model/Domain.java
(original)
+++ db/torque/torque4/trunk/torque-templates/src/main/java/org/apache/torque/templates/model/Domain.java
Sun May  5 20:22:21 2013
@@ -27,17 +27,24 @@ package org.apache.torque.templates.mode
  */
 public class Domain
 {
+    /** The database where this domain is defined. */
     public Database parent;
 
+    /** The name of the domain. */
     public String name;
 
+    /** The torque type of the columns belonging to this domain. */
     public String type;
 
+    /** The size of the columns belonging to this domain. */
     public String size;
 
+    /** The scale of the columns belonging to this domain. */
     public String scale;
 
+    /** The default value of the columns belonging to this domain. */
     public String _default;
 
+    /** The description of this domain. */
     public String description;
 }



---------------------------------------------------------------------
To unsubscribe, e-mail: torque-dev-unsubscribe@db.apache.org
For additional commands, e-mail: torque-dev-help@db.apache.org


Mime
View raw message