Google Git
Sign in
apache / archiva-web-content / 7e392b6aae8c93dae988a28b080d4efae6263de1 / . / redback / components / modello-plugins / modello-plugin-jpox / jpox-model-syntax.html
blob: fb8f0271c3579e82f3acb9e6d835ab68b40f89f2 [file] [log] [blame]
<!DOCTYPE html>
<!--
| Generated by Apache Maven Doxia Site Renderer 1.8.1
| Rendered using Apache Maven Fluido Skin 1.6
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="author" content="Joakim Erdfelt" />
<meta http-equiv="Content-Language" content="en" />
<title>Modello JPOX Plugin &#x2013; jpox-jdo-mapping model syntax</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.6.min.css" />
<link rel="stylesheet" href="./css/site.css" />
<link rel="stylesheet" href="./css/print.css" media="print" />
<script type="text/javascript" src="./js/apache-maven-fluido-1.6.min.js"></script>
<style type="text/css"></style> <!-- Google Analytics -->
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-140879-5']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
</head>
<body class="topBarEnabled">
<a href="https://github.com/apache/archiva">
<img style="position: absolute; top: 0; right: 0; border: 0; z-index: 10000;"
src="https://s3.amazonaws.com/github/ribbons/forkme_right_gray_6d6d6d.png"
alt="Fork me on GitHub">
</a>
<div id="topbar" class="navbar navbar-fixed-top ">
<div class="navbar-inner">
<div class="container"><div class="nav-collapse">
<ul class="nav">
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Parent Project <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="../index.html" title="Modello Plugins">Modello Plugins</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Maven 2.0 <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="index.html" title="Introduction">Introduction</a></li>
<li><a href="jpox-model-syntax.html" title="Model Syntax">Model Syntax</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">ASF <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="http://www.apache.org/foundation/how-it-works.html" title="How Apache Works">How Apache Works</a></li>
<li><a href="http://www.apache.org/foundation/" title="Foundation">Foundation</a></li>
<li><a href="http://www.apache.org/foundation/sponsorship.html" title="Sponsoring Apache">Sponsoring Apache</a></li>
<li><a href="http://www.apache.org/foundation/thanks.html" title="Thanks">Thanks</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Project Documentation <b class="caret"></b></a>
<ul class="dropdown-menu">
<li class="dropdown-submenu">
<a href="project-info.html" title="Project Information">Project Information</a>
<ul class="dropdown-menu">
<li><a href="index.html" title="About">About</a></li>
</ul>
</li>
<li class="dropdown-submenu">
<a href="project-reports.html" title="Project Reports">Project Reports</a>
<ul class="dropdown-menu">
<li><a href="xref/index.html" title="Source Xref">Source Xref</a></li>
<li><a href="xref-test/index.html" title="Test Source Xref">Test Source Xref</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<form id="search-form" action="https://www.google.com/search" method="get" class="navbar-search pull-right" >
<input value="http://archiva.apache.org/redback/components" name="sitesearch" type="hidden"/>
<input class="search-query" name="q" id="query" type="text" />
</form>
<script type="text/javascript">asyncJs( 'https://cse.google.com/brand?form=search-form' )</script>
</div>
</div>
</div>
</div>
<div class="container">
<div id="banner">
<div class="pull-left"><div id="bannerLeft"><h2>Modello</h2>
</div>
</div>
<div class="pull-right"><a href="http://www.apache.org/" id="bannerRight"><img src="http://www.apache.org/images/asf_logo_wide.png" alt="Apache Software Foundation"/></a></div>
<div class="clear"><hr/></div>
</div>
<div id="breadcrumbs">
<ul class="breadcrumb">
<li class=""><a href="http://archiva.apache.org/index.html" class="externalLink" title="Archiva">Archiva</a><span class="divider">/</span></li>
<li class=""><a href="../../index.html" title="Redback Components">Redback Components</a><span class="divider">/</span></li>
<li class=""><a href="../index.html" title="Modello Plugins">Modello Plugins</a><span class="divider">/</span></li>
<li class=""><a href="index.html" title="Modello JPOX Plugin">Modello JPOX Plugin</a><span class="divider">/</span></li>
<li class="active ">jpox-jdo-mapping model syntax</li>
<li id="projectVersion" class="pull-right">Version: 1.1-SNAPSHOT</li>
</ul>
</div>
<div id="bodyColumn" >
<div class="section">
<h2><a name="Modello_JPOX_Model_Syntax"></a>Modello JPOX Model Syntax</h2>
<div>
<pre class="model-xml">
&lt;model <a href="#model-reserved-word-strictness">jpox.reserved-word-strictness=&quot;<i>(enum)</i>&quot;</a>
<a href="#model-table-prefix">jpox.table-prefix=&quot;<i>(String)</i>&quot;</a>
<a href="#model-column-prefix">jpox.column-prefix=&quot;<i>(String)</i>&quot;</a>&gt;
&lt;name&gt;ExampleModel&lt;/name&gt;
&lt;classes&gt;
&lt;class <a href="#class-enabled">jpox.enabled=&quot;<i>(boolean)</i>&quot;</a>
<a href="#class-detachable">jpox.detachable=&quot;<i>(boolean)</i>&quot;</a>
<a href="#class-not-persisted-fields">jpox.not-persisted-fields=&quot;<i>(List)</i>&quot;</a>
<a href="#class-table">jpox.table=&quot;<i>(String)</i>&quot;</a>
<a href="#class-column-prefix">jpox.column-prefix=&quot;<i>(String)</i>&quot;</a>
<a href="#class-identity-type">jpox.identity-type=&quot;<i>(enum)</i>&quot;</a>
<a href="#class-identity-class">jpox.identity-class=&quot;<i>(String)</i>&quot;</a>
<a href="#class-use-identifiers-as-primary-key">jpox.use-identifiers-as-primary-key=&quot;<i>(boolean)</i>&quot;</a>&gt;
&lt;name&gt;SimpleClass&lt;/name&gt;
&lt;fields&gt;
&lt;field <a href="#field-fetch-groups">jpox.fetch-groups=&quot;<i>(List)</i>&quot;</a>
<a href="#field-mapped-by">jpox.mapped-by=&quot;<i>(String)</i>&quot;</a>
<a href="#field-null-value">jpox.null-value=&quot;<i>(String)</i>&quot;</a>
<a href="#field-column">jpox.column=&quot;<i>(String)</i>&quot;</a>
<a href="#field-join-table">jpox.join-table=&quot;<i>(String)</i>&quot;</a>
<a href="#field-indexed">jpox.indexed=&quot;<i>(enum)</i>&quot;</a>
<a href="#field-persistence-modifier">jpox.persistence-modifier=&quot;<i>(enum)</i>&quot;</a>
<a href="#field-value-strategy">jpox.value-strategy=&quot;<i>(enum)</i>&quot;</a>&gt;
&lt;name&gt;simple&lt;/name&gt;
&lt;type&gt;String&lt;/type&gt;
&lt;required&gt;true&lt;/required&gt;
&lt;/field&gt;
&lt;field&gt;
&lt;name&gt;associative&lt;/name&gt;
&lt;required&gt;false&lt;/required&gt;
&lt;association <a href="#association-dependent">jpox.dependent=&quot;<i>(boolean)</i>&quot;</a>
<a href="#association-join">jpox.join=&quot;<i>(boolean)</i>&quot;</a>&gt;
&lt;type&gt;AnotherClass&lt;/type&gt;
&lt;multiplicity&gt;*&lt;/multiplicity&gt;
&lt;/association&gt;
&lt;/field&gt;
&lt;/fields&gt;
&lt;/class&gt;
&lt;/classes&gt;
&lt;/model&gt;
</pre></div>
<table border="0" class="table table-striped">
<tr class="a">
<th>Context</th>
<th>Attribute</th>
<th>Values</th>
<th>Description</th>
</tr>
<tr class="b">
<td>Model</td>
<td><a name="model-reserved-word-strictness">jpox.reserved-word-strictness</a></td>
<td>&quot;warning&quot; or &quot;error&quot; (default: warning)</td>
<td>
<p>
This allows you to set the level of strictness on the reserved
word violations within the TABLE / COLUMN / JOIN-TABLE names.
</p>
<p>
A setting of &quot;error&quot; will only throw an exception if a reserved
word violation severity level of ERROR is encountered.
</p>
<p>
An attempt to use a reserved word found within the core SQL92 /
SQL99 / or SQL2003 set of reserved words are considered an ERROR.
Use of a reserved word found within a vendor specific SQL
implementation is considered a WARNING.
</p>
<p>
You are encouraged to fix all reserved word violations to make
your code as portable across multiple SQL implementations as
possible.
</p>
</td>
</tr>
<tr class="a">
<td>Model</td>
<td><a name="model-table-prefix">jpox.table-prefix</a></td>
<td>
Any non-empty String.
<br />(No Default)
</td>
<td>
</td>
</tr>
<tr class="b">
<td>Model</td>
<td><a name="model-column-prefix">jpox.column-prefix</a></td>
<td>
Any non-empty String.
<br />(No Default)
</td>
<td>
</td>
</tr>
<tr class="a">
<td>Class</td>
<td><a name="class-enabled">jpox.enabled</a></td>
<td>
true or false.
<br />(Default: true)
</td>
<td>
</td>
</tr>
<tr class="b">
<td>Class</td>
<td><a name="class-detachable">jpox.detachable</a></td>
<td>
true or false
<br />(Default: true)
</td>
<td>
</td>
</tr>
<tr class="a">
<td>Class</td>
<td><a name="class-not-persisted-fields">jpox.not-persisted-fields</a></td>
<td>
List of fields that are not persisted (seperated by spaces)
<br />(No Default)
</td>
<td>
</td>
</tr>
<tr class="b">
<td>Class</td>
<td><a name="class-table">jpox.table</a></td>
<td>
Any non-empty String.
<br />(No Default)
</td>
<td>
</td>
</tr>
<tr class="a">
<td>Class</td>
<td><a name="class-column-prefix">jpox.column-prefix</a></td>
<td>
Any non-empty String.
<br />(No Default)
</td>
<td>
</td>
</tr>
<tr class="b">
<td>Class</td>
<td><a name="class-identity-type">jpox.identity-type</a></td>
<td>
&quot;application&quot;, &quot;datastore&quot;, or &quot;nondurable&quot;
<br />(No Default)
</td>
<td>
</td>
</tr>
<tr class="a">
<td>Class</td>
<td><a name="class-identity-class">jpox.identity-class</a></td>
<td>
Any non-empty String.
Refers to a Java Class name in the same package as
the model.
<br />(No Default)
</td>
<td>
</td>
</tr>
<tr class="b">
<td>Class</td>
<td><a name="class-use-identifiers-as-primary-key">jpox.use-identifiers-as-primary-key</a></td>
<td>
true or false
<br />(Default: true)
</td>
<td>
</td>
</tr>
<tr class="a">
<td>Field</td>
<td><a name="field-fetch-groups">jpox.fetch-groups</a></td>
<td>
List of fetch-group names (seperated by space).
<br />(No Default)
</td>
<td>
</td>
</tr>
<tr class="b">
<td>Field</td>
<td><a name="field-mapped-by">jpox.mapped-by</a></td>
<td>
Any non-empty String.
<br />(No Default)
</td>
<td>
</td>
</tr>
<tr class="a">
<td>Field</td>
<td><a name="field-null-value">jpox.null-value</a></td>
<td>
Any non-empty String.
<br />(No Default)
</td>
<td>
</td>
</tr>
<tr class="b">
<td>Field</td>
<td><a name="field-column">jpox.column</a></td>
<td>
Any non-empty String.
<br />(No Default)
</td>
<td>
</td>
</tr>
<tr class="a">
<td>Field</td>
<td><a name="field-join-table">jpox.join-table</a></td>
<td>
Any non-empty String.
<br />(No Default)
</td>
<td>
</td>
</tr>
<tr class="b">
<td>Field</td>
<td><a name="field-indexed">jpox.indexed</a></td>
<td>
'true', 'false', or 'unique'
<br />(No Default)
</td>
<td>
</td>
</tr>
<tr class="a">
<td>Field</td>
<td><a name="field-persistence-modifier">jpox.persistence-modifier</a></td>
<td>
'persistent', 'transactiona', or 'none'
<br />(No Default)
</td>
<td>
</td>
</tr>
<tr class="b">
<td>Field</td>
<td><a name="field-value-strategy">jpox.value-strategy</a></td>
<td>
'off', 'native', 'sequence', 'identity', 'increment', 'uuid-string',
'uuid-hex', 'datastore-uuid-hex', 'max', or 'auid'
<br />(Default: 'native')
</td>
<td>
</td>
</tr>
<tr class="a">
<td>Association</td>
<td><a name="association-dependent">jpox.dependent</a></td>
<td>
true or false
<br />(Default: true)
</td>
<td>
</td>
</tr>
<tr class="b">
<td>Association</td>
<td><a name="association-join">jpox.join</a></td>
<td>
true or false
<br />(Default: true)
</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<hr/>
<footer>
<div class="container">
<div class="row">
<p>Copyright &copy;2006&#x2013;2018
<a href="http://www.apache.org/">The Apache Software Foundation</a>.
All rights reserved.</p>
</div>
<p id="poweredBy" class="pull-right"> <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy"><img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /></a>
</p>
<div id="ohloh" class="pull-right">
<script type="text/javascript" src="https://www.ohloh.net/p/6670/widgets/project_thin_badge.js"></script>
</div>
</div>
</footer>
</body>
</html>