diff options
Diffstat (limited to 'docs/java/com/sleepycat/db/SecondaryConfig.html')
| -rw-r--r-- | docs/java/com/sleepycat/db/SecondaryConfig.html | 1314 |
1 files changed, 604 insertions, 710 deletions
diff --git a/docs/java/com/sleepycat/db/SecondaryConfig.html b/docs/java/com/sleepycat/db/SecondaryConfig.html index 39a7afc5..3c24e06d 100644 --- a/docs/java/com/sleepycat/db/SecondaryConfig.html +++ b/docs/java/com/sleepycat/db/SecondaryConfig.html @@ -1,113 +1,117 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<!--NewPage--> -<HTML> -<HEAD> -<!-- Generated by javadoc (build 1.6.0_23) on Fri May 11 14:10:05 EDT 2012 --> -<TITLE> -SecondaryConfig (Oracle - Berkeley DB Java API) -</TITLE> - -<META NAME="date" CONTENT="2012-05-11"> - -<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../style.css" TITLE="Style"> - -<SCRIPT type="text/javascript"> -function windowTitle() -{ +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_60) on Tue Feb 17 12:25:54 EST 2015 --> +<title>SecondaryConfig (Oracle - Berkeley DB Java API)</title> +<meta name="date" content="2015-02-17"> +<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> -</NOSCRIPT> - -</HEAD> - -<BODY BGCOLOR="white" onload="windowTitle();"> -<HR> - - +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> <!-- ========= START OF TOP NAVBAR ======= --> -<A NAME="navbar_top"><!-- --></A> -<A HREF="#skip-navbar_top" title="Skip navigation links"></A> -<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> -<TR> -<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> -<A NAME="navbar_top_firstrow"><!-- --></A> -<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> - <TR ALIGN="center" VALIGN="top"> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> - <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SecondaryConfig.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> - </TR> -</TABLE> -</TD> -<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> -<b>Berkeley DB</b><br><font size="-1"> version 5.3.21</font></EM> -</TD> -</TR> - -<TR> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../com/sleepycat/db/RunRecoveryException.html" title="class in com.sleepycat.db"><B>PREV CLASS</B></A> - <A HREF="../../../com/sleepycat/db/SecondaryCursor.html" title="class in com.sleepycat.db"><B>NEXT CLASS</B></A></FONT></TD> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../index.html?com/sleepycat/db/SecondaryConfig.html" target="_top"><B>FRAMES</B></A> - <A HREF="SecondaryConfig.html" target="_top"><B>NO FRAMES</B></A> - <SCRIPT type="text/javascript"> - <!-- +<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.23</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) { - document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; } //--> -</SCRIPT> -<NOSCRIPT> - <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> -</NOSCRIPT> - - -</FONT></TD> -</TR> -<TR> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> - SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> -DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> -</TR> -</TABLE> -<A NAME="skip-navbar_top"></A> +</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 ========= --> - -<HR> <!-- ======== START OF CLASS DATA ======== --> -<H2> -<FONT SIZE="-1"> -com.sleepycat.db</FONT> -<BR> -Class SecondaryConfig</H2> -<PRE> -<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A> - <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../com/sleepycat/db/DatabaseConfig.html" title="class in com.sleepycat.db">com.sleepycat.db.DatabaseConfig</A> - <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>com.sleepycat.db.SecondaryConfig</B> -</PRE> -<DL> -<DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</A></DD> -</DL> -<HR> -<DL> -<DT><PRE>public class <B>SecondaryConfig</B><DT>extends <A HREF="../../../com/sleepycat/db/DatabaseConfig.html" title="class in com.sleepycat.db">DatabaseConfig</A><DT>implements <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</A></DL> -</PRE> - -<P> -The configuration properties of a <code>SecondaryDatabase</code> extend +<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, java.lang.String, java.lang.String, com.sleepycat.db.Database, com.sleepycat.db.SecondaryConfig)"><CODE>Environment.openSecondaryDatabase</CODE></A>. +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> @@ -144,274 +148,245 @@ of the incomplete update or to take steps to prevent this situation from happening in the first place. <p> </hr> -<p> -<P> - -<P> -<DL> -<DT><B>See Also:</B><DD><A HREF="../../../com/sleepycat/db/Environment.html#openSecondaryDatabase(com.sleepycat.db.Transaction, java.lang.String, java.lang.String, com.sleepycat.db.Database, com.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></DL> -<HR> - -<P> +<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 =========== --> - -<A NAME="field_summary"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> -<B>Field Summary</B></FONT></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>static <A HREF="../../../com/sleepycat/db/SecondaryConfig.html" title="class in com.sleepycat.db">SecondaryConfig</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/SecondaryConfig.html#DEFAULT">DEFAULT</A></B></CODE> - -<BR> - </TD> -</TR> -</TABLE> - +<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 ======== --> - -<A NAME="constructor_summary"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> -<B>Constructor Summary</B></FONT></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/SecondaryConfig.html#SecondaryConfig()">SecondaryConfig</A></B>()</CODE> - -<BR> - Creates an instance with the system's default settings.</TD> -</TR> -</TABLE> - +<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 =========== --> - -<A NAME="method_summary"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> -<B>Method Summary</B></FONT></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> boolean</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/SecondaryConfig.html#getAllowPopulate()">getAllowPopulate</A></B>()</CODE> - -<BR> - Returns whether automatic population of the secondary is allowed.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> com.sleepycat.db.internal.Db</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/SecondaryConfig.html#getForeignKeyDatabase()">getForeignKeyDatabase</A></B>()</CODE> - -<BR> - Returns the database used to check the foreign key integrity constraint, - or null if no foreign key constraint will be checked.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/db/ForeignKeyDeleteAction.html" title="class in com.sleepycat.db">ForeignKeyDeleteAction</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/SecondaryConfig.html#getForeignKeyDeleteAction()">getForeignKeyDeleteAction</A></B>()</CODE> - -<BR> - Returns the action taken when a referenced record in the foreign key - database is deleted.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/db/ForeignKeyNullifier.html" title="interface in com.sleepycat.db">ForeignKeyNullifier</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/SecondaryConfig.html#getForeignKeyNullifier()">getForeignKeyNullifier</A></B>()</CODE> - -<BR> - Returns the user-supplied object used for setting single-valued foreign - keys to null.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/db/ForeignMultiKeyNullifier.html" title="interface in com.sleepycat.db">ForeignMultiKeyNullifier</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/SecondaryConfig.html#getForeignMultiKeyNullifier()">getForeignMultiKeyNullifier</A></B>()</CODE> - -<BR> - Returns the user-supplied object used for setting multi-valued foreign - keys to null.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> boolean</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/SecondaryConfig.html#getImmutableSecondaryKey()">getImmutableSecondaryKey</A></B>()</CODE> - -<BR> - Returns whether the secondary key is immutable.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/db/SecondaryKeyCreator.html" title="interface in com.sleepycat.db">SecondaryKeyCreator</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/SecondaryConfig.html#getKeyCreator()">getKeyCreator</A></B>()</CODE> - -<BR> - Returns the user-supplied object used for creating single-valued secondary - keys.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/db/SecondaryMultiKeyCreator.html" title="interface in com.sleepycat.db">SecondaryMultiKeyCreator</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/SecondaryConfig.html#getMultiKeyCreator()">getMultiKeyCreator</A></B>()</CODE> - -<BR> - Returns the user-supplied object used for creating multi-valued secondary - keys.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/SecondaryConfig.html#setAllowPopulate(boolean)">setAllowPopulate</A></B>(boolean allowPopulate)</CODE> - -<BR> - Specifies whether automatic population of the secondary is allowed.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/SecondaryConfig.html#setForeignKeyDatabase(com.sleepycat.db.Database)">setForeignKeyDatabase</A></B>(<A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</A> foreignDb)</CODE> - -<BR> - Defines a foreign key integrity constraint for a given foreign key - database.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/SecondaryConfig.html#setForeignKeyDeleteAction(com.sleepycat.db.ForeignKeyDeleteAction)">setForeignKeyDeleteAction</A></B>(<A HREF="../../../com/sleepycat/db/ForeignKeyDeleteAction.html" title="class in com.sleepycat.db">ForeignKeyDeleteAction</A> action)</CODE> - -<BR> - Specifies the action taken when a referenced record in the foreign key - database is deleted.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/SecondaryConfig.html#setForeignKeyNullifier(com.sleepycat.db.ForeignKeyNullifier)">setForeignKeyNullifier</A></B>(<A HREF="../../../com/sleepycat/db/ForeignKeyNullifier.html" title="interface in com.sleepycat.db">ForeignKeyNullifier</A> keyNullifier)</CODE> - -<BR> - Specifies the user-supplied object used for setting single-valued - foreign keys to null.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/SecondaryConfig.html#setForeignMultiKeyNullifier(com.sleepycat.db.ForeignMultiKeyNullifier)">setForeignMultiKeyNullifier</A></B>(<A HREF="../../../com/sleepycat/db/ForeignMultiKeyNullifier.html" title="interface in com.sleepycat.db">ForeignMultiKeyNullifier</A> multiKeyNullifier)</CODE> - -<BR> - Specifies the user-supplied object used for setting multi-valued foreign - keys to null.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/SecondaryConfig.html#setImmutableSecondaryKey(boolean)">setImmutableSecondaryKey</A></B>(boolean immutableSecondaryKey)</CODE> - -<BR> - Specifies whether the secondary key is immutable.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/SecondaryConfig.html#setKeyCreator(com.sleepycat.db.SecondaryKeyCreator)">setKeyCreator</A></B>(<A HREF="../../../com/sleepycat/db/SecondaryKeyCreator.html" title="interface in com.sleepycat.db">SecondaryKeyCreator</A> keyCreator)</CODE> - -<BR> - Specifies the user-supplied object used for creating single-valued - secondary keys.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/SecondaryConfig.html#setMultiKeyCreator(com.sleepycat.db.SecondaryMultiKeyCreator)">setMultiKeyCreator</A></B>(<A HREF="../../../com/sleepycat/db/SecondaryMultiKeyCreator.html" title="interface in com.sleepycat.db">SecondaryMultiKeyCreator</A> multiKeyCreator)</CODE> - -<BR> - Specifies the user-supplied object used for creating multi-valued - secondary keys.</TD> -</TR> -</TABLE> - <A NAME="methods_inherited_from_class_com.sleepycat.db.DatabaseConfig"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> -<TH ALIGN="left"><B>Methods inherited from class com.sleepycat.db.<A HREF="../../../com/sleepycat/db/DatabaseConfig.html" title="class in com.sleepycat.db">DatabaseConfig</A></B></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><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#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#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#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, com.sleepycat.db.PartitionHandler)">setPartitionByCallback</A>, <A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setPartitionByRange(int, com.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></TD> -</TR> -</TABLE> - <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> -<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> -</TR> -</TABLE> - -<P> - +<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 =========== --> - -<A NAME="field_detail"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> -<B>Field Detail</B></FONT></TH> -</TR> -</TABLE> - -<A NAME="DEFAULT"><!-- --></A><H3> -DEFAULT</H3> -<PRE> -public static final <A HREF="../../../com/sleepycat/db/SecondaryConfig.html" title="class in com.sleepycat.db">SecondaryConfig</A> <B>DEFAULT</B></PRE> -<DL> -<DL> -</DL> -</DL> - +<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 ======== --> - -<A NAME="constructor_detail"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> -<B>Constructor Detail</B></FONT></TH> -</TR> -</TABLE> - -<A NAME="SecondaryConfig()"><!-- --></A><H3> -SecondaryConfig</H3> -<PRE> -public <B>SecondaryConfig</B>()</PRE> -<DL> -<DD>Creates an instance with the system's default settings. -<P> -</DL> - +<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 ========== --> - -<A NAME="method_detail"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> -<B>Method Detail</B></FONT></TH> -</TR> -</TABLE> - -<A NAME="setAllowPopulate(boolean)"><!-- --></A><H3> -setAllowPopulate</H3> -<PRE> -public void <B>setAllowPopulate</B>(boolean allowPopulate)</PRE> -<DL> -<DD>Specifies whether automatic population of the secondary is allowed. +<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 @@ -421,45 +396,34 @@ public void <B>setAllowPopulate</B>(boolean allowPopulate)</PRE> 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> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>allowPopulate</CODE> - whether automatic population of the secondary is - allowed.</DL> -</DD> -</DL> -<HR> - -<A NAME="getAllowPopulate()"><!-- --></A><H3> -getAllowPopulate</H3> -<PRE> -public boolean <B>getAllowPopulate</B>()</PRE> -<DL> -<DD>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 + <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> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>whether automatic population of the secondary is allowed. - <p><DT><B>See Also:</B><DD><A HREF="../../../com/sleepycat/db/SecondaryConfig.html#setAllowPopulate(boolean)"><CODE>setAllowPopulate(boolean)</CODE></A></DL> -</DD> -</DL> -<HR> - -<A NAME="setImmutableSecondaryKey(boolean)"><!-- --></A><H3> -setImmutableSecondaryKey</H3> -<PRE> -public void <B>setImmutableSecondaryKey</B>(boolean immutableSecondaryKey)</PRE> -<DL> -<DD>Specifies whether the secondary key is immutable. + <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 @@ -474,44 +438,33 @@ public void <B>setImmutableSecondaryKey</B>(boolean immutableSecondaryKey)< 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> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>immutableSecondaryKey</CODE> - whether the secondary key is immutable.</DL> -</DD> -</DL> -<HR> - -<A NAME="getImmutableSecondaryKey()"><!-- --></A><H3> -getImmutableSecondaryKey</H3> -<PRE> -public boolean <B>getImmutableSecondaryKey</B>()</PRE> -<DL> -<DD>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 + <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> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>whether the secondary key is immutable. - <p><DT><B>See Also:</B><DD><A HREF="../../../com/sleepycat/db/SecondaryConfig.html#setImmutableSecondaryKey(boolean)"><CODE>setImmutableSecondaryKey(boolean)</CODE></A></DL> -</DD> -</DL> -<HR> - -<A NAME="setKeyCreator(com.sleepycat.db.SecondaryKeyCreator)"><!-- --></A><H3> -setKeyCreator</H3> -<PRE> -public void <B>setKeyCreator</B>(<A HREF="../../../com/sleepycat/db/SecondaryKeyCreator.html" title="interface in com.sleepycat.db">SecondaryKeyCreator</A> keyCreator)</PRE> -<DL> -<DD>Specifies the user-supplied object used for creating single-valued + <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 @@ -520,89 +473,67 @@ public void <B>setKeyCreator</B>(<A HREF="../../../com/sleepycat/db/SecondaryKey <p> Unless the primary database is read-only, a key creator is required when opening a secondary database. - <p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>keyCreator</CODE> - the user-supplied object used for creating single-valued - secondary keys.</DL> -</DD> -</DL> -<HR> - -<A NAME="getKeyCreator()"><!-- --></A><H3> -getKeyCreator</H3> -<PRE> -public <A HREF="../../../com/sleepycat/db/SecondaryKeyCreator.html" title="interface in com.sleepycat.db">SecondaryKeyCreator</A> <B>getKeyCreator</B>()</PRE> -<DL> -<DD>Returns the user-supplied object used for creating single-valued secondary + <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> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>the user-supplied object used for creating single-valued secondary + <p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the user-supplied object used for creating single-valued secondary keys. - <p><DT><B>See Also:</B><DD><A HREF="../../../com/sleepycat/db/SecondaryConfig.html#setKeyCreator(com.sleepycat.db.SecondaryKeyCreator)"><CODE>setKeyCreator(com.sleepycat.db.SecondaryKeyCreator)</CODE></A></DL> -</DD> -</DL> -<HR> - -<A NAME="setMultiKeyCreator(com.sleepycat.db.SecondaryMultiKeyCreator)"><!-- --></A><H3> -setMultiKeyCreator</H3> -<PRE> -public void <B>setMultiKeyCreator</B>(<A HREF="../../../com/sleepycat/db/SecondaryMultiKeyCreator.html" title="interface in com.sleepycat.db">SecondaryMultiKeyCreator</A> multiKeyCreator)</PRE> -<DL> -<DD>Specifies the user-supplied object used for creating multi-valued + <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> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>multiKeyCreator</CODE> - the user-supplied object used for creating multi-valued - secondary keys.</DL> -</DD> -</DL> -<HR> - -<A NAME="getMultiKeyCreator()"><!-- --></A><H3> -getMultiKeyCreator</H3> -<PRE> -public <A HREF="../../../com/sleepycat/db/SecondaryMultiKeyCreator.html" title="interface in com.sleepycat.db">SecondaryMultiKeyCreator</A> <B>getMultiKeyCreator</B>()</PRE> -<DL> -<DD>Returns the user-supplied object used for creating multi-valued secondary + <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> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>the user-supplied object used for creating multi-valued secondary + <p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the user-supplied object used for creating multi-valued secondary keys. - <p><DT><B>See Also:</B><DD><A HREF="../../../com/sleepycat/db/SecondaryConfig.html#setKeyCreator(com.sleepycat.db.SecondaryKeyCreator)"><CODE>setKeyCreator(com.sleepycat.db.SecondaryKeyCreator)</CODE></A></DL> -</DD> -</DL> -<HR> - -<A NAME="setForeignKeyDatabase(com.sleepycat.db.Database)"><!-- --></A><H3> -setForeignKeyDatabase</H3> -<PRE> -public void <B>setForeignKeyDatabase</B>(<A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</A> foreignDb)</PRE> -<DL> -<DD>Defines a foreign key integrity constraint for a given foreign key + <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 @@ -611,86 +542,64 @@ public void <B>setForeignKeyDatabase</B>(<A HREF="../../../com/sleepycat/db/Data 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> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>foreignDb</CODE> - the database used to check the foreign key + <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.</DL> -</DD> -</DL> -<HR> - -<A NAME="getForeignKeyDatabase()"><!-- --></A><H3> -getForeignKeyDatabase</H3> -<PRE> -public com.sleepycat.db.internal.Db <B>getForeignKeyDatabase</B>()</PRE> -<DL> -<DD>Returns the database used to check the foreign key integrity constraint, - or null if no foreign key constraint will be checked. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>the foreign key database, or null.<DT><B>See Also:</B><DD><A HREF="../../../com/sleepycat/db/SecondaryConfig.html#setForeignKeyDatabase(com.sleepycat.db.Database)"><CODE>setForeignKeyDatabase(com.sleepycat.db.Database)</CODE></A></DL> -</DD> -</DL> -<HR> - -<A NAME="setForeignKeyDeleteAction(com.sleepycat.db.ForeignKeyDeleteAction)"><!-- --></A><H3> -setForeignKeyDeleteAction</H3> -<PRE> -public void <B>setForeignKeyDeleteAction</B>(<A HREF="../../../com/sleepycat/db/ForeignKeyDeleteAction.html" title="class in com.sleepycat.db">ForeignKeyDeleteAction</A> action)</PRE> -<DL> -<DD>Specifies the action taken when a referenced record in the foreign key + 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> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>action</CODE> - the action taken when a referenced record - in the foreign key database is deleted.<DT><B>See Also:</B><DD><A HREF="../../../com/sleepycat/db/ForeignKeyDeleteAction.html" title="class in com.sleepycat.db"><CODE>@see #setForeignKeyDatabase</CODE></A></DL> -</DD> -</DL> -<HR> - -<A NAME="getForeignKeyDeleteAction()"><!-- --></A><H3> -getForeignKeyDeleteAction</H3> -<PRE> -public <A HREF="../../../com/sleepycat/db/ForeignKeyDeleteAction.html" title="class in com.sleepycat.db">ForeignKeyDeleteAction</A> <B>getForeignKeyDeleteAction</B>()</PRE> -<DL> -<DD>Returns the action taken when a referenced record in the foreign key - database is deleted. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>the action taken when a referenced record in the foreign key - database is deleted.<DT><B>See Also:</B><DD><A HREF="../../../com/sleepycat/db/SecondaryConfig.html#setForeignKeyDeleteAction(com.sleepycat.db.ForeignKeyDeleteAction)"><CODE>setForeignKeyDeleteAction(com.sleepycat.db.ForeignKeyDeleteAction)</CODE></A></DL> -</DD> -</DL> -<HR> - -<A NAME="setForeignKeyNullifier(com.sleepycat.db.ForeignKeyNullifier)"><!-- --></A><H3> -setForeignKeyNullifier</H3> -<PRE> -public void <B>setForeignKeyNullifier</B>(<A HREF="../../../com/sleepycat/db/ForeignKeyNullifier.html" title="interface in com.sleepycat.db">ForeignKeyNullifier</A> keyNullifier)</PRE> -<DL> -<DD>Specifies the user-supplied object used for setting single-valued + 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>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 @@ -700,44 +609,33 @@ public void <B>setForeignKeyNullifier</B>(<A HREF="../../../com/sleepycat/db/For 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> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>keyNullifier</CODE> - the user-supplied object used for setting - single-valued foreign keys to null.<DT><B>See Also:</B><DD><A HREF="../../../com/sleepycat/db/ForeignKeyNullifier.html" title="interface in com.sleepycat.db"><CODE>@see ForeignKeyDeleteAction#NULLIFY @see - #setForeignKeyDatabase</CODE></A></DL> -</DD> -</DL> -<HR> - -<A NAME="getForeignKeyNullifier()"><!-- --></A><H3> -getForeignKeyNullifier</H3> -<PRE> -public <A HREF="../../../com/sleepycat/db/ForeignKeyNullifier.html" title="interface in com.sleepycat.db">ForeignKeyNullifier</A> <B>getForeignKeyNullifier</B>()</PRE> -<DL> -<DD>Returns the user-supplied object used for setting single-valued foreign - keys to null. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>the user-supplied object used for setting single-valued foreign - keys to null.<DT><B>See Also:</B><DD><A HREF="../../../com/sleepycat/db/SecondaryConfig.html#setForeignKeyNullifier(com.sleepycat.db.ForeignKeyNullifier)"><CODE>setForeignKeyNullifier(com.sleepycat.db.ForeignKeyNullifier)</CODE></A></DL> -</DD> -</DL> -<HR> - -<A NAME="setForeignMultiKeyNullifier(com.sleepycat.db.ForeignMultiKeyNullifier)"><!-- --></A><H3> -setForeignMultiKeyNullifier</H3> -<PRE> -public void <B>setForeignMultiKeyNullifier</B>(<A HREF="../../../com/sleepycat/db/ForeignMultiKeyNullifier.html" title="interface in com.sleepycat.db">ForeignMultiKeyNullifier</A> multiKeyNullifier)</PRE> -<DL> -<DD>Specifies the user-supplied object used for setting multi-valued foreign + 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 @@ -748,97 +646,93 @@ public void <B>setForeignMultiKeyNullifier</B>(<A HREF="../../../com/sleepycat/d 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> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>multiKeyNullifier</CODE> - the user-supplied object used for - setting multi-valued foreign keys to null.<DT><B>See Also:</B><DD><A HREF="../../../com/sleepycat/db/ForeignMultiKeyNullifier.html" title="interface in com.sleepycat.db"><CODE>@see ForeignKeyDeleteAction#NULLIFY @see - #setForeignKeyDatabase</CODE></A></DL> -</DD> -</DL> -<HR> - -<A NAME="getForeignMultiKeyNullifier()"><!-- --></A><H3> -getForeignMultiKeyNullifier</H3> -<PRE> -public <A HREF="../../../com/sleepycat/db/ForeignMultiKeyNullifier.html" title="interface in com.sleepycat.db">ForeignMultiKeyNullifier</A> <B>getForeignMultiKeyNullifier</B>()</PRE> -<DL> -<DD>Returns the user-supplied object used for setting multi-valued foreign - keys to null. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>the user-supplied object used for setting multi-valued foreign - keys to null.<DT><B>See Also:</B><DD><A HREF="../../../com/sleepycat/db/SecondaryConfig.html#setForeignMultiKeyNullifier(com.sleepycat.db.ForeignMultiKeyNullifier)"><CODE>setForeignMultiKeyNullifier(com.sleepycat.db.ForeignMultiKeyNullifier)</CODE></A></DL> -</DD> -</DL> + 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 ========= --> -<HR> - - <!-- ======= START OF BOTTOM NAVBAR ====== --> -<A NAME="navbar_bottom"><!-- --></A> -<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> -<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> -<TR> -<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> -<A NAME="navbar_bottom_firstrow"><!-- --></A> -<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> - <TR ALIGN="center" VALIGN="top"> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> - <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SecondaryConfig.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> - </TR> -</TABLE> -</TD> -<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> -<b>Berkeley DB</b><br><font size="-1"> version 5.3.21</font></EM> -</TD> -</TR> - -<TR> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../com/sleepycat/db/RunRecoveryException.html" title="class in com.sleepycat.db"><B>PREV CLASS</B></A> - <A HREF="../../../com/sleepycat/db/SecondaryCursor.html" title="class in com.sleepycat.db"><B>NEXT CLASS</B></A></FONT></TD> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../index.html?com/sleepycat/db/SecondaryConfig.html" target="_top"><B>FRAMES</B></A> - <A HREF="SecondaryConfig.html" target="_top"><B>NO FRAMES</B></A> - <SCRIPT type="text/javascript"> - <!-- +<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.23</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) { - document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; } //--> -</SCRIPT> -<NOSCRIPT> - <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> -</NOSCRIPT> - - -</FONT></TD> -</TR> -<TR> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> - SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> -DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> -</TR> -</TABLE> -<A NAME="skip-navbar_bottom"></A> +</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 ======= --> - -<HR> -<font size=1>Copyright (c) 1996, 2012 Oracle and/or its affiliates. All rights reserved.</font> -</BODY> -</HTML> +<p class="legalCopy"><small><font size=1>Copyright (c) 1996, 2015 Oracle and/or its affiliates. All rights reserved.</font></small></p> +</body> +</html> |
