Built by Maven

tentackle-wizard:pdo

Full name:

org.tentackle:tentackle-wizard-maven-plugin:25.18.1.0:pdo

Description:

Wizard to create PDO files.
Brings up an FX UI to create the PDO-related Java files.

Best invoked from within the directory of the maven parent of the project.

Attributes:

  • Requires a Maven project to be executed.
  • Executes as an aggregator goal.
  • The goal is not marked as thread-safe and thus does not support parallel builds.

Required Parameters

Name Type Since Description
<profiles> List<Profile> - The profiles.

Optional Parameters

Name Type Since Description
<batchFilesets> List<FileSet> - Filesets to read a secondary model from.
If set, the PDO wizard works in batch mode, and for each input file (i.e., entity) the corresponding Java code is generated.
The files must be in model-format, i.e., same as here-docs read by the wurbelizer or if dumped by the tentackle-sql plugin with dumpAsComment and dumpVariables both set to false.

If there is more than one PdoProfile, the name of the profile must be given as an entity stereotype (case-insensitive), for example #MASTERDATA.

<batchModelDefaults> String - The model defaults to use in batch mode.
Since the model to load is usually dumped with model defaults applied, we cannot apply them here again. However, some options such as !ROOT, !ROOTID, !ROOTCLASSID or UNTRACKED should be set to avoid unwanted entity options.
Default: !ROOT, !ROOTID, !ROOTCLASSID, UNTRACKED
<charset> String - The encoding to read and write files.
Default: ${project.build.sourceEncoding}
<darkMode> Boolean - Enables dark mode.
If missing, the mode is determined from the desktop settings.
<dumpAnnotationsAsOptions> String - List of annotations that should be printed as attribute options.
A comma separates multiple annotations.
If the annotation ends with a |, it matches only annotations without parameters.
The special annotation @* matches all annotations and @*| matches all annotations without parameters.

Example: @NotNull|, @NotZero

For generated model source in batch mode only.

<dumpColumnGap> int - Minimum number of spaces between columns in the attribute section (default = 2).

For generated model source in batch mode only.


Default: 2
<entityAliases> String - The entity aliases.
User Property: tentackle.entityAliases
<filesets> List<FileSet> - The list of file sets containing the model.
If set, the modelDir is ignored.
<jdkToolchain> Map<String,String> - Toolchain for invocation of external tools.
Explicitly specifies the "jdk" toolchain for this plugin only. Overrides the toolchain selected by the maven-toolchain-plugin, if any.

Example:

  <jdkToolchain>
    <version>14</version>
  </jdkToolchain>
To deselect the toolchain configured by the maven-toolchain-plugin: 
  <jdkToolchain></jdkToolchain>
<loadModelFromDependencies> boolean - Load the model from the plugin dependencies on the classpath.
Default: true
<minLogLevel> String - The minimum logging java.util.logging.Level to redirect java.util logging to the maven logger.
Default: WARNING
<modelDefaults> String - The model defaults.
User Property: tentackle.modelDefaults
<modelDir> File - Directory holding the model files to be processed.
Ignored if fileset explicitly given.
Default: ${project.build.directory}/wurbel/model
User Property: tentackle.modelDir
<modelName> String - The model name.
Default: default
User Property: tentackle.modelName
<skip> Boolean - Skips processing.
Defaults to true if packaging is "pom".
<statusDir> File - Directory holding the status info.
Used to store the next free classId per profile in case multiple PDOs are generated without an intermediate mvn clean package/install or wurbel run.
Must be a subdirectory of the target directory to be removed via mvn clean.
Default: ${project.build.directory}/wizard
<templateDir> File - The directory holding the templates.
Default: ${project.basedir}/templates
<themeName> String - Selects the theme.
The AtlantaFX themes are: Primer, Cupertino, and Nord.
The default is Primer.
<verbosity> String - The verbosity.
One of "default", "info" or "debug". Debug is also turned on (if not set explicitly) by Maven's global debug flag (see command line switch -X).
Default: ${tentackle.verbosity}

Parameter Details

<batchFilesets>

Filesets to read a secondary model from.
If set, the PDO wizard works in batch mode, and for each input file (i.e., entity) the corresponding Java code is generated.
The files must be in model-format, i.e., same as here-docs read by the wurbelizer or if dumped by the tentackle-sql plugin with dumpAsComment and dumpVariables both set to false.

If there is more than one PdoProfile, the name of the profile must be given as an entity stereotype (case-insensitive), for example #MASTERDATA.

  • Type: java.util.List<org.apache.maven.shared.model.fileset.FileSet>
  • Required: No

<batchModelDefaults>

The model defaults to use in batch mode.
Since the model to load is usually dumped with model defaults applied, we cannot apply them here again. However, some options such as !ROOT, !ROOTID, !ROOTCLASSID or UNTRACKED should be set to avoid unwanted entity options.
  • Type: java.lang.String
  • Required: No
  • Default: !ROOT, !ROOTID, !ROOTCLASSID, UNTRACKED

<charset>

The encoding to read and write files.
  • Type: java.lang.String
  • Required: No
  • Default: ${project.build.sourceEncoding}

<darkMode>

Enables dark mode.
If missing, the mode is determined from the desktop settings.
  • Type: java.lang.Boolean
  • Required: No

<dumpAnnotationsAsOptions>

List of annotations that should be printed as attribute options.
A comma separates multiple annotations.
If the annotation ends with a |, it matches only annotations without parameters.
The special annotation @* matches all annotations and @*| matches all annotations without parameters.

Example: @NotNull|, @NotZero

For generated model source in batch mode only.

  • Type: java.lang.String
  • Required: No

<dumpColumnGap>

Minimum number of spaces between columns in the attribute section (default = 2).

For generated model source in batch mode only.

  • Type: int
  • Required: No
  • Default: 2

<entityAliases>

The entity aliases.
  • Type: java.lang.String
  • Required: No
  • User Property: tentackle.entityAliases

<filesets>

The list of file sets containing the model.
If set, the modelDir is ignored.
  • Type: java.util.List<org.apache.maven.shared.model.fileset.FileSet>
  • Required: No

<jdkToolchain>

Toolchain for invocation of external tools.
Explicitly specifies the "jdk" toolchain for this plugin only. Overrides the toolchain selected by the maven-toolchain-plugin, if any.

Example:

  <jdkToolchain>
    <version>14</version>
  </jdkToolchain>
To deselect the toolchain configured by the maven-toolchain-plugin: 
  <jdkToolchain></jdkToolchain>
  • Type: java.util.Map<java.lang.String, java.lang.String>
  • Required: No

<loadModelFromDependencies>

Load the model from the plugin dependencies on the classpath.
  • Type: boolean
  • Required: No
  • Default: true

<minLogLevel>

The minimum logging java.util.logging.Level to redirect java.util logging to the maven logger.
  • Type: java.lang.String
  • Required: No
  • Default: WARNING

<modelDefaults>

The model defaults.
  • Type: java.lang.String
  • Required: No
  • User Property: tentackle.modelDefaults

<modelDir>

Directory holding the model files to be processed.
Ignored if fileset explicitly given.
  • Type: java.io.File
  • Required: No
  • User Property: tentackle.modelDir
  • Default: ${project.build.directory}/wurbel/model

<modelName>

The model name.
  • Type: java.lang.String
  • Required: No
  • User Property: tentackle.modelName
  • Default: default

<profiles>

The profiles.
  • Type: java.util.List<org.tentackle.maven.plugin.wizard.Profile>
  • Required: Yes

<skip>

Skips processing.
Defaults to true if packaging is "pom".
  • Type: java.lang.Boolean
  • Required: No

<statusDir>

Directory holding the status info.
Used to store the next free classId per profile in case multiple PDOs are generated without an intermediate mvn clean package/install or wurbel run.
Must be a subdirectory of the target directory to be removed via mvn clean.
  • Type: java.io.File
  • Required: No
  • Default: ${project.build.directory}/wizard

<templateDir>

The directory holding the templates.
  • Type: java.io.File
  • Required: No
  • Default: ${project.basedir}/templates

<themeName>

Selects the theme.
The AtlantaFX themes are: Primer, Cupertino, and Nord.
The default is Primer.
  • Type: java.lang.String
  • Required: No

<verbosity>

The verbosity.
One of "default", "info" or "debug". Debug is also turned on (if not set explicitly) by Maven's global debug flag (see command line switch -X).
  • Type: java.lang.String
  • Required: No
  • Default: ${tentackle.verbosity}