View Javadoc

1   /*
2    *   Copyright (C) Christian Schulte, 2005-206
3    *   All rights reserved.
4    *
5    *   Redistribution and use in source and binary forms, with or without
6    *   modification, are permitted provided that the following conditions
7    *   are met:
8    *
9    *     o Redistributions of source code must retain the above copyright
10   *       notice, this list of conditions and the following disclaimer.
11   *
12   *     o Redistributions in binary form must reproduce the above copyright
13   *       notice, this list of conditions and the following disclaimer in
14   *       the documentation and/or other materials provided with the
15   *       distribution.
16   *
17   *   THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
18   *   INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
19   *   AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
20   *   THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY DIRECT, INDIRECT,
21   *   INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22   *   NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23   *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24   *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25   *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26   *   THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27   *
28   *   $JOMC: AbstractModelShowMojo.java 4613 2012-09-22 10:07:08Z schulte $
29   *
30   */
31  package org.jomc.mojo;
32  
33  import java.io.File;
34  import java.io.StringWriter;
35  import java.util.logging.Level;
36  import javax.xml.bind.Marshaller;
37  import org.apache.maven.plugin.MojoExecutionException;
38  import org.jomc.modlet.Model;
39  import org.jomc.modlet.ModelContext;
40  import org.jomc.modlet.ObjectFactory;
41  
42  /**
43   * Base class for displaying and dumping model objects.
44   *
45   * @author <a href="mailto:cs@schulte.it">Christian Schulte</a>
46   * @version $JOMC: AbstractModelShowMojo.java 4613 2012-09-22 10:07:08Z schulte $
47   * @since 1.1
48   */
49  public abstract class AbstractModelShowMojo extends AbstractJomcMojo
50  {
51  
52      /** Constant for the name of the tool backing the mojo. */
53      private static final String TOOLNAME = "ModelProcessor";
54  
55      /**
56       * File to write the model to.
57       *
58       * @parameter expression="${jomc.document}"
59       */
60      private File document;
61  
62      /**
63       * Encoding of the document to write.
64       *
65       * @parameter default-value="${project.build.sourceEncoding}" expression="${jomc.documentEncoding}"
66       */
67      private String documentEncoding;
68  
69      /** Creates a new {@code AbstractModelShowMojo} instance. */
70      public AbstractModelShowMojo()
71      {
72          super();
73      }
74  
75      @Override
76      protected final void executeTool() throws Exception
77      {
78          this.logSeparator();
79          this.logProcessingModel( TOOLNAME, this.getModel() );
80  
81          final ModelContext modelContext = this.createModelContext( this.getDisplayClassLoader() );
82          final Marshaller m = modelContext.createMarshaller( this.getModel() );
83          final Model displayModel = this.getDisplayModel( modelContext );
84          m.setSchema( modelContext.createSchema( this.getModel() ) );
85          m.setProperty( Marshaller.JAXB_FORMATTED_OUTPUT, Boolean.TRUE );
86  
87          if ( displayModel != null )
88          {
89              if ( this.document == null )
90              {
91                  final StringWriter stringWriter = new StringWriter();
92                  m.marshal( new ObjectFactory().createModel( displayModel ), stringWriter );
93  
94                  final boolean verbose = this.isVerbose();
95                  try
96                  {
97                      this.setVerbose( true );
98  
99                      if ( this.isLoggable( Level.INFO ) )
100                     {
101                         this.log( Level.INFO, stringWriter.toString(), null );
102                     }
103                 }
104                 finally
105                 {
106                     this.setVerbose( verbose );
107                 }
108             }
109             else
110             {
111                 if ( this.document.exists() && !this.document.delete() && this.isLoggable( Level.WARNING ) )
112                 {
113                     this.log( Level.WARNING, Messages.getMessage(
114                         "failedDeletingFile", this.document.getAbsolutePath() ), null );
115 
116                 }
117 
118                 if ( this.isLoggable( Level.INFO ) )
119                 {
120                     this.log( Level.INFO, Messages.getMessage(
121                         "writingEncoded", this.document.getAbsolutePath(), this.documentEncoding ), null );
122 
123                 }
124 
125                 m.setProperty( Marshaller.JAXB_ENCODING, this.documentEncoding );
126                 m.marshal( new ObjectFactory().createModel( displayModel ), this.document );
127             }
128 
129             this.logToolSuccess( TOOLNAME );
130         }
131         else if ( this.isLoggable( Level.WARNING ) )
132         {
133             this.log( Level.WARNING, Messages.getMessage( "modelObjectNotFound" ), null );
134         }
135     }
136 
137     /**
138      * Gets the model to display or dump.
139      *
140      * @param modelContext The model context to use for getting the model.
141      *
142      * @return The model to display or dump.
143      *
144      * @throws MojoExecutionException if getting the model fails.
145      */
146     protected abstract Model getDisplayModel( ModelContext modelContext ) throws MojoExecutionException;
147 
148     /**
149      * Gets the class loader to use for displaying or dumping model objects.
150      *
151      * @return The class loader to use for displaying or dumping model objects.
152      *
153      * @throws MojoExecutionException if getting the class loader fails.
154      */
155     protected abstract ClassLoader getDisplayClassLoader() throws MojoExecutionException;
156 
157 }