Package org.apache.openjpa.tools.maven

Class OpenJpaSchemaMojo

  • All Implemented Interfaces:
    org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
    @Mojo(name="schema",
      defaultPhase=PROCESS_CLASSES,
      requiresDependencyResolution=COMPILE,
      threadSafe=true)
public class OpenJpaSchemaMojo
extends AbstractOpenJpaMappingToolMojo
    Executes the schema generation via the OpenJPA MappingTool.
    Since:
    1.0
    Version:
    $Id$

    • Field Detail

      • schemaAction

        @Parameter(defaultValue="add")
protected String schemaAction
        The action to take on the schema. 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)

      • OPTION_SCHEMA_ACTION

        protected static final String OPTION_SCHEMA_ACTION
        used for passing the schemaAction parameter to the mapping tool
        See Also:
        Constant Field Values

      • schemaFile

        @Parameter(defaultValue="${project.build.directory}/schema.xml")
protected File schemaFile
        Use this option to write the planned schema to an XML document rather than modify the database. The document can then be manipulated and committed to the database with the schema tool

      • OPTION_SCHEMA_FILE

        protected static final String OPTION_SCHEMA_FILE
        used for passing the schemaFile parameter to the mapping tool
        See Also:
        Constant Field Values

    • Constructor Detail

      • OpenJpaSchemaMojo

        public OpenJpaSchemaMojo()

    • Method Detail

      • 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