juplo.de Git - website/blob - dist/hibernate-maven-plugin-2.1.0/xref/de/juplo/plugins/hibernate/UpdateMojo.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   3 <head><meta http-equiv="content-type" content="text/html; charset=UTF-8" />
   4 <title>UpdateMojo xref</title>
   5 <link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
   6 </head>
   7 <body>
   8 <div id="overview"><a href="../../../../../apidocs/de/juplo/plugins/hibernate/UpdateMojo.html">View Javadoc</a></div><pre>
   9 <a class="jxr_linenumber" name="L1" href="#L1">1</a>   <strong class="jxr_keyword">package</strong> de.juplo.plugins.hibernate;
  10 <a class="jxr_linenumber" name="L2" href="#L2">2</a>
  11 <a class="jxr_linenumber" name="L3" href="#L3">3</a>   <em class="jxr_comment">/*</em>
  12 <a class="jxr_linenumber" name="L4" href="#L4">4</a>   <em class="jxr_comment"> * Copyright 2001-2005 The Apache Software Foundation.</em>
  13 <a class="jxr_linenumber" name="L5" href="#L5">5</a>   <em class="jxr_comment"> *</em>
  14 <a class="jxr_linenumber" name="L6" href="#L6">6</a>   <em class="jxr_comment"> * Licensed under the Apache License, Version 2.0 (the "License");</em>
  15 <a class="jxr_linenumber" name="L7" href="#L7">7</a>   <em class="jxr_comment"> * you may not use this file except in compliance with the License.</em>
  16 <a class="jxr_linenumber" name="L8" href="#L8">8</a>   <em class="jxr_comment"> * You may obtain a copy of the License at</em>
  17 <a class="jxr_linenumber" name="L9" href="#L9">9</a>   <em class="jxr_comment"> *</em>
  18 <a class="jxr_linenumber" name="L10" href="#L10">10</a>  <em class="jxr_comment"> *      <a href="http://www.apache.org/licenses/LICENSE-2." target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.</a>0</em>
  19 <a class="jxr_linenumber" name="L11" href="#L11">11</a>  <em class="jxr_comment"> *</em>
  20 <a class="jxr_linenumber" name="L12" href="#L12">12</a>  <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em>
  21 <a class="jxr_linenumber" name="L13" href="#L13">13</a>  <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
  22 <a class="jxr_linenumber" name="L14" href="#L14">14</a>  <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
  23 <a class="jxr_linenumber" name="L15" href="#L15">15</a>  <em class="jxr_comment"> * See the License for the specific language governing permissions and</em>
  24 <a class="jxr_linenumber" name="L16" href="#L16">16</a>  <em class="jxr_comment"> * limitations under the License.</em>
  25 <a class="jxr_linenumber" name="L17" href="#L17">17</a>  <em class="jxr_comment"> */</em>
  26 <a class="jxr_linenumber" name="L18" href="#L18">18</a>
  27 <a class="jxr_linenumber" name="L19" href="#L19">19</a>  <strong class="jxr_keyword">import</strong> java.util.Map;
  28 <a class="jxr_linenumber" name="L20" href="#L20">20</a>  <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException;
  29 <a class="jxr_linenumber" name="L21" href="#L21">21</a>  <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoFailureException;
  30 <a class="jxr_linenumber" name="L22" href="#L22">22</a>  <strong class="jxr_keyword">import</strong> org.hibernate.boot.spi.MetadataImplementor;
  31 <a class="jxr_linenumber" name="L23" href="#L23">23</a>  <strong class="jxr_keyword">import</strong> org.hibernate.service.ServiceRegistry;
  32 <a class="jxr_linenumber" name="L24" href="#L24">24</a>  <strong class="jxr_keyword">import</strong> org.hibernate.tool.schema.spi.ExecutionOptions;
  33 <a class="jxr_linenumber" name="L25" href="#L25">25</a>  <strong class="jxr_keyword">import</strong> org.hibernate.tool.schema.spi.SchemaManagementTool;
  34 <a class="jxr_linenumber" name="L26" href="#L26">26</a>  <strong class="jxr_keyword">import</strong> org.hibernate.tool.schema.spi.TargetDescriptor;
  35 <a class="jxr_linenumber" name="L27" href="#L27">27</a>
  36 <a class="jxr_linenumber" name="L28" href="#L28">28</a>
  37 <a class="jxr_linenumber" name="L29" href="#L29">29</a>  <em class="jxr_javadoccomment">/**</em>
  38 <a class="jxr_linenumber" name="L30" href="#L30">30</a>  <em class="jxr_javadoccomment"> * Generate/Execute SQL to update the database-schema according to the</em>
  39 <a class="jxr_linenumber" name="L31" href="#L31">31</a>  <em class="jxr_javadoccomment"> * configured mappings.</em>
  40 <a class="jxr_linenumber" name="L32" href="#L32">32</a>  <em class="jxr_javadoccomment"> *</em>
  41 <a class="jxr_linenumber" name="L33" href="#L33">33</a>  <em class="jxr_javadoccomment"> * @goal update</em>
  42 <a class="jxr_linenumber" name="L34" href="#L34">34</a>  <em class="jxr_javadoccomment"> * @phase process-classes</em>
  43 <a class="jxr_linenumber" name="L35" href="#L35">35</a>  <em class="jxr_javadoccomment"> * @threadSafe</em>
  44 <a class="jxr_linenumber" name="L36" href="#L36">36</a>  <em class="jxr_javadoccomment"> * @requiresDependencyResolution runtime</em>
  45 <a class="jxr_linenumber" name="L37" href="#L37">37</a>  <em class="jxr_javadoccomment"> */</em>
  46 <a class="jxr_linenumber" name="L38" href="#L38">38</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../de/juplo/plugins/hibernate/UpdateMojo.html">UpdateMojo</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../de/juplo/plugins/hibernate/AbstractSchemaMojo.html">AbstractSchemaMojo</a>
  47 <a class="jxr_linenumber" name="L39" href="#L39">39</a>  {
  48 <a class="jxr_linenumber" name="L40" href="#L40">40</a>    <em class="jxr_javadoccomment">/**</em>
  49 <a class="jxr_linenumber" name="L41" href="#L41">41</a>  <em class="jxr_javadoccomment">   * Output file.</em>
  50 <a class="jxr_linenumber" name="L42" href="#L42">42</a>  <em class="jxr_javadoccomment">   * &lt;p&gt;</em>
  51 <a class="jxr_linenumber" name="L43" href="#L43">43</a>  <em class="jxr_javadoccomment">   * If the specified filename is not absolut, the file will be created</em>
  52 <a class="jxr_linenumber" name="L44" href="#L44">44</a>  <em class="jxr_javadoccomment">   * relative to the project build directory</em>
  53 <a class="jxr_linenumber" name="L45" href="#L45">45</a>  <em class="jxr_javadoccomment">   * (&lt;code&gt;project.build.directory&lt;/code&gt;).</em>
  54 <a class="jxr_linenumber" name="L46" href="#L46">46</a>  <em class="jxr_javadoccomment">   *</em>
  55 <a class="jxr_linenumber" name="L47" href="#L47">47</a>  <em class="jxr_javadoccomment">   * @parameter property="hibernate.schema.update" default-value="update.sql"</em>
  56 <a class="jxr_linenumber" name="L48" href="#L48">48</a>  <em class="jxr_javadoccomment">   * @since 1.0</em>
  57 <a class="jxr_linenumber" name="L49" href="#L49">49</a>  <em class="jxr_javadoccomment">   */</em>
  58 <a class="jxr_linenumber" name="L50" href="#L50">50</a>    <strong class="jxr_keyword">private</strong> String outputFile;
  59 <a class="jxr_linenumber" name="L51" href="#L51">51</a>
  60 <a class="jxr_linenumber" name="L52" href="#L52">52</a>
  61 <a class="jxr_linenumber" name="L53" href="#L53">53</a>    @Override
  62 <a class="jxr_linenumber" name="L54" href="#L54">54</a>    <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">void</strong> execute()
  63 <a class="jxr_linenumber" name="L55" href="#L55">55</a>      <strong class="jxr_keyword">throws</strong>
  64 <a class="jxr_linenumber" name="L56" href="#L56">56</a>        MojoFailureException,
  65 <a class="jxr_linenumber" name="L57" href="#L57">57</a>        MojoExecutionException
  66 <a class="jxr_linenumber" name="L58" href="#L58">58</a>    {
  67 <a class="jxr_linenumber" name="L59" href="#L59">59</a>      <strong class="jxr_keyword">super</strong>.execute(outputFile);
  68 <a class="jxr_linenumber" name="L60" href="#L60">60</a>    }
  69 <a class="jxr_linenumber" name="L61" href="#L61">61</a>
  70 <a class="jxr_linenumber" name="L62" href="#L62">62</a>
  71 <a class="jxr_linenumber" name="L63" href="#L63">63</a>    @Override
  72 <a class="jxr_linenumber" name="L64" href="#L64">64</a>    <strong class="jxr_keyword">void</strong> build(
  73 <a class="jxr_linenumber" name="L65" href="#L65">65</a>        MetadataImplementor metadata,
  74 <a class="jxr_linenumber" name="L66" href="#L66">66</a>        ExecutionOptions options,
  75 <a class="jxr_linenumber" name="L67" href="#L67">67</a>        TargetDescriptor target
  76 <a class="jxr_linenumber" name="L68" href="#L68">68</a>        )
  77 <a class="jxr_linenumber" name="L69" href="#L69">69</a>        <strong class="jxr_keyword">throws</strong>
  78 <a class="jxr_linenumber" name="L70" href="#L70">70</a>          MojoExecutionException,
  79 <a class="jxr_linenumber" name="L71" href="#L71">71</a>          MojoFailureException
  80 <a class="jxr_linenumber" name="L72" href="#L72">72</a>    {
  81 <a class="jxr_linenumber" name="L73" href="#L73">73</a>      ServiceRegistry service =
  82 <a class="jxr_linenumber" name="L74" href="#L74">74</a>          metadata.getMetadataBuildingOptions().getServiceRegistry();
  83 <a class="jxr_linenumber" name="L75" href="#L75">75</a>      SchemaManagementTool tool = service.getService(SchemaManagementTool.<strong class="jxr_keyword">class</strong>);
  84 <a class="jxr_linenumber" name="L76" href="#L76">76</a>
  85 <a class="jxr_linenumber" name="L77" href="#L77">77</a>      Map config = options.getConfigurationValues();
  86 <a class="jxr_linenumber" name="L78" href="#L78">78</a>
  87 <a class="jxr_linenumber" name="L79" href="#L79">79</a>      tool.getSchemaMigrator(config).doMigration(metadata, options, target);
  88 <a class="jxr_linenumber" name="L80" href="#L80">80</a>    }
  89 <a class="jxr_linenumber" name="L81" href="#L81">81</a>  }
  90 </pre>
  91 <hr/>
  92 <div id="footer">Copyright &#169; 2017. All rights reserved.</div>
  93 </body>
  94 </html>