db-torque-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From tfisc...@apache.org
Subject svn commit: r1396951 [19/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 GMT
Added: db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/xref/org/apache/torque/mojo/DataDumpMojo.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/DataDumpMojo.html?rev=1396951&view=auto
==============================================================================
--- db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/xref/org/apache/torque/mojo/DataDumpMojo.html (added)
+++ db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/xref/org/apache/torque/mojo/DataDumpMojo.html Thu Oct 11 08:51:09 2012
@@ -0,0 +1,318 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
+<title>DataDumpMojo xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../apidocs/org/apache/torque/mojo/DataDumpMojo.html">View Javadoc</a></div><pre>
+
+<a name="1" href="#1">1</a>   <strong class="jxr_keyword">package</strong> org.apache.torque.mojo;
+<a name="2" href="#2">2</a>   
+<a name="3" href="#3">3</a>   <em class="jxr_comment">/*</em>
+<a name="4" href="#4">4</a>   <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
+<a name="5" href="#5">5</a>   <em class="jxr_comment"> * or more contributor license agreements.  See the NOTICE file</em>
+<a name="6" href="#6">6</a>   <em class="jxr_comment"> * distributed with this work for additional information</em>
+<a name="7" href="#7">7</a>   <em class="jxr_comment"> * regarding copyright ownership.  The ASF licenses this file</em>
+<a name="8" href="#8">8</a>   <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
+<a name="9" href="#9">9</a>   <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
+<a name="10" href="#10">10</a>  <em class="jxr_comment"> * with the License.  You may obtain a copy of the License at</em>
+<a name="11" href="#11">11</a>  <em class="jxr_comment"> *</em>
+<a name="12" href="#12">12</a>  <em class="jxr_comment"> *   <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
+<a name="13" href="#13">13</a>  <em class="jxr_comment"> *</em>
+<a name="14" href="#14">14</a>  <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
+<a name="15" href="#15">15</a>  <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
+<a name="16" href="#16">16</a>  <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
+<a name="17" href="#17">17</a>  <em class="jxr_comment"> * KIND, either express or implied.  See the License for the</em>
+<a name="18" href="#18">18</a>  <em class="jxr_comment"> * specific language governing permissions and limitations</em>
+<a name="19" href="#19">19</a>  <em class="jxr_comment"> * under the License.</em>
+<a name="20" href="#20">20</a>  <em class="jxr_comment"> */</em>
+<a name="21" href="#21">21</a>  
+<a name="22" href="#22">22</a>  <strong class="jxr_keyword">import</strong> org.apache.commons.configuration.PropertiesConfiguration;
+<a name="23" href="#23">23</a>  <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException;
+<a name="24" href="#24">24</a>  <strong class="jxr_keyword">import</strong> org.apache.torque.task.TorqueDataDumpTask;
+<a name="25" href="#25">25</a>  
+<a name="26" href="#26">26</a>  <em class="jxr_javadoccomment">/**</em>
+<a name="27" href="#27">27</a>  <em class="jxr_javadoccomment"> * Reads the content of tables from thh database and stores the data</em>
+<a name="28" href="#28">28</a>  <em class="jxr_javadoccomment"> * in XML files.</em>
+<a name="29" href="#29">29</a>  <em class="jxr_javadoccomment"> *</em>
+<a name="30" href="#30">30</a>  <em class="jxr_javadoccomment"> * @author Raphael Pieroni (rafale_at_codehaus.org)</em>
+<a name="31" href="#31">31</a>  <em class="jxr_javadoccomment"> * @author &lt;a href="fischer@seitenbau.de"&gt;Thomas Fischer&lt;/a&gt;</em>
+<a name="32" href="#32">32</a>  <em class="jxr_javadoccomment"> *</em>
+<a name="33" href="#33">33</a>  <em class="jxr_javadoccomment"> * @goal datadump</em>
+<a name="34" href="#34">34</a>  <em class="jxr_javadoccomment"> * @phase generate-sources</em>
+<a name="35" href="#35">35</a>  <em class="jxr_javadoccomment"> */</em>
+<a name="36" href="#36">36</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/torque/mojo/DataDumpMojo.html">DataDumpMojo</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../org/apache/torque/mojo/DataModelTaskMojo.html">DataModelTaskMojo</a>
+<a name="37" href="#37">37</a>  {
+<a name="38" href="#38">38</a>      <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> The context property for the name of the project. */</em>
+<a name="39" href="#39">39</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String PROJECT_CONTEXT_PROPERTY
+<a name="40" href="#40">40</a>          = <span class="jxr_string">"project"</span>;
+<a name="41" href="#41">41</a>  
+<a name="42" href="#42">42</a>      <em class="jxr_comment">// The following dummies trick the Mojo Description Extractor</em>
+<a name="43" href="#43">43</a>      <em class="jxr_comment">// into setting the correct default values for</em>
+<a name="44" href="#44">44</a>      <em class="jxr_comment">// outputDir, reportFile, contextPropertiesPath, schemaExcludes</em>
+<a name="45" href="#45">45</a>      <em class="jxr_javadoccomment">/**</em>
+<a name="46" href="#46">46</a>  <em class="jxr_javadoccomment">     * The directory in which the data files will be created.</em>
+<a name="47" href="#47">47</a>  <em class="jxr_javadoccomment">     *</em>
+<a name="48" href="#48">48</a>  <em class="jxr_javadoccomment">     * @parameter property="outputDir"</em>
+<a name="49" href="#49">49</a>  <em class="jxr_javadoccomment">     *            expression="${project.build.directory}/data/torque"</em>
+<a name="50" href="#50">50</a>  <em class="jxr_javadoccomment">     */</em>
+<a name="51" href="#51">51</a>      <strong class="jxr_keyword">private</strong> String dummy;
+<a name="52" href="#52">52</a>  
+<a name="53" href="#53">53</a>      <em class="jxr_javadoccomment">/**</em>
+<a name="54" href="#54">54</a>  <em class="jxr_javadoccomment">     * The location where the report file will be generated.</em>
+<a name="55" href="#55">55</a>  <em class="jxr_javadoccomment">     *</em>
+<a name="56" href="#56">56</a>  <em class="jxr_javadoccomment">     * @parameter property="reportFile"</em>
+<a name="57" href="#57">57</a>  <em class="jxr_javadoccomment">     *            expression="../../torque/report.${project.artifact.artifactId}.data.generation"</em>
+<a name="58" href="#58">58</a>  <em class="jxr_javadoccomment">     */</em>
+<a name="59" href="#59">59</a>      <strong class="jxr_keyword">private</strong> String dummy2;
+<a name="60" href="#60">60</a>  
+<a name="61" href="#61">61</a>      <em class="jxr_javadoccomment">/**</em>
+<a name="62" href="#62">62</a>  <em class="jxr_javadoccomment">     * The location where the context property file for velocity will be</em>
+<a name="63" href="#63">63</a>  <em class="jxr_javadoccomment">     * generated.</em>
+<a name="64" href="#64">64</a>  <em class="jxr_javadoccomment">     *</em>
+<a name="65" href="#65">65</a>  <em class="jxr_javadoccomment">     * @parameter property="contextPropertiesPath"</em>
+<a name="66" href="#66">66</a>  <em class="jxr_javadoccomment">     *            expression="${project.build.directory}/torque/context.data.properties"</em>
+<a name="67" href="#67">67</a>  <em class="jxr_javadoccomment">     */</em>
+<a name="68" href="#68">68</a>      <strong class="jxr_keyword">private</strong> String dummy3;
+<a name="69" href="#69">69</a>  
+<a name="70" href="#70">70</a>      <em class="jxr_javadoccomment">/**</em>
+<a name="71" href="#71">71</a>  <em class="jxr_javadoccomment">     * The schema files which should be excluded in generation</em>
+<a name="72" href="#72">72</a>  <em class="jxr_javadoccomment">     * (in ant-style notation).</em>
+<a name="73" href="#73">73</a>  <em class="jxr_javadoccomment">     *</em>
+<a name="74" href="#74">74</a>  <em class="jxr_javadoccomment">     * @parameter property="schemaExcludes" expression="id-table-schema.xml"</em>
+<a name="75" href="#75">75</a>  <em class="jxr_javadoccomment">     */</em>
+<a name="76" href="#76">76</a>      <strong class="jxr_keyword">private</strong> String dummy4;
+<a name="77" href="#77">77</a>  
+<a name="78" href="#78">78</a>      <em class="jxr_javadoccomment">/**</em>
+<a name="79" href="#79">79</a>  <em class="jxr_javadoccomment">     * The fully qualified class name of the database driver.</em>
+<a name="80" href="#80">80</a>  <em class="jxr_javadoccomment">     *</em>
+<a name="81" href="#81">81</a>  <em class="jxr_javadoccomment">     * @parameter</em>
+<a name="82" href="#82">82</a>  <em class="jxr_javadoccomment">     * @required</em>
+<a name="83" href="#83">83</a>  <em class="jxr_javadoccomment">     */</em>
+<a name="84" href="#84">84</a>      <strong class="jxr_keyword">private</strong> String driver = <strong class="jxr_keyword">null</strong>;
+<a name="85" href="#85">85</a>  
+<a name="86" href="#86">86</a>      <em class="jxr_javadoccomment">/**</em>
+<a name="87" href="#87">87</a>  <em class="jxr_javadoccomment">     * The connect URL of the database.</em>
+<a name="88" href="#88">88</a>  <em class="jxr_javadoccomment">     *</em>
+<a name="89" href="#89">89</a>  <em class="jxr_javadoccomment">     * @parameter</em>
+<a name="90" href="#90">90</a>  <em class="jxr_javadoccomment">     * @required</em>
+<a name="91" href="#91">91</a>  <em class="jxr_javadoccomment">     */</em>
+<a name="92" href="#92">92</a>      <strong class="jxr_keyword">private</strong> String url = <strong class="jxr_keyword">null</strong>;
+<a name="93" href="#93">93</a>  
+<a name="94" href="#94">94</a>      <em class="jxr_javadoccomment">/**</em>
+<a name="95" href="#95">95</a>  <em class="jxr_javadoccomment">     * The user name to connect to the database.</em>
+<a name="96" href="#96">96</a>  <em class="jxr_javadoccomment">     *</em>
+<a name="97" href="#97">97</a>  <em class="jxr_javadoccomment">     * @parameter</em>
+<a name="98" href="#98">98</a>  <em class="jxr_javadoccomment">     * @required</em>
+<a name="99" href="#99">99</a>  <em class="jxr_javadoccomment">     */</em>
+<a name="100" href="#100">100</a>     <strong class="jxr_keyword">private</strong> String user = <strong class="jxr_keyword">null</strong>;
+<a name="101" href="#101">101</a> 
+<a name="102" href="#102">102</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="103" href="#103">103</a> <em class="jxr_javadoccomment">     * The password for the database user.</em>
+<a name="104" href="#104">104</a> <em class="jxr_javadoccomment">     *</em>
+<a name="105" href="#105">105</a> <em class="jxr_javadoccomment">     * @parameter</em>
+<a name="106" href="#106">106</a> <em class="jxr_javadoccomment">     */</em>
+<a name="107" href="#107">107</a>     <strong class="jxr_keyword">private</strong> String password = <strong class="jxr_keyword">null</strong>;
+<a name="108" href="#108">108</a> 
+<a name="109" href="#109">109</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="110" href="#110">110</a> <em class="jxr_javadoccomment">     * The name of the project, used as a prefix of the names</em>
+<a name="111" href="#111">111</a> <em class="jxr_javadoccomment">     * of the generated files and the name of the datadtd.</em>
+<a name="112" href="#112">112</a> <em class="jxr_javadoccomment">     *</em>
+<a name="113" href="#113">113</a> <em class="jxr_javadoccomment">     * @parameter expression="torque"</em>
+<a name="114" href="#114">114</a> <em class="jxr_javadoccomment">     */</em>
+<a name="115" href="#115">115</a>     <strong class="jxr_keyword">private</strong> String projectName = <strong class="jxr_keyword">null</strong>;
+<a name="116" href="#116">116</a> 
+<a name="117" href="#117">117</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="118" href="#118">118</a> <em class="jxr_javadoccomment">     * The name of the xml file to process. Only one xml file can be processed</em>
+<a name="119" href="#119">119</a> <em class="jxr_javadoccomment">     * at a time.</em>
+<a name="120" href="#120">120</a> <em class="jxr_javadoccomment">     * Overrides the settings schemaIncludes and schemaExcludes</em>
+<a name="121" href="#121">121</a> <em class="jxr_javadoccomment">     *</em>
+<a name="122" href="#122">122</a> <em class="jxr_javadoccomment">     * @parameter</em>
+<a name="123" href="#123">123</a> <em class="jxr_javadoccomment">     * @required</em>
+<a name="124" href="#124">124</a> <em class="jxr_javadoccomment">     */</em>
+<a name="125" href="#125">125</a>     <strong class="jxr_keyword">private</strong> String xmlFile = <strong class="jxr_keyword">null</strong>;
+<a name="126" href="#126">126</a> 
+<a name="127" href="#127">127</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="128" href="#128">128</a> <em class="jxr_javadoccomment">     * Creates a new SQLMojo object.</em>
+<a name="129" href="#129">129</a> <em class="jxr_javadoccomment">     */</em>
+<a name="130" href="#130">130</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/torque/mojo/DataDumpMojo.html">DataDumpMojo</a>()
+<a name="131" href="#131">131</a>     {
+<a name="132" href="#132">132</a>         <strong class="jxr_keyword">super</strong>(<strong class="jxr_keyword">new</strong> TorqueDataDumpTask());
+<a name="133" href="#133">133</a>     }
+<a name="134" href="#134">134</a> 
+<a name="135" href="#135">135</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="136" href="#136">136</a> <em class="jxr_javadoccomment">     * Returns the path to the control template.</em>
+<a name="137" href="#137">137</a> <em class="jxr_javadoccomment">     *</em>
+<a name="138" href="#138">138</a> <em class="jxr_javadoccomment">     * @return "data/Control.vm"</em>
+<a name="139" href="#139">139</a> <em class="jxr_javadoccomment">     */</em>
+<a name="140" href="#140">140</a>     <strong class="jxr_keyword">protected</strong> String getControlTemplate()
+<a name="141" href="#141">141</a>     {
+<a name="142" href="#142">142</a>         <strong class="jxr_keyword">return</strong> <span class="jxr_string">"data/dump/Control.vm"</span>;
+<a name="143" href="#143">143</a>     }
+<a name="144" href="#144">144</a> 
+<a name="145" href="#145">145</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="146" href="#146">146</a> <em class="jxr_javadoccomment">     * Returns the context properties for the Texen task.</em>
+<a name="147" href="#147">147</a> <em class="jxr_javadoccomment">     *</em>
+<a name="148" href="#148">148</a> <em class="jxr_javadoccomment">     * @return The PropertiesConfiguration containing all context properties,</em>
+<a name="149" href="#149">149</a> <em class="jxr_javadoccomment">     *         not null.</em>
+<a name="150" href="#150">150</a> <em class="jxr_javadoccomment">     */</em>
+<a name="151" href="#151">151</a>     <strong class="jxr_keyword">protected</strong> PropertiesConfiguration getMojoContextProperties()
+<a name="152" href="#152">152</a>     {
+<a name="153" href="#153">153</a>         PropertiesConfiguration configuration = <strong class="jxr_keyword">new</strong> PropertiesConfiguration();
+<a name="154" href="#154">154</a>         configuration.addProperty(PROJECT_CONTEXT_PROPERTY, projectName);
+<a name="155" href="#155">155</a>         <strong class="jxr_keyword">return</strong> configuration;
+<a name="156" href="#156">156</a>     }
+<a name="157" href="#157">157</a> 
+<a name="158" href="#158">158</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="159" href="#159">159</a> <em class="jxr_javadoccomment">     * Configures the Texen task which is wrapped by this mojo.</em>
+<a name="160" href="#160">160</a> <em class="jxr_javadoccomment">     * In this implementation, the context properties, useClasspath,</em>
+<a name="161" href="#161">161</a> <em class="jxr_javadoccomment">     * the output directory, the control template, the schema Fileset,</em>
+<a name="162" href="#162">162</a> <em class="jxr_javadoccomment">     * the target package, the target database and the xml file are set.</em>
+<a name="163" href="#163">163</a> <em class="jxr_javadoccomment">     *</em>
+<a name="164" href="#164">164</a> <em class="jxr_javadoccomment">     * @throws MojoExecutionException if an error occurs when setting the Tasks</em>
+<a name="165" href="#165">165</a> <em class="jxr_javadoccomment">     *         properties.</em>
+<a name="166" href="#166">166</a> <em class="jxr_javadoccomment">     *</em>
+<a name="167" href="#167">167</a> <em class="jxr_javadoccomment">     * @see TexenTaskMojo#configureTask()</em>
+<a name="168" href="#168">168</a> <em class="jxr_javadoccomment">     */</em>
+<a name="169" href="#169">169</a>     <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> configureTask() <strong class="jxr_keyword">throws</strong> MojoExecutionException
+<a name="170" href="#170">170</a>     {
+<a name="171" href="#171">171</a>         <strong class="jxr_keyword">super</strong>.configureTask();
+<a name="172" href="#172">172</a> 
+<a name="173" href="#173">173</a>         TorqueDataDumpTask task
+<a name="174" href="#174">174</a>                 = (TorqueDataDumpTask) <strong class="jxr_keyword">super</strong>.getGeneratorTask();
+<a name="175" href="#175">175</a> 
+<a name="176" href="#176">176</a>         task.setDatabaseDriver(driver);
+<a name="177" href="#177">177</a>         task.setDatabaseUrl(url);
+<a name="178" href="#178">178</a>         task.setDatabaseUser(user);
+<a name="179" href="#179">179</a>         task.setDatabasePassword(password);
+<a name="180" href="#180">180</a>         task.setXmlFile(xmlFile);
+<a name="181" href="#181">181</a>     }
+<a name="182" href="#182">182</a> 
+<a name="183" href="#183">183</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="184" href="#184">184</a> <em class="jxr_javadoccomment">     * Returns the fully qualified class name of the database driver.</em>
+<a name="185" href="#185">185</a> <em class="jxr_javadoccomment">     *</em>
+<a name="186" href="#186">186</a> <em class="jxr_javadoccomment">     * @return the fully qualified class name of the database driver.</em>
+<a name="187" href="#187">187</a> <em class="jxr_javadoccomment">     */</em>
+<a name="188" href="#188">188</a>     <strong class="jxr_keyword">public</strong> String getDriver()
+<a name="189" href="#189">189</a>     {
+<a name="190" href="#190">190</a>         <strong class="jxr_keyword">return</strong> driver;
+<a name="191" href="#191">191</a>     }
+<a name="192" href="#192">192</a> 
+<a name="193" href="#193">193</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="194" href="#194">194</a> <em class="jxr_javadoccomment">     * Sets the fully qualified class name of the database driver.</em>
+<a name="195" href="#195">195</a> <em class="jxr_javadoccomment">     *</em>
+<a name="196" href="#196">196</a> <em class="jxr_javadoccomment">     * @param driver the fully qualified class name of the database driver.</em>
+<a name="197" href="#197">197</a> <em class="jxr_javadoccomment">     */</em>
+<a name="198" href="#198">198</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setDriver(String driver)
+<a name="199" href="#199">199</a>     {
+<a name="200" href="#200">200</a>         <strong class="jxr_keyword">this</strong>.driver = driver;
+<a name="201" href="#201">201</a>     }
+<a name="202" href="#202">202</a> 
+<a name="203" href="#203">203</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="204" href="#204">204</a> <em class="jxr_javadoccomment">     * Returns the password of the database user.</em>
+<a name="205" href="#205">205</a> <em class="jxr_javadoccomment">     *</em>
+<a name="206" href="#206">206</a> <em class="jxr_javadoccomment">     * @return the password of the database user.</em>
+<a name="207" href="#207">207</a> <em class="jxr_javadoccomment">     */</em>
+<a name="208" href="#208">208</a>     <strong class="jxr_keyword">public</strong> String getPassword()
+<a name="209" href="#209">209</a>     {
+<a name="210" href="#210">210</a>         <strong class="jxr_keyword">return</strong> password;
+<a name="211" href="#211">211</a>     }
+<a name="212" href="#212">212</a> 
+<a name="213" href="#213">213</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="214" href="#214">214</a> <em class="jxr_javadoccomment">     * Sets the password of the database user.</em>
+<a name="215" href="#215">215</a> <em class="jxr_javadoccomment">     *</em>
+<a name="216" href="#216">216</a> <em class="jxr_javadoccomment">     * @param password the password of the database user.</em>
+<a name="217" href="#217">217</a> <em class="jxr_javadoccomment">     */</em>
+<a name="218" href="#218">218</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setPassword(String password)
+<a name="219" href="#219">219</a>     {
+<a name="220" href="#220">220</a>         <strong class="jxr_keyword">this</strong>.password = password;
+<a name="221" href="#221">221</a>     }
+<a name="222" href="#222">222</a> 
+<a name="223" href="#223">223</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="224" href="#224">224</a> <em class="jxr_javadoccomment">     * Returns the connect URL to the database.</em>
+<a name="225" href="#225">225</a> <em class="jxr_javadoccomment">     *</em>
+<a name="226" href="#226">226</a> <em class="jxr_javadoccomment">     * @return the connect URL to the database.</em>
+<a name="227" href="#227">227</a> <em class="jxr_javadoccomment">     */</em>
+<a name="228" href="#228">228</a>     <strong class="jxr_keyword">public</strong> String getUrl()
+<a name="229" href="#229">229</a>     {
+<a name="230" href="#230">230</a>         <strong class="jxr_keyword">return</strong> url;
+<a name="231" href="#231">231</a>     }
+<a name="232" href="#232">232</a> 
+<a name="233" href="#233">233</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="234" href="#234">234</a> <em class="jxr_javadoccomment">     * Sets the connect URL to the database.</em>
+<a name="235" href="#235">235</a> <em class="jxr_javadoccomment">     *</em>
+<a name="236" href="#236">236</a> <em class="jxr_javadoccomment">     * @param url the connect URL to the database.</em>
+<a name="237" href="#237">237</a> <em class="jxr_javadoccomment">     */</em>
+<a name="238" href="#238">238</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setUrl(String url)
+<a name="239" href="#239">239</a>     {
+<a name="240" href="#240">240</a>         <strong class="jxr_keyword">this</strong>.url = url;
+<a name="241" href="#241">241</a>     }
+<a name="242" href="#242">242</a> 
+<a name="243" href="#243">243</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="244" href="#244">244</a> <em class="jxr_javadoccomment">     * Returns the database user.</em>
+<a name="245" href="#245">245</a> <em class="jxr_javadoccomment">     *</em>
+<a name="246" href="#246">246</a> <em class="jxr_javadoccomment">     * @return the userId of the database user.</em>
+<a name="247" href="#247">247</a> <em class="jxr_javadoccomment">     */</em>
+<a name="248" href="#248">248</a>     <strong class="jxr_keyword">public</strong> String getUser()
+<a name="249" href="#249">249</a>     {
+<a name="250" href="#250">250</a>         <strong class="jxr_keyword">return</strong> user;
+<a name="251" href="#251">251</a>     }
+<a name="252" href="#252">252</a> 
+<a name="253" href="#253">253</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="254" href="#254">254</a> <em class="jxr_javadoccomment">     * Sets the database user.</em>
+<a name="255" href="#255">255</a> <em class="jxr_javadoccomment">     *</em>
+<a name="256" href="#256">256</a> <em class="jxr_javadoccomment">     * @param user the userId of the database user.</em>
+<a name="257" href="#257">257</a> <em class="jxr_javadoccomment">     */</em>
+<a name="258" href="#258">258</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setUser(String user)
+<a name="259" href="#259">259</a>     {
+<a name="260" href="#260">260</a>         <strong class="jxr_keyword">this</strong>.user = user;
+<a name="261" href="#261">261</a>     }
+<a name="262" href="#262">262</a> 
+<a name="263" href="#263">263</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="264" href="#264">264</a> <em class="jxr_javadoccomment">     * Returns the name of the project, which is used as prefix for the</em>
+<a name="265" href="#265">265</a> <em class="jxr_javadoccomment">     * generated table names and the name of the datadtd.</em>
+<a name="266" href="#266">266</a> <em class="jxr_javadoccomment">     *</em>
+<a name="267" href="#267">267</a> <em class="jxr_javadoccomment">     * @return the name of the project.</em>
+<a name="268" href="#268">268</a> <em class="jxr_javadoccomment">     */</em>
+<a name="269" href="#269">269</a>     <strong class="jxr_keyword">public</strong> String getProjectName()
+<a name="270" href="#270">270</a>     {
+<a name="271" href="#271">271</a>         <strong class="jxr_keyword">return</strong> projectName;
+<a name="272" href="#272">272</a>     }
+<a name="273" href="#273">273</a> 
+<a name="274" href="#274">274</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="275" href="#275">275</a> <em class="jxr_javadoccomment">     * Sets the name of the project, which is used as prefix for the</em>
+<a name="276" href="#276">276</a> <em class="jxr_javadoccomment">     * generated table names and the name of the datadtd.</em>
+<a name="277" href="#277">277</a> <em class="jxr_javadoccomment">     *</em>
+<a name="278" href="#278">278</a> <em class="jxr_javadoccomment">     * @param project the name of the project.</em>
+<a name="279" href="#279">279</a> <em class="jxr_javadoccomment">     */</em>
+<a name="280" href="#280">280</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setProjectName(String projectName)
+<a name="281" href="#281">281</a>     {
+<a name="282" href="#282">282</a>         <strong class="jxr_keyword">this</strong>.projectName = projectName;
+<a name="283" href="#283">283</a>     }
+<a name="284" href="#284">284</a> 
+<a name="285" href="#285">285</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="286" href="#286">286</a> <em class="jxr_javadoccomment">     * Returns the name of the xml file to process.</em>
+<a name="287" href="#287">287</a> <em class="jxr_javadoccomment">     *</em>
+<a name="288" href="#288">288</a> <em class="jxr_javadoccomment">     * @return the name of the xml file to process.</em>
+<a name="289" href="#289">289</a> <em class="jxr_javadoccomment">     */</em>
+<a name="290" href="#290">290</a>     <strong class="jxr_keyword">public</strong> String getXmlFile()
+<a name="291" href="#291">291</a>     {
+<a name="292" href="#292">292</a>         <strong class="jxr_keyword">return</strong> xmlFile;
+<a name="293" href="#293">293</a>     }
+<a name="294" href="#294">294</a> 
+<a name="295" href="#295">295</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="296" href="#296">296</a> <em class="jxr_javadoccomment">     * Sets the name of the xml file to process.</em>
+<a name="297" href="#297">297</a> <em class="jxr_javadoccomment">     *</em>
+<a name="298" href="#298">298</a> <em class="jxr_javadoccomment">     * @param project the name of the xml file to process.</em>
+<a name="299" href="#299">299</a> <em class="jxr_javadoccomment">     */</em>
+<a name="300" href="#300">300</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setXmlFile(String xmlFile)
+<a name="301" href="#301">301</a>     {
+<a name="302" href="#302">302</a>         <strong class="jxr_keyword">this</strong>.xmlFile = xmlFile;
+<a name="303" href="#303">303</a>     }
+<a name="304" href="#304">304</a> }
+</pre>
+<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
+</html>
+

Added: db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/xref/org/apache/torque/mojo/DataModelTaskMojo.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/DataModelTaskMojo.html?rev=1396951&view=auto
==============================================================================
--- db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/xref/org/apache/torque/mojo/DataModelTaskMojo.html (added)
+++ db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/xref/org/apache/torque/mojo/DataModelTaskMojo.html Thu Oct 11 08:51:09 2012
@@ -0,0 +1,430 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
+<title>DataModelTaskMojo xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../apidocs/org/apache/torque/mojo/DataModelTaskMojo.html">View Javadoc</a></div><pre>
+
+<a name="1" href="#1">1</a>   <strong class="jxr_keyword">package</strong> org.apache.torque.mojo;
+<a name="2" href="#2">2</a>   
+<a name="3" href="#3">3</a>   <em class="jxr_comment">/*</em>
+<a name="4" href="#4">4</a>   <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
+<a name="5" href="#5">5</a>   <em class="jxr_comment"> * or more contributor license agreements.  See the NOTICE file</em>
+<a name="6" href="#6">6</a>   <em class="jxr_comment"> * distributed with this work for additional information</em>
+<a name="7" href="#7">7</a>   <em class="jxr_comment"> * regarding copyright ownership.  The ASF licenses this file</em>
+<a name="8" href="#8">8</a>   <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
+<a name="9" href="#9">9</a>   <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
+<a name="10" href="#10">10</a>  <em class="jxr_comment"> * with the License.  You may obtain a copy of the License at</em>
+<a name="11" href="#11">11</a>  <em class="jxr_comment"> *</em>
+<a name="12" href="#12">12</a>  <em class="jxr_comment"> *   <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
+<a name="13" href="#13">13</a>  <em class="jxr_comment"> *</em>
+<a name="14" href="#14">14</a>  <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
+<a name="15" href="#15">15</a>  <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
+<a name="16" href="#16">16</a>  <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
+<a name="17" href="#17">17</a>  <em class="jxr_comment"> * KIND, either express or implied.  See the License for the</em>
+<a name="18" href="#18">18</a>  <em class="jxr_comment"> * specific language governing permissions and limitations</em>
+<a name="19" href="#19">19</a>  <em class="jxr_comment"> * under the License.</em>
+<a name="20" href="#20">20</a>  <em class="jxr_comment"> */</em>
+<a name="21" href="#21">21</a>  
+<a name="22" href="#22">22</a>  <strong class="jxr_keyword">import</strong> java.io.File;
+<a name="23" href="#23">23</a>  
+<a name="24" href="#24">24</a>  <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException;
+<a name="25" href="#25">25</a>  <strong class="jxr_keyword">import</strong> org.apache.tools.ant.DirectoryScanner;
+<a name="26" href="#26">26</a>  <strong class="jxr_keyword">import</strong> org.apache.tools.ant.types.FileSet;
+<a name="27" href="#27">27</a>  <strong class="jxr_keyword">import</strong> org.apache.torque.task.TorqueDataModelTask;
+<a name="28" href="#28">28</a>  
+<a name="29" href="#29">29</a>  <em class="jxr_javadoccomment">/**</em>
+<a name="30" href="#30">30</a>  <em class="jxr_javadoccomment"> * The base class for all mojos wrapping DataModelTasks.</em>
+<a name="31" href="#31">31</a>  <em class="jxr_javadoccomment"> *</em>
+<a name="32" href="#32">32</a>  <em class="jxr_javadoccomment"> * @author Raphael Pieroni (rafale_at_codehaus.org)</em>
+<a name="33" href="#33">33</a>  <em class="jxr_javadoccomment"> * @author &lt;a href="fischer@seitenbau.de"&gt;Thomas Fischer&lt;/a&gt;</em>
+<a name="34" href="#34">34</a>  <em class="jxr_javadoccomment"> */</em>
+<a name="35" href="#35">35</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/torque/mojo/DataModelTaskMojo.html">DataModelTaskMojo</a>
+<a name="36" href="#36">36</a>          <strong class="jxr_keyword">extends</strong> <a href="../../../../org/apache/torque/mojo/TexenTaskMojo.html">TexenTaskMojo</a>
+<a name="37" href="#37">37</a>  {
+<a name="38" href="#38">38</a>      <em class="jxr_javadoccomment">/**</em>
+<a name="39" href="#39">39</a>  <em class="jxr_javadoccomment">     * The context property for the database.</em>
+<a name="40" href="#40">40</a>  <em class="jxr_javadoccomment">     */</em>
+<a name="41" href="#41">41</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String TARGET_DATABASE_CONTEXT_PROPERTY
+<a name="42" href="#42">42</a>              = <span class="jxr_string">"targetDatabase"</span>;
+<a name="43" href="#43">43</a>  
+<a name="44" href="#44">44</a>      <em class="jxr_javadoccomment">/**</em>
+<a name="45" href="#45">45</a>  <em class="jxr_javadoccomment">     * The path to the directory where the schema files are located in.</em>
+<a name="46" href="#46">46</a>  <em class="jxr_javadoccomment">     *</em>
+<a name="47" href="#47">47</a>  <em class="jxr_javadoccomment">     * @parameter expression="${basedir}/src/main/torque/schema"</em>
+<a name="48" href="#48">48</a>  <em class="jxr_javadoccomment">     * @required</em>
+<a name="49" href="#49">49</a>  <em class="jxr_javadoccomment">     */</em>
+<a name="50" href="#50">50</a>      <strong class="jxr_keyword">private</strong> String schemaDir;
+<a name="51" href="#51">51</a>  
+<a name="52" href="#52">52</a>      <em class="jxr_javadoccomment">/**</em>
+<a name="53" href="#53">53</a>  <em class="jxr_javadoccomment">     * The schema files which should be included in generation</em>
+<a name="54" href="#54">54</a>  <em class="jxr_javadoccomment">     * (in ant-style notation).</em>
+<a name="55" href="#55">55</a>  <em class="jxr_javadoccomment">     *</em>
+<a name="56" href="#56">56</a>  <em class="jxr_javadoccomment">     * @parameter expression="*schema.xml"</em>
+<a name="57" href="#57">57</a>  <em class="jxr_javadoccomment">     * @required</em>
+<a name="58" href="#58">58</a>  <em class="jxr_javadoccomment">     */</em>
+<a name="59" href="#59">59</a>      <strong class="jxr_keyword">private</strong> String schemaIncludes;
+<a name="60" href="#60">60</a>  
+<a name="61" href="#61">61</a>      <em class="jxr_javadoccomment">/**</em>
+<a name="62" href="#62">62</a>  <em class="jxr_javadoccomment">     * The schema files which should be excluded in generation</em>
+<a name="63" href="#63">63</a>  <em class="jxr_javadoccomment">     * (in ant-style notation).</em>
+<a name="64" href="#64">64</a>  <em class="jxr_javadoccomment">     */</em>
+<a name="65" href="#65">65</a>      <strong class="jxr_keyword">private</strong> String schemaExcludes;
+<a name="66" href="#66">66</a>  
+<a name="67" href="#67">67</a>      <em class="jxr_javadoccomment">/**</em>
+<a name="68" href="#68">68</a>  <em class="jxr_javadoccomment">     * The database type (e.g. mysql, oracle, ...) for the generated persistence</em>
+<a name="69" href="#69">69</a>  <em class="jxr_javadoccomment">     * classes,</em>
+<a name="70" href="#70">70</a>  <em class="jxr_javadoccomment">     *</em>
+<a name="71" href="#71">71</a>  <em class="jxr_javadoccomment">     * @parameter</em>
+<a name="72" href="#72">72</a>  <em class="jxr_javadoccomment">     * @required</em>
+<a name="73" href="#73">73</a>  <em class="jxr_javadoccomment">     */</em>
+<a name="74" href="#74">74</a>      <strong class="jxr_keyword">private</strong> String targetDatabase;
+<a name="75" href="#75">75</a>  
+<a name="76" href="#76">76</a>      <em class="jxr_javadoccomment">/**</em>
+<a name="77" href="#77">77</a>  <em class="jxr_javadoccomment">     * The target package for the generated classes.</em>
+<a name="78" href="#78">78</a>  <em class="jxr_javadoccomment">     *</em>
+<a name="79" href="#79">79</a>  <em class="jxr_javadoccomment">     * @parameter expression="torque.generated"</em>
+<a name="80" href="#80">80</a>  <em class="jxr_javadoccomment">     */</em>
+<a name="81" href="#81">81</a>      <strong class="jxr_keyword">private</strong> String targetPackage;
+<a name="82" href="#82">82</a>  
+<a name="83" href="#83">83</a>      <em class="jxr_javadoccomment">/**</em>
+<a name="84" href="#84">84</a>  <em class="jxr_javadoccomment">     * The file containing the generation report, relative to</em>
+<a name="85" href="#85">85</a>  <em class="jxr_javadoccomment">     * &lt;code&gt;outputDir&lt;/code&gt;.</em>
+<a name="86" href="#86">86</a>  <em class="jxr_javadoccomment">     *</em>
+<a name="87" href="#87">87</a>  <em class="jxr_javadoccomment">     * @required</em>
+<a name="88" href="#88">88</a>  <em class="jxr_javadoccomment">     */</em>
+<a name="89" href="#89">89</a>      <strong class="jxr_keyword">private</strong> String reportFile;
+<a name="90" href="#90">90</a>  
+<a name="91" href="#91">91</a>      <em class="jxr_javadoccomment">/**</em>
+<a name="92" href="#92">92</a>  <em class="jxr_javadoccomment">     * Determines if this task should run only if the schema has changed.</em>
+<a name="93" href="#93">93</a>  <em class="jxr_javadoccomment">     *</em>
+<a name="94" href="#94">94</a>  <em class="jxr_javadoccomment">     * @parameter expression="true"</em>
+<a name="95" href="#95">95</a>  <em class="jxr_javadoccomment">     */</em>
+<a name="96" href="#96">96</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> runOnlyOnSchemaChange;
+<a name="97" href="#97">97</a>  
+<a name="98" href="#98">98</a>      <em class="jxr_javadoccomment">/**</em>
+<a name="99" href="#99">99</a>  <em class="jxr_javadoccomment">     * The path to the properties file containing the mapping</em>
+<a name="100" href="#100">100</a> <em class="jxr_javadoccomment">     * sql file -&gt; target database.</em>
+<a name="101" href="#101">101</a> <em class="jxr_javadoccomment">     *</em>
+<a name="102" href="#102">102</a> <em class="jxr_javadoccomment">     * @parameter expression="${project.build.directory}/torque/sqldbmap.properties"</em>
+<a name="103" href="#103">103</a> <em class="jxr_javadoccomment">     */</em>
+<a name="104" href="#104">104</a>     <strong class="jxr_keyword">private</strong> String sqlDbMap;
+<a name="105" href="#105">105</a> 
+<a name="106" href="#106">106</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="107" href="#107">107</a> <em class="jxr_javadoccomment">     * Creates a new TorqueOMMojo object.</em>
+<a name="108" href="#108">108</a> <em class="jxr_javadoccomment">     */</em>
+<a name="109" href="#109">109</a>     <a href="../../../../org/apache/torque/mojo/DataModelTaskMojo.html">DataModelTaskMojo</a>()
+<a name="110" href="#110">110</a>     {
+<a name="111" href="#111">111</a>         <strong class="jxr_keyword">super</strong>(<strong class="jxr_keyword">new</strong> TorqueDataModelTask());
+<a name="112" href="#112">112</a>     }
+<a name="113" href="#113">113</a> 
+<a name="114" href="#114">114</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="115" href="#115">115</a> <em class="jxr_javadoccomment">     * Creates a new TorqueOMMojo object wrapping the passed</em>
+<a name="116" href="#116">116</a> <em class="jxr_javadoccomment">     * TorqueDataModelTask.</em>
+<a name="117" href="#117">117</a> <em class="jxr_javadoccomment">     *</em>
+<a name="118" href="#118">118</a> <em class="jxr_javadoccomment">     * @param torqueDataModelTask the DataModelTask to be wrapped by this Mojo.</em>
+<a name="119" href="#119">119</a> <em class="jxr_javadoccomment">     */</em>
+<a name="120" href="#120">120</a>     <a href="../../../../org/apache/torque/mojo/DataModelTaskMojo.html">DataModelTaskMojo</a>(TorqueDataModelTask torqueDataModelTask)
+<a name="121" href="#121">121</a>     {
+<a name="122" href="#122">122</a>         <strong class="jxr_keyword">super</strong>(torqueDataModelTask);
+<a name="123" href="#123">123</a>     }
+<a name="124" href="#124">124</a> 
+<a name="125" href="#125">125</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="126" href="#126">126</a> <em class="jxr_javadoccomment">     * Configures the Texen task which is wrapped by this mojo.</em>
+<a name="127" href="#127">127</a> <em class="jxr_javadoccomment">     * In this implementation, the context properties, useClasspath,</em>
+<a name="128" href="#128">128</a> <em class="jxr_javadoccomment">     * the output directory, the control template, the schema Fileset,</em>
+<a name="129" href="#129">129</a> <em class="jxr_javadoccomment">     * the target package and the target database are set.</em>
+<a name="130" href="#130">130</a> <em class="jxr_javadoccomment">     *</em>
+<a name="131" href="#131">131</a> <em class="jxr_javadoccomment">     * @throws MojoExecutionException if an error occurs when setting the Tasks</em>
+<a name="132" href="#132">132</a> <em class="jxr_javadoccomment">     *         properties.</em>
+<a name="133" href="#133">133</a> <em class="jxr_javadoccomment">     *</em>
+<a name="134" href="#134">134</a> <em class="jxr_javadoccomment">     * @see TexenTaskMojo#configureTask()</em>
+<a name="135" href="#135">135</a> <em class="jxr_javadoccomment">     */</em>
+<a name="136" href="#136">136</a>     <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> configureTask() <strong class="jxr_keyword">throws</strong> MojoExecutionException
+<a name="137" href="#137">137</a>     {
+<a name="138" href="#138">138</a>         <strong class="jxr_keyword">super</strong>.configureTask();
+<a name="139" href="#139">139</a> 
+<a name="140" href="#140">140</a>         TorqueDataModelTask task
+<a name="141" href="#141">141</a>                 = (TorqueDataModelTask) <strong class="jxr_keyword">super</strong>.getGeneratorTask();
+<a name="142" href="#142">142</a> 
+<a name="143" href="#143">143</a>         task.setControlTemplate(getControlTemplate());
+<a name="144" href="#144">144</a> 
+<a name="145" href="#145">145</a>         task.setOutputFile(reportFile);
+<a name="146" href="#146">146</a> 
+<a name="147" href="#147">147</a>         task.setTargetDatabase(targetDatabase);
+<a name="148" href="#148">148</a> 
+<a name="149" href="#149">149</a>         task.setTargetPackage(getTargetPackage());
+<a name="150" href="#150">150</a> 
+<a name="151" href="#151">151</a>         <strong class="jxr_keyword">if</strong> (sqlDbMap != <strong class="jxr_keyword">null</strong>)
+<a name="152" href="#152">152</a>         {
+<a name="153" href="#153">153</a>             task.setSqlDbMap(sqlDbMap);
+<a name="154" href="#154">154</a>         }
+<a name="155" href="#155">155</a> 
+<a name="156" href="#156">156</a>         {
+<a name="157" href="#157">157</a>             FileSet fileSet = <strong class="jxr_keyword">new</strong> FileSet();
+<a name="158" href="#158">158</a>             fileSet.setDir(<strong class="jxr_keyword">new</strong> File(schemaDir));
+<a name="159" href="#159">159</a>             fileSet.setIncludes(schemaIncludes);
+<a name="160" href="#160">160</a>             fileSet.setExcludes(schemaExcludes);
+<a name="161" href="#161">161</a> 
+<a name="162" href="#162">162</a>             task.addFileset(fileSet);
+<a name="163" href="#163">163</a>         }
+<a name="164" href="#164">164</a>     }
+<a name="165" href="#165">165</a> 
+<a name="166" href="#166">166</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="167" href="#167">167</a> <em class="jxr_javadoccomment">     * Returns whether the schema has changed. This is done by comparing</em>
+<a name="168" href="#168">168</a> <em class="jxr_javadoccomment">     * the modification date of all schema files to the modification date</em>
+<a name="169" href="#169">169</a> <em class="jxr_javadoccomment">     * of the report file.</em>
+<a name="170" href="#170">170</a> <em class="jxr_javadoccomment">     *</em>
+<a name="171" href="#171">171</a> <em class="jxr_javadoccomment">     * @return whether the schema has changed.</em>
+<a name="172" href="#172">172</a> <em class="jxr_javadoccomment">     */</em>
+<a name="173" href="#173">173</a>     <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> schemaChanged()
+<a name="174" href="#174">174</a>     {
+<a name="175" href="#175">175</a>         <strong class="jxr_keyword">boolean</strong> schemaChanged = <strong class="jxr_keyword">true</strong>;
+<a name="176" href="#176">176</a>         File report = <strong class="jxr_keyword">new</strong> File(<strong class="jxr_keyword">super</strong>.getOutputDir(), <strong class="jxr_keyword">this</strong>.reportFile);
+<a name="177" href="#177">177</a>         <strong class="jxr_keyword">if</strong> (report.exists())
+<a name="178" href="#178">178</a>         {
+<a name="179" href="#179">179</a>             FileSet fileSet = <strong class="jxr_keyword">new</strong> FileSet();
+<a name="180" href="#180">180</a>             fileSet.setDir(<strong class="jxr_keyword">new</strong> File(schemaDir));
+<a name="181" href="#181">181</a>             fileSet.setIncludes(schemaIncludes);
+<a name="182" href="#182">182</a>             fileSet.setExcludes(schemaExcludes);
+<a name="183" href="#183">183</a> 
+<a name="184" href="#184">184</a>             DirectoryScanner directoryScanner
+<a name="185" href="#185">185</a>                 = fileSet.getDirectoryScanner(getAntProject());
+<a name="186" href="#186">186</a> 
+<a name="187" href="#187">187</a>             String[] fileNames = directoryScanner.getIncludedFiles();
+<a name="188" href="#188">188</a> 
+<a name="189" href="#189">189</a> <em class="jxr_comment">/*<em class="jxr_comment">            File schemaDirectory = new File(schemaDir);</em></em>
+<a name="190" href="#190">190</a> <em class="jxr_comment">            FileFilter schemaFileFilter = new FileFilter() {</em>
+<a name="191" href="#191">191</a> <em class="jxr_comment">                public boolean accept(File toCheck)</em>
+<a name="192" href="#192">192</a> <em class="jxr_comment">                {</em>
+<a name="193" href="#193">193</a> <em class="jxr_comment">                    String path = toCheck.getAbsolutePath();</em>
+<a name="194" href="#194">194</a> <em class="jxr_comment">                    if (schemaExcludes != null</em>
+<a name="195" href="#195">195</a> <em class="jxr_comment">                        &amp;&amp; !schemaExcludes.trim().equals("")</em>
+<a name="196" href="#196">196</a> <em class="jxr_comment">                        &amp;&amp; Pattern.matches(schemaExcludes, path))</em>
+<a name="197" href="#197">197</a> <em class="jxr_comment">                    {</em>
+<a name="198" href="#198">198</a> <em class="jxr_comment">                        return false;</em>
+<a name="199" href="#199">199</a> <em class="jxr_comment">                    }</em>
+<a name="200" href="#200">200</a> <em class="jxr_comment">                    return Pattern.matches(schemaIncludes, path);</em>
+<a name="201" href="#201">201</a> <em class="jxr_comment">                }</em>
+<a name="202" href="#202">202</a> <em class="jxr_comment">            };</em>
+<a name="203" href="#203">203</a> <em class="jxr_comment">            File[] schemaFiles = schemaDirectory.listFiles(schemaFileFilter);*/</em>
+<a name="204" href="#204">204</a> 
+<a name="205" href="#205">205</a>             <em class="jxr_comment">// schema has changed if one of the schema files has a modification</em>
+<a name="206" href="#206">206</a>             <em class="jxr_comment">// Date larger than the report.</em>
+<a name="207" href="#207">207</a>             schemaChanged = false;
+<a name="208" href="#208">208</a>             <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i &lt; fileNames.length; ++i)
+<a name="209" href="#209">209</a>             {
+<a name="210" href="#210">210</a>                 File file = <strong class="jxr_keyword">new</strong> File(fileNames[i]);
+<a name="211" href="#211">211</a>                 <strong class="jxr_keyword">if</strong> (file.lastModified() &gt; report.lastModified())
+<a name="212" href="#212">212</a>                 {
+<a name="213" href="#213">213</a>                     schemaChanged = <strong class="jxr_keyword">true</strong>;
+<a name="214" href="#214">214</a>                     <strong class="jxr_keyword">break</strong>;
+<a name="215" href="#215">215</a>                 }
+<a name="216" href="#216">216</a>             }
+<a name="217" href="#217">217</a>         }
+<a name="218" href="#218">218</a> 
+<a name="219" href="#219">219</a>         <strong class="jxr_keyword">return</strong> schemaChanged;
+<a name="220" href="#220">220</a>     }
+<a name="221" href="#221">221</a> 
+<a name="222" href="#222">222</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="223" href="#223">223</a> <em class="jxr_javadoccomment">     * Returns the directory where the schema files are located.</em>
+<a name="224" href="#224">224</a> <em class="jxr_javadoccomment">     *</em>
+<a name="225" href="#225">225</a> <em class="jxr_javadoccomment">     * @return the the directory where the schema files are located.</em>
+<a name="226" href="#226">226</a> <em class="jxr_javadoccomment">     */</em>
+<a name="227" href="#227">227</a>     <strong class="jxr_keyword">public</strong> String getSchemaDir()
+<a name="228" href="#228">228</a>     {
+<a name="229" href="#229">229</a>         <strong class="jxr_keyword">return</strong> schemaDir;
+<a name="230" href="#230">230</a>     }
+<a name="231" href="#231">231</a> 
+<a name="232" href="#232">232</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="233" href="#233">233</a> <em class="jxr_javadoccomment">     * Sets the the directory where the schema files are located.</em>
+<a name="234" href="#234">234</a> <em class="jxr_javadoccomment">     *</em>
+<a name="235" href="#235">235</a> <em class="jxr_javadoccomment">     * @param schemaDir the directory where the schema files are located.</em>
+<a name="236" href="#236">236</a> <em class="jxr_javadoccomment">     */</em>
+<a name="237" href="#237">237</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setSchemaDir(String schemaDir)
+<a name="238" href="#238">238</a>     {
+<a name="239" href="#239">239</a>         <strong class="jxr_keyword">this</strong>.schemaDir = schemaDir;
+<a name="240" href="#240">240</a>     }
+<a name="241" href="#241">241</a> 
+<a name="242" href="#242">242</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="243" href="#243">243</a> <em class="jxr_javadoccomment">     * Returns the target database (e.g. mysql, oracle, ... )</em>
+<a name="244" href="#244">244</a> <em class="jxr_javadoccomment">     * for the generated files.</em>
+<a name="245" href="#245">245</a> <em class="jxr_javadoccomment">     *</em>
+<a name="246" href="#246">246</a> <em class="jxr_javadoccomment">     * @return the target database for the generated files.</em>
+<a name="247" href="#247">247</a> <em class="jxr_javadoccomment">     */</em>
+<a name="248" href="#248">248</a>     <strong class="jxr_keyword">public</strong> String getTargetDatabase()
+<a name="249" href="#249">249</a>     {
+<a name="250" href="#250">250</a>         <strong class="jxr_keyword">return</strong> targetDatabase;
+<a name="251" href="#251">251</a>     }
+<a name="252" href="#252">252</a> 
+<a name="253" href="#253">253</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="254" href="#254">254</a> <em class="jxr_javadoccomment">     * Sets the target database (e.g. mysql, oracle, ... )</em>
+<a name="255" href="#255">255</a> <em class="jxr_javadoccomment">     * for the generated files.</em>
+<a name="256" href="#256">256</a> <em class="jxr_javadoccomment">     *</em>
+<a name="257" href="#257">257</a> <em class="jxr_javadoccomment">     * @param targetDatabase the target database for the generated files.</em>
+<a name="258" href="#258">258</a> <em class="jxr_javadoccomment">     */</em>
+<a name="259" href="#259">259</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setTargetDatabase(String targetDatabase)
+<a name="260" href="#260">260</a>     {
+<a name="261" href="#261">261</a>         <strong class="jxr_keyword">this</strong>.targetDatabase = targetDatabase;
+<a name="262" href="#262">262</a>     }
+<a name="263" href="#263">263</a> 
+<a name="264" href="#264">264</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="265" href="#265">265</a> <em class="jxr_javadoccomment">     * Returns the target package for the generated classes.</em>
+<a name="266" href="#266">266</a> <em class="jxr_javadoccomment">     *</em>
+<a name="267" href="#267">267</a> <em class="jxr_javadoccomment">     * @return the target package for the generated classes.</em>
+<a name="268" href="#268">268</a> <em class="jxr_javadoccomment">     */</em>
+<a name="269" href="#269">269</a>     <strong class="jxr_keyword">public</strong> String getTargetPackage()
+<a name="270" href="#270">270</a>     {
+<a name="271" href="#271">271</a>         <strong class="jxr_keyword">return</strong> targetPackage;
+<a name="272" href="#272">272</a>     }
+<a name="273" href="#273">273</a> 
+<a name="274" href="#274">274</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="275" href="#275">275</a> <em class="jxr_javadoccomment">     * Sets the target package for the generated classes.</em>
+<a name="276" href="#276">276</a> <em class="jxr_javadoccomment">     *</em>
+<a name="277" href="#277">277</a> <em class="jxr_javadoccomment">     * param targetPackage the target package for the generated classes.</em>
+<a name="278" href="#278">278</a> <em class="jxr_javadoccomment">     */</em>
+<a name="279" href="#279">279</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setTargetPackage(String targetPackage)
+<a name="280" href="#280">280</a>     {
+<a name="281" href="#281">281</a>         <strong class="jxr_keyword">this</strong>.targetPackage = targetPackage;
+<a name="282" href="#282">282</a>     }
+<a name="283" href="#283">283</a> 
+<a name="284" href="#284">284</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="285" href="#285">285</a> <em class="jxr_javadoccomment">     * Gets the path to the report file. The path is relative to</em>
+<a name="286" href="#286">286</a> <em class="jxr_javadoccomment">     * &lt;code&gt;outputDir&lt;/code&gt;.</em>
+<a name="287" href="#287">287</a> <em class="jxr_javadoccomment">     *</em>
+<a name="288" href="#288">288</a> <em class="jxr_javadoccomment">     * @return the path to the report file.</em>
+<a name="289" href="#289">289</a> <em class="jxr_javadoccomment">     */</em>
+<a name="290" href="#290">290</a>     <strong class="jxr_keyword">public</strong> String getReportFile()
+<a name="291" href="#291">291</a>     {
+<a name="292" href="#292">292</a>         <strong class="jxr_keyword">return</strong> reportFile;
+<a name="293" href="#293">293</a>     }
+<a name="294" href="#294">294</a> 
+<a name="295" href="#295">295</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="296" href="#296">296</a> <em class="jxr_javadoccomment">     * Sets the path to the report file. The path is relative to</em>
+<a name="297" href="#297">297</a> <em class="jxr_javadoccomment">     * &lt;code&gt;outputDir&lt;/code&gt;.</em>
+<a name="298" href="#298">298</a> <em class="jxr_javadoccomment">     *</em>
+<a name="299" href="#299">299</a> <em class="jxr_javadoccomment">     * @param reportFile the path to the report file.</em>
+<a name="300" href="#300">300</a> <em class="jxr_javadoccomment">     */</em>
+<a name="301" href="#301">301</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setReportFile(String reportFile)
+<a name="302" href="#302">302</a>     {
+<a name="303" href="#303">303</a>         <strong class="jxr_keyword">this</strong>.reportFile = reportFile;
+<a name="304" href="#304">304</a>     }
+<a name="305" href="#305">305</a> 
+<a name="306" href="#306">306</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="307" href="#307">307</a> <em class="jxr_javadoccomment">     * Returns whether this mojo should be executed only if the schema has</em>
+<a name="308" href="#308">308</a> <em class="jxr_javadoccomment">     * changed.</em>
+<a name="309" href="#309">309</a> <em class="jxr_javadoccomment">     *</em>
+<a name="310" href="#310">310</a> <em class="jxr_javadoccomment">     * @return true if the mojo only runs if the schema has changed,</em>
+<a name="311" href="#311">311</a> <em class="jxr_javadoccomment">     *         false otherwise.</em>
+<a name="312" href="#312">312</a> <em class="jxr_javadoccomment">     */</em>
+<a name="313" href="#313">313</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isRunOnlyOnSchemaChange()
+<a name="314" href="#314">314</a>     {
+<a name="315" href="#315">315</a>         <strong class="jxr_keyword">return</strong> runOnlyOnSchemaChange;
+<a name="316" href="#316">316</a>     }
+<a name="317" href="#317">317</a> 
+<a name="318" href="#318">318</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="319" href="#319">319</a> <em class="jxr_javadoccomment">     * Sets whether this mojo should be executed only if the schema has</em>
+<a name="320" href="#320">320</a> <em class="jxr_javadoccomment">     * changed.</em>
+<a name="321" href="#321">321</a> <em class="jxr_javadoccomment">     *</em>
+<a name="322" href="#322">322</a> <em class="jxr_javadoccomment">     * @param runOnlyOnSchemaChange whether the mojo only should run</em>
+<a name="323" href="#323">323</a> <em class="jxr_javadoccomment">     *        if the schema has changed.</em>
+<a name="324" href="#324">324</a> <em class="jxr_javadoccomment">     */</em>
+<a name="325" href="#325">325</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setRunOnlyOnSchemaChange(<strong class="jxr_keyword">boolean</strong> runOnlyOnSchemaChange)
+<a name="326" href="#326">326</a>     {
+<a name="327" href="#327">327</a>         <strong class="jxr_keyword">this</strong>.runOnlyOnSchemaChange = runOnlyOnSchemaChange;
+<a name="328" href="#328">328</a>     }
+<a name="329" href="#329">329</a> 
+<a name="330" href="#330">330</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="331" href="#331">331</a> <em class="jxr_javadoccomment">     * Runs the generation for the database layout defined in the schema.xml</em>
+<a name="332" href="#332">332</a> <em class="jxr_javadoccomment">     * files.</em>
+<a name="333" href="#333">333</a> <em class="jxr_javadoccomment">     *</em>
+<a name="334" href="#334">334</a> <em class="jxr_javadoccomment">     * @throws MojoExecutionException If an error occurs during generation.</em>
+<a name="335" href="#335">335</a> <em class="jxr_javadoccomment">     *</em>
+<a name="336" href="#336">336</a> <em class="jxr_javadoccomment">     * @see TexenTaskMojo#execute()</em>
+<a name="337" href="#337">337</a> <em class="jxr_javadoccomment">     * @see org.apache.maven.plugin.Mojo#execute()</em>
+<a name="338" href="#338">338</a> <em class="jxr_javadoccomment">     */</em>
+<a name="339" href="#339">339</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> execute() <strong class="jxr_keyword">throws</strong> MojoExecutionException
+<a name="340" href="#340">340</a>     {
+<a name="341" href="#341">341</a>         <strong class="jxr_keyword">if</strong> (!schemaChanged() &amp;&amp; isRunOnlyOnSchemaChange())
+<a name="342" href="#342">342</a>         {
+<a name="343" href="#343">343</a>             getLog().info(<span class="jxr_string">"Schema has not changed; skipping generation"</span>);
+<a name="344" href="#344">344</a>             <strong class="jxr_keyword">return</strong>;
+<a name="345" href="#345">345</a>         }
+<a name="346" href="#346">346</a> 
+<a name="347" href="#347">347</a>         <strong class="jxr_keyword">super</strong>.execute();
+<a name="348" href="#348">348</a>     }
+<a name="349" href="#349">349</a> 
+<a name="350" href="#350">350</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="351" href="#351">351</a> <em class="jxr_javadoccomment">     * Returns the schema files which are excluded from generation.</em>
+<a name="352" href="#352">352</a> <em class="jxr_javadoccomment">     *</em>
+<a name="353" href="#353">353</a> <em class="jxr_javadoccomment">     * @return the pattern for the excluded files.</em>
+<a name="354" href="#354">354</a> <em class="jxr_javadoccomment">     */</em>
+<a name="355" href="#355">355</a>     <strong class="jxr_keyword">public</strong> String getSchemaExcludes()
+<a name="356" href="#356">356</a>     {
+<a name="357" href="#357">357</a>         <strong class="jxr_keyword">return</strong> schemaExcludes;
+<a name="358" href="#358">358</a>     }
+<a name="359" href="#359">359</a> 
+<a name="360" href="#360">360</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="361" href="#361">361</a> <em class="jxr_javadoccomment">     * Sets the schema files which are excluded from generation.</em>
+<a name="362" href="#362">362</a> <em class="jxr_javadoccomment">     *</em>
+<a name="363" href="#363">363</a> <em class="jxr_javadoccomment">     * @param schemaExcludes the pattern for the excluded files.</em>
+<a name="364" href="#364">364</a> <em class="jxr_javadoccomment">     */</em>
+<a name="365" href="#365">365</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setSchemaExcludes(String schemaExcludes)
+<a name="366" href="#366">366</a>     {
+<a name="367" href="#367">367</a>         <strong class="jxr_keyword">this</strong>.schemaExcludes = schemaExcludes;
+<a name="368" href="#368">368</a>     }
+<a name="369" href="#369">369</a> 
+<a name="370" href="#370">370</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="371" href="#371">371</a> <em class="jxr_javadoccomment">     * Returns the schema files which are included in generation.</em>
+<a name="372" href="#372">372</a> <em class="jxr_javadoccomment">     *</em>
+<a name="373" href="#373">373</a> <em class="jxr_javadoccomment">     * @return the pattern for the included files.</em>
+<a name="374" href="#374">374</a> <em class="jxr_javadoccomment">     */</em>
+<a name="375" href="#375">375</a>     <strong class="jxr_keyword">public</strong> String getSchemaIncludes()
+<a name="376" href="#376">376</a>     {
+<a name="377" href="#377">377</a>         <strong class="jxr_keyword">return</strong> schemaIncludes;
+<a name="378" href="#378">378</a>     }
+<a name="379" href="#379">379</a> 
+<a name="380" href="#380">380</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="381" href="#381">381</a> <em class="jxr_javadoccomment">     * Sets the schema files which are included in generation.</em>
+<a name="382" href="#382">382</a> <em class="jxr_javadoccomment">     *</em>
+<a name="383" href="#383">383</a> <em class="jxr_javadoccomment">     * @param schemaIncludes the pattern for the included files.</em>
+<a name="384" href="#384">384</a> <em class="jxr_javadoccomment">     */</em>
+<a name="385" href="#385">385</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setSchemaIncludes(String schemaIncludes)
+<a name="386" href="#386">386</a>     {
+<a name="387" href="#387">387</a>         <strong class="jxr_keyword">this</strong>.schemaIncludes = schemaIncludes;
+<a name="388" href="#388">388</a>     }
+<a name="389" href="#389">389</a> 
+<a name="390" href="#390">390</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="391" href="#391">391</a> <em class="jxr_javadoccomment">     * Returns the path to the mapping SQL Files -&gt; database.</em>
+<a name="392" href="#392">392</a> <em class="jxr_javadoccomment">     *</em>
+<a name="393" href="#393">393</a> <em class="jxr_javadoccomment">     * @return the path to the mapping SQL Files -&gt; database.</em>
+<a name="394" href="#394">394</a> <em class="jxr_javadoccomment">     */</em>
+<a name="395" href="#395">395</a>     <strong class="jxr_keyword">public</strong> String getSqlDbMap()
+<a name="396" href="#396">396</a>     {
+<a name="397" href="#397">397</a>         <strong class="jxr_keyword">return</strong> sqlDbMap;
+<a name="398" href="#398">398</a>     }
+<a name="399" href="#399">399</a> 
+<a name="400" href="#400">400</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="401" href="#401">401</a> <em class="jxr_javadoccomment">     * Sets the path to the mapping SQL Files -&gt; database.</em>
+<a name="402" href="#402">402</a> <em class="jxr_javadoccomment">     *</em>
+<a name="403" href="#403">403</a> <em class="jxr_javadoccomment">     * @param sqlDbMap the absolute path to the mapping SQL Files -&gt; database.</em>
+<a name="404" href="#404">404</a> <em class="jxr_javadoccomment">     */</em>
+<a name="405" href="#405">405</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setSqlDbMap(String sqlDbMap)
+<a name="406" href="#406">406</a>     {
+<a name="407" href="#407">407</a>         <strong class="jxr_keyword">this</strong>.sqlDbMap = sqlDbMap;
+<a name="408" href="#408">408</a>     }
+<a name="409" href="#409">409</a> 
+<a name="410" href="#410">410</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="411" href="#411">411</a> <em class="jxr_javadoccomment">     * Returns the path to the control template.</em>
+<a name="412" href="#412">412</a> <em class="jxr_javadoccomment">     *</em>
+<a name="413" href="#413">413</a> <em class="jxr_javadoccomment">     * @return the path to the control template.</em>
+<a name="414" href="#414">414</a> <em class="jxr_javadoccomment">     */</em>
+<a name="415" href="#415">415</a>     <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> String getControlTemplate();
+<a name="416" href="#416">416</a> }
+</pre>
+<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
+</html>
+

Added: db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/xref/org/apache/torque/mojo/DataSqlMojo.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/DataSqlMojo.html?rev=1396951&view=auto
==============================================================================
--- db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/xref/org/apache/torque/mojo/DataSqlMojo.html (added)
+++ db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/xref/org/apache/torque/mojo/DataSqlMojo.html Thu Oct 11 08:51:09 2012
@@ -0,0 +1,193 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
+<title>DataSqlMojo xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../apidocs/org/apache/torque/mojo/DataSqlMojo.html">View Javadoc</a></div><pre>
+
+<a name="1" href="#1">1</a>   <strong class="jxr_keyword">package</strong> org.apache.torque.mojo;
+<a name="2" href="#2">2</a>   
+<a name="3" href="#3">3</a>   <em class="jxr_comment">/*</em>
+<a name="4" href="#4">4</a>   <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
+<a name="5" href="#5">5</a>   <em class="jxr_comment"> * or more contributor license agreements.  See the NOTICE file</em>
+<a name="6" href="#6">6</a>   <em class="jxr_comment"> * distributed with this work for additional information</em>
+<a name="7" href="#7">7</a>   <em class="jxr_comment"> * regarding copyright ownership.  The ASF licenses this file</em>
+<a name="8" href="#8">8</a>   <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
+<a name="9" href="#9">9</a>   <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
+<a name="10" href="#10">10</a>  <em class="jxr_comment"> * with the License.  You may obtain a copy of the License at</em>
+<a name="11" href="#11">11</a>  <em class="jxr_comment"> *</em>
+<a name="12" href="#12">12</a>  <em class="jxr_comment"> *   <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
+<a name="13" href="#13">13</a>  <em class="jxr_comment"> *</em>
+<a name="14" href="#14">14</a>  <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
+<a name="15" href="#15">15</a>  <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
+<a name="16" href="#16">16</a>  <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
+<a name="17" href="#17">17</a>  <em class="jxr_comment"> * KIND, either express or implied.  See the License for the</em>
+<a name="18" href="#18">18</a>  <em class="jxr_comment"> * specific language governing permissions and limitations</em>
+<a name="19" href="#19">19</a>  <em class="jxr_comment"> * under the License.</em>
+<a name="20" href="#20">20</a>  <em class="jxr_comment"> */</em>
+<a name="21" href="#21">21</a>  
+<a name="22" href="#22">22</a>  <strong class="jxr_keyword">import</strong> org.apache.commons.configuration.PropertiesConfiguration;
+<a name="23" href="#23">23</a>  <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException;
+<a name="24" href="#24">24</a>  <strong class="jxr_keyword">import</strong> org.apache.torque.task.TorqueDataSQLTask;
+<a name="25" href="#25">25</a>  
+<a name="26" href="#26">26</a>  <em class="jxr_javadoccomment">/**</em>
+<a name="27" href="#27">27</a>  <em class="jxr_javadoccomment"> * Generates SQL for populating the database from data.xml files.</em>
+<a name="28" href="#28">28</a>  <em class="jxr_javadoccomment"> *</em>
+<a name="29" href="#29">29</a>  <em class="jxr_javadoccomment"> * @author Raphael Pieroni (rafale_at_codehaus.org)</em>
+<a name="30" href="#30">30</a>  <em class="jxr_javadoccomment"> * @author &lt;a href="fischer@seitenbau.de"&gt;Thomas Fischer&lt;/a&gt;</em>
+<a name="31" href="#31">31</a>  <em class="jxr_javadoccomment"> *</em>
+<a name="32" href="#32">32</a>  <em class="jxr_javadoccomment"> * @goal datasql</em>
+<a name="33" href="#33">33</a>  <em class="jxr_javadoccomment"> * @phase generate-sources</em>
+<a name="34" href="#34">34</a>  <em class="jxr_javadoccomment"> */</em>
+<a name="35" href="#35">35</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/torque/mojo/DataSqlMojo.html">DataSqlMojo</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../org/apache/torque/mojo/DataModelTaskMojo.html">DataModelTaskMojo</a>
+<a name="36" href="#36">36</a>  {
+<a name="37" href="#37">37</a>      <em class="jxr_comment">// The following three dummies trick the Mojo Description Extractor</em>
+<a name="38" href="#38">38</a>      <em class="jxr_comment">// into setting the correct default values for</em>
+<a name="39" href="#39">39</a>      <em class="jxr_comment">// outputDir, reportFile and contextPropertiesPath</em>
+<a name="40" href="#40">40</a>      <em class="jxr_javadoccomment">/**</em>
+<a name="41" href="#41">41</a>  <em class="jxr_javadoccomment">     * The directory in which the sql will be generated.</em>
+<a name="42" href="#42">42</a>  <em class="jxr_javadoccomment">     *</em>
+<a name="43" href="#43">43</a>  <em class="jxr_javadoccomment">     * @parameter property="outputDir"</em>
+<a name="44" href="#44">44</a>  <em class="jxr_javadoccomment">     *            expression="${project.build.directory}/generated-sql/torque"</em>
+<a name="45" href="#45">45</a>  <em class="jxr_javadoccomment">     */</em>
+<a name="46" href="#46">46</a>      <strong class="jxr_keyword">private</strong> String dummy;
+<a name="47" href="#47">47</a>  
+<a name="48" href="#48">48</a>      <em class="jxr_javadoccomment">/**</em>
+<a name="49" href="#49">49</a>  <em class="jxr_javadoccomment">     * The location where the sql file will be generated.</em>
+<a name="50" href="#50">50</a>  <em class="jxr_javadoccomment">     *</em>
+<a name="51" href="#51">51</a>  <em class="jxr_javadoccomment">     * @parameter property="reportFile"</em>
+<a name="52" href="#52">52</a>  <em class="jxr_javadoccomment">     *            expression="${project.artifact.artifactId}-data.sql"</em>
+<a name="53" href="#53">53</a>  <em class="jxr_javadoccomment">     */</em>
+<a name="54" href="#54">54</a>      <strong class="jxr_keyword">private</strong> String dummy2;
+<a name="55" href="#55">55</a>  
+<a name="56" href="#56">56</a>      <em class="jxr_javadoccomment">/**</em>
+<a name="57" href="#57">57</a>  <em class="jxr_javadoccomment">     * The location where the context property file for velocity will be</em>
+<a name="58" href="#58">58</a>  <em class="jxr_javadoccomment">     * generated.</em>
+<a name="59" href="#59">59</a>  <em class="jxr_javadoccomment">     *</em>
+<a name="60" href="#60">60</a>  <em class="jxr_javadoccomment">     * @parameter property="contextPropertiesPath"</em>
+<a name="61" href="#61">61</a>  <em class="jxr_javadoccomment">     *            expression="${project.build.directory}/torque/context.datasql.properties"</em>
+<a name="62" href="#62">62</a>  <em class="jxr_javadoccomment">     */</em>
+<a name="63" href="#63">63</a>      <strong class="jxr_keyword">private</strong> String dummy3;
+<a name="64" href="#64">64</a>  
+<a name="65" href="#65">65</a>      <em class="jxr_javadoccomment">/**</em>
+<a name="66" href="#66">66</a>  <em class="jxr_javadoccomment">     * The schema files which should be excluded in generation</em>
+<a name="67" href="#67">67</a>  <em class="jxr_javadoccomment">     * (in ant-style notation).</em>
+<a name="68" href="#68">68</a>  <em class="jxr_javadoccomment">     *</em>
+<a name="69" href="#69">69</a>  <em class="jxr_javadoccomment">     * @parameter property="schemaExcludes" expression="id-table-schema.xml"</em>
+<a name="70" href="#70">70</a>  <em class="jxr_javadoccomment">     */</em>
+<a name="71" href="#71">71</a>      <strong class="jxr_keyword">private</strong> String dummy4;
+<a name="72" href="#72">72</a>  
+<a name="73" href="#73">73</a>      <em class="jxr_javadoccomment">/**</em>
+<a name="74" href="#74">74</a>  <em class="jxr_javadoccomment">     * The data Xml file to process.</em>
+<a name="75" href="#75">75</a>  <em class="jxr_javadoccomment">     *</em>
+<a name="76" href="#76">76</a>  <em class="jxr_javadoccomment">     * @parameter</em>
+<a name="77" href="#77">77</a>  <em class="jxr_javadoccomment">     * @required</em>
+<a name="78" href="#78">78</a>  <em class="jxr_javadoccomment">     */</em>
+<a name="79" href="#79">79</a>      <strong class="jxr_keyword">private</strong> String dataXmlFile;
+<a name="80" href="#80">80</a>  
+<a name="81" href="#81">81</a>      <em class="jxr_javadoccomment">/**</em>
+<a name="82" href="#82">82</a>  <em class="jxr_javadoccomment">     * The data dtd file for the data xml file to process.</em>
+<a name="83" href="#83">83</a>  <em class="jxr_javadoccomment">     *</em>
+<a name="84" href="#84">84</a>  <em class="jxr_javadoccomment">     * @parameter</em>
+<a name="85" href="#85">85</a>  <em class="jxr_javadoccomment">     * @required</em>
+<a name="86" href="#86">86</a>  <em class="jxr_javadoccomment">     */</em>
+<a name="87" href="#87">87</a>      <strong class="jxr_keyword">private</strong> String dataDtd;
+<a name="88" href="#88">88</a>  
+<a name="89" href="#89">89</a>      <em class="jxr_javadoccomment">/**</em>
+<a name="90" href="#90">90</a>  <em class="jxr_javadoccomment">     * Creates a new SQLMojo object.</em>
+<a name="91" href="#91">91</a>  <em class="jxr_javadoccomment">     */</em>
+<a name="92" href="#92">92</a>      <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/torque/mojo/DataSqlMojo.html">DataSqlMojo</a>()
+<a name="93" href="#93">93</a>      {
+<a name="94" href="#94">94</a>          <strong class="jxr_keyword">super</strong>(<strong class="jxr_keyword">new</strong> TorqueDataSQLTask());
+<a name="95" href="#95">95</a>      }
+<a name="96" href="#96">96</a>  
+<a name="97" href="#97">97</a>      <em class="jxr_javadoccomment">/**</em>
+<a name="98" href="#98">98</a>  <em class="jxr_javadoccomment">     * Returns the context properties for the Texen task.</em>
+<a name="99" href="#99">99</a>  <em class="jxr_javadoccomment">     *</em>
+<a name="100" href="#100">100</a> <em class="jxr_javadoccomment">     * @return The PropertiesConfiguration containing all context properties,</em>
+<a name="101" href="#101">101</a> <em class="jxr_javadoccomment">     *         not null.</em>
+<a name="102" href="#102">102</a> <em class="jxr_javadoccomment">     */</em>
+<a name="103" href="#103">103</a>     <strong class="jxr_keyword">protected</strong> PropertiesConfiguration getMojoContextProperties()
+<a name="104" href="#104">104</a>     {
+<a name="105" href="#105">105</a>         PropertiesConfiguration configuration = <strong class="jxr_keyword">new</strong> PropertiesConfiguration();
+<a name="106" href="#106">106</a>         <strong class="jxr_keyword">return</strong> configuration;
+<a name="107" href="#107">107</a>     }
+<a name="108" href="#108">108</a> 
+<a name="109" href="#109">109</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="110" href="#110">110</a> <em class="jxr_javadoccomment">     * Configures the Texen task which is wrapped by this mojo.</em>
+<a name="111" href="#111">111</a> <em class="jxr_javadoccomment">     * In addition to the prioerties set by DataModelTaskMojo#configureTask(),</em>
+<a name="112" href="#112">112</a> <em class="jxr_javadoccomment">     * the properties dataXmlFile and dataDTD are set.</em>
+<a name="113" href="#113">113</a> <em class="jxr_javadoccomment">     *</em>
+<a name="114" href="#114">114</a> <em class="jxr_javadoccomment">     * @throws MojoExecutionException if an error occurs when setting the Tasks</em>
+<a name="115" href="#115">115</a> <em class="jxr_javadoccomment">     *         properties.</em>
+<a name="116" href="#116">116</a> <em class="jxr_javadoccomment">     *</em>
+<a name="117" href="#117">117</a> <em class="jxr_javadoccomment">     * @see DataModelTaskMojo#configureTask()</em>
+<a name="118" href="#118">118</a> <em class="jxr_javadoccomment">     */</em>
+<a name="119" href="#119">119</a>     <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> configureTask() <strong class="jxr_keyword">throws</strong> MojoExecutionException
+<a name="120" href="#120">120</a>     {
+<a name="121" href="#121">121</a>         <strong class="jxr_keyword">super</strong>.configureTask();
+<a name="122" href="#122">122</a> 
+<a name="123" href="#123">123</a>         TorqueDataSQLTask task
+<a name="124" href="#124">124</a>                 = (TorqueDataSQLTask) <strong class="jxr_keyword">super</strong>.getGeneratorTask();
+<a name="125" href="#125">125</a> 
+<a name="126" href="#126">126</a>         task.setDataXmlFile(dataXmlFile);
+<a name="127" href="#127">127</a>         task.setDataDTD(dataDtd);
+<a name="128" href="#128">128</a>     }
+<a name="129" href="#129">129</a> 
+<a name="130" href="#130">130</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="131" href="#131">131</a> <em class="jxr_javadoccomment">     * Returns the path to the control template.</em>
+<a name="132" href="#132">132</a> <em class="jxr_javadoccomment">     *</em>
+<a name="133" href="#133">133</a> <em class="jxr_javadoccomment">     * @return "sql/load/Control.vm"</em>
+<a name="134" href="#134">134</a> <em class="jxr_javadoccomment">     */</em>
+<a name="135" href="#135">135</a>     <strong class="jxr_keyword">protected</strong> String getControlTemplate()
+<a name="136" href="#136">136</a>     {
+<a name="137" href="#137">137</a>         <strong class="jxr_keyword">return</strong> <span class="jxr_string">"sql/load/Control.vm"</span>;
+<a name="138" href="#138">138</a>     }
+<a name="139" href="#139">139</a> 
+<a name="140" href="#140">140</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="141" href="#141">141</a> <em class="jxr_javadoccomment">     * Returns the data dtd file for the data xml file.</em>
+<a name="142" href="#142">142</a> <em class="jxr_javadoccomment">     *</em>
+<a name="143" href="#143">143</a> <em class="jxr_javadoccomment">     * @return the data dtd file for the data xml file.</em>
+<a name="144" href="#144">144</a> <em class="jxr_javadoccomment">     */</em>
+<a name="145" href="#145">145</a>     <strong class="jxr_keyword">public</strong> String getDataDtd()
+<a name="146" href="#146">146</a>     {
+<a name="147" href="#147">147</a>         <strong class="jxr_keyword">return</strong> dataDtd;
+<a name="148" href="#148">148</a>     }
+<a name="149" href="#149">149</a> 
+<a name="150" href="#150">150</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="151" href="#151">151</a> <em class="jxr_javadoccomment">     * Sets the data dtd file for the data xml file.</em>
+<a name="152" href="#152">152</a> <em class="jxr_javadoccomment">     *</em>
+<a name="153" href="#153">153</a> <em class="jxr_javadoccomment">     * @param dataDtd the data dtd file for the data xml file.</em>
+<a name="154" href="#154">154</a> <em class="jxr_javadoccomment">     */</em>
+<a name="155" href="#155">155</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setDataDtd(String dataDtd)
+<a name="156" href="#156">156</a>     {
+<a name="157" href="#157">157</a>         <strong class="jxr_keyword">this</strong>.dataDtd = dataDtd;
+<a name="158" href="#158">158</a>     }
+<a name="159" href="#159">159</a> 
+<a name="160" href="#160">160</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="161" href="#161">161</a> <em class="jxr_javadoccomment">     * Returns the data xml file which should be processed.</em>
+<a name="162" href="#162">162</a> <em class="jxr_javadoccomment">     *</em>
+<a name="163" href="#163">163</a> <em class="jxr_javadoccomment">     * @return the data xml file which should be processed.</em>
+<a name="164" href="#164">164</a> <em class="jxr_javadoccomment">     */</em>
+<a name="165" href="#165">165</a>     <strong class="jxr_keyword">public</strong> String getDataXmlFile()
+<a name="166" href="#166">166</a>     {
+<a name="167" href="#167">167</a>         <strong class="jxr_keyword">return</strong> dataXmlFile;
+<a name="168" href="#168">168</a>     }
+<a name="169" href="#169">169</a> 
+<a name="170" href="#170">170</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="171" href="#171">171</a> <em class="jxr_javadoccomment">     * Sets the data xml file which should be processed.</em>
+<a name="172" href="#172">172</a> <em class="jxr_javadoccomment">     *</em>
+<a name="173" href="#173">173</a> <em class="jxr_javadoccomment">     * @param dataXmlFile the data xml file which should be processed.</em>
+<a name="174" href="#174">174</a> <em class="jxr_javadoccomment">     */</em>
+<a name="175" href="#175">175</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setDataXmlFile(String dataXmlFile)
+<a name="176" href="#176">176</a>     {
+<a name="177" href="#177">177</a>         <strong class="jxr_keyword">this</strong>.dataXmlFile = dataXmlFile;
+<a name="178" href="#178">178</a>     }
+<a name="179" href="#179">179</a> }
+</pre>
+<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
+</html>
+



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