<!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 (version 1.7.0_75) on Fri May 13 13:32:18 PDT 2016 -->
<title>KeyField (Oracle - Berkeley DB Java API)</title>
<meta name="date" content="2016-05-13">
<link rel="stylesheet" type="text/css" href="../../../../style.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="KeyField (Oracle - Berkeley DB Java API)";
}
//-->
</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/KeyField.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"><em><b>Berkeley DB</b><br><font size="-1"> version 6.1.29</font></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/sleepycat/persist/model/FieldMetadata.html" title="class in com.sleepycat.persist.model"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../com/sleepycat/persist/model/ModelInternal.html" title="class in com.sleepycat.persist.model"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/sleepycat/persist/model/KeyField.html" target="_top">Frames</a></li>
<li><a href="KeyField.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><a href="#annotation_type_required_element_summary">Required</a> | </li>
<li>Optional</li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#annotation_type_element_detail">Element</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="Annotation Type KeyField" class="title">Annotation Type KeyField</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>@Documented
@Retention(value=RUNTIME)
@Target(value=FIELD)
public @interface <span class="strong">KeyField</span></pre>
<div class="block">Indicates the sorting position of a key field in a composite key class when
the <code>Comparable</code> interface is not implemented. The <code>KeyField</code>
integer value specifies the sort order of this field within the set of
fields in the composite key.
<p>If the field type of a <a href="../../../../com/sleepycat/persist/model/PrimaryKey.html" title="annotation in com.sleepycat.persist.model"><code>PrimaryKey</code></a> or <a href="../../../../com/sleepycat/persist/model/SecondaryKey.html" title="annotation in com.sleepycat.persist.model"><code>SecondaryKey</code></a> is a
composite key class containing more than one key field, then a <code>KeyField</code> annotation must be present on each non-transient instance field of
the composite key class. The <code>KeyField</code> value must be a number
between one and the number of non-transient instance fields declared in the
composite key class.</p>
<p>Note that a composite key class is a flat container for one or more
simple type fields. All non-transient instance fields in the composite key
class are key fields, and its superclass must be <code>Object</code>.</p>
<p>For example:</p>
<pre class="code">
@Entity
class Animal {
@PrimaryKey
Classification classification;
...
}
@Persistent
class Classification {
@KeyField(1) String kingdom;
@KeyField(2) String phylum;
@KeyField(3) String clazz;
@KeyField(4) String order;
@KeyField(5) String family;
@KeyField(6) String genus;
@KeyField(7) String species;
@KeyField(8) String subspecies;
...
}</pre>
<p>This causes entities to be sorted first by <code>kingdom</code>, then by
<code>phylum</code> within <code>kingdom</code>, and so on.</p>
<p>The fields in a composite key class may not be null.</p>
<p><a name="comparable"><strong>Custom Sort Order</strong></a></p>
<p>To override the default sort order, a composite key class may implement
the <code>Comparable</code> interface. This allows overriding the sort order and
is therefore useful even when there is only one key field in the composite
key class. For example, the following class sorts Strings using a Canadian
collator:</p>
<pre class="code">
import java.text.Collator;
import java.util.Locale;
@Entity
class Animal {
...
@SecondaryKey(relate=ONE_TO_ONE)
CollatedString canadianName;
...
}
@Persistent
class CollatedString implements Comparable<CollatedString> {
static Collator collator = Collator.getInstance(Locale.CANADA);
@KeyField(1)
String value;
CollatedString(String value) { this.value = value; }
private CollatedString() {}
public int compareTo(CollatedString o) {
return collator.compare(value, o.value);
}
}</pre>
<p>Several important rules should be considered when implementing a custom
comparison method. Failure to follow these rules may result in the primary
or secondary index becoming unusable; in other words, the store will not be
able to function.</p>
<ol>
<li>The comparison method must always return the same result, given the same
inputs. The behavior of the comparison method must not change over
time.</li>
<br>
<li>A corollary to the first rule is that the behavior of the comparison
method must not be dependent on state which may change over time. For
example, if the above collation method used the default Java locale, and the
default locale is changed, then the sort order will change.</li>
<br>
<li>The comparison method must not assume that it is called after the store
has been opened. With Berkeley DB Java Edition, the comparison method is
called during database recovery, which occurs in the <a href="../../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><code>Environment</code></a>
constructor.</li>
<br>
<li>The comparison method must not assume that it will only be called with
keys that are currently present in the database. The comparison method will
occasionally be called with deleted keys or with keys for records that were
not part of a committed transaction.</li>
</ol></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="annotation_type_required_element_summary">
<!-- -->
</a>
<h3>Required Element Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Required Element Summary table, listing required elements, and an explanation">
<caption><span>Required Elements</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Required Element and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../com/sleepycat/persist/model/KeyField.html#value()">value</a></strong></code> </td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="annotation_type_element_detail">
<!-- -->
</a>
<h3>Element Detail</h3>
<a name="value()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>value</h4>
<pre>public abstract int value</pre>
</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/KeyField.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"><em><b>Berkeley DB</b><br><font size="-1"> version 6.1.29</font></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/sleepycat/persist/model/FieldMetadata.html" title="class in com.sleepycat.persist.model"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../com/sleepycat/persist/model/ModelInternal.html" title="class in com.sleepycat.persist.model"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/sleepycat/persist/model/KeyField.html" target="_top">Frames</a></li>
<li><a href="KeyField.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><a href="#annotation_type_required_element_summary">Required</a> | </li>
<li>Optional</li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#annotation_type_element_detail">Element</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><font size=1>Copyright (c) 1996, 2016 Oracle and/or its affiliates. All rights reserved.</font></small></p>
</body>
</html>
