tentackle-wizard:browse

Full name:

org.tentackle:tentackle-wizard-maven-plugin:25.20.1.0:browse

Description:

PDO browser.
Brings up an FX UI to analyze PDOs persisted in a database and to generate test code from them.

In batch mode, enabled by both pdoConfig and outputFile, the Java code for the given PDOs is written to a file without opening the UI.

Attributes:

  • Requires a Maven project to be executed.
  • Executes as an aggregator goal.
  • The goal is thread-safe and supports parallel builds.

Required Parameters

Name Type Since Description
<url> String - The backend URL.
<user> String - The backend username.

Optional Parameters

Name Type Since Description
<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.
<distinctVariables> boolean - By default, the variables of the created entities are reused for the 2nd, 3rd, etc... instances. If this flag is true, the variable names are numbered starting at variableOffset .
User Property: distinct
<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 <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
<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
<mapSchemas> boolean - Map schema names to flat table names in generated SQL SELECT statements.
User Property: tentackle.mapSchemas
<maxLinesInStringLiteral> int - Limits the number of lines in generated multi-line string literals.
0 or less means unlimited (the default).
User Property: maxLines
<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/model
User Property: tentackle.modelDir
<modelName> String - The model name.
Default: default
User Property: tentackle.modelName
<outputFile> File - The generated output file.
Turns on batch mode in conjunction with the pdo parameter.
User Property: output
<password> String - The backend password.
<pdoConfig> String - The PDOs to generate code for.
Turns on batch mode in conjunction with the output parameter.

The format is: -Dpdo=<entity>[<id>,<id>,...], where the square brackets are literal and:

  • entity is the entity name, for example Customer
  • id is one or more object IDs, separated by commas or spaces.
Example: -Dpdo=Customer[17878,221221,333]
User Property: pdo
<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.
<variableOffset> Integer - If distinctVariables is true, the variable names are numbered. If variableOffset is null, the first instance has no number. Otherwise, it starts with the given offset.
Ignored if distinctVariables is false.
User Property: offset
<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

<charset>

The encoding to read and write files.
Applied JVM-wide, see determineEncoding() .
  • Type: java.lang.String
  • Required: No
  • Default: ${project.build.sourceEncoding}

<darkMode>

Enables dark mode.
If missing, the mode follows the desktop settings and changes along with them.
  • Type: java.lang.Boolean
  • Required: No

<distinctVariables>

By default, the variables of the created entities are reused for the 2nd, 3rd, etc... instances. If this flag is true, the variable names are numbered starting at variableOffset .
  • Type: boolean
  • Required: No
  • User Property: distinct

<entityAliases>

The entity aliases, in the same syntax as in the model source.
  • 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. 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>

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>
  • Type: java.util.Map<java.lang.String, java.lang.String>
  • Required: No

<layers>

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 <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>

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.
  • Type: java.lang.String
  • Required: No

<loadModelFromDependencies>

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

<mapSchemas>

Map schema names to flat table names in generated SQL SELECT statements.
  • Type: boolean
  • Required: No
  • User Property: tentackle.mapSchemas

<maxLinesInStringLiteral>

Limits the number of lines in generated multi-line string literals.
0 or less means unlimited (the default).
  • Type: int
  • Required: No
  • User Property: maxLines

<minLogLevel>

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) .
  • Type: java.lang.String
  • Required: No
  • Default: WARNING

<modelDefaults>

The model defaults, in the same syntax as in the model source.
  • Type: java.lang.String
  • Required: No
  • User Property: tentackle.modelDefaults

<modelDir>

Directory holding the model files to be processed.
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>

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

<outputFile>

The generated output file.
Turns on batch mode in conjunction with the pdo parameter.
  • Type: java.io.File
  • Required: No
  • User Property: output

<password>

The backend password.
  • Type: java.lang.String
  • Required: No

<pdoConfig>

The PDOs to generate code for.
Turns on batch mode in conjunction with the output parameter.

The format is: -Dpdo=<entity>[<id>,<id>,...], where the square brackets are literal and:

  • entity is the entity name, for example Customer
  • id is one or more object IDs, separated by commas or spaces.
Example: -Dpdo=Customer[17878,221221,333]
  • Type: java.lang.String
  • Required: No
  • User Property: pdo

<profiles>

The 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>

Skips processing.
If not set, defaults to true if packaging is "pom" and the execution is recursive (see isSkippedByDefault() ).
  • Type: java.lang.Boolean
  • Required: No

<statusDir>

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.
  • Type: java.io.File
  • Required: No
  • Default: ${project.build.directory}/wizard

<templateDir>

The directory holding the templates.
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>

Selects the theme.
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

<url>

The backend URL.
  • Type: java.lang.String
  • Required: Yes

<user>

The backend username.
  • Type: java.lang.String
  • Required: Yes

<variableOffset>

If distinctVariables is true, the variable names are numbered. If variableOffset is null, the first instance has no number. Otherwise, it starts with the given offset.
Ignored if distinctVariables is false.
  • Type: java.lang.Integer
  • Required: No
  • User Property: offset

<verbosity>

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).
  • Type: java.lang.String
  • Required: No
  • Default: ${tentackle.verbosity}