A good starting place to get some insight into Modello is Modello's wiki.
Modello model descriptor is described and documented with Modello.
Modello is used extensively in Maven. You can find examples of models:
site.xml model.
${basedir}/target/generated-site/resources/xsd.
*
* @parameter expression="${basedir}/target/generated-site/xsd"
*
* @required
*/
private File outputDirectory;
/**
*
* @parameter
*
* @since 1.0-alpha-21
*/
private String xsdFileName;
protected String getGeneratorType()
{
return "xsd";
}
protected void customizeParameters( Properties parameters )
{
super.customizeParameters( parameters );
if ( xsdFileName != null )
{
parameters.put( ModelloParameterConstants.OUTPUT_XSD_FILE_NAME, xsdFileName );
}
}
protected boolean producesCompilableResult()
{
return false;
}
public File getOutputDirectory()
{
return outputDirectory;
}
public void setOutputDirectory( File outputDirectory )
{
this.outputDirectory = outputDirectory;
}
}
modello-maven-plugin-1.1/src/main/java/org/codehaus/modello/maven/ModelloXdocMojo.java 0000644 0001750 0001750 00000006347 11043272564 030070 0 ustar mkoch mkoch package org.codehaus.modello.maven;
/*
* Copyright (c) 2004, Codehaus.org
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of
* this software and associated documentation files (the "Software"), to deal in
* the Software without restriction, including without limitation the rights to
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
* of the Software, and to permit persons to whom the Software is furnished to do
* so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
import org.codehaus.modello.ModelloParameterConstants;
import java.io.File;
import java.util.Properties;
/**
* Creates documentation for the model in xdoc format.
*
* @goal xdoc
*
* @author Brett Porter
* @version $Id: ModelloXdocMojo.java 914 2008-07-28 07:29:56Z olamy $
*/
public class ModelloXdocMojo
extends AbstractModelloGeneratorMojo
{
/**
* The output directory of the generated documentation.
*
* @parameter expression="${basedir}/target/generated-site/xdoc"
*
* @required
*/
private File outputDirectory;
/**
*
* @parameter
*
* @since 1.0-alpha-21
*/
private String xdocFileName;
/**
* The first version of the model. This is used to decide whether or not
* to show the since column. If this is not specified, it defaults to the
* version of the model, which in turn means that the since column will not
* be shown.
*
* @parameter
* @since 1.0-alpha-14
*/
private String firstVersion;
protected String getGeneratorType()
{
return "xdoc";
}
protected boolean producesCompilableResult()
{
return false;
}
public File getOutputDirectory()
{
return outputDirectory;
}
public void setOutputDirectory( File outputDirectory )
{
this.outputDirectory = outputDirectory;
}
protected void customizeParameters( Properties parameters )
{
super.customizeParameters( parameters );
// Use version if firstVersion was not specified
if ( firstVersion == null )
{
firstVersion = getVersion();
}
parameters.put( ModelloParameterConstants.FIRST_VERSION, firstVersion );
if ( xdocFileName != null )
{
parameters.put( ModelloParameterConstants.OUTPUT_XDOC_FILE_NAME, xdocFileName );
}
}
public String getFirstVersion()
{
return firstVersion;
}
public void setFirstVersion( String firstVersion )
{
this.firstVersion = firstVersion;
}
}
modello-maven-plugin-1.1/src/main/java/org/codehaus/modello/maven/ModelloXpp3WriterMojo.java 0000644 0001750 0001750 00000003726 10544333624 031220 0 ustar mkoch mkoch package org.codehaus.modello.maven;
import java.io.File;
/*
* Copyright (c) 2004, Codehaus.org
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of
* this software and associated documentation files (the "Software"), to deal in
* the Software without restriction, including without limitation the rights to
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
* of the Software, and to permit persons to whom the Software is furnished to do
* so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
/**
* Creates an XPP3 writer from the model.
*
* @goal xpp3-writer
*
* @phase generate-sources
*
* @author Brett Porter
* @version $Id: ModelloXpp3WriterMojo.java 765 2006-12-27 00:00:20Z aheritier $
*/
public class ModelloXpp3WriterMojo
extends AbstractModelloGeneratorMojo
{
/**
* The output directory of the generated XPP writer.
*
* @parameter expression="${basedir}/target/generated-sources/modello"
*
* @required
*/
private File outputDirectory;
protected String getGeneratorType()
{
return "xpp3-writer";
}
public File getOutputDirectory()
{
return outputDirectory;
}
public void setOutputDirectory( File outputDirectory )
{
this.outputDirectory = outputDirectory;
}
}
modello-maven-plugin-1.1/src/main/java/org/codehaus/modello/maven/ModelloDom4jWriterMojo.java 0000644 0001750 0001750 00000001457 11214024744 031335 0 ustar mkoch mkoch package org.codehaus.modello.maven;
import java.io.File;
/**
* Creates a DOM4J writer from the model.
*
* @version $Id: ModelloDom4jWriterMojo.java 1244 2009-06-10 21:47:16Z olamy $
* @goal dom4j-writer
* @phase generate-sources
*/
public class ModelloDom4jWriterMojo
extends AbstractModelloGeneratorMojo
{
/**
* The output directory of the generated DOM4J reader.
*
* @parameter expression="${basedir}/target/generated-sources/modello"
* @required
*/
private File outputDirectory;
protected String getGeneratorType()
{
return "dom4j-writer";
}
public File getOutputDirectory()
{
return outputDirectory;
}
public void setOutputDirectory( File outputDirectory )
{
this.outputDirectory = outputDirectory;
}
}
modello-maven-plugin-1.1/src/main/java/org/codehaus/modello/maven/AbstractModelloGeneratorMojo.java 0000644 0001750 0001750 00000025236 11145330132 032570 0 ustar mkoch mkoch package org.codehaus.modello.maven;
/*
* Copyright (c) 2004, Codehaus.org
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of
* this software and associated documentation files (the "Software"), to deal in
* the Software without restriction, including without limitation the rights to
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
* of the Software, and to permit persons to whom the Software is furnished to do
* so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
import java.io.File;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;
import java.util.Properties;
import org.apache.maven.model.Resource;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.project.MavenProject;
import org.codehaus.modello.ModelloException;
import org.codehaus.modello.ModelloParameterConstants;
import org.codehaus.modello.core.ModelloCore;
import org.codehaus.modello.model.Model;
import org.codehaus.modello.model.ModelValidationException;
import org.sonatype.plexus.build.incremental.BuildContext;
import org.codehaus.plexus.util.StringUtils;
/**
* @author Trygve Laugstøl
* @version $Id: AbstractModelloGeneratorMojo.java 1184 2009-02-13 17:39:38Z igorife $
*/
public abstract class AbstractModelloGeneratorMojo
extends AbstractMojo
{
// ----------------------------------------------------------------------
// Parameters
// ----------------------------------------------------------------------
/**
* Base directory of the project.
*
* @parameter expression="${basedir}"
* @required
*/
private String basedir;
/**
* List of relative paths to mdo files containing the models.
*
* @parameter
* @required
*/
private String[] models;
/**
* The version of the model we will be working on.
*
* @parameter expression="${version}"
* @required
*/
private String version;
/**
* The encoding to use when generating Java source files.
*
* @parameter expression="${encoding}" default-value="${project.build.sourceEncoding}"
* @since 1.0-alpha-19
*/
private String encoding;
/**
* True if the generated package names should include the version.
*
* @parameter expression="${packageWithVersion}" default-value="false"
* @required
*/
private boolean packageWithVersion;
/**
* Note: This is passed by Maven and must not be configured by the user.
* * @component */ private ModelloCore modelloCore; /** * The Maven project instance for the executing project. * * @parameter expression="${project}" * @required */ private MavenProject project; /** * Additional historical versions to generate, each being packaged with the version regardless of the *packageWithVersion setting.
*
* @parameter
*/
private List/** ModelloGenerateMojo - A dynamic way to use generators and modello plugins. *
* ** Example Usage: *
** <plugin> * <groupId>org.codehaus.modello</groupId> * <artifactId>modello-maven-plugin</artifactId> * <version>1.0-alpha-15-SNAPSHOT</version> * <dependencies> * <dependency> * <groupId>org.codehaus.modello</groupId> * <artifactId>modello-plugin-jpa</artifactId> * <version>1.0.0-SNAPSHOT</version> * </dependency> * </dependencies> * <configuration> * <version>1.0.0</version> * <packageWithVersion>false</packageWithVersion> * <models> * <model>src/main/mdo/project-model.xml</model> * </models> * </configuration> * <executions> * <execution> * <id>java</id> * <goals> * <goal>generate</goal> * </goals> * <configuration> * <generatorId>java</generatorId> * </configuration> * </execution> * <execution> * <id>jpa</id> * <goals> * <goal>generate</goal> * </goals> * <configuration> * <generatorId>jpa-mapping</generatorId> * </configuration> * </execution> * </executions> * </plugin> ** * @author Joakim Erdfelt * @version $Id: ModelloGenerateMojo.java 1094 2009-01-02 22:06:17Z hboutemy $ * * @goal generate * @phase generate-sources * @description Execute a Modello Generator. */ public class ModelloGenerateMojo extends AbstractModelloGeneratorMojo { /** * @component role="org.codehaus.modello.plugin.ModelloGenerator" * @required */ private Map generatorMap; /** * @parameter expression="${modello.generator.id}" default-value="java" */ private String generatorId; /** * The output directory of the generated source files. * * @parameter expression="${basedir}/target/generated-sources/modello" * @required */ private File outputDirectory; protected String getGeneratorType() { return generatorId; } public File getOutputDirectory() { return outputDirectory; } public void execute() throws MojoExecutionException { if ( !generatorMap.containsKey( generatorId ) ) { throw new MojoExecutionException( "Unable to execute modello, generator id [" + generatorId + "] not found. (Available generator ids : " + generatorMap.keySet() + ")" ); } getLog().info( "[modello:generate {generator: " + generatorId + "}]" ); super.execute(); } }