io.permazen.maven

Class AbstractSchemaMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

io.permazen.maven.AbstractSchemaMojo

All Implemented Interfaces:

ContextEnabled, Mojo

Direct Known Subclasses:

AbstractMainSchemaMojo

public abstract class AbstractSchemaMojo
extends AbstractMojo

Generates a schema XML file from a set of Permazen model classes.

Field Summary

Fields

Modifier and Type	Field and Description
protected String[]	classes Specifies the names of specific Java classes to search for @PermazenType or @JFieldType annotations.
protected String[]	packages Specifies Java package names under which to search for classes with @PermazenType or @JFieldType annotations.
protected MavenProject	project
protected String	schemaVersionProperty The name of a Maven property to set to the auto-generated schema version number.
protected String	storageIdGeneratorClass The StorageIdGenerator to use for generating Permazen storage ID's.

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractSchemaMojo()

Method Summary

Modifier and Type	Method and Description
protected abstract void	addDependencyClasspathElements(List<String> elements)
void	execute()
protected abstract void	execute(Permazen jdb)
protected void	generate(SchemaModel schema, File file) Generate schema XML file, overwriting any previous file.
protected abstract File	getClassOutputDirectory()
protected boolean	verify(Permazen jdb, Iterator<? extends File> otherVersionFiles) Check schema for structural conflicts with other schema versions defined by an iteration of XML files.
protected boolean	verify(SchemaModel schema, File file, boolean matchNames) Verify that the provided schema is "same version" compatible with the schema defined by the specified XML file.

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 Detail

packages

@Parameter
protected String[] packages

Specifies Java package names under which to search for classes with @PermazenType or @JFieldType annotations.

If no <classes> or <packages> are configured, then by default this plugin searches all classes in the output directory.

classes

@Parameter
protected String[] classes

Specifies the names of specific Java classes to search for @PermazenType or @JFieldType annotations.

If no <classes> or <packages> are configured, then by default this plugin searches all classes in the output directory.

storageIdGeneratorClass

@Parameter
protected String storageIdGeneratorClass

The StorageIdGenerator to use for generating Permazen storage ID's. By default, a DefaultStorageIdGenerator is used.

To configure a custom StorageIdGenerator, specify its class name like this:

 <configuration>
     <storageIdGeneratorClass>com.example.MyStorageIdGenerator</storageIdGeneratorClass>
     ...
 </configuration>
 

The specified class (com.example.MyStorageIdGenerator in this example) must be available either as part of the project being built or in one of the project's dependencies.

schemaVersionProperty

@Parameter(defaultValue="")
protected String schemaVersionProperty

The name of a Maven property to set to the auto-generated schema version number. This is the schema version number that will be auto-generated when a schema version number of -1 is configured. This auto-generated version number is based on hashing the generated schema.

project

@Parameter(defaultValue="${project}",
           readonly=true)
protected MavenProject project

Constructor Detail

AbstractSchemaMojo

public AbstractSchemaMojo()

Method Detail

getClassOutputDirectory

protected abstract File getClassOutputDirectory()

addDependencyClasspathElements

protected abstract void addDependencyClasspathElements(List<String> elements)
                                                throws DependencyResolutionRequiredException

Throws:

DependencyResolutionRequiredException

execute

protected abstract void execute(Permazen jdb)
                         throws MojoExecutionException,
                                MojoFailureException

Throws:

MojoExecutionException

MojoFailureException

execute

public final void execute()
                   throws MojoExecutionException,
                          MojoFailureException

Throws:

MojoExecutionException

MojoFailureException

generate

protected void generate(SchemaModel schema,
                        File file)
                 throws MojoExecutionException

Generate schema XML file, overwriting any previous file.

Parameters:

schema - database schema

file - schema XML output file

Throws:

MojoExecutionException - if an unexpected error occurs

verify

protected boolean verify(SchemaModel schema,
                         File file,
                         boolean matchNames)
                  throws MojoExecutionException

Verify that the provided schema is "same version" compatible with the schema defined by the specified XML file.

Parameters:

schema - actual schema

file - expected schema XML file

matchNames - whether schema must match exactly, or only be compatible with

Returns:

true if verification succeeded, otherwise false

Throws:

MojoExecutionException - if an unexpected error occurs

verify

protected boolean verify(Permazen jdb,
                         Iterator<? extends File> otherVersionFiles)
                  throws MojoExecutionException

Check schema for structural conflicts with other schema versions defined by an iteration of XML files.

Parameters:

jdb - database instance

otherVersionFiles - iteration of other schema version XML files

Returns:

true if verification succeeded, otherwise false

Throws:

MojoExecutionException - if an unexpected error occurs