<!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:17 PDT 2016 -->
<title>SecondaryConfig (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="SecondaryConfig (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/SecondaryConfig.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/db/RunRecoveryException.html" title="class in com.sleepycat.db"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../com/sleepycat/db/SecondaryCursor.html" title="class in com.sleepycat.db"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/sleepycat/db/SecondaryConfig.html" target="_top">Frames</a></li>
<li><a href="SecondaryConfig.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><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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.db</div>
<h2 title="Class SecondaryConfig" class="title">Class SecondaryConfig</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../com/sleepycat/db/DatabaseConfig.html" title="class in com.sleepycat.db">com.sleepycat.db.DatabaseConfig</a></li>
<li>
<ul class="inheritance">
<li>com.sleepycat.db.SecondaryConfig</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.lang.Cloneable</dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">SecondaryConfig</span>
extends <a href="../../../com/sleepycat/db/DatabaseConfig.html" title="class in com.sleepycat.db">DatabaseConfig</a>
implements java.lang.Cloneable</pre>
<div class="block">The configuration properties of a <code>SecondaryDatabase</code> extend
those of a primary <code>Database</code>.
The secondary database configuration is specified when calling <a href="../../../com/sleepycat/db/Environment.html#openSecondaryDatabase(com.sleepycat.db.Transaction,%20java.lang.String,%20java.lang.String,%20com.sleepycat.db.Database,%20com.sleepycat.db.SecondaryConfig)"><code>Environment.openSecondaryDatabase</code></a>.
<p>
To create a configuration object with default attributes:
<pre>
SecondaryConfig config = new SecondaryConfig();
</pre>
To set custom attributes:
<pre>
SecondaryConfig config = new SecondaryConfig();
config.setAllowCreate(true);
config.setSortedDuplicates(true);
config.setKeyCreator(new MyKeyCreator());
</pre>
<p>
<hr>
<p>
NOTE: There are two situations where the use of secondary databases without
transactions requires special consideration. When using a transactional
database or when doing read operations only, this note does not apply.
<ul>
<li>If secondary is configured to not allow duplicates, when the secondary
is being updated it is possible that an error will occur when the secondary
key value in a record being added is already present in the database. A
<code>DatabaseException</code> will be thrown in this situation.</li>
<li>If a foreign key constraint is configured with the delete action
<code>ABORT</code> (the default setting), a <code>DatabaseException</code>
will be thrown if an attempt is made to delete a referenced foreign
key.</li>
</ul>
In both cases, the operation will be partially complete because the primary
database record will have already been updated or deleted. In the presence
of transactions, the exception will cause the transaction to abort. Without
transactions, it is the responsibility of the caller to handle the results
of the incomplete update or to take steps to prevent this situation from
happening in the first place.
<p>
</hr>
<p></div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../com/sleepycat/db/Environment.html#openSecondaryDatabase(com.sleepycat.db.Transaction,%20java.lang.String,%20java.lang.String,%20com.sleepycat.db.Database,%20com.sleepycat.db.SecondaryConfig)"><code>Environment.openSecondaryDatabase</code></a>,
<a href="../../../com/sleepycat/db/SecondaryDatabase.html" title="class in com.sleepycat.db"><code>SecondaryDatabase</code></a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../com/sleepycat/db/SecondaryConfig.html" title="class in com.sleepycat.db">SecondaryConfig</a></code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/SecondaryConfig.html#DEFAULT">DEFAULT</a></strong></code> </td>
</tr>
</table>
</li>
</ul>
<!-- ======== 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/db/SecondaryConfig.html#SecondaryConfig()">SecondaryConfig</a></strong>()</code>
<div class="block">Creates an instance with the system's default settings.</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/db/SecondaryConfig.html#getAllowPopulate()">getAllowPopulate</a></strong>()</code>
<div class="block">Returns whether automatic population of the secondary is allowed.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>com.sleepycat.db.internal.Db</code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/SecondaryConfig.html#getForeignKeyDatabase()">getForeignKeyDatabase</a></strong>()</code>
<div class="block">Returns the database used to check the foreign key integrity constraint,
or null if no foreign key constraint will be checked.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/db/ForeignKeyDeleteAction.html" title="class in com.sleepycat.db">ForeignKeyDeleteAction</a></code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/SecondaryConfig.html#getForeignKeyDeleteAction()">getForeignKeyDeleteAction</a></strong>()</code>
<div class="block">Returns the action taken when a referenced record in the foreign key
database is deleted.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/db/ForeignKeyNullifier.html" title="interface in com.sleepycat.db">ForeignKeyNullifier</a></code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/SecondaryConfig.html#getForeignKeyNullifier()">getForeignKeyNullifier</a></strong>()</code>
<div class="block">Returns the user-supplied object used for setting single-valued foreign
keys to null.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/db/ForeignMultiKeyNullifier.html" title="interface in com.sleepycat.db">ForeignMultiKeyNullifier</a></code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/SecondaryConfig.html#getForeignMultiKeyNullifier()">getForeignMultiKeyNullifier</a></strong>()</code>
<div class="block">Returns the user-supplied object used for setting multi-valued foreign
keys to null.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/SecondaryConfig.html#getImmutableSecondaryKey()">getImmutableSecondaryKey</a></strong>()</code>
<div class="block">Returns whether the secondary key is immutable.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/db/SecondaryKeyCreator.html" title="interface in com.sleepycat.db">SecondaryKeyCreator</a></code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/SecondaryConfig.html#getKeyCreator()">getKeyCreator</a></strong>()</code>
<div class="block">Returns the user-supplied object used for creating single-valued secondary
keys.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/db/SecondaryMultiKeyCreator.html" title="interface in com.sleepycat.db">SecondaryMultiKeyCreator</a></code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/SecondaryConfig.html#getMultiKeyCreator()">getMultiKeyCreator</a></strong>()</code>
<div class="block">Returns the user-supplied object used for creating multi-valued secondary
keys.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/SecondaryConfig.html#setAllowPopulate(boolean)">setAllowPopulate</a></strong>(boolean allowPopulate)</code>
<div class="block">Specifies whether automatic population of the secondary is allowed.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/SecondaryConfig.html#setForeignKeyDatabase(com.sleepycat.db.Database)">setForeignKeyDatabase</a></strong>(<a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</a> foreignDb)</code>
<div class="block">Defines a foreign key integrity constraint for a given foreign key
database.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/SecondaryConfig.html#setForeignKeyDeleteAction(com.sleepycat.db.ForeignKeyDeleteAction)">setForeignKeyDeleteAction</a></strong>(<a href="../../../com/sleepycat/db/ForeignKeyDeleteAction.html" title="class in com.sleepycat.db">ForeignKeyDeleteAction</a> action)</code>
<div class="block">Specifies the action taken when a referenced record in the foreign key
database is deleted.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/SecondaryConfig.html#setForeignKeyNullifier(com.sleepycat.db.ForeignKeyNullifier)">setForeignKeyNullifier</a></strong>(<a href="../../../com/sleepycat/db/ForeignKeyNullifier.html" title="interface in com.sleepycat.db">ForeignKeyNullifier</a> keyNullifier)</code>
<div class="block">Specifies the user-supplied object used for setting single-valued
foreign keys to null.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/SecondaryConfig.html#setForeignMultiKeyNullifier(com.sleepycat.db.ForeignMultiKeyNullifier)">setForeignMultiKeyNullifier</a></strong>(<a href="../../../com/sleepycat/db/ForeignMultiKeyNullifier.html" title="interface in com.sleepycat.db">ForeignMultiKeyNullifier</a> multiKeyNullifier)</code>
<div class="block">Specifies the user-supplied object used for setting multi-valued foreign
keys to null.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/SecondaryConfig.html#setImmutableSecondaryKey(boolean)">setImmutableSecondaryKey</a></strong>(boolean immutableSecondaryKey)</code>
<div class="block">Specifies whether the secondary key is immutable.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/SecondaryConfig.html#setKeyCreator(com.sleepycat.db.SecondaryKeyCreator)">setKeyCreator</a></strong>(<a href="../../../com/sleepycat/db/SecondaryKeyCreator.html" title="interface in com.sleepycat.db">SecondaryKeyCreator</a> keyCreator)</code>
<div class="block">Specifies the user-supplied object used for creating single-valued
secondary keys.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/SecondaryConfig.html#setMultiKeyCreator(com.sleepycat.db.SecondaryMultiKeyCreator)">setMultiKeyCreator</a></strong>(<a href="../../../com/sleepycat/db/SecondaryMultiKeyCreator.html" title="interface in com.sleepycat.db">SecondaryMultiKeyCreator</a> multiKeyCreator)</code>
<div class="block">Specifies the user-supplied object used for creating multi-valued
secondary keys.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_com.sleepycat.db.DatabaseConfig">
<!-- -->
</a>
<h3>Methods inherited from class com.sleepycat.db.<a href="../../../com/sleepycat/db/DatabaseConfig.html" title="class in com.sleepycat.db">DatabaseConfig</a></h3>
<code><a href="../../../com/sleepycat/db/DatabaseConfig.html#cloneConfig()">cloneConfig</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#getAllowCreate()">getAllowCreate</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#getBlobDir()">getBlobDir</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#getBlobThreshold()">getBlobThreshold</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#getBtreeComparator()">getBtreeComparator</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#getBtreeCompressor()">getBtreeCompressor</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#getBtreeMinKey()">getBtreeMinKey</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#getBtreePrefixCalculator()">getBtreePrefixCalculator</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#getBtreeRecordNumbers()">getBtreeRecordNumbers</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#getByteOrder()">getByteOrder</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#getByteSwapped()">getByteSwapped</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#getCacheCount()">getCacheCount</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#getCacheSize()">getCacheSize</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#getChecksum()">getChecksum</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#getCreateDir()">getCreateDir</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#getDirtyRead()">getDirtyRead</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#getDuplicateComparator()">getDuplicateComparator</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#getEncrypted()">getEncrypted</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#getErrorHandler()">getErrorHandler</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#getErrorPrefix()">getErrorPrefix</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#getErrorStream()">getErrorStream</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#getExclusiveCreate()">getExclusiveCreate</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#getFeedbackHandler()">getFeedbackHandler</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#getHashComparator()">getHashComparator</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#getHasher()">getHasher</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#getHashFillFactor()">getHashFillFactor</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#getHashNumElements()">getHashNumElements</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#getHeapRegionSize()">getHeapRegionSize</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#getHeapsize()">getHeapsize</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#getMessageHandler()">getMessageHandler</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#getMessageStream()">getMessageStream</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#getMode()">getMode</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#getMultiversion()">getMultiversion</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#getNoMMap()">getNoMMap</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#getNoWaitDbExclusiveLock()">getNoWaitDbExclusiveLock</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#getPageSize()">getPageSize</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#getPanicHandler()">getPanicHandler</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#getPartitionDirs()">getPartitionDirs</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#getPartitionHandler()">getPartitionHandler</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#getPartitionKeys()">getPartitionKeys</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#getPartitionParts()">getPartitionParts</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#getPriority()">getPriority</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#getQueueExtentSize()">getQueueExtentSize</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#getQueueInOrder()">getQueueInOrder</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#getReadOnly()">getReadOnly</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#getReadUncommitted()">getReadUncommitted</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#getRecordDelimiter()">getRecordDelimiter</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#getRecordLength()">getRecordLength</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#getRecordNumberAppender()">getRecordNumberAppender</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#getRecordPad()">getRecordPad</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#getRecordSource()">getRecordSource</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#getRenumbering()">getRenumbering</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#getReverseSplitOff()">getReverseSplitOff</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#getSnapshot()">getSnapshot</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#getSortedDuplicates()">getSortedDuplicates</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#getTransactional()">getTransactional</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#getTransactionNotDurable()">getTransactionNotDurable</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#getTruncate()">getTruncate</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#getType()">getType</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#getUnsortedDuplicates()">getUnsortedDuplicates</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#setAllowCreate(boolean)">setAllowCreate</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#setBlobDir(java.io.File)">setBlobDir</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#setBlobThreshold(int)">setBlobThreshold</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#setBtreeComparator(java.util.Comparator)">setBtreeComparator</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#setBtreeCompressor(com.sleepycat.db.BtreeCompressor)">setBtreeCompressor</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#setBtreeMinKey(int)">setBtreeMinKey</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#setBtreePrefixCalculator(com.sleepycat.db.BtreePrefixCalculator)">setBtreePrefixCalculator</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#setBtreeRecordNumbers(boolean)">setBtreeRecordNumbers</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#setByteOrder(int)">setByteOrder</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#setCacheCount(int)">setCacheCount</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#setCacheSize(long)">setCacheSize</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#setChecksum(boolean)">setChecksum</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#setCreateDir(java.io.File)">setCreateDir</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#setDirtyRead(boolean)">setDirtyRead</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#setDuplicateComparator(java.util.Comparator)">setDuplicateComparator</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#setEncrypted(java.lang.String)">setEncrypted</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#setErrorHandler(com.sleepycat.db.ErrorHandler)">setErrorHandler</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#setErrorPrefix(java.lang.String)">setErrorPrefix</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#setErrorStream(java.io.OutputStream)">setErrorStream</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#setExclusiveCreate(boolean)">setExclusiveCreate</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#setFeedbackHandler(com.sleepycat.db.FeedbackHandler)">setFeedbackHandler</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#setHashComparator(java.util.Comparator)">setHashComparator</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#setHasher(com.sleepycat.db.Hasher)">setHasher</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#setHashFillFactor(int)">setHashFillFactor</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#setHashNumElements(int)">setHashNumElements</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#setHeapRegionSize(int)">setHeapRegionSize</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#setHeapsize(long)">setHeapsize</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#setMessageHandler(com.sleepycat.db.MessageHandler)">setMessageHandler</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#setMessageStream(java.io.OutputStream)">setMessageStream</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#setMode(int)">setMode</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#setMsgfile(java.io.File)">setMsgfile</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#setMultiversion(boolean)">setMultiversion</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#setNoMMap(boolean)">setNoMMap</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#setNoWaitDbExclusiveLock(java.lang.Boolean)">setNoWaitDbExclusiveLock</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#setPageSize(int)">setPageSize</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#setPanicHandler(com.sleepycat.db.PanicHandler)">setPanicHandler</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#setPartitionByCallback(int,%20com.sleepycat.db.PartitionHandler)">setPartitionByCallback</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#setPartitionByRange(int,%20com.sleepycat.db.MultipleDataEntry)">setPartitionByRange</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#setPartitionDirs(java.io.File[])">setPartitionDirs</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#setPriority(com.sleepycat.db.CacheFilePriority)">setPriority</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#setQueueExtentSize(int)">setQueueExtentSize</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#setQueueInOrder(boolean)">setQueueInOrder</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#setReadOnly(boolean)">setReadOnly</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#setReadUncommitted(boolean)">setReadUncommitted</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#setRecordDelimiter(int)">setRecordDelimiter</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#setRecordLength(int)">setRecordLength</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#setRecordNumberAppender(com.sleepycat.db.RecordNumberAppender)">setRecordNumberAppender</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#setRecordPad(int)">setRecordPad</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#setRecordSource(java.io.File)">setRecordSource</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#setRenumbering(boolean)">setRenumbering</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#setReverseSplitOff(boolean)">setReverseSplitOff</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#setSnapshot(boolean)">setSnapshot</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#setSortedDuplicates(boolean)">setSortedDuplicates</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#setTransactional(boolean)">setTransactional</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#setTransactionNotDurable(boolean)">setTransactionNotDurable</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#setTruncate(boolean)">setTruncate</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#setType(com.sleepycat.db.DatabaseType)">setType</a>, <a href="../../../com/sleepycat/db/DatabaseConfig.html#setUnsortedDuplicates(boolean)">setUnsortedDuplicates</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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="DEFAULT">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DEFAULT</h4>
<pre>public static final <a href="../../../com/sleepycat/db/SecondaryConfig.html" title="class in com.sleepycat.db">SecondaryConfig</a> DEFAULT</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="SecondaryConfig()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SecondaryConfig</h4>
<pre>public SecondaryConfig()</pre>
<div class="block">Creates an instance with the system's default settings.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setAllowPopulate(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAllowPopulate</h4>
<pre>public void setAllowPopulate(boolean allowPopulate)</pre>
<div class="block">Specifies whether automatic population of the secondary is allowed.
<p>
If automatic population is allowed, when the secondary database is
opened it is checked to see if it is empty. If it is empty, the
primary database is read in its entirety and keys are added to the
secondary database using the information read from the primary.
<p>
If this property is set to true and the database is transactional, the
population of the secondary will be done within the explicit or auto-commit
transaction that is used to open the database.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>allowPopulate</code> - whether automatic population of the secondary is
allowed.</dd></dl>
</li>
</ul>
<a name="getAllowPopulate()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAllowPopulate</h4>
<pre>public boolean getAllowPopulate()</pre>
<div class="block">Returns whether automatic population of the secondary is allowed. If
<a href="../../../com/sleepycat/db/SecondaryConfig.html#setAllowPopulate(boolean)"><code>setAllowPopulate(boolean)</code></a> has not been called, this method returns
false.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>whether automatic population of the secondary is allowed.
<p></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../com/sleepycat/db/SecondaryConfig.html#setAllowPopulate(boolean)"><code>setAllowPopulate(boolean)</code></a></dd></dl>
</li>
</ul>
<a name="setImmutableSecondaryKey(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setImmutableSecondaryKey</h4>
<pre>public void setImmutableSecondaryKey(boolean immutableSecondaryKey)</pre>
<div class="block">Specifies whether the secondary key is immutable.
<p>
Specifying that a secondary key is immutable can be used to optimize
updates when the secondary key in a primary record will never be changed
after that primary record is inserted. For immutable secondary keys, a
best effort is made to avoid calling
<code>SecondaryKeyCreator.createSecondaryKey</code> when a primary record
is updated. This optimization may reduce the overhead of an update
operation significantly if the <code>createSecondaryKey</code> operation is
expensive.
<p>
Be sure to set this property to true only if the secondary key in the
primary record is never changed. If this rule is violated, the secondary
index will become corrupted, that is, it will become out of sync with the
primary.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>immutableSecondaryKey</code> - whether the secondary key is immutable.</dd></dl>
</li>
</ul>
<a name="getImmutableSecondaryKey()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getImmutableSecondaryKey</h4>
<pre>public boolean getImmutableSecondaryKey()</pre>
<div class="block">Returns whether the secondary key is immutable. If
<a href="../../../com/sleepycat/db/SecondaryConfig.html#setImmutableSecondaryKey(boolean)"><code>setImmutableSecondaryKey(boolean)</code></a> has not been called, this method returns
false.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>whether the secondary key is immutable.
<p></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../com/sleepycat/db/SecondaryConfig.html#setImmutableSecondaryKey(boolean)"><code>setImmutableSecondaryKey(boolean)</code></a></dd></dl>
</li>
</ul>
<a name="setKeyCreator(com.sleepycat.db.SecondaryKeyCreator)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setKeyCreator</h4>
<pre>public void setKeyCreator(<a href="../../../com/sleepycat/db/SecondaryKeyCreator.html" title="interface in com.sleepycat.db">SecondaryKeyCreator</a> keyCreator)</pre>
<div class="block">Specifies the user-supplied object used for creating single-valued
secondary keys.
<p>
Unless the primary database is read-only, a key creator is required
when opening a secondary database. Either a KeyCreator or MultiKeyCreator
must be specified, but both may not be specified.
<p>
Unless the primary database is read-only, a key creator is required
when opening a secondary database.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>keyCreator</code> - the user-supplied object used for creating single-valued
secondary keys.</dd></dl>
</li>
</ul>
<a name="getKeyCreator()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getKeyCreator</h4>
<pre>public <a href="../../../com/sleepycat/db/SecondaryKeyCreator.html" title="interface in com.sleepycat.db">SecondaryKeyCreator</a> getKeyCreator()</pre>
<div class="block">Returns the user-supplied object used for creating single-valued secondary
keys.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the user-supplied object used for creating single-valued secondary
keys.
<p></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../com/sleepycat/db/SecondaryConfig.html#setKeyCreator(com.sleepycat.db.SecondaryKeyCreator)"><code>setKeyCreator(com.sleepycat.db.SecondaryKeyCreator)</code></a></dd></dl>
</li>
</ul>
<a name="setMultiKeyCreator(com.sleepycat.db.SecondaryMultiKeyCreator)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMultiKeyCreator</h4>
<pre>public void setMultiKeyCreator(<a href="../../../com/sleepycat/db/SecondaryMultiKeyCreator.html" title="interface in com.sleepycat.db">SecondaryMultiKeyCreator</a> multiKeyCreator)</pre>
<div class="block">Specifies the user-supplied object used for creating multi-valued
secondary keys.
<p>
Unless the primary database is read-only, a key creator is required
when opening a secondary database. Either a KeyCreator or MultiKeyCreator
must be specified, but both may not be specified.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>multiKeyCreator</code> - the user-supplied object used for creating multi-valued
secondary keys.</dd></dl>
</li>
</ul>
<a name="getMultiKeyCreator()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMultiKeyCreator</h4>
<pre>public <a href="../../../com/sleepycat/db/SecondaryMultiKeyCreator.html" title="interface in com.sleepycat.db">SecondaryMultiKeyCreator</a> getMultiKeyCreator()</pre>
<div class="block">Returns the user-supplied object used for creating multi-valued secondary
keys.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the user-supplied object used for creating multi-valued secondary
keys.
<p></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../com/sleepycat/db/SecondaryConfig.html#setKeyCreator(com.sleepycat.db.SecondaryKeyCreator)"><code>setKeyCreator(com.sleepycat.db.SecondaryKeyCreator)</code></a></dd></dl>
</li>
</ul>
<a name="setForeignKeyDatabase(com.sleepycat.db.Database)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setForeignKeyDatabase</h4>
<pre>public void setForeignKeyDatabase(<a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</a> foreignDb)</pre>
<div class="block">Defines a foreign key integrity constraint for a given foreign key
database.
<p>If this property is non-null, a record must be present in the
specified foreign database for every record in the secondary database,
where the secondary key value is equal to the foreign database key
value. Whenever a record is to be added to the secondary database, the
secondary key is used as a lookup key in the foreign database.
<p>The foreign database must not have duplicates allowed.</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>foreignDb</code> - the database used to check the foreign key
integrity constraint, or null if no foreign key constraint should be
checked.</dd></dl>
</li>
</ul>
<a name="getForeignKeyDatabase()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getForeignKeyDatabase</h4>
<pre>public com.sleepycat.db.internal.Db getForeignKeyDatabase()</pre>
<div class="block">Returns the database used to check the foreign key integrity constraint,
or null if no foreign key constraint will be checked.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the foreign key database, or null.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../com/sleepycat/db/SecondaryConfig.html#setForeignKeyDatabase(com.sleepycat.db.Database)"><code>setForeignKeyDatabase(com.sleepycat.db.Database)</code></a></dd></dl>
</li>
</ul>
<a name="setForeignKeyDeleteAction(com.sleepycat.db.ForeignKeyDeleteAction)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setForeignKeyDeleteAction</h4>
<pre>public void setForeignKeyDeleteAction(<a href="../../../com/sleepycat/db/ForeignKeyDeleteAction.html" title="class in com.sleepycat.db">ForeignKeyDeleteAction</a> action)</pre>
<div class="block">Specifies the action taken when a referenced record in the foreign key
database is deleted.
<p>This property is ignored if the foreign key database property is
null.</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>action</code> - the action taken when a referenced record
in the foreign key database is deleted.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../com/sleepycat/db/ForeignKeyDeleteAction.html" title="class in com.sleepycat.db"><code>@see #setForeignKeyDatabase</code></a></dd></dl>
</li>
</ul>
<a name="getForeignKeyDeleteAction()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getForeignKeyDeleteAction</h4>
<pre>public <a href="../../../com/sleepycat/db/ForeignKeyDeleteAction.html" title="class in com.sleepycat.db">ForeignKeyDeleteAction</a> getForeignKeyDeleteAction()</pre>
<div class="block">Returns the action taken when a referenced record in the foreign key
database is deleted.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the action taken when a referenced record in the foreign key
database is deleted.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../com/sleepycat/db/SecondaryConfig.html#setForeignKeyDeleteAction(com.sleepycat.db.ForeignKeyDeleteAction)"><code>setForeignKeyDeleteAction(com.sleepycat.db.ForeignKeyDeleteAction)</code></a></dd></dl>
</li>
</ul>
<a name="setForeignKeyNullifier(com.sleepycat.db.ForeignKeyNullifier)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setForeignKeyNullifier</h4>
<pre>public void setForeignKeyNullifier(<a href="../../../com/sleepycat/db/ForeignKeyNullifier.html" title="interface in com.sleepycat.db">ForeignKeyNullifier</a> keyNullifier)</pre>
<div class="block">Specifies the user-supplied object used for setting single-valued
foreign keys to null.
<p>This method may <em>not</em> be used along with <a href="../../../com/sleepycat/db/SecondaryConfig.html#setMultiKeyCreator(com.sleepycat.db.SecondaryMultiKeyCreator)"><code>setMultiKeyCreator(com.sleepycat.db.SecondaryMultiKeyCreator)</code></a>. When using a multi-key creator, use <a href="../../../com/sleepycat/db/SecondaryConfig.html#setForeignMultiKeyNullifier(com.sleepycat.db.ForeignMultiKeyNullifier)"><code>setForeignMultiKeyNullifier(com.sleepycat.db.ForeignMultiKeyNullifier)</code></a> instead.</p>
<p>If the foreign key database property is non-null and the foreign key
delete action is <code>NULLIFY</code>, this property is required to be
non-null; otherwise, this property is ignored.</p>
<p><em>WARNING:</em> Key nullifier instances are shared by multiple
threads and key nullifier methods are called without any special
synchronization. Therefore, key creators must be thread safe. In
general no shared state should be used and any caching of computed
values must be done with proper synchronization.</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>keyNullifier</code> - the user-supplied object used for setting
single-valued foreign keys to null.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../com/sleepycat/db/ForeignKeyNullifier.html" title="interface in com.sleepycat.db"><code>@see ForeignKeyDeleteAction#NULLIFY @see
#setForeignKeyDatabase</code></a></dd></dl>
</li>
</ul>
<a name="getForeignKeyNullifier()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getForeignKeyNullifier</h4>
<pre>public <a href="../../../com/sleepycat/db/ForeignKeyNullifier.html" title="interface in com.sleepycat.db">ForeignKeyNullifier</a> getForeignKeyNullifier()</pre>
<div class="block">Returns the user-supplied object used for setting single-valued foreign
keys to null.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the user-supplied object used for setting single-valued foreign
keys to null.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../com/sleepycat/db/SecondaryConfig.html#setForeignKeyNullifier(com.sleepycat.db.ForeignKeyNullifier)"><code>setForeignKeyNullifier(com.sleepycat.db.ForeignKeyNullifier)</code></a></dd></dl>
</li>
</ul>
<a name="setForeignMultiKeyNullifier(com.sleepycat.db.ForeignMultiKeyNullifier)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setForeignMultiKeyNullifier</h4>
<pre>public void setForeignMultiKeyNullifier(<a href="../../../com/sleepycat/db/ForeignMultiKeyNullifier.html" title="interface in com.sleepycat.db">ForeignMultiKeyNullifier</a> multiKeyNullifier)</pre>
<div class="block">Specifies the user-supplied object used for setting multi-valued foreign
keys to null.
<p>If the foreign key database property is non-null and the foreign key
delete action is <code>NULLIFY</code>, this property is required to be
non-null; otherwise, this property is ignored.</p>
<p><em>WARNING:</em> Key nullifier instances are shared by multiple
threads and key nullifier methods are called without any special
synchronization. Therefore, key creators must be thread safe. In
general no shared state should be used and any caching of computed
values must be done with proper synchronization.</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>multiKeyNullifier</code> - the user-supplied object used for
setting multi-valued foreign keys to null.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../com/sleepycat/db/ForeignMultiKeyNullifier.html" title="interface in com.sleepycat.db"><code>@see ForeignKeyDeleteAction#NULLIFY @see
#setForeignKeyDatabase</code></a></dd></dl>
</li>
</ul>
<a name="getForeignMultiKeyNullifier()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getForeignMultiKeyNullifier</h4>
<pre>public <a href="../../../com/sleepycat/db/ForeignMultiKeyNullifier.html" title="interface in com.sleepycat.db">ForeignMultiKeyNullifier</a> getForeignMultiKeyNullifier()</pre>
<div class="block">Returns the user-supplied object used for setting multi-valued foreign
keys to null.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the user-supplied object used for setting multi-valued foreign
keys to null.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../com/sleepycat/db/SecondaryConfig.html#setForeignMultiKeyNullifier(com.sleepycat.db.ForeignMultiKeyNullifier)"><code>setForeignMultiKeyNullifier(com.sleepycat.db.ForeignMultiKeyNullifier)</code></a></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/SecondaryConfig.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/db/RunRecoveryException.html" title="class in com.sleepycat.db"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../com/sleepycat/db/SecondaryCursor.html" title="class in com.sleepycat.db"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/sleepycat/db/SecondaryConfig.html" target="_top">Frames</a></li>
<li><a href="SecondaryConfig.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><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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>
