db-torque-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From tfisc...@apache.org
Subject svn commit: r1195776 - in /db/torque/torque4/trunk/torque-generator/src/main: java/org/apache/torque/generator/configuration/option/ java/org/apache/torque/generator/configuration/source/ resources/org/apache/torque/generator/configuration/
Date Tue, 01 Nov 2011 02:35:52 GMT
Author: tfischer
Date: Tue Nov  1 02:35:52 2011
New Revision: 1195776

URL: http://svn.apache.org/viewvc?rev=1195776&view=rev
Log:
Added javadoc and XSD documentation

Modified:
    db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/option/XmlOptionConfiguration.java
    db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/source/SourceSaxHandler.java
    db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/source/SourceTransformerSaxHandler.java
    db/torque/torque4/trunk/torque-generator/src/main/resources/org/apache/torque/generator/configuration/configuration.xsd

Modified: db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/option/XmlOptionConfiguration.java
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/option/XmlOptionConfiguration.java?rev=1195776&r1=1195775&r2=1195776&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/option/XmlOptionConfiguration.java
(original)
+++ db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/option/XmlOptionConfiguration.java
Tue Nov  1 02:35:52 2011
@@ -31,7 +31,8 @@ import org.apache.torque.generator.confi
 import org.apache.torque.generator.option.Option;
 
 /**
- * An option configuration which reads the options from a XML file.
+ * An option configuration which reads the options from a XML file
+ * in the java properties XML format.
  *
  * $Id: $
  */

Modified: db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/source/SourceSaxHandler.java
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/source/SourceSaxHandler.java?rev=1195776&r1=1195775&r2=1195776&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/source/SourceSaxHandler.java
(original)
+++ db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/source/SourceSaxHandler.java
Tue Nov  1 02:35:52 2011
@@ -248,7 +248,7 @@ public abstract class SourceSaxHandler e
     public abstract SourceProvider getSourceProvider();
 
     /**
-     * Returns the information how to post-process the sources.
+     * Returns the information how to post-process the sources after loading.
      *
      * @return the sourceProcessConfiguration, not null if the
      *         source snippet was processed.

Modified: db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/source/SourceTransformerSaxHandler.java
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/source/SourceTransformerSaxHandler.java?rev=1195776&r1=1195775&r2=1195776&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/source/SourceTransformerSaxHandler.java
(original)
+++ db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/source/SourceTransformerSaxHandler.java
Tue Nov  1 02:35:52 2011
@@ -269,6 +269,12 @@ public class SourceTransformerSaxHandler
         return sourceTransformer;
     }
 
+    /**
+     * Returns the path to source elements to which the transformer is applied.
+     *
+     * @return the path to the source element, or null to apply the transformer
+     *         to the root element.
+     */
     public String getElements()
     {
         return elements;

Modified: db/torque/torque4/trunk/torque-generator/src/main/resources/org/apache/torque/generator/configuration/configuration.xsd
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-generator/src/main/resources/org/apache/torque/generator/configuration/configuration.xsd?rev=1195776&r1=1195775&r2=1195776&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-generator/src/main/resources/org/apache/torque/generator/configuration/configuration.xsd
(original)
+++ db/torque/torque4/trunk/torque-generator/src/main/resources/org/apache/torque/generator/configuration/configuration.xsd
Tue Nov  1 02:35:52 2011
@@ -28,6 +28,11 @@
   <include schemaLocation="http://db.apache.org/torque/4.0/generator/outlet.xsd"/>
 
   <simpleType name="loglevelType">
+    <annotation>
+      <documentation>
+        The possible log levels for the generator.
+      </documentation>
+    </annotation>
     <restriction base="string">
       <enumeration value="trace"/>
       <enumeration value="debug"/>
@@ -46,6 +51,13 @@
   </complexType>
 
   <complexType name="xmlOptions">
+    <annotation>
+      <documentation>
+        A reference to a options file in java properties XML format.
+        See the javadoc of java.util.Properties for more information about
+        this format.
+      </documentation>
+    </annotation>
     <complexContent>
       <extension base="configuration:baseOptions">
         <sequence>
@@ -57,6 +69,11 @@
   </complexType>
 
   <complexType name="propertiesOptions">
+    <annotation>
+      <documentation>
+        A reference to a options file in java properties format (key=value).
+      </documentation>
+    </annotation>
     <complexContent>
       <extension base="configuration:baseOptions">
         <sequence>
@@ -68,6 +85,12 @@
   </complexType>
 
   <complexType name="entityReference">
+    <annotation>
+      <documentation>
+        Where to find external resources which are referenced by a key.
+        Typically this will be XSD files where the key is the systemId.
+      </documentation>
+    </annotation>
     <attribute name="systemId" type="string" use="required"/>
     <attribute name="resource" type="string" use="required"/>
   </complexType>
@@ -89,7 +112,7 @@
     <attribute name="file" type="string" use="optional">
       <annotation>
         <documentation>
-          This attribute contains the name of the generated file.
+          Contains the name of the generated file.
           Relative paths are relative to the target directory.
           If the file name is not fixed, omit this attribute and use
           the child element filenameOutlet instead.
@@ -107,7 +130,7 @@
     <attribute name="existingTargetStrategy" use="optional">
       <annotation>
         <documentation>
-          If set to true, the file will be skipped if it already exists.
+          What to do when a file which is about to be generated already exists.
           Default is "replace".
         </documentation>
       </annotation>
@@ -133,14 +156,49 @@
   </complexType>
   
   <complexType name="source" abstract="true">
+    <annotation>
+      <documentation>
+        A collection of sources for a generation process.
+        Typically this will be one or more files, but can virtually be anything.
+      </documentation>
+    </annotation>
     <sequence>
-      <element name="transformer" type="configuration:transformer" minOccurs="0" maxOccurs="unbounded"/>
+      <element name="transformer" type="configuration:transformer" minOccurs="0" maxOccurs="unbounded">
+        <annotation>
+          <documentation>
+            The transformers which are applied to the source.
+            Transformers transform (change) the source graph before generation
+            starts.
+          </documentation>
+        </annotation>
+      </element>
     </sequence>
-    <attribute name="elements" type="string" use="optional"/>
-    <attribute name="skipDecider" type="string" use="optional"/>
+    <attribute name="elements" type="string" use="optional">
+      <annotation>
+        <documentation>
+          The path to the source elements for which an own output file should
+          be created.
+        </documentation>
+      </annotation>
+    </attribute>
+    <attribute name="skipDecider" type="string" use="optional">
+      <annotation>
+        <documentation>
+          The fully qualified class name of a java class implementing the
+          org.apache.torque.generator.source.skipDecider.SkipDecider
+          interface. This class decides whether to proceed
+          with the current generation or not after the source has been loaded.
+        </documentation>
+      </annotation>
+    </attribute>
   </complexType>
   
   <complexType name="fileSource">
+    <annotation>
+      <documentation>
+        A collection of source files.
+      </documentation>
+    </annotation>
     <complexContent>
       <extension base="configuration:source">
         <sequence>
@@ -153,6 +211,11 @@
   </complexType>
 
   <complexType name="jdbcMetadataSource">
+    <annotation>
+      <documentation>
+        A source read from the jbdc metadata of a database.
+      </documentation>
+    </annotation>
     <complexContent>
       <extension base="configuration:source">
         <attribute name="driverOption" type="string" use="required"/>
@@ -165,18 +228,53 @@
   </complexType>
 
   <complexType name="transformer">
+    <annotation>
+      <documentation>
+        Configures a transformer which transforms the source tree before
+        generation starts. The transformer can be configured by adding
+        nested elements where the element name is the property name
+        and the text content the property value.
+      </documentation>
+    </annotation>
     <sequence>
       <any processContents="skip" minOccurs="0" maxOccurs="unbounded"/>
     </sequence>
-    <attribute name="class" type="string" use="required"/>
-    <attribute name="elements" type="string" use="optional"/>
+    <attribute name="class" type="string" use="required">
+      <annotation>
+        <documentation>
+          The fully qualified class name of a java class implementing the
+          org.apache.torque.generator.source.transform.SourceTransformer
+          interface. Instances of this interface transform (change)
+          the source graph.
+        </documentation>
+      </annotation>
+    </attribute>
+    <attribute name="elements" type="string" use="optional">
+      <annotation>
+        <documentation>
+          The path to source elements to which the transformer is applied.
+          If not set, the transformer is applied to the root element
+          of the source.
+        </documentation>
+      </annotation>
+    </attribute>
   </complexType>
 
   <complexType name="outletReference">
+    <annotation>
+      <documentation>
+        Points to an outlet defined in the outlet definition directory.
+      </documentation>
+    </annotation>
     <attribute name="name" type="string" use="required"/>
   </complexType>
 
   <element name="control">
+    <annotation>
+      <documentation>
+        The root element of the control configuration.
+      </documentation>
+    </annotation>
     <complexType>
       <sequence>
         <element name="options" type="configuration:baseOptions" minOccurs="0" maxOccurs="unbounded"/>



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