Maven Impex Plugin - impex:datadtd

impex:datadtd

Full name:

org.kuali.maven.plugins:maven-impex-plugin:1.1.13-SNAPSHOT:datadtd

Description:

Generates a DTD for the database tables from a schema XML file

Attributes:

Requires a Maven project to be executed.
Binds by default to the lifecycle phase: generate-sources.

Required Parameters

Name	Type	Since	Description
forceMojoExecution	`boolean`	`-`	Setting this parameter to `true` will force the execution of this mojo, even if it would get skipped usually. Default value is: `false`. User property is: `forceMojoExecution`.
schemaDir	`String`	`-`	The path to the directory where the schema XML files are located Default value is: `${basedir}/src/main/impex`. User property is: `schemaDir`.
schemaIncludes	`String`	`-`	The schema files from that directory which should be included (ant-style notation). Default value is: `${project.artifactId}.xml`. User property is: `schemaIncludes`.
schemaXMLFile	`String`	`-`	The name of the schema.xml file to process Default value is: `${project.build.directory}/generated-impex/${project.artifactId}.xml`. User property is: `schemaXMLFile`.

Optional Parameters

Name	Type	Since	Description
antCompatibilityMode	`boolean`	`-`	(no description) User property is: `antCompatibilityMode`.
artifactId	`String`	`-`	Included here as a simple property to facilitate generating DTD's for other artifacts Default value is: `${project.artifactId}`. User property is: `artifactId`.
copyToFile	`String`	`-`	Only used if antCompatibilityMode is set to true. If so, the dtd that gets generated will be copied to Default value is: `${basedir}/src/main/impex/data.dtd`. User property is: `copyToFile`.
dummy1	`String`	`-`	The directory in which the DTD will be generated Default value is: `${project.build.directory}/generated-impex`. User property is: `outputDir`.
dummy2	`String`	`-`	The location where the report file will be generated, relative to outputDir. Default value is: `../reports/report.${project.artifactId}.datadtd.generation`. User property is: `reportFile`.
dummy3	`String`	`-`	The location where the context property file for velocity will be generated. Default value is: `${project.build.directory}/reports/context.datadtd.properties`. User property is: `contextPropertiesPath`.
encoding	`String`	`-`	The encoding to use when reading/writing files. If not specified this defaults to the platform specific encoding of whatever machine the build is running on. Default value is: `${project.build.sourceEncoding}`. User property is: `encoding`.
projectName	`String`	`-`	The name of the project Default value is: `impex`. User property is: `projectName`.
runOnlyOnSchemaChange	`boolean`	`-`	Determines if this task should run only if the schema has changed Default value is: `true`. User property is: `runOnlyOnSchemaChange`.
skip	`boolean`	`-`	When `true`, skip the execution of this mojo Default value is: `false`.
sqlDbMap	`String`	`-`	The path to the properties file containing the mapping sql file -> target database. Default value is: `${project.build.directory}/reports/sqldbmap.properties`. User property is: `sqlDbMap`.
startMavenLogger	`boolean`	`-`	When true, redirect logging from Log4j and Jakarta Commons Logging to the Maven logging system Default value is: `true`. User property is: `startMavenLogger`.
targetDatabase	`String`	`-`	The type of database we are targeting (eg oracle, mysql). This is optional if `url` is supplied as the database type will be automatically detected based on the `url`. If targetDatabase is explicitly supplied it will override the type selected by the automatic detection logic. User property is: `targetDatabase`.
targetPackage	`String`	`-`	The target package for the generated classes. Default value is: `impex.generated`. User property is: `targetPackage`.
templatePath	`String`	`-`	The base path where the templates are read from, if they are not read from the classpath. Default value is: `${basedir}/src/main/impex/templates`. User property is: `templatePath`.
url	`String`	`-`	Database URL. User property is: `url`.
useClasspath	`boolean`	`-`	Whether the templates should be loaded from the classpath. Default value is: `true`. User property is: `useClasspath`.
userContextProperties	`Map`	`-`	A map where all user-defined context properties can be set. Overrides all other mojo configuration settings which are mapped to context properties.

Parameter Details

antCompatibilityMode:

(no description)

Type: boolean
Required: No
User Property: antCompatibilityMode

artifactId:

Included here as a simple property to facilitate generating DTD's for other artifacts

Type: java.lang.String
Required: No
User Property: artifactId
Default: ${project.artifactId}

copyToFile:

Only used if antCompatibilityMode is set to true. If so, the dtd that gets generated will be copied to

Type: java.lang.String
Required: No
User Property: copyToFile
Default: ${basedir}/src/main/impex/data.dtd

dummy1:

The directory in which the DTD will be generated

Type: java.lang.String
Required: No
User Property: outputDir
Default: ${project.build.directory}/generated-impex

dummy2:

The location where the report file will be generated, relative to outputDir.

Type: java.lang.String
Required: No
User Property: reportFile
Default: ../reports/report.${project.artifactId}.datadtd.generation

dummy3:

The location where the context property file for velocity will be generated.

Type: java.lang.String
Required: No
User Property: contextPropertiesPath
Default: ${project.build.directory}/reports/context.datadtd.properties

encoding:

The encoding to use when reading/writing files. If not specified this defaults to the platform specific encoding of whatever machine the build is running on.

Type: java.lang.String
Required: No
User Property: encoding
Default: ${project.build.sourceEncoding}

forceMojoExecution:

Setting this parameter to true will force the execution of this mojo, even if it would get skipped usually.

Type: boolean
Required: Yes
User Property: forceMojoExecution
Default: false

projectName:

The name of the project

Type: java.lang.String
Required: No
User Property: projectName
Default: impex

runOnlyOnSchemaChange:

Determines if this task should run only if the schema has changed

Type: boolean
Required: No
User Property: runOnlyOnSchemaChange
Default: true

schemaDir:

The path to the directory where the schema XML files are located

Type: java.lang.String
Required: Yes
User Property: schemaDir
Default: ${basedir}/src/main/impex

schemaIncludes:

The schema files from that directory which should be included (ant-style notation).

Type: java.lang.String
Required: Yes
User Property: schemaIncludes
Default: ${project.artifactId}.xml

schemaXMLFile:

The name of the schema.xml file to process

Type: java.lang.String
Required: Yes
User Property: schemaXMLFile
Default: ${project.build.directory}/generated-impex/${project.artifactId}.xml

skip:

When true, skip the execution of this mojo

Type: boolean
Required: No
Default: false

sqlDbMap:

The path to the properties file containing the mapping sql file -> target database.

Type: java.lang.String
Required: No
User Property: sqlDbMap
Default: ${project.build.directory}/reports/sqldbmap.properties

startMavenLogger:

When true, redirect logging from Log4j and Jakarta Commons Logging to the Maven logging system

Type: boolean
Required: No
User Property: startMavenLogger
Default: true

targetDatabase:

The type of database we are targeting (eg oracle, mysql). This is optional if url is supplied as the database type will be automatically detected based on the url. If targetDatabase is explicitly supplied it will override the type selected by the automatic detection logic.

Type: java.lang.String
Required: No
User Property: targetDatabase

targetPackage:

The target package for the generated classes.