japedo:generate

Full name:

com.logitags:japedo-maven-plugin:1.0:generate

Description:

The 'generate' goal generates an html documentation for the persistence implementations of the configured sources and database connection.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: compile.
  • Binds by default to the lifecycle phase: install.

Required Parameters

Name Type Since Description
<japedoDirectory> File - the directory where japedo executable japedo.jar and license file (if present) are installed

Optional Parameters

Name Type Since Description
<additionalDependencies> List - Dependencies are resolved from the pom.xml of the analyzed application. It could be however, that some transitive provided dependencies could not be resolved by the plugin. The database driver dependency for example is often missing in the pom.xml. Such additional dependencies can be added in format [groupId]:[artifactId]:[version]. The version accepts also 'LATEST'.
<charset> String - charset used to parse the sources
Default value is: UTF-8.
<dbConnectionUrl> String - database connection URL
<dbDriverClassName> String - database driver
<dbNbThreads> String - number of parallel threads for generation execution
Default value is: 4.
<dbPassword> String - database password
<dbSchema> String - database schema name. Necessary with some jdbc drivers
<dbUsername> String - database user name
<excludeSources> List - By default, the sources of all dependencies of the Maven project are scanned for JPA implementations, including third-party dependencies. Dependency sources can be excluded from scanning in the following formats:
  • [groupId] - excludes all sources with group id starting with the given group id
  • [groupId]:[artifactId] - excludes the source with group and artifact id and the version as taken from the pom.xml
  • [groupId]:[artifactId]:[version] - excludes the source with the given group id, artifact id and version. The version accepts also 'LATEST'.

<htmlFilename> String - name of the generated html page
Default value is: ${project.artifactId}.html.
<includeSources> List - By default, the sources of all dependencies of the Maven project are scanned for JPA implementations, including third-party dependencies. The dependency sources to scan can be explicitly set in following formats:
  • [groupId] - includes all sources with group id starting with [groupId]
  • [groupId]:[artifactId] - includes the source with group and artifact id and the version as taken from the pom.xml
  • [groupId]:[artifactId]:[version] - includes the source with the given group id, artifact id and version. The version accepts also 'LATEST'.

<longDescriptionTarget> String - Long attribute descriptions can be displayed in a POPUP window or in the lower right PANEL.
Default value is: POPUP.
<name> String - name that is displayed on the generated html page.
Default value is: Japedo Persistence Documentation.
<proxyHost> String - proxy host
<proxyPort> String - proxy port
<showAttributesOfHierarchy> boolean - flag if true the attribute table of an entity shows also attributes inherited from super classes.
Default value is: false.
<showCounts> boolean - show number of types in the generated html page
Default value is: false.
<targetDirectory> String - target directory for the generated html page
Default value is: ${project.build.directory}/japedo.
<timeout> String - timeout for the generation in sec. Default is no timeout
Default value is: -1.

Parameter Details

<additionalDependencies>

Dependencies are resolved from the pom.xml of the analyzed application. It could be however, that some transitive provided dependencies could not be resolved by the plugin. The database driver dependency for example is often missing in the pom.xml. Such additional dependencies can be added in format [groupId]:[artifactId]:[version]. The version accepts also 'LATEST'.
  • Type: java.util.List
  • Required: No

<charset>

charset used to parse the sources
  • Type: java.lang.String
  • Required: No
  • Default: UTF-8

<dbConnectionUrl>

database connection URL
  • Type: java.lang.String
  • Required: No

<dbDriverClassName>

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

<dbNbThreads>

number of parallel threads for generation execution
  • Type: java.lang.String
  • Required: No
  • Default: 4

<dbPassword>

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

<dbSchema>

database schema name. Necessary with some jdbc drivers
  • Type: java.lang.String
  • Required: No

<dbUsername>

database user name
  • Type: java.lang.String
  • Required: No

<excludeSources>

By default, the sources of all dependencies of the Maven project are scanned for JPA implementations, including third-party dependencies. Dependency sources can be excluded from scanning in the following formats:
  • [groupId] - excludes all sources with group id starting with the given group id
  • [groupId]:[artifactId] - excludes the source with group and artifact id and the version as taken from the pom.xml
  • [groupId]:[artifactId]:[version] - excludes the source with the given group id, artifact id and version. The version accepts also 'LATEST'.
  • Type: java.util.List
  • Required: No

<htmlFilename>

name of the generated html page
  • Type: java.lang.String
  • Required: No
  • Default: ${project.artifactId}.html

<includeSources>

By default, the sources of all dependencies of the Maven project are scanned for JPA implementations, including third-party dependencies. The dependency sources to scan can be explicitly set in following formats:
  • [groupId] - includes all sources with group id starting with [groupId]
  • [groupId]:[artifactId] - includes the source with group and artifact id and the version as taken from the pom.xml
  • [groupId]:[artifactId]:[version] - includes the source with the given group id, artifact id and version. The version accepts also 'LATEST'.
  • Type: java.util.List
  • Required: No

<japedoDirectory>

the directory where japedo executable japedo.jar and license file (if present) are installed
  • Type: java.io.File
  • Required: Yes

<longDescriptionTarget>

Long attribute descriptions can be displayed in a POPUP window or in the lower right PANEL.
  • Type: java.lang.String
  • Required: No
  • Default: POPUP

<name>

name that is displayed on the generated html page.
  • Type: java.lang.String
  • Required: No
  • Default: Japedo Persistence Documentation

<proxyHost>

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

<proxyPort>

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

<showAttributesOfHierarchy>

flag if true the attribute table of an entity shows also attributes inherited from super classes.
  • Type: boolean
  • Required: No
  • Default: false

<showCounts>

show number of types in the generated html page
  • Type: boolean
  • Required: No
  • Default: false

<targetDirectory>

target directory for the generated html page
  • Type: java.lang.String
  • Required: No
  • Default: ${project.build.directory}/japedo

<timeout>

timeout for the generation in sec. Default is no timeout
  • Type: java.lang.String
  • Required: No
  • Default: -1