<!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>SecondaryKeyMetadata (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="SecondaryKeyMetadata (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/SecondaryKeyMetadata.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/SecondaryKey.html" title="annotation in com.sleepycat.persist.model"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/sleepycat/persist/model/SecondaryKeyMetadata.html" target="_top">Frames</a></li>
<li><a href="SecondaryKeyMetadata.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 SecondaryKeyMetadata" class="title">Class SecondaryKeyMetadata</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../com/sleepycat/persist/model/FieldMetadata.html" title="class in com.sleepycat.persist.model">com.sleepycat.persist.model.FieldMetadata</a></li>
<li>
<ul class="inheritance">
<li>com.sleepycat.persist.model.SecondaryKeyMetadata</li>
</ul>
</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="strong">SecondaryKeyMetadata</span>
extends <a href="../../../../com/sleepycat/persist/model/FieldMetadata.html" title="class in com.sleepycat.persist.model">FieldMetadata</a></pre>
<div class="block">The metadata for a secondary key field. A secondary key may be specified
with the <a href="../../../../com/sleepycat/persist/model/SecondaryKey.html" title="annotation in com.sleepycat.persist.model"><code>SecondaryKey</code></a> annotation.
<p><code>SecondaryKeyMetadata</code> objects are thread-safe. Multiple threads
may safely call the methods of a shared <code>SecondaryKeyMetadata</code>
object.</p></div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../serialized-form.html#com.sleepycat.persist.model.SecondaryKeyMetadata">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="overviewSummary" 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><strong><a href="../../../../com/sleepycat/persist/model/SecondaryKeyMetadata.html#SecondaryKeyMetadata(java.lang.String,%20java.lang.String,%20java.lang.String,%20java.lang.String,%20java.lang.String,%20com.sleepycat.persist.model.Relationship,%20java.lang.String,%20com.sleepycat.persist.model.DeleteAction)">SecondaryKeyMetadata</a></strong>(java.lang.String name,
java.lang.String className,
java.lang.String declaringClassName,
java.lang.String elementClassName,
java.lang.String keyName,
<a href="../../../../com/sleepycat/persist/model/Relationship.html" title="enum in com.sleepycat.persist.model">Relationship</a> relationship,
java.lang.String relatedEntity,
<a href="../../../../com/sleepycat/persist/model/DeleteAction.html" title="enum in com.sleepycat.persist.model">DeleteAction</a> deleteAction)</code>
<div class="block">Used by an <code>EntityModel</code> to construct secondary key 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="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>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../com/sleepycat/persist/model/SecondaryKeyMetadata.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object other)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../com/sleepycat/persist/model/DeleteAction.html" title="enum in com.sleepycat.persist.model">DeleteAction</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/sleepycat/persist/model/SecondaryKeyMetadata.html#getDeleteAction()">getDeleteAction</a></strong>()</code>
<div class="block">Returns the action to take when a related entity is deleted having a
primary key value that exists as a secondary key value for this entity.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../com/sleepycat/persist/model/SecondaryKeyMetadata.html#getElementClassName()">getElementClassName</a></strong>()</code>
<div class="block">Returns the class name of the array or collection element for a <a href="../../../../com/sleepycat/persist/model/Relationship.html#ONE_TO_MANY"><code>ONE_TO_MANY</code></a> or <a href="../../../../com/sleepycat/persist/model/Relationship.html#MANY_TO_MANY"><code>MANY_TO_MANY</code></a> relationship, or null for a
Relationship#ONE_TO_ONE ONE_TO_ONE} or <a href="../../../../com/sleepycat/persist/model/Relationship.html#MANY_TO_ONE"><code>MANY_TO_ONE</code></a> relationship.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../com/sleepycat/persist/model/SecondaryKeyMetadata.html#getKeyName()">getKeyName</a></strong>()</code>
<div class="block">Returns the key name, which may be different from the field name.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../com/sleepycat/persist/model/SecondaryKeyMetadata.html#getRelatedEntity()">getRelatedEntity</a></strong>()</code>
<div class="block">Returns the class name of the related (foreign) entity, for which
foreign key constraints are specified using the <a href="../../../../com/sleepycat/persist/model/SecondaryKey.html#relatedEntity()"><code>SecondaryKey.relatedEntity()</code></a> annotation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../com/sleepycat/persist/model/Relationship.html" title="enum in com.sleepycat.persist.model">Relationship</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/sleepycat/persist/model/SecondaryKeyMetadata.html#getRelationship()">getRelationship</a></strong>()</code>
<div class="block">Returns the relationship between instances of the entity class and the
secondary keys.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../com/sleepycat/persist/model/SecondaryKeyMetadata.html#hashCode()">hashCode</a></strong>()</code> </td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_com.sleepycat.persist.model.FieldMetadata">
<!-- -->
</a>
<h3>Methods inherited from class com.sleepycat.persist.model.<a href="../../../../com/sleepycat/persist/model/FieldMetadata.html" title="class in com.sleepycat.persist.model">FieldMetadata</a></h3>
<code><a href="../../../../com/sleepycat/persist/model/FieldMetadata.html#getClassName()">getClassName</a>, <a href="../../../../com/sleepycat/persist/model/FieldMetadata.html#getDeclaringClassName()">getDeclaringClassName</a>, <a href="../../../../com/sleepycat/persist/model/FieldMetadata.html#getName()">getName</a>, <a href="../../../../com/sleepycat/persist/model/FieldMetadata.html#toString()">toString</a></code></li>
</ul>
<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, 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="SecondaryKeyMetadata(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, com.sleepycat.persist.model.Relationship, java.lang.String, com.sleepycat.persist.model.DeleteAction)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SecondaryKeyMetadata</h4>
<pre>public SecondaryKeyMetadata(java.lang.String name,
java.lang.String className,
java.lang.String declaringClassName,
java.lang.String elementClassName,
java.lang.String keyName,
<a href="../../../../com/sleepycat/persist/model/Relationship.html" title="enum in com.sleepycat.persist.model">Relationship</a> relationship,
java.lang.String relatedEntity,
<a href="../../../../com/sleepycat/persist/model/DeleteAction.html" title="enum in com.sleepycat.persist.model">DeleteAction</a> deleteAction)</pre>
<div class="block">Used by an <code>EntityModel</code> to construct secondary key metadata.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getElementClassName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getElementClassName</h4>
<pre>public java.lang.String getElementClassName()</pre>
<div class="block">Returns the class name of the array or collection element for a <a href="../../../../com/sleepycat/persist/model/Relationship.html#ONE_TO_MANY"><code>ONE_TO_MANY</code></a> or <a href="../../../../com/sleepycat/persist/model/Relationship.html#MANY_TO_MANY"><code>MANY_TO_MANY</code></a> relationship, or null for a
Relationship#ONE_TO_ONE ONE_TO_ONE} or <a href="../../../../com/sleepycat/persist/model/Relationship.html#MANY_TO_ONE"><code>MANY_TO_ONE</code></a> relationship.</div>
</li>
</ul>
<a name="getKeyName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getKeyName</h4>
<pre>public java.lang.String getKeyName()</pre>
<div class="block">Returns the key name, which may be different from the field name.</div>
</li>
</ul>
<a name="getRelationship()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRelationship</h4>
<pre>public <a href="../../../../com/sleepycat/persist/model/Relationship.html" title="enum in com.sleepycat.persist.model">Relationship</a> getRelationship()</pre>
<div class="block">Returns the relationship between instances of the entity class and the
secondary keys. This may be specified using the <a href="../../../../com/sleepycat/persist/model/SecondaryKey.html#relate()"><code>SecondaryKey.relate()</code></a> annotation.</div>
</li>
</ul>
<a name="getRelatedEntity()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRelatedEntity</h4>
<pre>public java.lang.String getRelatedEntity()</pre>
<div class="block">Returns the class name of the related (foreign) entity, for which
foreign key constraints are specified using the <a href="../../../../com/sleepycat/persist/model/SecondaryKey.html#relatedEntity()"><code>SecondaryKey.relatedEntity()</code></a> annotation.</div>
</li>
</ul>
<a name="getDeleteAction()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDeleteAction</h4>
<pre>public <a href="../../../../com/sleepycat/persist/model/DeleteAction.html" title="enum in com.sleepycat.persist.model">DeleteAction</a> getDeleteAction()</pre>
<div class="block">Returns the action to take when a related entity is deleted having a
primary key value that exists as a secondary key value for this entity.
This may be specified using the <a href="../../../../com/sleepycat/persist/model/SecondaryKey.html#onRelatedEntityDelete()"><code>SecondaryKey.onRelatedEntityDelete()</code></a> annotation.</div>
</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><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../com/sleepycat/persist/model/FieldMetadata.html#equals(java.lang.Object)">equals</a></code> in class <code><a href="../../../../com/sleepycat/persist/model/FieldMetadata.html" title="class in com.sleepycat.persist.model">FieldMetadata</a></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><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../com/sleepycat/persist/model/FieldMetadata.html#hashCode()">hashCode</a></code> in class <code><a href="../../../../com/sleepycat/persist/model/FieldMetadata.html" title="class in com.sleepycat.persist.model">FieldMetadata</a></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><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/SecondaryKeyMetadata.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/SecondaryKey.html" title="annotation in com.sleepycat.persist.model"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/sleepycat/persist/model/SecondaryKeyMetadata.html" target="_top">Frames</a></li>
<li><a href="SecondaryKeyMetadata.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) 1996, 2016 Oracle and/or its affiliates. All rights reserved.</font></small></p>
</body>
</html>
