db-torque-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mpoes...@apache.org
Subject cvs commit: db-torque/xdocs navigation.xml schema-reference.xml properties-reference.xml
Date Thu, 26 Jun 2003 21:41:36 GMT
mpoeschl    2003/06/26 14:41:36

  Modified:    src/generator/xdocs navigation.xml
               xdocs    navigation.xml
  Added:       src/generator/xdocs schema-reference.xml
                        properties-reference.xml
  Removed:     xdocs    schema-reference.xml properties-reference.xml
  Log:
  move repository and properties reference to generator docs
  
  Revision  Changes    Path
  1.2       +2 -30     db-torque/src/generator/xdocs/navigation.xml
  
  Index: navigation.xml
  ===================================================================
  RCS file: /home/cvs/db-torque/src/generator/xdocs/navigation.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- navigation.xml	18 Feb 2003 06:40:19 -0000	1.1
  +++ navigation.xml	26 Jun 2003 21:41:36 -0000	1.2
  @@ -9,38 +9,10 @@
         <item name="generator"             href="http://db.apache.org/torque/generator/"/>
       </links>
   
  -<!--
  -    <menu name="Torque">
  -      <item name="Overview"              href="/index.html"/>
  -      <item name="News and Status"       href="/status.html"/>
  +    <menu name="Overview">
         <item name="Schema Reference"      href="/schema-reference.html"/>
         <item name="Properties Reference"  href="/properties-reference.html"/>
       </menu>
  -    <menu name="Guides">
  -      <item name="Tutorial"              href="/tutorial/index.html"/>
  -      <item name="User Guide"            href="/user-guide.html"/>
  -      <item name="Inheritance Guide"     href="/inheritance-guide.html"/>
  -      <item name="Developer Guide"       href="/developer-guide.html"/>
  -    </menu>
  -    <menu name="Howto Guides">
  -      <item name="Caching Howto"         href="/managers-cache.html"/>
  -      <item name="Criteria Howto"        href="/criteria-howto.html"/>
  -      <item name="JDBC2 Pool Howto"      href="/jdbc2pool-howto.html"/>
  -      <item name="Maven Howto"           href="/maven-howto.html"/>
  -      <item name="Peers Howto"           href="/peers-howto.html"/>
  -    </menu>
  -    <menu name="Database Howto Guides">
  -      <item name="MS SQL Server Howto"   href="/mssql-howto.html"/>
  -      <item name="Oracle 8i Howto"       href="/oracle-howto.html"/>
  -      <item name="Postgres Howto"        href="/postgres-howto.html"/>
  -      <item name="Sybase Howto"          href="/sybase-howto.html"/>
  -    </menu>
  -    <menu name="Development">
  -      <item name="DB Adapters"           href="/db-adapters.html"/>
  -      <item name="Changes"               href="/changes.html"/>
  -      <item name="References"            href="/references.html"/>
  -      <item name="Todo"                  href="/todo.html"/>
  -    </menu>
  --->
  +
     </body>
   </project>
  
  
  
  1.1                  db-torque/src/generator/xdocs/schema-reference.xml
  
  Index: schema-reference.xml
  ===================================================================
  <?xml version="1.0" encoding="ISO-8859-1"?>
  
  <document>
  
   <properties>
    <title>Torque Schema Reference</title>
    <author email="warner@warneronstine.com">Warner Onstine</author>
    <author email="jvanzyl@apache.org">Jason van Zyl</author>
    <author email="ville.skytta@iki.fi">Ville Skyttä</author>
   </properties>
  
  <body>
    <section name="Torque Schema Reference">
      <p>
        The Torque Database Schema Reference attempts to explain what the
        different elements and attributes are when defining your own database
        schema. In addition I will attempt to explain which attributes mean what
        in the different databases that are currently supported.
      </p>
     </section>
  
     <section name="Elements and their attributes">
       <p>
         Some of the following examples are taken from the project-schema.xml
         document in the src/conf/torque/schema.
       </p>
       <subsection name="Element: database">
         <p>
           The database element and its relevant attributes.
         </p>
         <source><![CDATA[
           <database
             name="MY_DATABASE"
             defaultIdMethod="idBroker"
             package="com.myapp.om"
             baseClass="com.myapp.om.BaseClass"
             basePeer="com.myapp.om.BasePeer">
  
             <table name="SIMPLE">
               <!-- table info goes here -->
             </table>
           </database>]]>
         </source>
         <p>
           The database element has 8 attributes associated with it, they are:
         </p>
         <p>
           <table>
             <tr>
               <td>name</td>
               <td>The name of the database being referenced</td>
             </tr>
             <tr>
               <td>defaultIdMethod</td>
               <td>How will the primary keys be created, defaults to "none"</td>
             </tr>
             <tr>
               <td>defaultJavaType</td>
               <td>Default type of columns in the database
                   (object or primitive, defaults to primitive)</td>
             </tr>
             <tr>
               <td>package</td>
               <td>Used for OM Peer generation</td>
             </tr>
             <tr>
               <td>baseClass</td>
               <td>Used for OM generation</td>
             </tr>
             <tr>
               <td>basePeer</td>
               <td>Used for OM Peer generation</td>
             </tr>
             <tr>
               <td>defaultJavaNamingMethod</td>
               <td>Indicates how a schema table or column name is mapped to a
                   Java class or method name respectively</td>
             </tr>
             <tr>
               <td>heavyIndexing</td>
               <td>? (true or false, defaults to false)</td>
             </tr>
           </table>
         </p>
  
         <p>
           The database element can contain the following elements:
         </p>
         <p>
          <table>
            <tr>
              <td>table</td>
              <td>1 or more</td>
            </tr>
          </table>
         </p>
       </subsection>
  
       <subsection name="Attribute: defaultIdMethod">
         <p>
           By defining this attribute at the database level it applies the
           defaultIdMethod to those tables which do not have an idMethod
           attribute defined. The attribute defaultIdMethod has 5 possible
           values, they are:
         </p>
         <p>
           <table>
             <tr>
               <td>idbroker</td>
               <td>This allows Torque to generate the IDs through its IDBroker
                   Service</td>
             </tr>
             <tr>
               <td>native</td>
               <td>Torque will determine how the database will auto-generate
                   IDs</td>
             </tr>
             <tr>
               <td>autoincrement</td>
               <td>deprecated, please use native</td>
             </tr>
             <tr>
               <td>sequence</td>
               <td>deprecated, please use native</td>
             </tr>
             <tr>
               <td>none</td>
               <td>Typically used if you do not want IDs generated</td>
             </tr>
           </table>
         </p>
       </subsection>
       <subsection name="Attribute: defaultJavaNamingMethod">
         <p>
           This attribute determines how table or column names, from the name
           attribute of the table or column element, are converted to a Java
           class or method name respectively when creating the OM Java objects.
           defaultJavaNamingMethod can contain 3 different values:
         </p>
         <p>
           <table>
             <tr>
               <td>nochange</td>
               <td>Indicates no change is performed.</td>
             </tr>
             <tr>
               <td>underscore</td>
               <td>Underscores are removed, First letter is capitalized, first
                 letter after an underscore is capitalized, the rest of the
                 letters are converted to lowercase.
               </td>
             </tr>
             <tr>
               <td>javaname</td>
               <td>Same as underscore, but no letters are converted to lowercase.
               </td>
             </tr>
           </table>
         </p>
       </subsection>
       <subsection name="Attribute: package">
         <p>
           The base package in which this database will generate the Object
           Models associated with it. This overrides the targetPackage property
           in the Torque build.properties file.
         </p>
       </subsection>
       <subsection name="Attribute: baseClass">
         <p>
           The base class to use when generating the Object Model.
           This class does not have to extend org.apache.torque.om.BaseObject.
         </p>
       </subsection>
       <subsection name="Attribute: basePeer">
         <p>
           The base peer to use when generating the Object Model Peers.
           Unlike baseClass, basePeer should extend BasePeer at some point in the
           chain, i.e. it needs to be the superclass.
         </p>
       </subsection>
       <subsection name="Element: table">
         <p>
           The table element and its relevant attributes
         </p>
         <source><![CDATA[
           <table
             name="MY_TABLE"
             javaName="table"
             idMethod="idbroker"
             skipSql="false"
             baseClass="com.myapp.om.table.BaseClass"
             basePeer="com.myapp.om.table.BasePeer"
             javaNamingMethod="underscore"
             description="Table for Torque tests">
  
             <!-- column information here -->
  
           </table>]]>
         </source>
         <p>
           The table element has 13 attributes associated with it, they are:
         </p>
         <p>
           <table>
             <tr>
               <td>name</td>
               <td>The name of the table being referenced</td>
             </tr>
             <tr>
               <td>javaName</td>
               <td>How this table will be referenced in Java</td>
             </tr>
             <tr>
               <td>idMethod</td>
               <td>How will the primary keys be created, defaults to "null"</td>
             </tr>
             <tr>
               <td>skipSql</td>
               <td>Whether or not to skip SQL generation for this reference</td>
             </tr>
             <tr>
               <td>abstract</td>
               <td>Whether or not to generate the class as Abstract or not</td>
             </tr>
             <tr>
               <td>baseClass</td>
               <td>Used for OM Peer generation</td>
             </tr>
             <tr>
               <td>basePeer</td>
               <td>Used for OM Peer generation</td>
             </tr>
             <tr>
               <td>alias</td>
               <td>The table alias</td>
             </tr>
             <tr>
               <td>interface</td>
               <td>?</td>
             </tr>
             <tr>
               <td>javaNamingMethod</td>
               <td>Specifies how the name attribute is converted to the Java
                   class name of the corresponding OM object.  This attribute
                   overrides the defaultJavaNamingMethod attribute of the
                   database element</td>
             </tr>
             <tr>
               <td>heavyIndexing</td>
               <td>? (true or false)</td>
             </tr>
             <tr>
               <td>description</td>
               <td>Used for doc generation</td>
             </tr>
           </table>
         </p>
  
         <p>
           The table element can contain the following elements:
         </p>
         <p>
           <table>
             <tr>
               <td>column</td>
               <td>1 or more</td>
             </tr>
             <tr>
               <td>foreign-key</td>
               <td>0 or more</td>
             </tr>
             <tr>
               <td>index</td>
               <td>0 or more</td>
             </tr>
             <tr>
               <td>unique</td>
               <td>0 or more</td>
             </tr>
             <tr>
               <td>id-method-parameter</td>
               <td>0 or more</td>
             </tr>
           </table>
         </p>
       </subsection>
       <subsection name="Attribute: javaName">
         <p>
           This is the Java class name to use when generating the Table or
           column. If this is missing the Java name is generated in the
           following manner:
         </p>
         <p>
           Underscores are removed, first letter and first letter after each
           underscore is uppercased, all other letters are lowercased.
           So YOUR_TABLE_NAME would become YourTableName.
         </p>
       </subsection>
       <subsection name="Element: column">
         <p>
           The column element and its relevant attributes
         </p>
         <source><![CDATA[
           <column
             name="MY_COLUMN"
             javaName="Column"
             primaryKey="true"
             required="true"
             size="4"
             type="VARCHAR"
             javaNamingMethod="underscore">
  
             <!-- inheritance info if necessary -->
           </column>]]>
         </source>
         <p>
           The column element has 13 attributes associated with it, they are:
         </p>
         <p>
           <table>
             <tr>
               <td>name</td>
               <td>The name of the column being referenced</td>
             </tr>
             <tr>
               <td>javaName</td>
               <td>How this column will be referred to in Java</td>
             </tr>
             <tr>
               <td>primaryKey</td>
               <td>Is this a primary key or not (true or false, defaults to
                   false)</td>
             </tr>
             <tr>
               <td>required</td>
               <td>Whether a value is required in this field (true or false,
                   defaults to false)</td>
             </tr>
             <tr>
               <td>type</td>
               <td>What type of column is it? Covered below, defaults to
                   VARCHAR</td>
             </tr>
             <tr>
               <td>javaType</td>
               <td>The type of the column in Java (object or primitive)</td>
             </tr>
             <tr>
               <td>size</td>
               <td>How many characters or digits can be stored?</td>
             </tr>
             <tr>
               <td>default</td>
               <td>Default value to insert into field if it is missing.</td>
             </tr>
             <tr>
               <td>autoIncrement</td>
               <td>Whether or not to auto-increment this field (true or false,
                   defaults to false)</td>
             </tr>
             <tr>
               <td>inheritance</td>
               <td>? (single or false, defaults to false)</td>
             </tr>
             <tr>
               <td>inputValidator</td>
               <td>?</td>
             </tr>
             <tr>
               <td>javaNamingMethod</td>
               <td>Specifies how the name attribute is converted to the Java
                   class name of the corresponding OM object.  This attribute
                   overrides the defaultJavaNamingMethod attribute of the
                   database element</td>
             </tr>
             <tr>
               <td>description</td>
               <td>Used for doc generation</td>
             </tr>
           </table>
         </p>
         <p>
           The column element can contain the following elements:
         </p>
         <p>
          <table>
            <tr>
              <td>inheritance</td>
              <td>0 or more</td>
            </tr>
          </table>
         </p>
        </subsection>
  
        <subsection name="Element: inheritance">
          <p>
            The inheritance element and its relevant attributes
          </p>
          <source><![CDATA[
            <inheritance key="key"
              class="classname"
              extends="mybase"/>]]>
          </source>
        <p>
          The inheritance element has 3 attributes associated with it, they are:
        </p>
        <p>
          <table>
            <tr>
              <td>key</td>
              <td>?</td>
            </tr>
            <tr>
              <td>class</td>
              <td>?</td>
            </tr>
            <tr>
              <td>extends</td>
              <td>?</td>
            </tr>
          </table>
        </p>
        <p>
          The inheritance element can not contain other elements.
        </p>
      </subsection>
  
      <subsection name="Element: foreign-key">
        <p>
          The foreign-key element and its relevant attributes
        </p>
        <source><![CDATA[
          <foreign-key foreignTable="MY_TABLE"
            name="MY_TABLE_FK"
            onUpdate="none"
            onDelete="none">
            <!-- reference info -->
          </foreign-key>]]>
        </source>
        <p>
          The foreign-key element has 4 attributes associated with it, they are:
        </p>
        <p>
          <table>
            <tr>
              <td>foreignTable</td>
              <td>The name of the table being referenced</td>
            </tr>
            <tr>
              <td>name</td>
              <td>The name of the foreign key</td>
            </tr>
            <tr>
              <td>onUpdate</td>
              <td>The action to take when the referenced value in foreignTable
                  is updated</td>
            </tr>
            <tr>
              <td>onDelete</td>
              <td>The action to take when the referenced value in foreignTable
                  is deleted</td>
            </tr>
          </table>
        </p>
        <p>
          The foreign-key element can contain the following elements:
        </p>
        <p>
          <table>
            <tr>
              <td>reference</td>
              <td>1 or more</td>
            </tr>
          </table>
        </p>
      </subsection>
  
      <subsection name="Element: reference">
        <p>
          The reference element and its relevant attributes
        </p>
        <source><![CDATA[
          <reference local="FK_TABLE_ID" foreign="PK_COLUMN_ID"/>]]>
        </source>
        <p>
          The reference element has 2 attributes associated with it, they are:
        </p>
        <p>
          <table>
            <tr>
              <td>local</td>
              <td>The local reference</td>
            </tr>
            <tr>
              <td>foreign</td>
              <td>The foreign key reference</td>
            </tr>
          </table>
        </p>
        <p>
          The reference element can not contain other elements.
        </p>
      </subsection>
  
      <subsection name="Element: index">
        <p>
          The index element and its relevant attributes
        </p>
        <source><![CDATA[
          <index name="MY_INDEX">
            <!-- index-column info -->
          </index>]]>
        </source>
        <p>
          The index element has 1 attribute associated with it, it is:
        </p>
        <p>
          <table>
            <tr>
              <td>name</td>
              <td>The name of the index</td>
            </tr>
          </table>
        </p>
        <p>
          The index element can contain the following elements:
        </p>
        <p>
          <table>
            <tr>
              <td>index-column</td>
              <td>1 or more</td>
            </tr>
          </table>
        </p>
      </subsection>
  
      <subsection name="Element: index-column">
        <p>
          The index-column element and its relevant attributes
        </p>
        <source><![CDATA[
          <index-column name="INDEX_COLUMN"/>]]>
        </source>
        <p>
          The index-column element has 2 attributes associated with it, they are:
        </p>
        <p>
          <table>
            <tr>
              <td>name</td>
              <td>The name of the indexed column</td>
            </tr>
            <tr>
              <td>size</td>
              <td>?</td>
            </tr>
          </table>
        </p>
        <p>
          The index-column element can not contain other elements.
        </p>
      </subsection>
  
      <subsection name="Element: unique">
        <p>
          The unique element and its relevant attributes
        </p>
        <source><![CDATA[
          <unique name="MY_UNIQUE">
            <!-- unique-column info -->
          </unique>]]>
        </source>
        <p>
          The unique element has 1 attribute associated with it, it is:
        </p>
        <p>
          <table>
            <tr>
              <td>name</td>
              <td>The name of the unique constraint</td>
            </tr>
          </table>
        </p>
        <p>
          The unique element can contain the following elements:
        </p>
        <p>
          <table>
            <tr>
              <td>unique-column</td>
              <td>1 or more</td>
            </tr>
          </table>
        </p>
      </subsection>
  
      <subsection name="Element: unique-column">
        <p>
          The unique-column element and its relevant attributes
        </p>
        <source><![CDATA[
          <unique-column name="UNIQUE_COLUMN"/>]]>
        </source>
        <p>
          The unique-column element has 1 attribute associated with it, it is:
        </p>
        <p>
          <table>
            <tr>
              <td>name</td>
              <td>The name of the unique column</td>
            </tr>
          </table>
        </p>
        <p>
          The unique-column element can not contain other elements.
        </p>
      </subsection>
  
    </section>
  </body>
  </document>
  
  
  
  1.1                  db-torque/src/generator/xdocs/properties-reference.xml
  
  Index: properties-reference.xml
  ===================================================================
  <?xml version="1.0"?>
  
  <document>
  
    <properties>
      <title>Torque - Properties Reference</title>
      <author email="stephenh@chase3000.com">Stephen Haberman</author>
    </properties>
  
    <body>
  
  <section name="Build-time Properties">
  
  <p>
    These properties are set in the <code>build.properties</code> file or the
    file of your chosing, specificed by the <code>torque.contextProperties</code>
    property. They affect how Torque generates Java and SQL code for your project.
  </p>
  
  <table>
  <tr>
    <th> Property </th>
    <th> Default </th>
    <th> Description </th>
  </tr>
  
  
  <tr>
    <td colspan="3"><strong> Basic Properties </strong></td>
  </tr>
  <tr>
    <td><code> torque.project </code></td>
    <td><code> N/A </code></td>
    <td>
      The name of the project Torque will generate code for. After choosing the
      project name, your XML schema file (originally <code>project-schema.xml</code>),
      that Torque will read should be renamed to <code>${torque.project}-schema.xml</code>.
    </td>
  </tr>
  <tr>
    <td><code> torque.database </code></td>
    <td><code> N/A </code></td>
    <td>
      Torque must know the target database platform in order to generate the
      appropriate Java and SQL code. Currently supported values are:
        axion, cloudscape, db2, db2400, hypersonic, interbase, mssql, mysql,
        oracle, postgresql, sapdb, and sybase.
    </td>
  </tr>
  <tr>
    <td><code> torque.targetPackage </code></td>
    <td><code> N/A </code></td>
    <td>
      The Java package that Torque will put the generated classes in. Generally
      something like <code>com.company.project.om</code>.
    </td>
  </tr>
  
  
  <tr>
    <td colspan="3"><strong> Directories and Paths </strong></td>
  </tr>
  <tr>
    <td><code> torque.home </code></td>
    <td><code> . </code></td>
    <td>
      The base directory for the input and output of files.
    </td>
  </tr>
  <tr>
    <td><code> torque.templatePath </code></td>
    <td><code> templates </code></td>
    <td>
      The path relative to where Torque is being executed to load the
      Velocity templates from.
    </td>
  </tr>
  <tr>
    <td><code> torque.useClasspath </code></td>
    <td><code> false </code></td>
    <td>
      If true, Torque will not look in the <code>templatePath</code> directory,
      for templates, but instead load them from the classpath, allowing you to
      use Torque without extracting it from the jar.
    </td>
  </tr>
  <tr>
    <td><code> torque.output.dir </code></td>
    <td><code> ${torque.home}/src </code></td>
    <td>
      The base directory for the output of SQL and Java files.
    </td>
  </tr>
  <tr>
    <td><code> torque.schema.dir </code></td>
    <td><code> ${torque.home}/schema </code></td>
    <td>
      The base directory to reading <code>*-schema.xml</code> files from.
    </td>
  </tr>
  <tr>
    <td><code> torque.doc.dir </code></td>
    <td><code> ${torque.output.dir}/doc </code></td>
    <td>
      The directory to place HTML documentation generated from the XML schema.
    </td>
  </tr>
  <tr>
    <td><code> torque.java.dir </code></td>
    <td><code> ${torque.output.dir}/java </code></td>
    <td>
      The directory to place all of the generated Java code in.
    </td>
  </tr>
  <tr>
    <td><code> torque.javadoc.dir </code></td>
    <td><code> ${torque.output.dir}/javadoc </code></td>
    <td>
      The directory to javadocs generated from the Java om files.
    </td>
  </tr>
  <tr>
    <td><code> torque.ojb.dir </code></td>
    <td><code> ${torque.output.dir}/ojb </code></td>
    <td>
      The directory to place all of the generated OJB code in.
    </td>
  </tr>
  <!--
      <tr>
        <td><code> torque.omzip.dir </code></td>
        <td><code> ${torque.output.dir} </code></td>
        <td>
          The directory a jar of the Java om files.
        </td>
      </tr>
  -->
  
  
  <tr>
    <td colspan="3"><strong> Database Settings </strong></td>
  </tr>
  <tr>
    <td><code> torque.database.createUrl </code></td>
    <td><code> N/A </code></td>
    <td>
      The JDBC URL that Torque can use to create and drop databases if instructed
      to do so. This is typically an administrative URL.
    </td>
  </tr>
  <tr>
    <td><code> torque.database.buildUrl </code></td>
    <td><code> N/A </code></td>
    <td>
      The JDBC URL that will be used to access your database. Torque can use
      this to create your tables if instructed to do so.  This value should
      reflect the database name specified in the database schema file
      (described in the next section).
    </td>
  </tr>
  <tr>
    <td><code> torque.database.url </code></td>
    <td><code> N/A </code></td>
    <td>
      This should contain the same value as <em>buildDatabaseURL</em>.
      [not quite sure why both of these properties exist]
    </td>
  </tr>
  <tr>
    <td><code> torque.database.driver </code></td>
    <td><code> N/A </code></td>
    <td>
      The JDBC database driver to use when connecting to your database.
    </td>
  </tr>
  <tr>
    <td><code> torque.database.user </code></td>
    <td><code> N/A </code></td>
    <td>
      The administrative username that has sufficient privileges to
      create and drop databases and tables that Torque executes at build time.
    </td>
  </tr>
  <tr>
    <td><code> torque.database.password </code></td>
    <td><code> N/A </code></td>
    <td>
      The administrative password for the supplied username.
    </td>
  </tr>
  <tr>
    <td><code> torque.database.host </code></td>
    <td><code> N/A </code></td>
    <td>
      The hostname or IP address of your database server.
    </td>
  </tr>
  <tr>
    <td><code> torque.database.schema </code></td>
    <td><code> N/A </code></td>
    <td>
      Used by the JDBC -> XML process, and by the SQL Ant Task
      that will initialize your target database with the
      generated SQL. This is only used by Oracle at this time.
      This must be UPPERCASE!
    </td>
  </tr>
  <tr>
    <td><code> torque.database.name </code></td>
    <td><code> N/A </code></td>
    <td>
      The database name to use in the <code>datadump</code> target.
    </td>
  </tr>
  <tr>
    <td><code> torque.database.manualCreation </code></td>
    <td><code> false </code></td>
    <td>
      When <code>false</code>, Torque can automatically execute the SQL to
      create your database tables via the <code>create-db</code> target. This
      will destroy old data, so manual creation is safer in non-dev environments.
    </td>
  </tr>
  <tr>
    <td><code> torque.sameJavaName </code></td>
    <td><code> false </code></td>
    <td>
    </td>
  </tr>
  
  
  <tr>
    <td colspan="3"><strong> Template Variables </strong></td>
  </tr>
  <tr>
    <td><code> torque.addGetByNameMethod </code></td>
    <td><code> true </code></td>
    <td>
      If true, Torque adds methods to get database fields by name/position.
    </td>
  </tr>
  <tr>
    <td><code> torque.addIntakeRetrievable </code></td>
    <td><code> false </code></td>
    <td>
      If true, the data objects will implement Intake's Retrievable
      interface
    </td>
  </tr>
  <tr>
    <td><code> torque.retrievableInterface </code></td>
    <td><code> org.apache.turbine.om.Retrievable (for Turbine 2.2) </code></td>
    <td>
      Defines the Retrievable interface. (set to
      org.apache.fulcrum.intake.Retrievable if you are using Fulcrum)
    </td>
  </tr>
  <tr>
    <td><code> torque.addSaveMethod </code></td>
    <td><code> true </code></td>
    <td>
      If true, Torque adds tracking code to determine how to save objects.
    </td>
  </tr>
  <tr>
    <td><code> torque.saveException </code></td>
    <td><code> Exception </code></td>
    <td>
      Defines which Exception should be thrown by the Object.save() method.
    </td>
  </tr>
  <tr>
    <td><code> torque.addTimeStamp </code></td>
    <td><code> true </code></td>
    <td>
      If true, Torque puts time stamps in generated om files.
    </td>
  </tr>
  <tr>
    <td><code> torque.basePrefix </code></td>
    <td><code> Base </code></td>
    <td>
      A string to pre-pend to the file names of base data and peer objects.
    </td>
  </tr>
  <tr>
    <td><code> torque.complexObjectModel </code></td>
    <td><code> true </code></td>
    <td>
      If true, Torque generates data objects with collection support and
      methods to easily retrieve foreign key relationships.
    </td>
  </tr>
  <tr>
    <td><code> torque.useClasspath </code></td>
    <td><code> false </code></td>
    <td>
      If true, Torque will not look in the <code>templatePath</code> directory,
      for templates, but instead load them from the classpath, allowing you to
      use Torque without extracted it from the jar.
    </td>
  </tr>
  <tr>
    <td><code> torque.useManagers </code></td>
    <td><code> false </code></td>
    <td>
      If true, Torque will generate Manager classes that use JCS for caching.
      Still considered experimental.
    </td>
  </tr>
  
  
  <tr>
    <td colspan="3"><strong> Misc. Settings </strong></td>
  </tr>
  <tr>
    <td><code> torque.idTableXMLFile </code></td>
    <td><code> N/A </code></td>
    <td>
  
    </td>
  </tr>
  <tr>
    <td><code> torque.doc.format </code></td>
    <td><code> html </code></td>
    <td>
      Possible values are html and anakia.
    </td>
  </tr>
  <tr>
    <td><code> torque.doc.html.normalFont </code></td>
    <td><code> font-family: Verdana; font-size: 10pt; </code></td>
    <td>
      The value for the CSS class <code>normalFont</code> that is used to format
      the text of the HTML output.
    </td>
  </tr>
  <tr>
    <td><code> torque.doc.html.fkColor </code></td>
    <td><code> afe295 </code></td>
    <td>
      The color that the names of foreign key columns are highlighted with in the
      HTML output.
    </td>
  </tr>
  <tr>
    <td><code> torque.initialID </code></td>
    <td><code> 101 </code></td>
    <td>
      Controls where the idbroker starts id numbers at.
    </td>
  </tr>
  
  
  <tr>
    <td colspan="3"><strong> Compile Settings </strong></td>
  </tr>
  <tr>
    <td><code> torque.compile.src.dir </code></td>
    <td><code> ${torque.java.dir} </code></td>
    <td>
      Where to read the Java om source files.
    </td>
  </tr>
  <tr>
    <td><code> torque.compile.build.dir </code></td>
    <td><code> bin/classes </code></td>
    <td>
      Where to put the compiled byte code for om classes.
    </td>
  </tr>
  <tr>
    <td><code> torque.compile.debug </code></td>
    <td><code> on </code></td>
    <td>
      Whether the om classes are compiled with debug code.
    </td>
  </tr>
  <tr>
    <td><code> torque.compile.deprecation </code></td>
    <td><code> off </code></td>
    <td>
      Whether the om classes are compiled with deprecation allowed.
    </td>
  </tr>
  <tr>
    <td><code> torque.compile.optimize </code></td>
    <td><code> off </code></td>
    <td>
      Whether the om classes are optimized during compilation.
    </td>
  </tr>
  </table>
  
  </section>
  
    </body>
  </document>
  
  
  
  1.9       +0 -2      db-torque/xdocs/navigation.xml
  
  Index: navigation.xml
  ===================================================================
  RCS file: /home/cvs/db-torque/xdocs/navigation.xml,v
  retrieving revision 1.8
  retrieving revision 1.9
  diff -u -r1.8 -r1.9
  --- navigation.xml	27 May 2003 17:55:33 -0000	1.8
  +++ navigation.xml	26 Jun 2003 21:41:36 -0000	1.9
  @@ -13,8 +13,6 @@
         <item name="Overview"              href="/index.html"/>
         <item name="News and Status"       href="/status.html"/>
         <item name="Downloads"             href="/status.html"/>
  -      <item name="Schema Reference"      href="/schema-reference.html"/>
  -      <item name="Properties Reference"  href="/properties-reference.html"/>
       </menu>
       <menu name="Guides">
         <item name="Tutorial"              href="/tutorial/index.html" collapse="true">
  
  
  

Mime
View raw message