Copy Page

You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account. You can also Sign Up for a new account.

<h1>The Modello Data Model.</h1>

<p>Staging site giving full modello's model (under construction) can be found here:
<a class="external-link" href="http://dcabasson.developpez.com/maven/modello-metamodel.html" rel="nofollow">http://dcabasson.developpez.com/maven/modello-metamodel.html</a></p>

<p>Here's an example of a modello data model.</p>
<table class="wysiwyg-macro" data-macro-name="code" data-macro-default-parameter="xml" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGU6eG1sfQ&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>
&lt;model>
  &lt;id>myproject&lt;/id>
  &lt;name>MyProject&lt;/name>
  &lt;description>My Project's Data Model&lt;/description>
  &lt;defaults>
    &lt;default>
      &lt;key>package&lt;/key>
      &lt;value>org.codehaus.myproject.model&lt;/value>
    &lt;/default>
  &lt;/defaults>
  &lt;classes>
    &lt;class rootElement="true" xml.tagName="myproject">
      &lt;name>Model&lt;/name>
      &lt;version>3.0.0+&lt;/version>
      &lt;fields>
        &lt;field>
          &lt;name>myfield&lt;/name>
          &lt;version>1.0.0&lt;/version>
          &lt;description>The example of field.&lt;/description>
          &lt;type>String&lt;/type>
        &lt;/field>
      &lt;/fields>
    &lt;/class>
  &lt;/classes>
&lt;/model>
</pre></td></tr></table>

<h2>Top level &lt;model&gt;</h2>

<p>The top level &lt;model&gt; must contain an &lt;id&gt; &lt;name&gt; and at least 1 &lt;classes&gt;&lt;class&gt; element.</p>

<p>The optional &lt;defaults&gt; tag is commonly used to define properties that the various modello generators use.</p>

<h2>The &lt;classes&gt; section.</h2>

<p>You can have 1 or more &lt;class&gt; elements within this section.</p>

<p>Each &lt;class&gt; represents a container for a set of &lt;field&gt;s.</p>

<p>Every &lt;field&gt; is a component in the container.</p>

<h3>Notes on the &lt;field&gt; section</h3>

<p>XML Generator Notes about &lt;field&gt;</p>
<ol>
	<li>By default each <code>&lt;field&gt;</code> starts out life as an <code>&lt;element&gt;</code> with text content.</li>
	<li>A <code>&lt;field&gt;</code> can be set to be an attribute on the <code>&lt;class&gt;</code> element by using the <code>&lt;field xml.attribute=&quot;true&quot;&gt;</code> syntax.</li>
	<li><code>field/name</code> becomes the name of the element (or attribute key).
	<ol>
		<li><code>field#xml.tagName</code> can be used to change the name of the element (or attribute key)</li>
	</ol>
	</li>
	<li><code>field/version</code> is unused.</li>
	<li><code>field/description</code> is unused.</li>
	<li><code>field/type</code> is one of the following
	<ul>
		<li>boolean</li>
		<li>char</li>
		<li>double</li>
		<li>int</li>
		<li>long</li>
		<li>short</li>
		<li>date</li>
		<li>String</li>
		<li>Boolean</li>
		<li>DOM (currently only supported by xpp3 generators)</li>
		<li>Another <code>&lt;class&gt;</code> <strong>this can only be achieved through an association tag</strong></li>
	</ul>
	</li>
	<li><code>field/association</code> allows linking to other classes of the model
	<ol>
		<li>generated readers and writers do not enforce the multiplicity rules (yet)</li>
		<li><code>field/association</code> must have at a minimum the &lt;type&gt; element defined.</li>
		<li><code>field/association/multiplicity</code> dictates the multiplicity of a field (1 or <code>*</code> : 0 to many so far)</li>
		<li><code>field/association/type</code> only refers to other &lt;class&gt; id's, no java primitives allowed here.
		<ol>
			<li><code>field/association/type</code> will be used to determine the name of the nested elements.</li>
			<li>singular form of the field tagname will be used for the nested element name.
			<ul>
				<li><code>s/(.*)ies$/\1y/g</code> - <code>&quot;Properies&quot;</code> becomes <code>&quot;Property&quot;</code></li>
				<li><code>s/(.*(ch)?)es$/\1/g</code> - <code>&quot;Branches&quot;</code> becomes <code>&quot;Branch&quot;</code></li>
				<li><code>s/(.*)s$/\1/g</code> - <code>&quot;Reports&quot;</code> becomes <code>&quot;Report&quot;</code></li>
			</ul>
			</li>
			<li><code>field/association#xml.associationTagName</code> can be used to specify an overridden nested element name.</li>
			<li>To learn more about tagName resolution, see <a class="confluence-link" href="/display/ACTIVEIO/TagName+resolution" data-linked-resource-id="59596" data-linked-resource-type="page" data-linked-resource-default-alias="TagName resolution" data-base-url="http://docs.codehaus.org">TagName resolution</a></li>
		</ol>
		</li>
		<li><code>field#xml.listStyle</code> defaults to &quot;wrapped&quot;.
		<ol>
			<li>Example of <code>field#xml.listStyle=&quot;wrapped&quot;</code>
<table class="wysiwyg-macro" data-macro-name="code" data-macro-default-parameter="xml" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGU6eG1sfQ&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>
&lt;!-- Model -->
&lt;class>
  &lt;name>example&lt;/name>
  &lt;fields>
    &lt;field xml.listStyle="wrapped">
      &lt;name>components&lt;/name>
      &lt;version>4.0.0&lt;/version>
      &lt;association>
        &lt;type>Component&lt;/type>
        &lt;multiplicity>*&lt;/multiplicity>
      &lt;/association>
    &lt;/field>
  &lt;/fields>
&lt;/class>
&lt;class>
  &lt;name>Component&lt;/name>
  &lt;version>4.0.0&lt;/version>
  &lt;fields>
    &lt;field>
      &lt;name>name&lt;/name>
      &lt;type>String&lt;/type>
    &lt;/field>
  &lt;/fields>
&lt;/class>

</pre></td></tr></table>
<table class="wysiwyg-macro" data-macro-name="code" data-macro-default-parameter="xml" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGU6eG1sfQ&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>
&lt;!-- xml -->
&lt;example>
  &lt;components>
    &lt;component>
      &lt;name>foo&lt;/name>
    &lt;/component>
    &lt;component>
      &lt;name>bar&lt;/name>
    &lt;/component>
  &lt;/components>
&lt;/example>
</pre></td></tr></table></li>
			<li>Example of <code>field#xml.listStyle=&quot;flat&quot;</code>
<table class="wysiwyg-macro" data-macro-name="code" data-macro-default-parameter="xml" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGU6eG1sfQ&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>
&lt;!-- Model -->
&lt;class>
  &lt;name>example&lt;/name>
  &lt;fields>
    &lt;field xml.listStyle="flat">
      &lt;name>components&lt;/name>
      &lt;version>4.0.0&lt;/version>
      &lt;association>
        &lt;type>Component&lt;/type>
        &lt;multiplicity>*&lt;/multiplicity>
      &lt;/association>
    &lt;/field>
  &lt;/fields>
&lt;/class>
&lt;class>
  &lt;name>Component&lt;/name>
  &lt;version>4.0.0&lt;/version>
  &lt;fields>
    &lt;field>
      &lt;name>name&lt;/name>
      &lt;type>String&lt;/type>
    &lt;/field>
  &lt;/fields>
&lt;/class>