Mojo - jasperreports:compile-reports

jasperreports:compile-reports

Full name:

org.codehaus.mojo:jasperreports-maven-plugin:1.0-beta-2-SNAPSHOT:compile-reports

Description:

Compiles JasperReports xml definition files.

Much of this was inspired by the JRAntCompileTask, while trying to make it slightly cleaner and easier to use with Maven's mojo api.

Attributes:

Requires a Maven 2.0 project to be executed.
Requires dependency resolution of artifacts in scope: compile.
Binds by default to the lifecycle phase: generate-sources.

Optional Parameters

Name	Type	Since	Description
additionalClasspath	`String`	`-`	Any additional classpath entry you might want to add to the JasperReports compiler. Not recommended for general use, plugin dependencies should be used instead.
additionalProperties	`Map`	`1.0-beta-2`	Additional JRProperties
classpathElements	`List`	`-`	(no description)
compiler	`String`	`-`	Uses the Javac compiler by default. This is different from the original JasperReports ant task, which uses the JDT compiler by default. Default value is: `net.sf.jasperreports.engine.design.JRJavacCompiler`.
javaDirectory	`File`	`-`	This is where the generated java sources are stored.
keepJava	`boolean`	`-`	Deprecated. There seems to be an issue with the compiler plugin so don't expect this to work yet - the dependencies will have disappeared. Default value is: `false`.
keepSerializedObject	`boolean`	`-`	Deprecated. Not implemented Default value is: `true`.
outputDirectory	`File`	`-`	This is where the .jasper files are written.
outputFileExt	`String`	`-`	The extension of the compiled report files. Creates files with a .jasper extension by default. Default value is: `.jasper`.
project	`MavenProject`	`-`	(no description)
sourceDirectory	`File`	`-`	This is where the xml report design files should be. Default value is: `src/main/jasperreports`.
sourceFileExt	`String`	`-`	The extension of the source files to look for. Finds files with a .jrxml extension by default. Default value is: `.jrxml`.
xmlValidation	`boolean`	`-`	Wether the xml design files must be validated. Default value is: `true`.

Parameter Details

additionalClasspath:

Any additional classpath entry you might want to add to the JasperReports compiler. Not recommended for general use, plugin dependencies should be used instead.

Type: java.lang.String
Required: No

additionalProperties:

Additional JRProperties

Type: java.util.Map
Since: 1.0-beta-2
Required: No

classpathElements:

(no description)

Type: java.util.List
Required: No
Expression: ${project.compileClasspathElements}

compiler:

Uses the Javac compiler by default. This is different from the original JasperReports ant task, which uses the JDT compiler by default.

Type: java.lang.String
Required: No
Default: net.sf.jasperreports.engine.design.JRJavacCompiler

javaDirectory:

This is where the generated java sources are stored.

Type: java.io.File
Required: No
Expression: ${project.build.directory}/jasperreports/java

keepJava:

Deprecated. There seems to be an issue with the compiler plugin so don't expect this to work yet - the dependencies will have disappeared.

Since the JasperReports compiler deletes the compiled classes, one might want to set this to true, if they want to handle the generated java source in their application. Mind that this will not work if the mojo is bound to the compile or any other later phase. (As one might need to do if they use classes from their project in their report design)

Type: boolean
Required: No
Default: false

keepSerializedObject:

Deprecated. Not implemented

Not used for now - just a TODO - the idea being that one might want to set this to false if they want to handle the generated java source in their application.

Type: boolean
Required: No
Default: true

outputDirectory:

This is where the .jasper files are written.