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.
schemaDir	String	-	The path to the directory where the schema XML files are located Default value is: ${basedir}/src/main/impex.
schemaIncludes	String	-	The schema files from that directory which should be included (ant-style notation). Default value is: ${project.artifactId}.xml.
schemaXMLFile	String	-	The name of the schema.xml file to process Default value is: ${project.build.directory}/generated-impex/${project.artifactId}.xml.

Optional Parameters

Name	Type	Since	Description
antCompatibilityMode	boolean	-	(no description)
artifactId	String	-	Included here as a simple property to facilitate generating DTD's for other artifacts Default value is: ${project.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.
outputDir	String	-	The directory in which the DTD will be generated Default value is: ${project.build.directory}/generated-impex.
reportFile	String	-	The location where the report file will be generated, relative to outputDir. Default value is: ../reports/report.${project.artifactId}.datadtd.generation.
contextPropertiesPath	String	-	The location where the context property file for velocity will be generated. Default value is: ${project.build.directory}/reports/context.datadtd.properties.
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}.
projectName	String	-	The name of the project Default value is: impex.
runOnlyOnSchemaChange	boolean	-	Determines if this task should run only if the schema has changed Default value is: true.
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.
startMavenLogger	boolean	-	When true, redirect logging from Log4j and Jakarta Commons Logging to the Maven logging system Default value is: true.
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.
targetPackage	String	-	The target package for the generated classes. Default value is: impex.generated.
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.
url	String	-	Database URL.
useClasspath	boolean	-	Whether the templates should be loaded from the classpath. Default value is: true.
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:

• Type: boolean
• Required: No
• Expression: ${antCompatibilityMode}

---

artifactId:

• Type: java.lang.String
• Required: No
• Expression: ${artifactId}
• Default: ${project.artifactId}

---

copyToFile:

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

---

outputDir:

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

---

reportFile:

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

---

contextPropertiesPath:

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

---

encoding:

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

---

forceMojoExecution:

• Type: boolean
• Required: Yes
• Expression: ${forceMojoExecution}
• Default: false

---

projectName:

• Type: java.lang.String
• Required: No
• Expression: ${projectName}
• Default: impex

---

runOnlyOnSchemaChange:

• Type: boolean
• Required: No
• Expression: ${runOnlyOnSchemaChange}
• Default: true

---

schemaDir:

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

---

schemaIncludes:

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

---

schemaXMLFile:

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

---

skip:

• Type: boolean
• Required: No
• Default: false

---

sqlDbMap:

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

---

startMavenLogger:

• Type: boolean
• Required: No
• Expression: ${startMavenLogger}
• Default: true

---

targetDatabase:

• Type: java.lang.String
• Required: No
• Expression: ${targetDatabase}

---

targetPackage:

• Type: java.lang.String
• Required: No
• Expression: ${targetPackage}
• Default: impex.generated

---

templatePath:

• Type: java.lang.String
• Required: No
• Expression: ${templatePath}
• Default: ${basedir}/src/main/impex/templates

---

url:

• Type: java.lang.String
• Required: No
• Expression: ${url}

---

useClasspath:

• Type: boolean
• Required: No
• Expression: ${useClasspath}
• Default: true

---

userContextProperties:

• Type: java.util.Map
• Required: No