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 model you wish your model to extend.</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 full description of the project.</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>The developers working on the project.</description>
          <type>java.util.List</type>
          <defaultValue>new ArrayList()</defaultValue>
        </field>
        <field>
          <name>contributors</name>
          <description>People who have contributed to the project.</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>The project's licenses.</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>Reports to be generated for the project.</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>the description</description>
          <type>String</type>
        </field>
        <field>
          <name>sourceDirectory</name>
          <description>the description</description>
          <type>String</type>
        </field>
        <field>
          <name>unitTestSourceDirectory</name>
          <description>the description</description>
          <type>String</type>
        </field>
        <field>
          <name>aspectSourceDirectory</name>
          <description>the description</description>
          <type>String</type>
        </field>
        <field>
          <name>sourceModifications</name>
          <description>the description</description>
          <type>java.util.List</type>
          <defaultValue>new ArrayList()</defaultValue>
        </field>
        <field>
          <name>unitTest</name>
          <description>the description</description>
          <type>UnitTest</type>
          <defaultValue>new UnitTest()</defaultValue>
        </field>
        <field>
          <name>resources</name>
          <description>the description</description>
          <type>java.util.List</type>
          <defaultValue>new ArrayList()</defaultValue>
        </field>
      </fields>
    </class>
    <class>
      <name>Contributor</name>
      <fields>
        <field>
          <name>name</name>
          <description>the description</description>
          <type>String</type>
        </field>
        <field>
          <name>email</name>
          <description>the description</description>
          <type>String</type>
        </field>
        <field>
          <name>url</name>
          <description>the description</description>
          <type>String</type>
        </field>
        <field>
          <name>organization</name>
          <description>the description</description>
          <type>String</type>
        </field>
        <field>
          <name>roles</name>
          <description>the description</description>
          <type>java.util.SortedSet</type>
          <defaultValue>new TreeSet()</defaultValue>
        </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 description</description>
          <type>String</type>
        </field>
      </fields>
    </class>
    <class>
      <name>License</name>
      <fields>
        <field>
          <name>name</name>
          <description>the description</description>
          <type>String</type>
        </field>
        <field>
          <name>url</name>
          <description>the description</description>
          <type>String</type>
        </field>
        <field>
          <name>distribution</name>
          <description>the description</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 description</description>
          <type>String</type>
        </field>
        <field>
          <name>developerConnection</name>
          <description>the description</description>
          <type>String</type>
        </field>
        <field>
          <name>url</name>
          <description>the description</description>
          <type>String</type>
        </field>
      </fields>
    </class>
    <class>
      <name>Resource</name>
      <superClass>PatternSet</superClass>
      <fields>
        <field>
          <name>directory</name>
          <description>the description</description>
          <type>String</type>
        </field>
        <field>
          <name>targetPath</name>
          <description>the description</description>
          <type>String</type>
        </field>
        <field>
          <name>filtering</name>
          <description>the description</description>
          <type>boolean</type>
        </field>
      </fields>
    </class>
    <class>
      <name>SourceModification</name>
      <superClass>Resource</superClass>
      <fields>
        <field>
          <name>className</name>
          <description>the description</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>