tentackle-wizard:pdo
Full name:
org.tentackle:tentackle-wizard-maven-plugin:25.20.1.0:pdo
Description:
Wizard to create PDO files.
Brings up an FX UI to create the PDO-related Java files.
In batch mode, enabled by batchFilesets or batchDir, the files are generated headless for every entity of a secondary model that does not exist in the project model yet.
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 thread-safe and supports parallel builds.
Optional Parameters
| Name | Type | Since | Description |
|---|---|---|---|
<batchDir> |
String |
- |
Alternative way to specify batch mode from the command line.
All files in that single directory are considered as input files. A relative path is resolved against the project's base directory. User Property: batchDir |
<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., similar to the here-docs read by the wurbelizer or if dumped by the tentackle-sql plugin with dumpAsComment and dumpVariables both set to false.
The whole directory of a fileset is loaded to resolve the relations, but code is generated only for the included files. A fileset without a directory defaults to the project's base directory. If there is more than one |
<batchModelDefaults> |
String |
- |
The model defaults applied when printing the model source of the generated PDO interfaces 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, !BIND or UNTRACKED should be set to avoid unwanted entity options.Default: !ROOT, !ROOTID, !ROOTCLASSID, !BIND, UNTRACKEDUser Property: batchDefaults |
<charset> |
String |
- |
The encoding to read and write files.
Applied JVM-wide, see determineEncoding()
.Default: ${project.build.sourceEncoding} |
<darkMode> |
Boolean |
- |
Enables dark mode.
If missing, the mode follows the desktop settings and changes along with them. |
<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: 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, in the same syntax as in the model source. User Property: tentackle.entityAliases |
<filesets> |
List<FileSet> |
- |
The list of file sets containing the model.
If set, the modelDir
is ignored. Each fileset is loaded as a whole directory, i.e. includes and excludes are not applied. |
<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>25</version>
</jdkToolchain>
To deselect the toolchain configured by the maven-toolchain-plugin:
<jdkToolchain></jdkToolchain> |
<layers> |
List<Layer> |
- |
Named, isolated ModuleLayers for dependencies that must run isolated from each other - typically because two of them need different, otherwise conflicting versions of the same module, or because the application itself is built with module layers.
If empty (the default), the goal runs exactly as without this feature at all: against the plain plugin classpath (populated the usual way, by declaring the application's dependencies as See also: leafLayer |
<leafLayer> |
String |
- |
The name of the layer holding the application's own PDO/domain/persistence classes, i.e. the layer whose classloader is installed as the thread's context classloader while the goal runs. Required if layers
is not empty and must match the name of one of them. |
<loadModelFromDependencies> |
boolean |
- |
Load the model from the resources of 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.
Any name or value accepted by java.util.logging.Level.parse(java.lang.String)
.Default: WARNING |
<modelDefaults> |
String |
- |
The model defaults, in the same syntax as in the model source. User Property: tentackle.modelDefaults |
<modelDir> |
File |
- |
Directory holding the model files to be processed.
Ignored if filesets
are given, except as the default directory of a fileset without a directory.Default: ${project.build.directory}/wurbel/modelUser Property: tentackle.modelDir |
<modelName> |
String |
- |
The model name. Default: defaultUser Property: tentackle.modelName |
<profiles> |
List<Profile> |
- |
The profiles.
Required by the pdo goal (at least one PdoProfile
) and the operation goal (at least one OperationProfile
). Profile names must be unique. |
<skip> |
Boolean |
- |
Skips processing.
If not set, defaults to true if packaging is "pom" and the execution is recursive (see isSkippedByDefault()
). |
<statusDir> |
File |
- |
Directory holding the status info.
Used to store the next free class ID per profile in case multiple PDOs are generated without an intermediate build that updates the model. Should be a subdirectory of the target directory, so that mvn clean removes it.Default: ${project.build.directory}/wizard |
<templateDir> |
File |
- |
The directory holding the templates.
If it does not exist, it is created and the default templates are installed. Default: ${project.basedir}/templates |
<themeName> |
String |
- |
Selects the theme.
The AtlantaFX themes are: Primer, Cupertino, and Nord.
The default is Cupertino on macOS and Primer on all other platforms. |
<verbosity> |
String |
- |
The verbosity.
One of "default", "info" or "debug". Other values are treated as "default". If not set, debug is turned on by Maven's global debug flag (see command line switch -X).Default: ${tentackle.verbosity} |
Parameter Details
<batchDir>
All files in that single directory are considered as input files. A relative path is resolved against the project's base directory.
- Type:
java.lang.String - Required:
No - User Property:
batchDir
<batchFilesets>
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., similar to the here-docs read by the wurbelizer or if dumped by the tentackle-sql plugin with
dumpAsComment and dumpVariables both set to false.
The whole directory of a fileset is loaded to resolve the relations, but code is generated only for the included files. A fileset without a directory defaults to the project's base directory.
If there is more than one PdoProfile, the name of the profile must be given as an entity stereotype (case-insensitive), for example #MASTERDATA. With only one profile, entities without such a stereotype use that profile.
- Type:
java.util.List<org.apache.maven.shared.model.fileset.FileSet> - Required:
No
<batchModelDefaults>
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, !BIND or UNTRACKED should be set to avoid unwanted entity options.- Type:
java.lang.String - Required:
No - User Property:
batchDefaults - Default:
!ROOT, !ROOTID, !ROOTCLASSID, !BIND, UNTRACKED
<charset>
Applied JVM-wide, see
determineEncoding()
.- Type:
java.lang.String - Required:
No - Default:
${project.build.sourceEncoding}
<darkMode>
If missing, the mode follows the desktop settings and changes along with them.
- Type:
java.lang.Boolean - Required:
No
<dumpAnnotationsAsOptions>
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>
For generated model source in batch mode only.
- Type:
int - Required:
No - Default:
2
<entityAliases>
- Type:
java.lang.String - Required:
No - User Property:
tentackle.entityAliases
<filesets>
If set, the
modelDir
is ignored. Each fileset is loaded as a whole directory, i.e. includes and excludes are not applied.- Type:
java.util.List<org.apache.maven.shared.model.fileset.FileSet> - Required:
No
<jdkToolchain>
Explicitly specifies the
"jdk" toolchain for this plugin only. Overrides the toolchain selected by the maven-toolchain-plugin, if any.
Example:
<jdkToolchain>
<version>25</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
<layers>
ModuleLayers for dependencies that must run isolated from each other - typically because two of them need different, otherwise conflicting versions of the same module, or because the application itself is built with module layers.
If empty (the default), the goal runs exactly as without this feature at all: against the plain plugin classpath (populated the usual way, by declaring the application's dependencies as <dependency> elements of this plugin). If not empty, this plugin builds the configured ModuleLayer graph at goal-execution time and installs the leafLayer's classloader as the thread's context classloader for the duration of the goal - which is what every existing, layer-unaware ServiceFactory.getServiceFinder()/Model.loadFromResources() call (and, for browse/script, the application's own domain/PDO/persistence classes) transparently resolves from. See the layers.md documentation.
See also: leafLayer
- Type:
java.util.List<org.tentackle.maven.plugin.wizard.Layer> - Required:
No
<leafLayer>
layers
is not empty and must match the name of one of them.- Type:
java.lang.String - Required:
No
<loadModelFromDependencies>
- Type:
boolean - Required:
No - Default:
true
<minLogLevel>
java.util.logging.Level
to redirect java.util logging to the maven logger.
Any name or value accepted by
java.util.logging.Level.parse(java.lang.String)
.- Type:
java.lang.String - Required:
No - Default:
WARNING
<modelDefaults>
- Type:
java.lang.String - Required:
No - User Property:
tentackle.modelDefaults
<modelDir>
Ignored if
filesets
are given, except as the default directory of a fileset without a directory.- Type:
java.io.File - Required:
No - User Property:
tentackle.modelDir - Default:
${project.build.directory}/wurbel/model
<modelName>
- Type:
java.lang.String - Required:
No - User Property:
tentackle.modelName - Default:
default
<profiles>
Required by the
pdo goal (at least one PdoProfile
) and the operation goal (at least one OperationProfile
). Profile names must be unique.- Type:
java.util.List<org.tentackle.maven.plugin.wizard.Profile> - Required:
No
<skip>
If not set, defaults to true if packaging is "pom" and the execution is recursive (see
isSkippedByDefault()
).- Type:
java.lang.Boolean - Required:
No
<statusDir>
Used to store the next free class ID per profile in case multiple PDOs are generated without an intermediate build that updates the model.
Should be a subdirectory of the target directory, so that
mvn clean removes it.- Type:
java.io.File - Required:
No - Default:
${project.build.directory}/wizard
<templateDir>
If it does not exist, it is created and the default templates are installed.
- Type:
java.io.File - Required:
No - Default:
${project.basedir}/templates
<themeName>
The AtlantaFX themes are:
Primer, Cupertino, and Nord.
The default is
Cupertino on macOS and Primer on all other platforms.- Type:
java.lang.String - Required:
No
<verbosity>
One of "default", "info" or "debug". Other values are treated as "default".
If not set, debug is turned on by Maven's global debug flag (see command line switch
-X).- Type:
java.lang.String - Required:
No - Default:
${tentackle.verbosity}
Tentackle