Field Detail

• packages

  @Parameter
  protected String[] packages

  Specifies Java package names under which to search for classes with @JSimpleClass 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 @JSimpleClass 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 JSimpleDB 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.

• 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(JSimpleDB 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 matches the schema defined by the specified XML file.

  Parameters:

  schema - actual schema

  file - expected schema XML file

  matchNames - whether names must match, or only storage ID's

  Returns:

  true if verification succeeded, otherwise false

  Throws:

  MojoExecutionException - if an unexpected error occurs

• verify

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

  Check schema for hard conflicts with other schema versions defined by an interation 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