Package org.apache.openjpa.tools.maven

Class OpenJpaSqlMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.openjpa.tools.maven.AbstractOpenJpaMojo

org.apache.openjpa.tools.maven.AbstractOpenJpaMappingToolMojo

org.apache.openjpa.tools.maven.OpenJpaSqlMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="sql",
      defaultPhase=PROCESS_CLASSES,
      requiresDependencyResolution=COMPILE,
      threadSafe=true)
public class OpenJpaSqlMojo
extends AbstractOpenJpaMappingToolMojo

Executes the SQL generation via the OpenJPA MappingTool.

Since:

1.0

Version:

$Id$

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	modifyDatabase	Use this option to write the planned schema modifications to the database.
protected static final String	OPTION_SQL_ACTION	internally the options is named 'schemaAction'!
protected static final String	OPTION_SQL_FILE	used for passing the sqlFile parameter to the mapping tool
protected String	sqlAction	The action to take for generating the SQL.
protected File	sqlFile	Use this option to write the planned schema modifications to a SQL script.

Fields inherited from class org.apache.openjpa.tools.maven.AbstractOpenJpaMappingToolMojo

action, OPTION_ACTION

Fields inherited from class org.apache.openjpa.tools.maven.AbstractOpenJpaMojo

classes, compileClasspathElements, OPTION_CONNECTION_DRIVER_NAME, OPTION_CONNECTION_PROPERTIES, OPTION_PROPERTIES, OPTION_PROPERTIES_FILE, project, workDir

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor	Description
OpenJpaSqlMojo()

Method Summary

Modifier and Type	Method	Description
protected Options	getOptions()	Get the options for the various OpenJPA tools.

Methods inherited from class org.apache.openjpa.tools.maven.AbstractOpenJpaMappingToolMojo

execute

Methods inherited from class org.apache.openjpa.tools.maven.AbstractOpenJpaMojo

createOptions, extendRealmClasspath, findEntityClassFiles, getClasspathElements, getEntityClasses, getFilePaths, skipMojo

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

sqlAction

@Parameter(defaultValue="build")
protected String sqlAction

The action to take for generating the SQL. Actions can be composed in a comma-separated list of one of the following items:

• add (see MappingTool#ACTION_ADD)
• refresh (see MappingTool#ACTION_REFRESH)
• drop (see MappingTool#ACTION_DROP)
• dropSchema (see MappingTool#ACTION_DROP_SCHEMA)
• buildSchema (see MappingTool#ACTION_BUILD_SCHEMA)
• import (see MappingTool#ACTION_IMPORT)
• export (see MappingTool#ACTION_EXPORT)
• validate (see MappingTool#ACTION_VALIDATE)

Technically this is the same like the schemaAction, but we have to split it for the plugin to allow different actions for generating the mapping and generating the SQL files.

OPTION_SQL_ACTION

protected static final String OPTION_SQL_ACTION

internally the options is named 'schemaAction'!

See Also:

• Constant Field Values

sqlFile

@Parameter(defaultValue="${project.build.directory}/database.sql")
protected File sqlFile

Use this option to write the planned schema modifications to a SQL script. Combine this with a schemaAction of "build" to generate a script that recreates the schema for the current mappings, even if the schema already exists.

OPTION_SQL_FILE

protected static final String OPTION_SQL_FILE

used for passing the sqlFile parameter to the mapping tool

See Also:

• Constant Field Values

modifyDatabase

@Parameter(defaultValue="false")
protected boolean modifyDatabase

Use this option to write the planned schema modifications to the database. If this is set, the sqlFile setting (if any) will be ignored.

Constructor Details

OpenJpaSqlMojo

public OpenJpaSqlMojo()

Method Details

getOptions

protected Options getOptions()
                      throws org.apache.maven.plugin.MojoExecutionException

Description copied from class: AbstractOpenJpaMojo

Get the options for the various OpenJPA tools.

Specified by:

getOptions in class AbstractOpenJpaMojo

Returns:

Options filled with all necessary plugin parameters

Throws:

org.apache.maven.plugin.MojoExecutionException