mirror of
https://github.com/berkeleydb/je.git
synced 2024-10-03 20:56:56 +00:00
570 lines
27 KiB
HTML
570 lines
27 KiB
HTML
|
<!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_151) on Tue Oct 31 17:36:46 EDT 2017 -->
|
||
|
|
<title>ClassMetadata (Oracle - Berkeley DB Java Edition API)</title>
|
||
|
|
<meta name="date" content="2017-10-31">
|
||
|
|
<link rel="stylesheet" type="text/css" href="../../../../style.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 (Oracle - Berkeley DB Java Edition API)";
|
||
|
|
}
|
||
|
|
}
|
||
|
|
catch(err) {
|
||
|
|
}
|
||
|
|
//-->
|
||
|
|
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10};
|
||
|
|
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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 class="aboutLanguage"><b>Berkeley DB Java Edition</b><br><font size=\"-1\"> version 7.5.11</font>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="subNav">
|
||
|
|
<ul class="navList">
|
||
|
|
<li><a href="../../../../com/sleepycat/persist/model/ClassEnhancerTask.html" title="class in com.sleepycat.persist.model"><span class="typeNameLink">Prev Class</span></a></li>
|
||
|
|
<li><a href="../../../../com/sleepycat/persist/model/DeleteAction.html" title="enum in com.sleepycat.persist.model"><span class="typeNameLink">Next Class</span></a></li>
|
||
|
|
</ul>
|
||
|
|
<ul class="navList">
|
||
|
|
<li><a href="../../../../index.html?com/sleepycat/persist/model/ClassMetadata.html" target="_top">Frames</a></li>
|
||
|
|
<li><a href="ClassMetadata.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><a href="#constructor.summary">Constr</a> | </li>
|
||
|
|
<li><a href="#method.summary">Method</a></li>
|
||
|
|
</ul>
|
||
|
|
<ul class="subNavList">
|
||
|
|
<li>Detail: </li>
|
||
|
|
<li>Field | </li>
|
||
|
|
<li><a href="#constructor.detail">Constr</a> | </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">com.sleepycat.persist.model</div>
|
||
|
|
<h2 title="Class ClassMetadata" class="title">Class ClassMetadata</h2>
|
||
|
|
</div>
|
||
|
|
<div class="contentContainer">
|
||
|
|
<ul class="inheritance">
|
||
|
|
<li>java.lang.Object</li>
|
||
|
|
<li>
|
||
|
|
<ul class="inheritance">
|
||
|
|
<li>com.sleepycat.persist.model.ClassMetadata</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<div class="description">
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<dl>
|
||
|
|
<dt>All Implemented Interfaces:</dt>
|
||
|
|
<dd>java.io.Serializable</dd>
|
||
|
|
</dl>
|
||
|
|
<hr>
|
||
|
|
<br>
|
||
|
|
<pre>public class <span class="typeNameLabel">ClassMetadata</span>
|
||
|
|
extends java.lang.Object
|
||
|
|
implements java.io.Serializable</pre>
|
||
|
|
<div class="block">The metadata for a persistent class. A persistent class may be specified
|
||
|
|
with the <a href="../../../../com/sleepycat/persist/model/Entity.html" title="annotation in com.sleepycat.persist.model"><code>Entity</code></a> or <a href="../../../../com/sleepycat/persist/model/Persistent.html" title="annotation in com.sleepycat.persist.model"><code>Persistent</code></a> annotation.
|
||
|
|
|
||
|
|
<p><code>ClassMetadata</code> objects are thread-safe. Multiple threads may
|
||
|
|
safely call the methods of a shared <code>ClassMetadata</code> object.</p>
|
||
|
|
|
||
|
|
<p>This and other metadata classes are classes rather than interfaces to
|
||
|
|
allow adding properties to the model at a future date without causing
|
||
|
|
incompatibilities. Any such property will be given a default value and
|
||
|
|
its use will be optional.</p></div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="simpleTagLabel">Author:</span></dt>
|
||
|
|
<dd>Mark Hayes</dd>
|
||
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
||
|
|
<dd><a href="../../../../serialized-form.html#com.sleepycat.persist.model.ClassMetadata">Serialized Form</a></dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<div class="summary">
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList"><a name="constructor.summary">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<h3>Constructor Summary</h3>
|
||
|
|
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
|
||
|
|
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
|
||
|
|
<tr>
|
||
|
|
<th class="colOne" scope="col">Constructor and Description</th>
|
||
|
|
</tr>
|
||
|
|
<tr class="altColor">
|
||
|
|
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/persist/model/ClassMetadata.html#ClassMetadata-java.lang.String-int-java.lang.String-boolean-com.sleepycat.persist.model.PrimaryKeyMetadata-java.util.Map-java.util.List-">ClassMetadata</a></span>(java.lang.String className,
|
||
|
|
int version,
|
||
|
|
java.lang.String proxiedClassName,
|
||
|
|
boolean entityClass,
|
||
|
|
<a href="../../../../com/sleepycat/persist/model/PrimaryKeyMetadata.html" title="class in com.sleepycat.persist.model">PrimaryKeyMetadata</a> primaryKey,
|
||
|
|
java.util.Map<java.lang.String,<a href="../../../../com/sleepycat/persist/model/SecondaryKeyMetadata.html" title="class in com.sleepycat.persist.model">SecondaryKeyMetadata</a>> secondaryKeys,
|
||
|
|
java.util.List<<a href="../../../../com/sleepycat/persist/model/FieldMetadata.html" title="class in com.sleepycat.persist.model">FieldMetadata</a>> compositeKeyFields)</code>
|
||
|
|
<div class="block">Used by an <code>EntityModel</code> to construct persistent class metadata.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="rowColor">
|
||
|
|
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/persist/model/ClassMetadata.html#ClassMetadata-java.lang.String-int-java.lang.String-boolean-com.sleepycat.persist.model.PrimaryKeyMetadata-java.util.Map-java.util.List-java.util.Collection-">ClassMetadata</a></span>(java.lang.String className,
|
||
|
|
int version,
|
||
|
|
java.lang.String proxiedClassName,
|
||
|
|
boolean entityClass,
|
||
|
|
<a href="../../../../com/sleepycat/persist/model/PrimaryKeyMetadata.html" title="class in com.sleepycat.persist.model">PrimaryKeyMetadata</a> primaryKey,
|
||
|
|
java.util.Map<java.lang.String,<a href="../../../../com/sleepycat/persist/model/SecondaryKeyMetadata.html" title="class in com.sleepycat.persist.model">SecondaryKeyMetadata</a>> secondaryKeys,
|
||
|
|
java.util.List<<a href="../../../../com/sleepycat/persist/model/FieldMetadata.html" title="class in com.sleepycat.persist.model">FieldMetadata</a>> compositeKeyFields,
|
||
|
|
java.util.Collection<<a href="../../../../com/sleepycat/persist/model/FieldMetadata.html" title="class in com.sleepycat.persist.model">FieldMetadata</a>> persistentFields)</code>
|
||
|
|
<div class="block">Used by an <code>EntityModel</code> to construct persistent class metadata.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<!-- ========== 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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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>boolean</code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/persist/model/ClassMetadata.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object other)</code> </td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i1" class="rowColor">
|
||
|
|
<td class="colFirst"><code>java.lang.String</code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/persist/model/ClassMetadata.html#getClassName--">getClassName</a></span>()</code>
|
||
|
|
<div class="block">Returns the name of the persistent class.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i2" class="altColor">
|
||
|
|
<td class="colFirst"><code>java.util.List<<a href="../../../../com/sleepycat/persist/model/FieldMetadata.html" title="class in com.sleepycat.persist.model">FieldMetadata</a>></code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/persist/model/ClassMetadata.html#getCompositeKeyFields--">getCompositeKeyFields</a></span>()</code>
|
||
|
|
<div class="block">Returns an unmodifiable list of metadata for the fields making up a
|
||
|
|
composite key, or null if this is a not a composite key class.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i3" class="rowColor">
|
||
|
|
<td class="colFirst"><code>java.util.Collection<<a href="../../../../com/sleepycat/persist/model/FieldMetadata.html" title="class in com.sleepycat.persist.model">FieldMetadata</a>></code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/persist/model/ClassMetadata.html#getPersistentFields--">getPersistentFields</a></span>()</code>
|
||
|
|
<div class="block">Returns an unmodifiable list of metadata for the persistent fields in
|
||
|
|
this class, or null if the default rules for persistent fields should be
|
||
|
|
used.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i4" class="altColor">
|
||
|
|
<td class="colFirst"><code><a href="../../../../com/sleepycat/persist/model/PrimaryKeyMetadata.html" title="class in com.sleepycat.persist.model">PrimaryKeyMetadata</a></code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/persist/model/ClassMetadata.html#getPrimaryKey--">getPrimaryKey</a></span>()</code>
|
||
|
|
<div class="block">Returns the primary key metadata for a key declared in this class, or
|
||
|
|
null if none is declared.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i5" class="rowColor">
|
||
|
|
<td class="colFirst"><code>java.lang.String</code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/persist/model/ClassMetadata.html#getProxiedClassName--">getProxiedClassName</a></span>()</code>
|
||
|
|
<div class="block">Returns the class name of the proxied class if this class is a <a href="../../../../com/sleepycat/persist/model/PersistentProxy.html" title="interface in com.sleepycat.persist.model"><code>PersistentProxy</code></a>, or null otherwise.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i6" class="altColor">
|
||
|
|
<td class="colFirst"><code>java.util.Map<java.lang.String,<a href="../../../../com/sleepycat/persist/model/SecondaryKeyMetadata.html" title="class in com.sleepycat.persist.model">SecondaryKeyMetadata</a>></code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/persist/model/ClassMetadata.html#getSecondaryKeys--">getSecondaryKeys</a></span>()</code>
|
||
|
|
<div class="block">Returns an unmodifiable map of key name (which may be different from
|
||
|
|
field name) to secondary key metadata for all secondary keys declared in
|
||
|
|
this class, or null if no secondary keys are declared in this class.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i7" class="rowColor">
|
||
|
|
<td class="colFirst"><code>int</code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/persist/model/ClassMetadata.html#getVersion--">getVersion</a></span>()</code>
|
||
|
|
<div class="block">Returns the version of this persistent class.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i8" class="altColor">
|
||
|
|
<td class="colFirst"><code>int</code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/persist/model/ClassMetadata.html#hashCode--">hashCode</a></span>()</code> </td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i9" class="rowColor">
|
||
|
|
<td class="colFirst"><code>boolean</code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/persist/model/ClassMetadata.html#isEntityClass--">isEntityClass</a></span>()</code>
|
||
|
|
<div class="block">Returns whether this class is an entity class.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<h3>Methods inherited from class java.lang.Object</h3>
|
||
|
|
<code>clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait</code></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<div class="details">
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList"><a name="constructor.detail">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<h3>Constructor Detail</h3>
|
||
|
|
<a name="ClassMetadata-java.lang.String-int-java.lang.String-boolean-com.sleepycat.persist.model.PrimaryKeyMetadata-java.util.Map-java.util.List-">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>ClassMetadata</h4>
|
||
|
|
<pre>public ClassMetadata(java.lang.String className,
|
||
|
|
int version,
|
||
|
|
java.lang.String proxiedClassName,
|
||
|
|
boolean entityClass,
|
||
|
|
<a href="../../../../com/sleepycat/persist/model/PrimaryKeyMetadata.html" title="class in com.sleepycat.persist.model">PrimaryKeyMetadata</a> primaryKey,
|
||
|
|
java.util.Map<java.lang.String,<a href="../../../../com/sleepycat/persist/model/SecondaryKeyMetadata.html" title="class in com.sleepycat.persist.model">SecondaryKeyMetadata</a>> secondaryKeys,
|
||
|
|
java.util.List<<a href="../../../../com/sleepycat/persist/model/FieldMetadata.html" title="class in com.sleepycat.persist.model">FieldMetadata</a>> compositeKeyFields)</pre>
|
||
|
|
<div class="block">Used by an <code>EntityModel</code> to construct persistent class metadata.
|
||
|
|
The optional <a href="../../../../com/sleepycat/persist/model/ClassMetadata.html#getPersistentFields--"><code>getPersistentFields()</code></a> property will be set to null.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
||
|
|
<dd><code>className</code> - the class name.</dd>
|
||
|
|
<dd><code>version</code> - the version.</dd>
|
||
|
|
<dd><code>proxiedClassName</code> - the proxied class name.</dd>
|
||
|
|
<dd><code>entityClass</code> - whether the class is an entity class.</dd>
|
||
|
|
<dd><code>primaryKey</code> - the primary key metadata.</dd>
|
||
|
|
<dd><code>secondaryKeys</code> - the secondary key metadata.</dd>
|
||
|
|
<dd><code>compositeKeyFields</code> - the composite key field metadata.</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="ClassMetadata-java.lang.String-int-java.lang.String-boolean-com.sleepycat.persist.model.PrimaryKeyMetadata-java.util.Map-java.util.List-java.util.Collection-">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockListLast">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>ClassMetadata</h4>
|
||
|
|
<pre>public ClassMetadata(java.lang.String className,
|
||
|
|
int version,
|
||
|
|
java.lang.String proxiedClassName,
|
||
|
|
boolean entityClass,
|
||
|
|
<a href="../../../../com/sleepycat/persist/model/PrimaryKeyMetadata.html" title="class in com.sleepycat.persist.model">PrimaryKeyMetadata</a> primaryKey,
|
||
|
|
java.util.Map<java.lang.String,<a href="../../../../com/sleepycat/persist/model/SecondaryKeyMetadata.html" title="class in com.sleepycat.persist.model">SecondaryKeyMetadata</a>> secondaryKeys,
|
||
|
|
java.util.List<<a href="../../../../com/sleepycat/persist/model/FieldMetadata.html" title="class in com.sleepycat.persist.model">FieldMetadata</a>> compositeKeyFields,
|
||
|
|
java.util.Collection<<a href="../../../../com/sleepycat/persist/model/FieldMetadata.html" title="class in com.sleepycat.persist.model">FieldMetadata</a>> persistentFields)</pre>
|
||
|
|
<div class="block">Used by an <code>EntityModel</code> to construct persistent class metadata.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
||
|
|
<dd><code>className</code> - the class name.</dd>
|
||
|
|
<dd><code>version</code> - the version.</dd>
|
||
|
|
<dd><code>proxiedClassName</code> - the proxied class name.</dd>
|
||
|
|
<dd><code>entityClass</code> - whether the class is an entity class.</dd>
|
||
|
|
<dd><code>primaryKey</code> - the primary key metadata.</dd>
|
||
|
|
<dd><code>secondaryKeys</code> - the secondary key metadata.</dd>
|
||
|
|
<dd><code>compositeKeyFields</code> - the composite key field metadata.</dd>
|
||
|
|
<dd><code>persistentFields</code> - the persistent field metadata.</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<!-- ============ METHOD DETAIL ========== -->
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList"><a name="method.detail">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<h3>Method Detail</h3>
|
||
|
|
<a name="getClassName--">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>getClassName</h4>
|
||
|
|
<pre>public java.lang.String getClassName()</pre>
|
||
|
|
<div class="block">Returns the name of the persistent class.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>the name of the persistent class.</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="getVersion--">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>getVersion</h4>
|
||
|
|
<pre>public int getVersion()</pre>
|
||
|
|
<div class="block">Returns the version of this persistent class. This may be specified
|
||
|
|
using the <a href="../../../../com/sleepycat/persist/model/Entity.html#version--"><code>Entity.version()</code></a> or <a href="../../../../com/sleepycat/persist/model/Persistent.html#version--"><code>Persistent.version()</code></a>
|
||
|
|
annotation.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>the version of this persistent class.</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="getProxiedClassName--">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>getProxiedClassName</h4>
|
||
|
|
<pre>public java.lang.String getProxiedClassName()</pre>
|
||
|
|
<div class="block">Returns the class name of the proxied class if this class is a <a href="../../../../com/sleepycat/persist/model/PersistentProxy.html" title="interface in com.sleepycat.persist.model"><code>PersistentProxy</code></a>, or null otherwise.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>the class name of the proxied class, or null.</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="isEntityClass--">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>isEntityClass</h4>
|
||
|
|
<pre>public boolean isEntityClass()</pre>
|
||
|
|
<div class="block">Returns whether this class is an entity class.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>whether this class is an entity class.</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="getPrimaryKey--">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>getPrimaryKey</h4>
|
||
|
|
<pre>public <a href="../../../../com/sleepycat/persist/model/PrimaryKeyMetadata.html" title="class in com.sleepycat.persist.model">PrimaryKeyMetadata</a> getPrimaryKey()</pre>
|
||
|
|
<div class="block">Returns the primary key metadata for a key declared in this class, or
|
||
|
|
null if none is declared. This may be specified using the <a href="../../../../com/sleepycat/persist/model/PrimaryKey.html" title="annotation in com.sleepycat.persist.model"><code>PrimaryKey</code></a> annotation.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>the primary key metadata, or null.</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="getSecondaryKeys--">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>getSecondaryKeys</h4>
|
||
|
|
<pre>public java.util.Map<java.lang.String,<a href="../../../../com/sleepycat/persist/model/SecondaryKeyMetadata.html" title="class in com.sleepycat.persist.model">SecondaryKeyMetadata</a>> getSecondaryKeys()</pre>
|
||
|
|
<div class="block">Returns an unmodifiable map of key name (which may be different from
|
||
|
|
field name) to secondary key metadata for all secondary keys declared in
|
||
|
|
this class, or null if no secondary keys are declared in this class.
|
||
|
|
This metadata may be specified using <a href="../../../../com/sleepycat/persist/model/SecondaryKey.html" title="annotation in com.sleepycat.persist.model"><code>SecondaryKey</code></a> annotations.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>the unmodifiable map, or null.</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="getCompositeKeyFields--">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>getCompositeKeyFields</h4>
|
||
|
|
<pre>public java.util.List<<a href="../../../../com/sleepycat/persist/model/FieldMetadata.html" title="class in com.sleepycat.persist.model">FieldMetadata</a>> getCompositeKeyFields()</pre>
|
||
|
|
<div class="block">Returns an unmodifiable list of metadata for the fields making up a
|
||
|
|
composite key, or null if this is a not a composite key class. The
|
||
|
|
order of the fields in the returned list determines their stored order
|
||
|
|
and may be specified using the <a href="../../../../com/sleepycat/persist/model/KeyField.html" title="annotation in com.sleepycat.persist.model"><code>KeyField</code></a> annotation. When the
|
||
|
|
composite key class does not implement <code>Comparable</code>, the order of
|
||
|
|
the fields is the relative sort order.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>the unmodifiable list, or null.</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="getPersistentFields--">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>getPersistentFields</h4>
|
||
|
|
<pre>public java.util.Collection<<a href="../../../../com/sleepycat/persist/model/FieldMetadata.html" title="class in com.sleepycat.persist.model">FieldMetadata</a>> getPersistentFields()</pre>
|
||
|
|
<div class="block">Returns an unmodifiable list of metadata for the persistent fields in
|
||
|
|
this class, or null if the default rules for persistent fields should be
|
||
|
|
used. All fields returned must be declared in this class and must be
|
||
|
|
non-static.
|
||
|
|
|
||
|
|
<p>By default (if null is returned) the persistent fields of a class
|
||
|
|
will be all declared instance fields that are non-transient (are not
|
||
|
|
declared with the <code>transient</code> keyword). The default rules
|
||
|
|
may be overridden by an <a href="../../../../com/sleepycat/persist/model/EntityModel.html" title="class in com.sleepycat.persist.model"><code>EntityModel</code></a>. For example, the <a href="../../../../com/sleepycat/persist/model/AnnotationModel.html" title="class in com.sleepycat.persist.model"><code>AnnotationModel</code></a> overrides the default rules when the <a href="../../../../com/sleepycat/persist/model/NotPersistent.html" title="annotation in com.sleepycat.persist.model"><code>NotPersistent</code></a> or <a href="../../../../com/sleepycat/persist/model/NotTransient.html" title="annotation in com.sleepycat.persist.model"><code>NotTransient</code></a> annotation is specified.</p></div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>the unmodifiable list, or null.</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="equals-java.lang.Object-">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>equals</h4>
|
||
|
|
<pre>public boolean equals(java.lang.Object other)</pre>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
|
||
|
|
<dd><code>equals</code> in class <code>java.lang.Object</code></dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="hashCode--">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockListLast">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>hashCode</h4>
|
||
|
|
<pre>public int hashCode()</pre>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
|
||
|
|
<dd><code>hashCode</code> in class <code>java.lang.Object</code></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 class="aboutLanguage"><b>Berkeley DB Java Edition</b><br><font size=\"-1\"> version 7.5.11</font>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="subNav">
|
||
|
|
<ul class="navList">
|
||
|
|
<li><a href="../../../../com/sleepycat/persist/model/ClassEnhancerTask.html" title="class in com.sleepycat.persist.model"><span class="typeNameLink">Prev Class</span></a></li>
|
||
|
|
<li><a href="../../../../com/sleepycat/persist/model/DeleteAction.html" title="enum in com.sleepycat.persist.model"><span class="typeNameLink">Next Class</span></a></li>
|
||
|
|
</ul>
|
||
|
|
<ul class="navList">
|
||
|
|
<li><a href="../../../../index.html?com/sleepycat/persist/model/ClassMetadata.html" target="_top">Frames</a></li>
|
||
|
|
<li><a href="ClassMetadata.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><a href="#constructor.summary">Constr</a> | </li>
|
||
|
|
<li><a href="#method.summary">Method</a></li>
|
||
|
|
</ul>
|
||
|
|
<ul class="subNavList">
|
||
|
|
<li>Detail: </li>
|
||
|
|
<li>Field | </li>
|
||
|
|
<li><a href="#constructor.detail">Constr</a> | </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><font size=1>Copyright (c) 2002, 2017 Oracle and/or its affiliates. All rights reserved.</font> </small></p>
|
||
|
|
</body>
|
||
|
|
</html>
|