uctool:export-xsd

Full name:

net.sf.uctool:uctool-maven-plugin:3.0.0:export-xsd

Description:

Generate an XSD file from data structures defined in the use cases.

Attributes:

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

Required Parameters

Name Type Since Description
mergedXsdFile File - Location of file to hold merged XML use case source files for XSD generation.
Default value is: ${project.build.outputDirectory}/net/sf/uctool/xsd-export-merged.xml.
outputFile File - The name of the XSD file to generate.
Default value is: ${project.build.directory}/site/xsd/data.xsd.
targetNamespaceUrl String - The target namespace for generated XSD elements.
Default value is: http://example.com/.
useCasesDirectory File - The directory holding the use case XML source files.
Default value is: ${project.basedir}/src/main/ucs/.
useCasesInclude String - Which files from the use cases directory tree should be included in the generation.

Specifies a file-set of source files in the comma- or space-separated list of patterns of files.


Default value is: **/*.xml.

Optional Parameters

Name Type Since Description
sourceEncoding String - Read the source files (XSL templates and XML transformation sources) using this encoding.
Default value is: ${project.build.sourceEncoding}.

Parameter Details

mergedXsdFile:

Location of file to hold merged XML use case source files for XSD generation.
  • Type: java.io.File
  • Required: Yes
  • Default: ${project.build.outputDirectory}/net/sf/uctool/xsd-export-merged.xml

outputFile:

The name of the XSD file to generate.
  • Type: java.io.File
  • Required: Yes
  • Default: ${project.build.directory}/site/xsd/data.xsd

sourceEncoding:

Read the source files (XSL templates and XML transformation sources) using this encoding.
  • Type: java.lang.String
  • Required: No
  • Default: ${project.build.sourceEncoding}

targetNamespaceUrl:

The target namespace for generated XSD elements.
  • Type: java.lang.String
  • Required: Yes
  • Default: http://example.com/

useCasesDirectory:

The directory holding the use case XML source files.
  • Type: java.io.File
  • Required: Yes
  • Default: ${project.basedir}/src/main/ucs/

useCasesInclude:

Which files from the use cases directory tree should be included in the generation.

Specifies a file-set of source files in the comma- or space-separated list of patterns of files.

  • Type: java.lang.String
  • Required: Yes
  • Default: **/*.xml