db-torque-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From tfisc...@apache.org
Subject svn commit: r1633953 - in /db/torque/torque4/trunk/torque-site/src/site: resources/images/ xdoc/documentation/orm-reference/ xdoc/documentation/tutorial/orm/
Date Thu, 23 Oct 2014 21:33:49 GMT
Author: tfischer
Date: Thu Oct 23 21:33:49 2014
New Revision: 1633953

URL: http://svn.apache.org/r1633953
Log:
TORQUE-331 - documentation
fix schema versions and namespaces

Modified:
    db/torque/torque4/trunk/torque-site/src/site/resources/images/schema-table.png
    db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/orm-reference/defining-the-schema.xml
    db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/orm-reference/running-the-generator.xml
    db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/tutorial/orm/step2.xml

Modified: db/torque/torque4/trunk/torque-site/src/site/resources/images/schema-table.png
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-site/src/site/resources/images/schema-table.png?rev=1633953&r1=1633952&r2=1633953&view=diff
==============================================================================
Binary files - no diff available.

Modified: db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/orm-reference/defining-the-schema.xml
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/orm-reference/defining-the-schema.xml?rev=1633953&r1=1633952&r2=1633953&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/orm-reference/defining-the-schema.xml
(original)
+++ db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/orm-reference/defining-the-schema.xml
Thu Oct 23 21:33:49 2014
@@ -50,10 +50,10 @@
       </p>
       <source><![CDATA[
 <database 
-    xmlns="http://db.apache.org/torque/4.0/templates/database"
+    xmlns="http://db.apache.org/torque/4.1/templates/database"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-    xsi:schemaLocation="http://db.apache.org/torque/4.0/templates/database 
-        http://db.apache.org/torque/torque-4.0/documentation/orm-reference/database-4-0-strict.xsd"
+    xsi:schemaLocation="http://db.apache.org/torque/4.1/templates/database 
+        http://db.apache.org/torque/torque-4.1/documentation/orm-reference/database-4-1-strict.xsd"
    ...
       ]]></source>
       <p>
@@ -61,10 +61,10 @@
       </p>
       <source><![CDATA[
 <database 
-    xmlns="http://db.apache.org/torque/4.0/templates/database"
+    xmlns="http://db.apache.org/torque/4.1/templates/database"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-    xsi:schemaLocation="http://db.apache.org/torque/4.0/templates/database 
-        http://db.apache.org/torque/torque-4.0/documentation/orm-reference/database-4-0.xsd"
+    xsi:schemaLocation="http://db.apache.org/torque/4.1/templates/database 
+        http://db.apache.org/torque/torque-4.1/documentation/orm-reference/database-4-1.xsd"
    ...
       ]]></source>
       <p>
@@ -73,7 +73,7 @@
       </p>
     </subsection>
 
-    <subsection name="example schema file">
+    <subsection name="Example schema file">
       <p>
         For an example schema file containing most of the discussed features,
         look at the bookstore-schema.xml from the test project.
@@ -579,6 +579,11 @@
             <td>see <a href="#Inheritance">Inheritance</a></td>
             <td>0 or more times</td>
           </tr>
+          <tr>
+            <td>enum-value</td>
+            <td>see <a href="#EnumValue">EnumValue</a></td>
+            <td>0 or more times</td>
+          </tr>
         </table>
       </p>
       <p>
@@ -717,6 +722,20 @@
             </td>
           </tr>
           <tr>
+            <td>enumType</td>
+            <td>
+              If set, declares this column as an enum.
+              The attribute value defines the enum class name and can either be unqualified,

+              in which case the enum will be generated using the enum-value child elements,
+              or the content can be fully qualified, in which case the enum
+              must be hand-written, and needs to contain the methods
+              getValue(), which returns the SQL value of the enum instance,
+              and the static method getByValue(${javaType} sqlValue),
+              which returns the enum instance corresponding to the sqlValue.
+            </td>
+            <td>false</td>
+          </tr>
+          <tr>
             <td>protected</td>
             <td>
               If true, the generated java setters and getters for this property 
@@ -897,6 +916,36 @@
       </p>
     </subsection>
 
+    <subsection name="EnumValue">
+      <p>
+        An enum-value element defines one possible value of a column. 
+      </p>
+      <p>
+        The enum-value element can contain the following attributes:
+        <table>
+          <tr>
+            <th>attribute</th>
+            <th>description</th>
+            <th>default value</th>
+          </tr>
+          <tr>
+            <td>value</td>
+            <td>The SQL value of the enum.</td>
+            <td></td>
+          </tr>
+          <tr>
+            <td>javaName</td>
+            <td>The name of the enum key.</td>
+            <td>computed from the value attribute</td>
+          </tr>
+          <tr>
+            <td>description</td>
+            <td>A description of the enum value</td>
+            <td></td>
+          </tr>
+        </table>
+      </p>
+    </subsection>
     <subsection name="Index">
       <p>
         An index element defines a SQL index on a table. 

Modified: db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/orm-reference/running-the-generator.xml
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/orm-reference/running-the-generator.xml?rev=1633953&r1=1633952&r2=1633953&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/orm-reference/running-the-generator.xml
(original)
+++ db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/orm-reference/running-the-generator.xml
Thu Oct 23 21:33:49 2014
@@ -217,10 +217,10 @@
       <source><![CDATA[
 <?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
 <database name="${database.name}"
-    xmlns="http://db.apache.org/torque/4.0/templates/database"
+    xmlns="http://db.apache.org/torque/4.1/templates/database"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-    xsi:schemaLocation="http://db.apache.org/torque/4.0/templates/database 
-        http://db.apache.org/torque/torque-4.0/documentation/orm-reference/database-4-0-strict.xsd">
+    xsi:schemaLocation="http://db.apache.org/torque/4.1/templates/database 
+        http://db.apache.org/torque/torque-4.1/documentation/orm-reference/database-4-1-strict.xsd">
 
   <table name="ID_TABLE" idMethod="idbroker">
     <column name="ID_TABLE_ID" required="true" primaryKey="true" type="INTEGER"/>

Modified: db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/tutorial/orm/step2.xml
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/tutorial/orm/step2.xml?rev=1633953&r1=1633952&r2=1633953&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/tutorial/orm/step2.xml
(original)
+++ db/torque/torque4/trunk/torque-site/src/site/xdoc/documentation/tutorial/orm/step2.xml
Thu Oct 23 21:33:49 2014
@@ -69,10 +69,10 @@
 
 <source><![CDATA[
 <?xml version="1.0" encoding="ISO-8859-1" ?>
-<database xmlns="http://db.apache.org/torque/4.0/templates/database"
+<database xmlns="http://db.apache.org/torque/4.1/templates/database"
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-  xsi:schemaLocation="http://db.apache.org/torque/4.0/templates/database
-        http://db.apache.org/torque/torque-4.0/documentation/orm-reference/database-4-0-strict.xsd"
+  xsi:schemaLocation="http://db.apache.org/torque/4.1/templates/database
+        http://db.apache.org/torque/torque-4.1/documentation/orm-reference/database-4-1-strict.xsd"
   name="bookstore"
   defaultIdMethod="native">
 



---------------------------------------------------------------------
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