Japedo Maven Plugin – japedo:generate

japedo:generate

Full name:

com.logitags:japedo-maven-plugin:1.5.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

<applications>

List

-

Configuration parameters for the applications to run. An <application> has the following child parameters:

Name	Type	Description
<name>	String	Unique name of the application that is displayed on the generated html page and used for the name of the generated data file. The expression %date% is resolved to the current date in format YYYYMMdd. The expression %version% is resolved to the applied project version (see <projectVersion>). Not allowed characters are spaces # = Default value is: ${project.artifactId}-${project.version} or <dataFile> without suffix
<description>	String	A description of the application. This will be added to the generated documentation. The expression %version% is resolved to the applied project version (see <projectVersion>).
<projectVersion>	String	The application version that is used for the source analysis. If set to LATEST or LATEST:ignoredVersions the latest released version is used for the analysis. Ignored versions can be appended optionally as a comma separated list of regular expressions. It is also possible to use LATEST-1, LATEST-2 to use the last but one, last but two etc. If LATEST[-n] is used the expression %version%, which can be used in other configuration parameters will be resolved to the detected version 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[:ignoredVersions]. The version accepts also 'LATEST'. If LATEST is set, ignored versions can be appended optionally as a comma separated list of regular expressions 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[:ignoredVersions] - includes the source with the given group id, artifact id and version. The version accepts also 'LATEST'. If LATEST is set, ignored versions can be appended optionally as a comma separated list of regular expressions
<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. Sometimes also a source may not be available. Sources can be excluded from scanning in the following formats: qualified class name - the class is ignored 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[:ignoredVersions] - excludes the source with the given group id, artifact id and version. The version accepts also 'LATEST'. If LATEST is set, ignored versions can be appended optionally as a comma separated list of regular expressions
<charset>	String	charset used to parse the sources. Default value is: UTF-8
<dbUsername>	String	database user name. The expression %version% is resolved to the applied project version (see <projectVersion>).
<dbPassword>	String	database password. The expression %version% is resolved to the applied project version (see <projectVersion>).
<dbConnectionUrl>	String	database connection URL. The expression %version% is resolved to the applied project version (see <projectVersion>).
<dbDriverClassName>	String	database driver
<dbSchema>	String	database schema name. Necessary with some jdbc drivers. The expression %version% is resolved to the applied project version (see <projectVersion>).
<dbNbThreads>	int	number of parallel threads for generation execution. Default value is: 4
<sqlScript>	String	path to an SQL script that will be executed before the database is analyzed. This allows for example to setup an in-memory database. INSERT, UPDATE and DELETE statements are ignored. If the path begins with classpath: the script is searched in the classpath. If the path begins with liquibase: a Liquibase changelog file is looked up in the filesystem or classpath and executed
<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 application are ignored except name. The expression %version% is resolved to the applied project version (see <projectVersion>).

<logLevel> String - Japedo log level as one of DEBUG, INFO, WARN and ERROR or any other log level of java.util.logging.
Default value is: INFO.

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

<outputDirectory> String - target directory for the generated html page
Default value is: ${project.build.directory}/japedo.

<outputFilename> String - name of the generated documentation file. In case of html output, .html will be appended.
Default value is: ${project.artifactId}.

<outputFormat> String - comma-separated list of output formats: HTML, JSON
Default value is: HTML.

<prettyPrint> boolean - flag if the generated data files contain line breaks and indentations
Default value is: false.

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

Parameter Details

<applications>

Configuration parameters for the applications to run. An <application> has the following child parameters:

Name	Type	Description
<name>	String	Unique name of the application that is displayed on the generated html page and used for the name of the generated data file. The expression %date% is resolved to the current date in format YYYYMMdd. The expression %version% is resolved to the applied project version (see <projectVersion>). Not allowed characters are spaces # = Default value is: ${project.artifactId}-${project.version} or <dataFile> without suffix
<description>	String	A description of the application. This will be added to the generated documentation. The expression %version% is resolved to the applied project version (see <projectVersion>).
<projectVersion>	String	The application version that is used for the source analysis. If set to LATEST or LATEST:ignoredVersions the latest released version is used for the analysis. Ignored versions can be appended optionally as a comma separated list of regular expressions. It is also possible to use LATEST-1, LATEST-2 to use the last but one, last but two etc. If LATEST[-n] is used the expression %version%, which can be used in other configuration parameters will be resolved to the detected version 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[:ignoredVersions]. The version accepts also 'LATEST'. If LATEST is set, ignored versions can be appended optionally as a comma separated list of regular expressions 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[:ignoredVersions] - includes the source with the given group id, artifact id and version. The version accepts also 'LATEST'. If LATEST is set, ignored versions can be appended optionally as a comma separated list of regular expressions
<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. Sometimes also a source may not be available. Sources can be excluded from scanning in the following formats: qualified class name - the class is ignored 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[:ignoredVersions] - excludes the source with the given group id, artifact id and version. The version accepts also 'LATEST'. If LATEST is set, ignored versions can be appended optionally as a comma separated list of regular expressions
<charset>	String	charset used to parse the sources. Default value is: UTF-8
<dbUsername>	String	database user name. The expression %version% is resolved to the applied project version (see <projectVersion>).
<dbPassword>	String	database password. The expression %version% is resolved to the applied project version (see <projectVersion>).
<dbConnectionUrl>	String	database connection URL. The expression %version% is resolved to the applied project version (see <projectVersion>).
<dbDriverClassName>	String	database driver
<dbSchema>	String	database schema name. Necessary with some jdbc drivers. The expression %version% is resolved to the applied project version (see <projectVersion>).
<dbNbThreads>	int	number of parallel threads for generation execution. Default value is: 4
<sqlScript>	String	path to an SQL script that will be executed before the database is analyzed. This allows for example to setup an in-memory database. INSERT, UPDATE and DELETE statements are ignored. If the path begins with classpath: the script is searched in the classpath. If the path begins with liquibase: a Liquibase changelog file is looked up in the filesystem or classpath and executed
<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 application are ignored except name. The expression %version% is resolved to the applied project version (see <projectVersion>).

Type: java.util.List
Required: No