| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (version 1.7.0_75) on Wed Mar 11 20:01:52 CET 2015 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>EmbeddedMetadata (JDO API ${pom.currentVersion})</title> |
| <meta name="date" content="2015-03-11"> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="EmbeddedMetadata (JDO API ${pom.currentVersion})"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/EmbeddedMetadata.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../index-all.html">Index</a></li> |
| <li><a href="../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../javax/jdo/metadata/ElementMetadata.html" title="interface in javax.jdo.metadata"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../javax/jdo/metadata/ExtensionMetadata.html" title="interface in javax.jdo.metadata"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?javax/jdo/metadata/EmbeddedMetadata.html" target="_top">Frames</a></li> |
| <li><a href="EmbeddedMetadata.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">javax.jdo.metadata</div> |
| <h2 title="Interface EmbeddedMetadata" class="title">Interface EmbeddedMetadata</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="../../../javax/jdo/metadata/Metadata.html" title="interface in javax.jdo.metadata">Metadata</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">EmbeddedMetadata</span> |
| extends <a href="../../../javax/jdo/metadata/Metadata.html" title="interface in javax.jdo.metadata">Metadata</a></pre> |
| <div class="block">Represents embedding details of a field/property in a class.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>3.0</dd></dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../javax/jdo/metadata/DiscriminatorMetadata.html" title="interface in javax.jdo.metadata">DiscriminatorMetadata</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../javax/jdo/metadata/EmbeddedMetadata.html#getDiscriminatorMetadata()">getDiscriminatorMetadata</a></strong>()</code> |
| <div class="block">Accessor for the discriminator metadata when handling inherited objects.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../javax/jdo/metadata/MemberMetadata.html" title="interface in javax.jdo.metadata">MemberMetadata</a>[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../javax/jdo/metadata/EmbeddedMetadata.html#getMembers()">getMembers</a></strong>()</code> |
| <div class="block">Accessor for all fields/properties defined on the fetch group.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../javax/jdo/metadata/EmbeddedMetadata.html#getNullIndicatorColumn()">getNullIndicatorColumn</a></strong>()</code> |
| <div class="block">Accessor for any column indicating a null embedded object</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../javax/jdo/metadata/EmbeddedMetadata.html#getNullIndicatorValue()">getNullIndicatorValue</a></strong>()</code> |
| <div class="block">Accessor for a null indicator value</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../javax/jdo/metadata/EmbeddedMetadata.html#getNumberOfMembers()">getNumberOfMembers</a></strong>()</code> |
| <div class="block">Accessor for the number of fields/properties defined for embedding</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../javax/jdo/metadata/EmbeddedMetadata.html#getOwnerMember()">getOwnerMember</a></strong>()</code> |
| <div class="block">Accessor for the owner field/property name.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../javax/jdo/metadata/DiscriminatorMetadata.html" title="interface in javax.jdo.metadata">DiscriminatorMetadata</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../javax/jdo/metadata/EmbeddedMetadata.html#newDiscriminatorMetadata()">newDiscriminatorMetadata</a></strong>()</code> |
| <div class="block">Method to define the new discriminator metadata for handling inherited embedded objects.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../javax/jdo/metadata/FieldMetadata.html" title="interface in javax.jdo.metadata">FieldMetadata</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../javax/jdo/metadata/EmbeddedMetadata.html#newFieldMetadata(java.lang.String)">newFieldMetadata</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> |
| <div class="block">Add a new field to be embedded.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../javax/jdo/metadata/PropertyMetadata.html" title="interface in javax.jdo.metadata">PropertyMetadata</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../javax/jdo/metadata/EmbeddedMetadata.html#newPropertyMetadata(java.lang.String)">newPropertyMetadata</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> |
| <div class="block">Add a new property for embedding</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../javax/jdo/metadata/EmbeddedMetadata.html" title="interface in javax.jdo.metadata">EmbeddedMetadata</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../javax/jdo/metadata/EmbeddedMetadata.html#setNullIndicatorColumn(java.lang.String)">setNullIndicatorColumn</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> col)</code> |
| <div class="block">Method to set any column that indicates a null embedded object</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../javax/jdo/metadata/EmbeddedMetadata.html" title="interface in javax.jdo.metadata">EmbeddedMetadata</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../javax/jdo/metadata/EmbeddedMetadata.html#setNullIndicatorValue(java.lang.String)">setNullIndicatorValue</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> val)</code> |
| <div class="block">Method to set the value of a null indicator column to signify null object</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../javax/jdo/metadata/EmbeddedMetadata.html" title="interface in javax.jdo.metadata">EmbeddedMetadata</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../javax/jdo/metadata/EmbeddedMetadata.html#setOwnerMember(java.lang.String)">setOwnerMember</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> member)</code> |
| <div class="block">Method to set the name of the owner field/property.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_javax.jdo.metadata.Metadata"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface javax.jdo.metadata.<a href="../../../javax/jdo/metadata/Metadata.html" title="interface in javax.jdo.metadata">Metadata</a></h3> |
| <code><a href="../../../javax/jdo/metadata/Metadata.html#getExtensions()">getExtensions</a>, <a href="../../../javax/jdo/metadata/Metadata.html#getNumberOfExtensions()">getNumberOfExtensions</a>, <a href="../../../javax/jdo/metadata/Metadata.html#getParent()">getParent</a>, <a href="../../../javax/jdo/metadata/Metadata.html#newExtensionMetadata(java.lang.String,%20java.lang.String,%20java.lang.String)">newExtensionMetadata</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="setOwnerMember(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setOwnerMember</h4> |
| <pre><a href="../../../javax/jdo/metadata/EmbeddedMetadata.html" title="interface in javax.jdo.metadata">EmbeddedMetadata</a> setOwnerMember(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> member)</pre> |
| <div class="block">Method to set the name of the owner field/property.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>member</code> - Name of the owner member</dd></dl> |
| </li> |
| </ul> |
| <a name="getOwnerMember()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOwnerMember</h4> |
| <pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getOwnerMember()</pre> |
| <div class="block">Accessor for the owner field/property name.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>The owner member name</dd></dl> |
| </li> |
| </ul> |
| <a name="setNullIndicatorColumn(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setNullIndicatorColumn</h4> |
| <pre><a href="../../../javax/jdo/metadata/EmbeddedMetadata.html" title="interface in javax.jdo.metadata">EmbeddedMetadata</a> setNullIndicatorColumn(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> col)</pre> |
| <div class="block">Method to set any column that indicates a null embedded object</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>col</code> - Null indicator column</dd></dl> |
| </li> |
| </ul> |
| <a name="getNullIndicatorColumn()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNullIndicatorColumn</h4> |
| <pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getNullIndicatorColumn()</pre> |
| <div class="block">Accessor for any column indicating a null embedded object</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>Whether to call post-load</dd></dl> |
| </li> |
| </ul> |
| <a name="setNullIndicatorValue(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setNullIndicatorValue</h4> |
| <pre><a href="../../../javax/jdo/metadata/EmbeddedMetadata.html" title="interface in javax.jdo.metadata">EmbeddedMetadata</a> setNullIndicatorValue(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> val)</pre> |
| <div class="block">Method to set the value of a null indicator column to signify null object</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>val</code> - Null indicator value</dd></dl> |
| </li> |
| </ul> |
| <a name="getNullIndicatorValue()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNullIndicatorValue</h4> |
| <pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getNullIndicatorValue()</pre> |
| <div class="block">Accessor for a null indicator value</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>Null indicator value</dd></dl> |
| </li> |
| </ul> |
| <a name="getMembers()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMembers</h4> |
| <pre><a href="../../../javax/jdo/metadata/MemberMetadata.html" title="interface in javax.jdo.metadata">MemberMetadata</a>[] getMembers()</pre> |
| <div class="block">Accessor for all fields/properties defined on the fetch group.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>The members</dd></dl> |
| </li> |
| </ul> |
| <a name="getNumberOfMembers()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNumberOfMembers</h4> |
| <pre>int getNumberOfMembers()</pre> |
| <div class="block">Accessor for the number of fields/properties defined for embedding</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>The number of members</dd></dl> |
| </li> |
| </ul> |
| <a name="newFieldMetadata(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newFieldMetadata</h4> |
| <pre><a href="../../../javax/jdo/metadata/FieldMetadata.html" title="interface in javax.jdo.metadata">FieldMetadata</a> newFieldMetadata(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> |
| <div class="block">Add a new field to be embedded.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - Name of the field</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>The FieldMetadata</dd></dl> |
| </li> |
| </ul> |
| <a name="newPropertyMetadata(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newPropertyMetadata</h4> |
| <pre><a href="../../../javax/jdo/metadata/PropertyMetadata.html" title="interface in javax.jdo.metadata">PropertyMetadata</a> newPropertyMetadata(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> |
| <div class="block">Add a new property for embedding</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - Name of the property</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>The PropertyMetadata</dd></dl> |
| </li> |
| </ul> |
| <a name="getDiscriminatorMetadata()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDiscriminatorMetadata</h4> |
| <pre><a href="../../../javax/jdo/metadata/DiscriminatorMetadata.html" title="interface in javax.jdo.metadata">DiscriminatorMetadata</a> getDiscriminatorMetadata()</pre> |
| <div class="block">Accessor for the discriminator metadata when handling inherited objects.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>Discriminator details</dd></dl> |
| </li> |
| </ul> |
| <a name="newDiscriminatorMetadata()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>newDiscriminatorMetadata</h4> |
| <pre><a href="../../../javax/jdo/metadata/DiscriminatorMetadata.html" title="interface in javax.jdo.metadata">DiscriminatorMetadata</a> newDiscriminatorMetadata()</pre> |
| <div class="block">Method to define the new discriminator metadata for handling inherited embedded objects.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>Discriminator metadata</dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/EmbeddedMetadata.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../index-all.html">Index</a></li> |
| <li><a href="../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../javax/jdo/metadata/ElementMetadata.html" title="interface in javax.jdo.metadata"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../javax/jdo/metadata/ExtensionMetadata.html" title="interface in javax.jdo.metadata"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?javax/jdo/metadata/EmbeddedMetadata.html" target="_top">Frames</a></li> |
| <li><a href="EmbeddedMetadata.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2005–2015 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
