maven/maven-model/maven.mdo

<!--
 |
 | o add specification element to a field, this would be more a technical description of
 |   what is allowed in the field.
 |
 | o validators: there could be several levels of validation. Simple type validation could
 |   be done with a regex, but we need inter-field validation and rules which could be
 |   dealt with by something like drools.
 |
 | o i18n: would be good to be able to have names/descriptions/specifications
 |   in as many languages as possible.
 |
 | o versioning of individual elements on the class level and the field level so that
 |   different versions of the model can be output.
 |
 | o annotation mechanism so that changes to the model can be accurately tracked.
 |
 -->
<model>
  <id>maven</id>
  <name>Maven</name>
  <version>3.0.0</version>
  <description>Maven's model for Java project.</description>
  <packageName>org.apache.maven.model</packageName>
  <classes>
    <class>
      <name>Model</name>
      <fields>
        <field>
          <name>extend</name>
          <description>
            The location of the parent project, if one exists. Values from the parent project will be
            the default for this project if they are left unspecified.
            The path may be absolute, or relative to the current project.xml file.
          </description>
          <type>String</type>
        </field>
        <field>
          <name>modelVersion</name>
          <description>The version of this model you are using.</description>
          <type>String</type>
        </field>
        <field>
          <name>groupId</name>
          <version>??? used post 3.0.0</version>
          <description>The primary grouping for your project.</description>
          <type>String</type>
        </field>
        <field>
          <name>artifactId</name>
          <version>??? used post 3.0.0</version>
          <description>The identifier used when generating the artifact for your project.</description>
          <type>String</type>
        </field>
        <field>
          <name>name</name>
          <description>Human readable name of the project.</description>
          <type>String</type>
        </field>
        <field>
          <name>version</name>
          <description>The currently version of the project.</description>
          <type>String</type>
        </field>
        <field>
          <name>shortDescription</name>
          <description>An abbreviated description of the project.</description>
          <type>String</type>
        </field>
        <field>
          <name>description</name>
          <description>
            A detailed description of the project.  This element is
            usually specified as CDATA to enable the use of HTML tags
            within the description.  This description is used to
            generate the <a href="plugins/site/index.html">front page</a>
            of the project's web site.
          </description>
          <type>String</type>
        </field>
        <field>
          <name>type</name>
          <version>??? use post 3.0.0</version>
          <description>The type of artifact produced by the project.</description>
          <type>String</type>
          <defaultValue>jar</defaultValue>
        </field>
        <field>
          <name>url</name>
          <description>The URL where the project can be found.</description>
          <type>String</type>
        </field>
        <field>
          <name>logo</name>
          <description>The logo for the project.</description>
          <type>String</type>
        </field>
        <field>
          <name>issueTrackingUrl</name>
          <description>The URL where the issue tracking system used by the project can be found.</description>
          <type>String</type>
        </field>
        <field>
          <name>inceptionYear</name>
          <description>The year the project started.</description>
          <type>String</type>
        </field>
        <field>
          <name>gumpRepositoryId</name>
          <description>Hint for the gump continuous integration build system.</description>
          <type>String</type>
        </field>
        <field>
          <name>siteAddress</name>
          <description>The FQDN of the host where the project's site is uploaded.</description>
          <type>String</type>
        </field>
        <field>
          <name>siteDirectory</name>
          <description>The directory on the site host where site documentation is placed when the site is uploaded.</description>
          <type>String</type>
        </field>
        <field>
          <name>distributionSite</name>
          <description>The FQDN of the host where the project's artifacts are uploaded.</description>
          <type>String</type>
          <comment>This naming is inconsistent and distriubtion should occur from a repository structure.</comment>
        </field>
        <field>
          <name>distributionDirectory</name>
          <description>The directory on the distribution host where artifacts are placed when uploaded.</description>
          <type>String</type>
          <comment>This naming is inconsistent and distriubtion should occur from a repository structure.</comment>
        </field>
        <field>
          <name>mailingLists</name>
          <description>The mailing lists for the project.</description>
          <type>java.util.List</type>
          <defaultValue>new ArrayList()</defaultValue>
        </field>
        <field>
          <name>developers</name>
          <description>
            This element describes all of the developers associated with a
            project.  Each developer is described by a
            <code>developer</code> element, which is then described by
            additional elements (described below).  The auto-generated site
            documentation references this information.
          </description>
          <type>java.util.List</type>
          <defaultValue>new ArrayList()</defaultValue>
        </field>
        <field>
          <name>contributors</name>
          <description>
            This element describes all of the contributors associated with a
            project who are not developers.  Each contributor is described by a
            <code>contributor</code> element, which is then describe by additional
            elements (described below).  The auto-generated site documentation
            references this information.
          </description>
          <type>java.util.List</type>
          <defaultValue>new ArrayList()</defaultValue>
        </field>
        <field>
          <name>dependencies</name>
          <description>The project's dependencies.</description>
          <type>java.util.List</type>
          <defaultValue>new ArrayList()</defaultValue>
          <comment>These should ultimately only be compile time dependencies when transitive dependencies come into play.</comment>
        </field>
        <field>
          <name>licenses</name>
          <description>
            This element describes all of the licenses for this project.  Each license is described by a
            <code>license</code> element, which is then describe by additional
            elements (described below).  The auto-generated site documentation
            references this information.  Projects should only list the license(s) that
            applies to the project and not the licenses that apply to dependencies.
          </description>
          <type>java.util.List</type>
          <defaultValue>new ArrayList()</defaultValue>
        </field>
        <field>
          <name>versions</name>
          <description>The released versions of the project.</description>
          <type>java.util.List</type>
          <defaultValue>new ArrayList()</defaultValue>
        </field>
        <field>
          <name>branches</name>
          <description>The SCM branches create for the project.</description>
          <type>java.util.List</type>
          <defaultValue>new ArrayList()</defaultValue>
        </field>
        <field>
          <name>packageGroups</name>
          <description>Package groups required for complete javadocs.</description>
          <type>java.util.List</type>
          <defaultValue>new ArrayList()</defaultValue>
        </field>
        <field>
          <name>reports</name>
          <description>
            This element includes the specification of reports to be
            included in a Maven-generated site.  These reports will be run
            when a user executes <code>maven site</code>.  All of the
            reports will be included in the navigation bar for browsing in
            the order they are specified.
          </description>
          <type>java.util.List</type>
          <defaultValue>new ArrayList()</defaultValue>
        </field>
        <field>
          <name>repository</name>
          <description>Specification for the SCM use by the project.</description>
          <type>Repository</type>
          <comment>This element needs to be renamed as it conflicts with the existing notion of repositories in Maven.</comment>
        </field>
        <field>
          <name>build</name>
          <description>Information required to build the project.</description>
          <type>Build</type>
        </field>
        <field>
          <name>organization</name>
          <description>
            This element describes various attributes of the organziation to
            which the project belongs.  These attributes are utilized when
            documentation is created (for copyright notices and links).
          </description>
          <type>Organization</type>
        </field>
      </fields>
      <!-- We need this because we can't use package as a field name. -->
      <code>
        private String packageName;

        public void setPackage(String packageName)
        {
            this.packageName = packageName;
        }

        public String getPackage()
        {
            return packageName;
        }

        public String getId()
        {
            StringBuffer id = new StringBuffer();
            id.append( getGroupId() );
            id.append( ":" );
            id.append( getArtifactId() );
            id.append( ":" );
            id.append( getType() );
            return id.toString();
        }

        public void setId( String id )
        {
            int i = id.indexOf( "+" );
            int j = id.indexOf( ":" );

            if ( i > 0 )
            {
                setGroupId( id.substring( 0, i ) );
                setArtifactId( id.replace( '+', '-' ) );
            }
            else if ( j > 0 )
            {
                setGroupId( id.substring( 0, j ) );
                setArtifactId( id.substring( j + 1 ) );
            }
            else
            {
                setGroupId( id );
                setArtifactId( id );
            }
        }
      </code>
    </class>
    <class>
      <name>Branch</name>
      <description>
        This element describes each of the branches of the
        project. Each branch is described by a <code>tag</code>
        element
      </description>
      <fields>
        <field>
          <name>tag</name>
          <description>
            The branch tag in the version control system
            (e.g. cvs) used by the project for the source
            code associated with this branch of the
            project.
          </description>
          <type>String</type>
        </field>
      </fields>
    </class>
    <class>
      <name>Build</name>
      <fields>
        <field>
          <name>nagEmailAddress</name>
          <description>
            An address to which notifications regarding the status of builds
            for this project can be sent. This is intended for use by tools
            which do unattended builds, for example those providing for
            continuous integration. Currently this is used by the
            <a href="build-file.html#maven:gump-descriptor">maven:gump-descriptor</a>
            target.
          </description>
          <type>String</type>
        </field>
        <field>
          <name>sourceDirectory</name>
          <description>
            This element specifies a directory containing the source
            of the project. The generated build system will compile
            the source in this directory when the project is built.
            The path given is relative to the project descriptor.
          </description>
          <type>String</type>
        </field>
        <field>
          <name>unitTestSourceDirectory</name>
          <description>
            This element specifies a directory containing the unit test
            source of the project. The generated build system will
            compile these directories when the project is being tested.
            The unit tests must use the JUnit test framework.
            The path given is relative to the project descriptor.
          </description>
          <type>String</type>
        </field>
        <field>
          <name>aspectSourceDirectory</name>
          <description>
            This element specifies a directory containing Aspect
            sources of the project.  The generated build system will
            compile the Aspects in this directory when the project is
            built if Aspects have been enabled (see the <a
            href="plugins/aspectj/goals.html">Aspectj goals</a> document).
            The path given is relative to the project descriptor.
          </description>
          <type>String</type>
        </field>
        <field>
          <name>sourceModifications</name>
          <description>
            This element describes all of the sourceModifications associated with a
            project.  Each source modification is described by a
            <code>sourceModification</code> element, which is then described by
            additional elements (described below).  These modifications are used
            to exclude or include various source depending on the environment
            the build is running in.
          </description>
          <type>java.util.List</type>
          <defaultValue>new ArrayList()</defaultValue>
        </field>
        <field>
          <name>unitTest</name>
          <description>This element specifies unit tests associated with the project.</description>
          <type>UnitTest</type>
          <defaultValue>new UnitTest()</defaultValue>
        </field>
        <field>
          <name>resources</name>
          <description>
            This element describes all of the resources associated with a project or unit tests.
            Each resource is described by a resource element, which is then described by additional
            elements (described <a href="#resource">below</a>). These resources are used to
            complete the jar file or to run unit test.
          </description>
          <type>java.util.List</type>
          <defaultValue>new ArrayList()</defaultValue>
        </field>
      </fields>
    </class>
    <class>
      <name>Contributor</name>
      <fields>
        <field>
          <name>name</name>
          <description>The full name of the contributor.</description>
          <type>String</type>
        </field>
        <field>
          <name>email</name>
          <description>The email address of the contributor.</description>
          <type>String</type>
        </field>
        <field>
          <name>url</name>
          <description>The URL for the homepage of the contributor.</description>
          <type>String</type>
        </field>
        <field>
          <name>organization</name>
          <description>The organization to which the contributor belongs.</description>
          <type>String</type>
        </field>
        <field>
          <name>roles</name>
          <description>
            The roles the contributor plays in the project.  Each role is
            describe by a <code>role</code> element, the body of which is a
            role name.
          </description>
          <type>java.util.SortedSet</type>
          <defaultValue>new TreeSet()</defaultValue>
        </field>
        <field>
          <name>timezone</name>
          <description>
            The timezone the contributor is in. This is a number in the range -14 to 14.
          </description>
          <type>String</type>
        </field>
      </fields>
    </class>
    <class>
      <name>Dependency</name>
      <fields>
        <field>
          <name>groupId</name>
          <description>the description</description>
          <type>String</type>
        </field>
        <field>
          <name>artifactId</name>
          <description>the description</description>
          <type>String</type>
        </field>
        <field>
          <name>version</name>
          <description>the description</description>
          <type>String</type>
        </field>
        <field>
          <name>url</name>
          <description>the description</description>
          <type>String</type>
          <comment>The URL should really be gleaned from a shared database of dependency information.</comment>
        </field>
        <field>
          <name>artifact</name>
          <description>the description</description>
          <type>String</type>
        </field>
        <field>
          <name>type</name>
          <description>The type of dependency.</description>
          <type>String</type>
          <defaultValue>jar</defaultValue>
        </field>
        <field>
          <name>properties</name>
          <description>Properties for this dependency.</description>
          <type>java.util.Properties</type>
          <defaultValue>new Properties()</defaultValue>
        </field>
      </fields>
      <code>
        public String getId()
        {
            return groupId + ":" + artifactId;
        }
      </code>
    </class>
    <class>
      <superClass>Contributor</superClass>
      <name>Developer</name>
      <fields>
        <field>
          <name>id</name>
          <description>The username of the developer.</description>
          <type>String</type>
        </field>
      </fields>
    </class>
    <class>
      <name>License</name>
      <fields>
        <field>
          <name>name</name>
          <description>The full legal name of the license.</description>
          <type>String</type>
        </field>
        <field>
          <name>url</name>
          <description>The official url for the license text.</description>
          <type>String</type>
        </field>
        <field>
          <name>distribution</name>
          <description>
              The primary method by which this project may be distributed.
              <dl>
                <dt>repo</dt>
                <dd>may be downloaded from the Maven repository</dd>
                <dt>manual</dt>
                <dd>user must manually download and install the dependency.</dd>
              </dl>
          </description>
          <type>String</type>
        </field>
        <field>
          <name>comments</name>
          <description>the description</description>
          <type>String</type>
        </field>
      </fields>
    </class>
    <class>
      <name>MailingList</name>
      <description>
        This element describes all of the mailing lists associated with
        a project.  Each mailing list is described by a
        <code>mailingList</code> element, which is then described by
        additional elements (described below).  The auto-generated site
        documentation references this information.
      </description>
      <fields>
        <field>
          <name>name</name>
          <description>The name of the mailing list.</description>
          <type>String</type>
        </field>
        <field>
          <name>subscribe</name>
          <description>
            The email address or link that can be used to subscribe to the mailing list.
            If this is an email address, a <code>mailto:</code> link will automatically be created when
            the documentation is created.
          </description>
          <type>String</type>
        </field>
        <field>
          <name>unsubscribe</name>
          <description>
            The email address or link that can be used to unsubscribe to
            the mailing list.  If this is an email address, a
            <code>mailto:</code> link will automatically be created
            when the documentation is created.
          </description>
          <type>String</type>
        </field>
        <field>
          <name>archive</name>
          <description>The link to a URL where you can browse the archive.</description>
          <type>String</type>
        </field>
      </fields>
    </class>
    <class>
      <name>Organization</name>
      <fields>
        <field>
          <name>name</name>
          <description>The full name of the organization.</description>
          <type>String</type>
        </field>
        <field>
          <name>url</name>
          <description>The URL to the organization's home page.</description>
          <type>String</type>
        </field>
        <field>
          <name>logo</name>
          <description>
            The URL to the organization's logo image.  This can be an URL relative
            to the base directory of the generated web site,
            (e.g., <code>/images/org-logo.png</code>) or an absolute URL
            (e.g., <code>http://my.corp/logo.png</code>).  This value is used
            when generating the project documentation.
          </description>
          <type>String</type>
        </field>
      </fields>
    </class>
    <class>
      <name>PackageGroup</name>
      <fields>
        <field>
          <name>title</name>
          <description>the description</description>
          <type>String</type>
        </field>
        <field>
          <name>packages</name>
          <description>the description</description>
          <type>String</type>
        </field>
      </fields>
    </class>
    <class>
      <name>PatternSet</name>
      <fields>
        <field>
          <name>includes</name>
          <description>the description</description>
          <type>java.util.List</type>
          <defaultValue>new ArrayList()</defaultValue>
        </field>
        <field>
          <name>excludes</name>
          <description>the description</description>
          <type>java.util.List</type>
          <defaultValue>new ArrayList()</defaultValue>
        </field>
      </fields>
    </class>
    <class>
      <name>Repository</name>
      <fields>
        <field>
          <name>connection</name>
          <description>
            The source configuration management system URL
            that describes the repository and how to connect to the
            repository.  This is used by Maven when <a
            href="plugins/dist/index.html">building versions</a>
            from specific ID.
          </description>
          <type>String</type>
        </field>
        <field>
          <name>developerConnection</name>
          <description>
            Just like connection, but for developers, i.e. this scm connection
            will not be read only.
          </description>
          <type>String</type>
        </field>
        <field>
          <name>url</name>
          <description>The URL to the project's browsable CVS repository.</description>
          <type>String</type>
        </field>
      </fields>
    </class>
    <class>
      <name>Resource</name>
      <superClass>PatternSet</superClass>
      <fields>
        <field>
          <name>directory</name>
          <description>
            Describe the directory where the resource is stored.
            The path may be absolute, or relative to the project.xml file.
          </description>
          <type>String</type>
        </field>
        <field>
          <name>targetPath</name>
          <description>
            Describe the resource target path. For example, if you want that resource
            appear into a specific package (<code>org.apache.maven.messages</code>), you must specify this
            element with this value : <code>org/apache/maven/messages</code>
          </description>
          <type>String</type>
        </field>
        <field>
          <name>filtering</name>
          <description>Describe if resources are filtered or not.</description>
          <type>boolean</type>
        </field>
      </fields>
    </class>
    <class>
      <name>SourceModification</name>
      <superClass>Resource</superClass>
      <fields>
        <field>
          <name>className</name>
          <description>
            If the class with this name can <strong>not</strong> be
            loaded, then the includes and excludes specified below
            will be applied to the contents of the
            <a href="#sourceDirectory">sourceDirectory</a>
          </description>
          <type>String</type>
        </field>
        <field>
          <name>property</name>
          <description>the description</description>
          <type>String</type>
        </field>
      </fields>
    </class>
    <class>
      <name>UnitTest</name>
      <superClass>PatternSet</superClass>
      <fields>
        <field>
          <name>resources</name>
          <description>the description</description>
          <type>java.util.List</type>
          <defaultValue>new ArrayList()</defaultValue>
        </field>
      </fields>
    </class>
    <class>
      <name>Version</name>
      <description>
        This element describes each of the previous versions of the
        project. Each version is described by a <code>version</code>
        element
      </description>
      <fields>
        <field>
          <name>name</name>
          <description>
            The external version number under which this release was distributed. Examples include:
            <code>1.0</code>, <code>1.1-alpha1</code>, <code>1.2-beta</code>, <code>1.3.2</code> etc.
          </description>
          <type>String</type>
        </field>
        <field>
          <name>tag</name>
          <description>
            The name given in the version control system (e.g. cvs) used by the project for the source
            code associated with this version of the project.
          </description>
          <type>String</type>
        </field>
        <field>
          <name>id</name>
          <description>
            A unique identifier for a version.  This ID is
            used to specify the version that <a href="plugins/dist/index.html"><code>maven:dist</code></a> builds.
          </description>
          <type>String</type>
        </field>
      </fields>
    </class>
  </classes>
</model>