From torque-dev-return-11998-apmail-db-torque-dev-archive=db.apache.org@db.apache.org Thu Oct 11 09:06:48 2012 Return-Path: X-Original-To: apmail-db-torque-dev-archive@www.apache.org Delivered-To: apmail-db-torque-dev-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id AA045DD47 for ; Thu, 11 Oct 2012 09:06:48 +0000 (UTC) Received: (qmail 81978 invoked by uid 500); 11 Oct 2012 08:55:40 -0000 Delivered-To: apmail-db-torque-dev-archive@db.apache.org Received: (qmail 81797 invoked by uid 500); 11 Oct 2012 08:55:31 -0000 Mailing-List: contact torque-dev-help@db.apache.org; run by ezmlm Precedence: bulk List-Unsubscribe: List-Help: List-Post: List-Id: "Apache Torque Developers List" Reply-To: "Apache Torque Developers List" Delivered-To: mailing list torque-dev@db.apache.org Received: (qmail 78042 invoked by uid 500); 11 Oct 2012 08:53:05 -0000 Received: (qmail 77957 invoked by uid 99); 11 Oct 2012 08:52:57 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 11 Oct 2012 08:52:57 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=5.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 11 Oct 2012 08:52:52 +0000 Received: from eris.apache.org (localhost [127.0.0.1]) by eris.apache.org (Postfix) with ESMTP id D21F52388C70; Thu, 11 Oct 2012 08:51:21 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1396951 [20/23] - in /db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin: ./ apidocs/ apidocs/org/ apidocs/org/apache/ apidocs/org/apache/torque/ apidocs/org/apache/torque/mojo/ apidocs/org/apache/torque/mojo/class-use/... Date: Thu, 11 Oct 2012 08:51:14 -0000 To: torque-commits@db.apache.org From: tfischer@apache.org X-Mailer: svnmailer-1.0.8-patched Message-Id: <20121011085121.D21F52388C70@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Added: db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/xref/org/apache/torque/mojo/DocumentationMojo.html URL: http://svn.apache.org/viewvc/db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/xref/org/apache/torque/mojo/DocumentationMojo.html?rev=1396951&view=auto ============================================================================== --- db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/xref/org/apache/torque/mojo/DocumentationMojo.html (added) +++ db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/xref/org/apache/torque/mojo/DocumentationMojo.html Thu Oct 11 08:51:09 2012 @@ -0,0 +1,150 @@ + + + + +DocumentationMojo xref + + + +
+
+1   package org.apache.torque.mojo;
+2   
+3   /*
+4    * Licensed to the Apache Software Foundation (ASF) under one
+5    * or more contributor license agreements.  See the NOTICE file
+6    * distributed with this work for additional information
+7    * regarding copyright ownership.  The ASF licenses this file
+8    * to you under the Apache License, Version 2.0 (the
+9    * "License"); you may not use this file except in compliance
+10   * with the License.  You may obtain a copy of the License at
+11   *
+12   *   http://www.apache.org/licenses/LICENSE-2.0
+13   *
+14   * Unless required by applicable law or agreed to in writing,
+15   * software distributed under the License is distributed on an
+16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+17   * KIND, either express or implied.  See the License for the
+18   * specific language governing permissions and limitations
+19   * under the License.
+20   */
+21  
+22  import org.apache.commons.configuration.PropertiesConfiguration;
+23  import org.apache.torque.task.TorqueSQLTask;
+24  
+25  /**
+26   * Creates html or anakia documentation for the data model from the
+27   * schema.xml files.
+28   *
+29   * @author Raphael Pieroni (rafale_at_codehaus.org)
+30   * @author <a href="fischer@seitenbau.de">Thomas Fischer</a>
+31   *
+32   * @goal documentation
+33   * @phase generate-sources
+34   */
+35  public class DocumentationMojo extends DataModelTaskMojo
+36  {
+37      /** The context property for the output format. */
+38      public static final String OUTPUT_FORMAT_CONTEXT_PROPERTY
+39          = "outputFormat";
+40  
+41      // The following dummies trick the Mojo Description Extractor
+42      // into setting the correct default values for
+43      // outputDir, reportFile, contextPropertiesPath, schemaExcludes
+44      /**
+45       * The directory in which the documentation will be generated
+46       *
+47       * @parameter property="outputDir"
+48       *            expression="${project.build.directory}/generated-docs/torque"
+49       */
+50      private String dummy;
+51  
+52      /**
+53       * The location where the report file will be generated.
+54       *
+55       * @parameter property="reportFile"
+56       *            expression="../../torque/report.${project.artifact.artifactId}.doc.generation"
+57       */
+58      private String dummy2;
+59  
+60      /**
+61       * The location where the context property file for velocity will be
+62       * generated.
+63       *
+64       * @parameter property="contextPropertiesPath"
+65       *            expression="${project.build.directory}/torque/context.doc.properties"
+66       */
+67      private String dummy3;
+68  
+69      /**
+70       * The schema files which should be excluded in generation
+71       * (in ant-style notation).
+72       *
+73       * @parameter property="schemaExcludes" expression="id-table-schema.xml"
+74       */
+75      private String dummy4;
+76  
+77      /**
+78       * The format of the generated documentation. Can be either html or anakia.
+79       *
+80       * @parameter expression="html"
+81       */
+82      private String outputFormat;
+83  
+84      /**
+85       * Creates a new SQLMojo object.
+86       */
+87      public DocumentationMojo()
+88      {
+89          super(new TorqueSQLTask());
+90      }
+91  
+92      /**
+93       * Sets the output format of the documentation (html or anakia)
+94       *
+95       * @param outputFormat the output format of the documentation.
+96       */
+97      public void setOutputFormat(String outputFormat)
+98      {
+99          this.outputFormat = outputFormat;
+100     }
+101 
+102     /**
+103      * Returns the output format of the documentation (html or anakia)
+104      *
+105      * @return the output format of the documentation.
+106      */
+107     public String getOutputFormat()
+108     {
+109         return outputFormat;
+110     }
+111 
+112     /**
+113      * Returns the context properties for the Texen task.
+114      *
+115      * @return The PropertiesConfiguration containing all context properties,
+116      *         not null.
+117      */
+118     protected PropertiesConfiguration getMojoContextProperties()
+119     {
+120         PropertiesConfiguration configuration = new PropertiesConfiguration();
+121         configuration.addProperty(
+122                 OUTPUT_FORMAT_CONTEXT_PROPERTY,
+123                 getOutputFormat());
+124         return configuration;
+125     }
+126 
+127     /**
+128      * Returns the path to the control template.
+129      *
+130      * @return "doc/Control.vm"
+131      */
+132     protected String getControlTemplate()
+133     {
+134         return "doc/Control.vm";
+135     }
+136 }
+
+
+ + Added: db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/xref/org/apache/torque/mojo/IdTableInitSqlMojo.html URL: http://svn.apache.org/viewvc/db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/xref/org/apache/torque/mojo/IdTableInitSqlMojo.html?rev=1396951&view=auto ============================================================================== --- db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/xref/org/apache/torque/mojo/IdTableInitSqlMojo.html (added) +++ db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/xref/org/apache/torque/mojo/IdTableInitSqlMojo.html Thu Oct 11 08:51:09 2012 @@ -0,0 +1,225 @@ + + + + +IdTableInitSqlMojo xref + + + +
+
+1   package org.apache.torque.mojo;
+2   
+3   /*
+4    * Licensed to the Apache Software Foundation (ASF) under one
+5    * or more contributor license agreements.  See the NOTICE file
+6    * distributed with this work for additional information
+7    * regarding copyright ownership.  The ASF licenses this file
+8    * to you under the Apache License, Version 2.0 (the
+9    * "License"); you may not use this file except in compliance
+10   * with the License.  You may obtain a copy of the License at
+11   *
+12   *   http://www.apache.org/licenses/LICENSE-2.0
+13   *
+14   * Unless required by applicable law or agreed to in writing,
+15   * software distributed under the License is distributed on an
+16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+17   * KIND, either express or implied.  See the License for the
+18   * specific language governing permissions and limitations
+19   * under the License.
+20   */
+21  
+22  import org.apache.commons.configuration.PropertiesConfiguration;
+23  
+24  /**
+25   * Generates SQL for populating the id table in the database.
+26   *
+27   * @author Raphael Pieroni (rafale_at_codehaus.org)
+28   * @author <a href="fischer@seitenbau.de">Thomas Fischer</a>
+29   * @author <a href="kannegiesser@synyx.de">Marc Kannegiesser</a>
+30   *
+31   * @goal id-table-init-sql
+32   * @phase generate-sources
+33   */
+34  public class IdTableInitSqlMojo extends SqlMojoBase
+35  {
+36      public static final String INITIALID_CONTEXT_PROPERTY
+37              = "initialID";
+38      public static final String INITIALIDVALUE_CONTEXT_PROPERTY
+39              = "initialIDValue";
+40      public static final String INITIALIDSTEP_CONTEXT_PROPERTY
+41              = "initialIDStep";
+42  
+43      // The following dummies trick the Mojo Description Extractor
+44      // into setting the correct default values for
+45      // outputDir, reportFile, contextPropertiesPath, schemaExcludes, suffix
+46      /**
+47       * The directory in which the SQL will be generated.
+48       *
+49       * @parameter property="outputDir"
+50       *            expression="${project.build.directory}/generated-sql/torque"
+51       */
+52      private String dummy;
+53  
+54      /**
+55       * The location where the report file will be generated.
+56       *
+57       * @parameter property="reportFile"
+58       *            expression="../../torque/report.${project.artifact.artifactId}.idtable-init-sql.generation"
+59       */
+60      private String dummy2;
+61  
+62      /**
+63       * The location where the context property file for velocity will be
+64       * generated.
+65       *
+66       * @parameter property="contextPropertiesPath"
+67       *            expression="${project.build.directory}/torque/context.idtable-init-sql.properties"
+68       */
+69      private String dummy3;
+70  
+71      /**
+72       * The schema files which should be excluded in generation
+73       * (in ant-style notation).
+74       *
+75       * @parameter property="schemaExcludes" expression="id-table-schema.xml"
+76       */
+77      private String dummy4;
+78  
+79      /**
+80       * The suffix of the idTable-sql files.
+81       *
+82       * @parameter property="suffix"
+83       *            expression="-idtable-init"
+84       */
+85      private String dummy5;
+86   
+87      /**
+88       * The initial ID of the idtables
+89       *
+90       * @parameter expression="101"
+91       */
+92      private String initialID;
+93  
+94      /**
+95       * The initial IDValue of the idtable
+96       *
+97       * @parameter expression="1000"
+98       */
+99      private String initialIDValue;
+100 
+101     /**
+102      * The initial ID Step of the idtable
+103      *
+104      * @parameter expression="10"
+105      */
+106     private String initialIDStep;
+107 
+108     /**
+109      * Creates a new IdTableInitSqlMojo object.
+110      */
+111     public IdTableInitSqlMojo()
+112     {
+113     }
+114 
+115     /**
+116      * Sets the initial id of the idtables
+117      *
+118      * @param initialID The initial of the idtables
+119      */
+120     public void setInitialID(String initialID)
+121     {
+122         this.initialID = initialID;
+123     }
+124 
+125     /**
+126      * Returns the initial id of the idtable
+127      *
+128      * @return initialID The initial ID of the idtables
+129      */
+130     public String getInitialID()
+131     {
+132         return this.initialID;
+133     }
+134 
+135 
+136 
+137     /**
+138      * Sets the initial id value of the idtables
+139      *
+140      * @param initialIDValue The initial id value of the tables
+141      */
+142     public void setInitialIDValue(String initialIDValue)
+143     {
+144         this.initialIDValue = initialIDValue;
+145     }
+146 
+147     /**
+148      * Returns the initial id value of the idtables
+149      *
+150      * @return initialIDValue the initial id value of the idtables
+151      */
+152     public String getInitialIDValue()
+153     {
+154         return this.initialIDValue;
+155     }
+156 
+157 
+158 
+159     /**
+160      * Sets the initial id step of the idtables
+161      *
+162      * @param initialIDStep The initial id step of the tables
+163      */
+164     public void setInitialIDStep(String initialIDStep)
+165     {
+166         this.initialIDStep = initialIDStep;
+167     }
+168 
+169     /**
+170      * Returns the initial id step of the idtables
+171      *
+172      * @return initialIDStep the initial id step of the idtables
+173      */
+174     public String getInitialIDStep()
+175     {
+176         return this.initialIDStep;
+177     }
+178 
+179     /**
+180      * Returns the context properties for the Texen task.
+181      *
+182      * @return The PropertiesConfiguration containing all context properties,
+183      *         not null.
+184      */
+185     protected PropertiesConfiguration getMojoContextProperties()
+186     {
+187       PropertiesConfiguration configuration = super.getMojoContextProperties();
+188       configuration.addProperty(
+189                INITIALID_CONTEXT_PROPERTY,
+190                initialID);
+191 
+192       configuration.addProperty(
+193                INITIALIDVALUE_CONTEXT_PROPERTY,
+194                initialIDValue);
+195 
+196       configuration.addProperty(
+197                INITIALIDSTEP_CONTEXT_PROPERTY,
+198                initialIDStep);
+199         return configuration;
+200     }
+201 
+202     /**
+203      * Returns the path to the control template.
+204      *
+205      * @return "sql/id-table/Control.vm"
+206      */
+207     protected String getControlTemplate()
+208     {
+209         return "sql/id-table/Control.vm";
+210     }
+211 }
+
+
+ + --------------------------------------------------------------------- To unsubscribe, e-mail: torque-dev-unsubscribe@db.apache.org For additional commands, e-mail: torque-dev-help@db.apache.org