blob: cbe7ba19c54bf83bebb8313ab942800a2be65c60 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_60) on Sat Jan 11 18:35:16 CET 2020 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ClassMetadata (JDO API 3.1)</title>
<meta name="date" content="2020-01-11">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ClassMetadata (JDO API 3.1)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<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/ClassMetadata.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/ArrayMetadata.html" title="interface in javax.jdo.metadata"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../javax/jdo/metadata/ClassPersistenceModifier.html" title="enum in javax.jdo.metadata"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?javax/jdo/metadata/ClassMetadata.html" target="_top">Frames</a></li>
<li><a href="ClassMetadata.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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 ClassMetadata" class="title">Interface ClassMetadata</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>, <a href="../../../javax/jdo/metadata/TypeMetadata.html" title="interface in javax.jdo.metadata">TypeMetadata</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">ClassMetadata</span>
extends <a href="../../../javax/jdo/metadata/TypeMetadata.html" title="interface in javax.jdo.metadata">TypeMetadata</a></pre>
<div class="block">Represents a class.</div>
<dl>
<dt><span class="simpleTagLabel">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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../javax/jdo/metadata/ClassPersistenceModifier.html" title="enum in javax.jdo.metadata">ClassPersistenceModifier</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/jdo/metadata/ClassMetadata.html#getPersistenceModifier--">getPersistenceModifier</a></span>()</code>
<div class="block">Accessor for the persistence modifier.</div>
</td>
</tr>
<tr id="i1" 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><span class="memberNameLink"><a href="../../../javax/jdo/metadata/ClassMetadata.html#newFieldMetadata-java.lang.reflect.Field-">newFieldMetadata</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/reflect/Field.html?is-external=true" title="class or interface in java.lang.reflect">Field</a>&nbsp;fld)</code>
<div class="block">Add a new field to this class.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<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><span class="memberNameLink"><a href="../../../javax/jdo/metadata/ClassMetadata.html#newFieldMetadata-java.lang.String-">newFieldMetadata</a></span>(<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>&nbsp;name)</code>
<div class="block">Add a new field to this class.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../javax/jdo/metadata/ClassMetadata.html" title="interface in javax.jdo.metadata">ClassMetadata</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/jdo/metadata/ClassMetadata.html#setPersistenceModifier-javax.jdo.metadata.ClassPersistenceModifier-">setPersistenceModifier</a></span>(<a href="../../../javax/jdo/metadata/ClassPersistenceModifier.html" title="enum in javax.jdo.metadata">ClassPersistenceModifier</a>&nbsp;mod)</code>
<div class="block">Method to define the persistence modifier.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.javax.jdo.metadata.TypeMetadata">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;javax.jdo.metadata.<a href="../../../javax/jdo/metadata/TypeMetadata.html" title="interface in javax.jdo.metadata">TypeMetadata</a></h3>
<code><a href="../../../javax/jdo/metadata/TypeMetadata.html#getCacheable--">getCacheable</a>, <a href="../../../javax/jdo/metadata/TypeMetadata.html#getCatalog--">getCatalog</a>, <a href="../../../javax/jdo/metadata/TypeMetadata.html#getColumns--">getColumns</a>, <a href="../../../javax/jdo/metadata/TypeMetadata.html#getDatastoreIdentityMetadata--">getDatastoreIdentityMetadata</a>, <a href="../../../javax/jdo/metadata/TypeMetadata.html#getDetachable--">getDetachable</a>, <a href="../../../javax/jdo/metadata/TypeMetadata.html#getEmbeddedOnly--">getEmbeddedOnly</a>, <a href="../../../javax/jdo/metadata/TypeMetadata.html#getFetchGroups--">getFetchGroups</a>, <a href="../../../javax/jdo/metadata/TypeMetadata.html#getForeignKeys--">getForeignKeys</a>, <a href="../../../javax/jdo/metadata/TypeMetadata.html#getIdentityType--">getIdentityType</a>, <a href="../../../javax/jdo/metadata/TypeMetadata.html#getIndices--">getIndices</a>, <a href="../../../javax/jdo/metadata/TypeMetadata.html#getInheritanceMetadata--">getInheritanceMetadata</a>, <a href="../../../javax/jdo/metadata/TypeMetadata.html#getJoins--">getJoins</a>, <a href="../../../javax/jdo/metadata/TypeMetadata.html#getMembers--">getMembers</a>, <a href="../../../javax/jdo/metadata/TypeMetadata.html#getName--">getName</a>, <a href="../../../javax/jdo/metadata/TypeMetadata.html#getNumberOfColumns--">getNumberOfColumns</a>, <a href="../../../javax/jdo/metadata/TypeMetadata.html#getNumberOfFetchGroups--">getNumberOfFetchGroups</a>, <a href="../../../javax/jdo/metadata/TypeMetadata.html#getNumberOfForeignKeys--">getNumberOfForeignKeys</a>, <a href="../../../javax/jdo/metadata/TypeMetadata.html#getNumberOfIndices--">getNumberOfIndices</a>, <a href="../../../javax/jdo/metadata/TypeMetadata.html#getNumberOfJoins--">getNumberOfJoins</a>, <a href="../../../javax/jdo/metadata/TypeMetadata.html#getNumberOfMembers--">getNumberOfMembers</a>, <a href="../../../javax/jdo/metadata/TypeMetadata.html#getNumberOfQueries--">getNumberOfQueries</a>, <a href="../../../javax/jdo/metadata/TypeMetadata.html#getNumberOfUniques--">getNumberOfUniques</a>, <a href="../../../javax/jdo/metadata/TypeMetadata.html#getObjectIdClass--">getObjectIdClass</a>, <a href="../../../javax/jdo/metadata/TypeMetadata.html#getPrimaryKeyMetadata--">getPrimaryKeyMetadata</a>, <a href="../../../javax/jdo/metadata/TypeMetadata.html#getQueries--">getQueries</a>, <a href="../../../javax/jdo/metadata/TypeMetadata.html#getRequiresExtent--">getRequiresExtent</a>, <a href="../../../javax/jdo/metadata/TypeMetadata.html#getSchema--">getSchema</a>, <a href="../../../javax/jdo/metadata/TypeMetadata.html#getSerializeRead--">getSerializeRead</a>, <a href="../../../javax/jdo/metadata/TypeMetadata.html#getTable--">getTable</a>, <a href="../../../javax/jdo/metadata/TypeMetadata.html#getUniques--">getUniques</a>, <a href="../../../javax/jdo/metadata/TypeMetadata.html#getVersionMetadata--">getVersionMetadata</a>, <a href="../../../javax/jdo/metadata/TypeMetadata.html#newColumnMetadata--">newColumnMetadata</a>, <a href="../../../javax/jdo/metadata/TypeMetadata.html#newDatastoreIdentityMetadata--">newDatastoreIdentityMetadata</a>, <a href="../../../javax/jdo/metadata/TypeMetadata.html#newFetchGroupMetadata-java.lang.String-">newFetchGroupMetadata</a>, <a href="../../../javax/jdo/metadata/TypeMetadata.html#newForeignKeyMetadata--">newForeignKeyMetadata</a>, <a href="../../../javax/jdo/metadata/TypeMetadata.html#newIndexMetadata--">newIndexMetadata</a>, <a href="../../../javax/jdo/metadata/TypeMetadata.html#newInheritanceMetadata--">newInheritanceMetadata</a>, <a href="../../../javax/jdo/metadata/TypeMetadata.html#newJoinMetadata--">newJoinMetadata</a>, <a href="../../../javax/jdo/metadata/TypeMetadata.html#newPrimaryKeyMetadata--">newPrimaryKeyMetadata</a>, <a href="../../../javax/jdo/metadata/TypeMetadata.html#newPropertyMetadata-java.lang.reflect.Method-">newPropertyMetadata</a>, <a href="../../../javax/jdo/metadata/TypeMetadata.html#newPropertyMetadata-java.lang.String-">newPropertyMetadata</a>, <a href="../../../javax/jdo/metadata/TypeMetadata.html#newQueryMetadata-java.lang.String-">newQueryMetadata</a>, <a href="../../../javax/jdo/metadata/TypeMetadata.html#newUniqueMetadata--">newUniqueMetadata</a>, <a href="../../../javax/jdo/metadata/TypeMetadata.html#newVersionMetadata--">newVersionMetadata</a>, <a href="../../../javax/jdo/metadata/TypeMetadata.html#setCacheable-boolean-">setCacheable</a>, <a href="../../../javax/jdo/metadata/TypeMetadata.html#setCatalog-java.lang.String-">setCatalog</a>, <a href="../../../javax/jdo/metadata/TypeMetadata.html#setDetachable-boolean-">setDetachable</a>, <a href="../../../javax/jdo/metadata/TypeMetadata.html#setEmbeddedOnly-boolean-">setEmbeddedOnly</a>, <a href="../../../javax/jdo/metadata/TypeMetadata.html#setIdentityType-javax.jdo.annotations.IdentityType-">setIdentityType</a>, <a href="../../../javax/jdo/metadata/TypeMetadata.html#setObjectIdClass-java.lang.String-">setObjectIdClass</a>, <a href="../../../javax/jdo/metadata/TypeMetadata.html#setRequiresExtent-boolean-">setRequiresExtent</a>, <a href="../../../javax/jdo/metadata/TypeMetadata.html#setSchema-java.lang.String-">setSchema</a>, <a href="../../../javax/jdo/metadata/TypeMetadata.html#setSerializeRead-boolean-">setSerializeRead</a>, <a href="../../../javax/jdo/metadata/TypeMetadata.html#setTable-java.lang.String-">setTable</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.javax.jdo.metadata.Metadata">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;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-java.lang.String-java.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="setPersistenceModifier-javax.jdo.metadata.ClassPersistenceModifier-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPersistenceModifier</h4>
<pre><a href="../../../javax/jdo/metadata/ClassMetadata.html" title="interface in javax.jdo.metadata">ClassMetadata</a>&nbsp;setPersistenceModifier(<a href="../../../javax/jdo/metadata/ClassPersistenceModifier.html" title="enum in javax.jdo.metadata">ClassPersistenceModifier</a>&nbsp;mod)</pre>
<div class="block">Method to define the persistence modifier.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>mod</code> - persistence modifier</dd>
</dl>
</li>
</ul>
<a name="getPersistenceModifier--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPersistenceModifier</h4>
<pre><a href="../../../javax/jdo/metadata/ClassPersistenceModifier.html" title="enum in javax.jdo.metadata">ClassPersistenceModifier</a>&nbsp;getPersistenceModifier()</pre>
<div class="block">Accessor for the persistence modifier.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>persistence modifier</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>&nbsp;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>&nbsp;name)</pre>
<div class="block">Add a new field to this class.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - Name of the field</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The FieldMetadata</dd>
</dl>
</li>
</ul>
<a name="newFieldMetadata-java.lang.reflect.Field-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>newFieldMetadata</h4>
<pre><a href="../../../javax/jdo/metadata/FieldMetadata.html" title="interface in javax.jdo.metadata">FieldMetadata</a>&nbsp;newFieldMetadata(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/reflect/Field.html?is-external=true" title="class or interface in java.lang.reflect">Field</a>&nbsp;fld)</pre>
<div class="block">Add a new field to this class.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fld</code> - The field</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The FieldMetadata</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>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<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/ClassMetadata.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/ArrayMetadata.html" title="interface in javax.jdo.metadata"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../javax/jdo/metadata/ClassPersistenceModifier.html" title="enum in javax.jdo.metadata"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?javax/jdo/metadata/ClassMetadata.html" target="_top">Frames</a></li>
<li><a href="ClassMetadata.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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 &#169; 2005&#x2013;2020 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>