japedo:generate

Full name:

com.logitags:japedo-maven-plugin:1.2.1: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
<htmlFilename> String - name of the generated html page
Default value is: ${project.artifactId}.html.
<jobs> List - Configuration parameters for the jobs to run. A <job> has the following child parameters:
Name Type Description
<name> String Unique name of the job that is displayed on the generated html page and used for the name of the generated data file. Not allowed characters are spaces # = Default value is: ${project.artifactId}-${project.version} or <dataFile> without suffix
<projectVersion> String The application version that is used for the source analysis. If set to 'LATEST' the latest released version is used for the analysis Default value is: ${project.version}
<additionalDependencies> List<String> Binary dependencies are required to compile the sources. 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'.
Additional dependencies can also be added with the full path to the library in the file system.
<includeSources> List<String> By default, the sources of all dependencies of the Maven project are scanned for JPA implementations, including third-party dependencies. This is normally not what is wanted. The sources should be restricted to those containing JPA persistent types. 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'.
<excludeSources> List<String> By default, the sources of all dependencies of the Maven project are scanned for JPA implementations, including third-party dependencies. This is normally not what is wanted. The sources should be restricted to those containing JPA persistent types. 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'.
<charset> String charset used to parse the sources. Default value is: UTF-8
<dbUsername> String database user name
<dbPassword> String database password
<dbConnectionUrl> String database connection URL
<dbDriverClassName> String database driver
<dbSchema> String database schema name. Necessary with some jdbc drivers
<dbNbThreads> int number of parallel threads for generation execution. Default value is: 4
<ignoredIssues> String comma separated list of unique ids of issues that will be ignored in the issue report. Ignored when property dataFile is set.
<dataFile> File a Japedo data file from a previous execution (only supported in premium version). If this property is set, all other parameters of this job are ignored except name.

<longDescriptionTarget> String - Long attribute descriptions can be displayed in a POPUP window or in the lower right PANEL.
Default value is: POPUP.
<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

Parameter Details

<htmlFilename>

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

<japedoDirectory>

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

<jobs>

Configuration parameters for the jobs to run. A <job> has the following child parameters:
Name Type Description
<name> String Unique name of the job that is displayed on the generated html page and used for the name of the generated data file. Not allowed characters are spaces # = Default value is: ${project.artifactId}-${project.version} or <dataFile> without suffix
<projectVersion> String The application version that is used for the source analysis. If set to 'LATEST' the latest released version is used for the analysis Default value is: ${project.version}
<additionalDependencies> List<String> Binary dependencies are required to compile the sources. 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'.
Additional dependencies can also be added with the full path to the library in the file system.
<includeSources> List<String> By default, the sources of all dependencies of the Maven project are scanned for JPA implementations, including third-party dependencies. This is normally not what is wanted. The sources should be restricted to those containing JPA persistent types. 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'.
<excludeSources> List<String> By default, the sources of all dependencies of the Maven project are scanned for JPA implementations, including third-party dependencies. This is normally not what is wanted. The sources should be restricted to those containing JPA persistent types. 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'.
<charset> String charset used to parse the sources. Default value is: UTF-8
<dbUsername> String database user name
<dbPassword> String database password
<dbConnectionUrl> String database connection URL
<dbDriverClassName> String database driver
<dbSchema> String database schema name. Necessary with some jdbc drivers
<dbNbThreads> int number of parallel threads for generation execution. Default value is: 4
<ignoredIssues> String comma separated list of unique ids of issues that will be ignored in the issue report. Ignored when property dataFile is set.
<dataFile> File a Japedo data file from a previous execution (only supported in premium version). If this property is set, all other parameters of this job are ignored except name.
  • Type: java.util.List
  • Required: No

<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

<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