• Home
  • History
  • Annotate
  • Line#
  • Navigate
  • Raw
  • Download
  • only in /netgear-WNDR4500-V1.0.1.40_1.0.68/ap/gpl/timemachine/db-4.7.25.NC/docs/java/com/sleepycat/db/
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!--NewPage-->
3<HTML>
4<HEAD>
5<!-- Generated by javadoc (build 1.5.0) on Thu May 15 17:17:31 EDT 2008 -->
6<TITLE>
7SecondaryConfig (Oracle - Berkeley DB Java API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="com.sleepycat.db.SecondaryConfig class">
11
12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../style.css" TITLE="Style">
13
14<SCRIPT type="text/javascript">
15function windowTitle()
16{
17    parent.document.title="SecondaryConfig (Oracle - Berkeley DB Java API)";
18}
19</SCRIPT>
20<NOSCRIPT>
21</NOSCRIPT>
22
23</HEAD>
24
25<BODY BGCOLOR="white" onload="windowTitle();">
26
27
28<!-- ========= START OF TOP NAVBAR ======= -->
29<A NAME="navbar_top"><!-- --></A>
30<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
31<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
32<TR>
33<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
34<A NAME="navbar_top_firstrow"><!-- --></A>
35<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
36  <TR ALIGN="center" VALIGN="top">
37  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
38  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
39  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
40  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/SecondaryConfig.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
41  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
42  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
43  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
44  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
45  </TR>
46</TABLE>
47</TD>
48<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
49<b>Berkeley DB</b><br><font size="-1"> version 4.7.25</font></EM>
50</TD>
51</TR>
52
53<TR>
54<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
55&nbsp;<A HREF="../../../com/sleepycat/db/RunRecoveryException.html" title="class in com.sleepycat.db"><B>PREV CLASS</B></A>&nbsp;
56&nbsp;<A HREF="../../../com/sleepycat/db/SecondaryCursor.html" title="class in com.sleepycat.db"><B>NEXT CLASS</B></A></FONT></TD>
57<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
58  <A HREF="../../../index.html?com/sleepycat/db/SecondaryConfig.html" target="_top"><B>FRAMES</B></A>  &nbsp;
59&nbsp;<A HREF="SecondaryConfig.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
60&nbsp;<SCRIPT type="text/javascript">
61  <!--
62  if(window==top) {
63    document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
64  }
65  //-->
66</SCRIPT>
67<NOSCRIPT>
68  <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
69</NOSCRIPT>
70
71
72</FONT></TD>
73</TR>
74<TR>
75<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
76  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
77<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
78DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
79</TR>
80</TABLE>
81<A NAME="skip-navbar_top"></A>
82<!-- ========= END OF TOP NAVBAR ========= -->
83
84<HR>
85<!-- ======== START OF CLASS DATA ======== -->
86<H2>
87<FONT SIZE="-1">
88com.sleepycat.db</FONT>
89<BR>
90Class SecondaryConfig</H2>
91<PRE>
92<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">java.lang.Object</A>
93  <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>
94      <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>com.sleepycat.db.SecondaryConfig</B>
95</PRE>
96<DL>
97<DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Cloneable.html" title="class or interface in java.lang">Cloneable</A></DD>
98</DL>
99<HR>
100<DL>
101<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://java.sun.com/j2se/1.5.0/docs/api/java/lang/Cloneable.html" title="class or interface in java.lang">Cloneable</A></DL>
102</PRE>
103
104<P>
105The configuration properties of a <code>SecondaryDatabase</code> extend
106those of a primary <code>Database</code>.
107The 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>.
108<p>
109To create a configuration object with default attributes:
110<pre>
111    SecondaryConfig config = new SecondaryConfig();
112</pre>
113To set custom attributes:
114<pre>
115    SecondaryConfig config = new SecondaryConfig();
116    config.setAllowCreate(true);
117    config.setSortedDuplicates(true);
118    config.setKeyCreator(new MyKeyCreator());
119</pre>
120<p>
121<hr>
122<p>
123NOTE: There are two situations where the use of secondary databases without
124transactions requires special consideration.  When using a transactional
125database or when doing read operations only, this note does not apply.
126<ul>
127<li>If secondary is configured to not allow duplicates, when the secondary
128is being updated it is possible that an error will occur when the secondary
129key value in a record being added is already present in the database.  A
130<code>DatabaseException</code> will be thrown in this situation.</li>
131<li>If a foreign key constraint is configured with the delete action
132<code>ABORT</code> (the default setting), a <code>DatabaseException</code>
133will be thrown if an attempt is made to delete a referenced foreign
134key.</li>
135</ul>
136In both cases, the operation will be partially complete because the primary
137database record will have already been updated or deleted.  In the presence
138of transactions, the exception will cause the transaction to abort.  Without
139transactions, it is the responsibility of the caller to handle the results
140of the incomplete update or to take steps to prevent this situation from
141happening in the first place.
142<p>
143</hr>
144<p>
145<P>
146
147<P>
148<DL>
149<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>, 
150<A HREF="../../../com/sleepycat/db/SecondaryDatabase.html" title="class in com.sleepycat.db"><CODE>SecondaryDatabase</CODE></A></DL>
151<HR>
152
153<P>
154<!-- =========== FIELD SUMMARY =========== -->
155
156<A NAME="field_summary"><!-- --></A>
157<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
158<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
159<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
160<B>Field Summary</B></FONT></TH>
161</TR>
162<TR BGCOLOR="white" CLASS="TableRowColor">
163<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
164<CODE>static&nbsp;<A HREF="../../../com/sleepycat/db/SecondaryConfig.html" title="class in com.sleepycat.db">SecondaryConfig</A></CODE></FONT></TD>
165<TD><CODE><B><A HREF="../../../com/sleepycat/db/SecondaryConfig.html#DEFAULT">DEFAULT</A></B></CODE>
166
167<BR>
168&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
169</TR>
170</TABLE>
171&nbsp;
172<!-- ======== CONSTRUCTOR SUMMARY ======== -->
173
174<A NAME="constructor_summary"><!-- --></A>
175<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
176<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
177<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
178<B>Constructor Summary</B></FONT></TH>
179</TR>
180<TR BGCOLOR="white" CLASS="TableRowColor">
181<TD><CODE><B><A HREF="../../../com/sleepycat/db/SecondaryConfig.html#SecondaryConfig()">SecondaryConfig</A></B>()</CODE>
182
183<BR>
184&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates an instance with the system's default settings.</TD>
185</TR>
186</TABLE>
187&nbsp;
188<!-- ========== METHOD SUMMARY =========== -->
189
190<A NAME="method_summary"><!-- --></A>
191<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
192<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
193<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
194<B>Method Summary</B></FONT></TH>
195</TR>
196<TR BGCOLOR="white" CLASS="TableRowColor">
197<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
198<CODE>&nbsp;boolean</CODE></FONT></TD>
199<TD><CODE><B><A HREF="../../../com/sleepycat/db/SecondaryConfig.html#getAllowPopulate()">getAllowPopulate</A></B>()</CODE>
200
201<BR>
202&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns whether automatic population of the secondary is allowed.</TD>
203</TR>
204<TR BGCOLOR="white" CLASS="TableRowColor">
205<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
206<CODE>&nbsp;com.sleepycat.db.internal.Db</CODE></FONT></TD>
207<TD><CODE><B><A HREF="../../../com/sleepycat/db/SecondaryConfig.html#getForeignKeyDatabase()">getForeignKeyDatabase</A></B>()</CODE>
208
209<BR>
210&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
211</TR>
212<TR BGCOLOR="white" CLASS="TableRowColor">
213<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
214<CODE>&nbsp;<A HREF="../../../com/sleepycat/db/ForeignKeyDeleteAction.html" title="class in com.sleepycat.db">ForeignKeyDeleteAction</A></CODE></FONT></TD>
215<TD><CODE><B><A HREF="../../../com/sleepycat/db/SecondaryConfig.html#getForeignKeyDeleteAction()">getForeignKeyDeleteAction</A></B>()</CODE>
216
217<BR>
218&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
219</TR>
220<TR BGCOLOR="white" CLASS="TableRowColor">
221<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
222<CODE>&nbsp;<A HREF="../../../com/sleepycat/db/ForeignKeyNullifier.html" title="interface in com.sleepycat.db">ForeignKeyNullifier</A></CODE></FONT></TD>
223<TD><CODE><B><A HREF="../../../com/sleepycat/db/SecondaryConfig.html#getForeignKeyNullifier()">getForeignKeyNullifier</A></B>()</CODE>
224
225<BR>
226&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
227</TR>
228<TR BGCOLOR="white" CLASS="TableRowColor">
229<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
230<CODE>&nbsp;<A HREF="../../../com/sleepycat/db/ForeignMultiKeyNullifier.html" title="interface in com.sleepycat.db">ForeignMultiKeyNullifier</A></CODE></FONT></TD>
231<TD><CODE><B><A HREF="../../../com/sleepycat/db/SecondaryConfig.html#getForeignMultiKeyNullifier()">getForeignMultiKeyNullifier</A></B>()</CODE>
232
233<BR>
234&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
235</TR>
236<TR BGCOLOR="white" CLASS="TableRowColor">
237<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
238<CODE>&nbsp;boolean</CODE></FONT></TD>
239<TD><CODE><B><A HREF="../../../com/sleepycat/db/SecondaryConfig.html#getImmutableSecondaryKey()">getImmutableSecondaryKey</A></B>()</CODE>
240
241<BR>
242&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns whether the secondary key is immutable.</TD>
243</TR>
244<TR BGCOLOR="white" CLASS="TableRowColor">
245<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
246<CODE>&nbsp;<A HREF="../../../com/sleepycat/db/SecondaryKeyCreator.html" title="interface in com.sleepycat.db">SecondaryKeyCreator</A></CODE></FONT></TD>
247<TD><CODE><B><A HREF="../../../com/sleepycat/db/SecondaryConfig.html#getKeyCreator()">getKeyCreator</A></B>()</CODE>
248
249<BR>
250&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the user-supplied object used for creating single-valued secondary
251    keys.</TD>
252</TR>
253<TR BGCOLOR="white" CLASS="TableRowColor">
254<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
255<CODE>&nbsp;<A HREF="../../../com/sleepycat/db/SecondaryMultiKeyCreator.html" title="interface in com.sleepycat.db">SecondaryMultiKeyCreator</A></CODE></FONT></TD>
256<TD><CODE><B><A HREF="../../../com/sleepycat/db/SecondaryConfig.html#getMultiKeyCreator()">getMultiKeyCreator</A></B>()</CODE>
257
258<BR>
259&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the user-supplied object used for creating multi-valued secondary
260    keys.</TD>
261</TR>
262<TR BGCOLOR="white" CLASS="TableRowColor">
263<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
264<CODE>&nbsp;void</CODE></FONT></TD>
265<TD><CODE><B><A HREF="../../../com/sleepycat/db/SecondaryConfig.html#setAllowPopulate(boolean)">setAllowPopulate</A></B>(boolean&nbsp;allowPopulate)</CODE>
266
267<BR>
268&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Specifies whether automatic population of the secondary is allowed.</TD>
269</TR>
270<TR BGCOLOR="white" CLASS="TableRowColor">
271<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
272<CODE>&nbsp;void</CODE></FONT></TD>
273<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>&nbsp;foreignDb)</CODE>
274
275<BR>
276&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
277</TR>
278<TR BGCOLOR="white" CLASS="TableRowColor">
279<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
280<CODE>&nbsp;void</CODE></FONT></TD>
281<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>&nbsp;action)</CODE>
282
283<BR>
284&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
285</TR>
286<TR BGCOLOR="white" CLASS="TableRowColor">
287<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
288<CODE>&nbsp;void</CODE></FONT></TD>
289<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>&nbsp;keyNullifier)</CODE>
290
291<BR>
292&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
293</TR>
294<TR BGCOLOR="white" CLASS="TableRowColor">
295<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
296<CODE>&nbsp;void</CODE></FONT></TD>
297<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>&nbsp;multiKeyNullifier)</CODE>
298
299<BR>
300&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
301</TR>
302<TR BGCOLOR="white" CLASS="TableRowColor">
303<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
304<CODE>&nbsp;void</CODE></FONT></TD>
305<TD><CODE><B><A HREF="../../../com/sleepycat/db/SecondaryConfig.html#setImmutableSecondaryKey(boolean)">setImmutableSecondaryKey</A></B>(boolean&nbsp;immutableSecondaryKey)</CODE>
306
307<BR>
308&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Specifies whether the secondary key is immutable.</TD>
309</TR>
310<TR BGCOLOR="white" CLASS="TableRowColor">
311<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
312<CODE>&nbsp;void</CODE></FONT></TD>
313<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>&nbsp;keyCreator)</CODE>
314
315<BR>
316&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Specifies the user-supplied object used for creating single-valued
317    secondary keys.</TD>
318</TR>
319<TR BGCOLOR="white" CLASS="TableRowColor">
320<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
321<CODE>&nbsp;void</CODE></FONT></TD>
322<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>&nbsp;multiKeyCreator)</CODE>
323
324<BR>
325&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Specifies the user-supplied object used for creating multi-valued
326    secondary keys.</TD>
327</TR>
328</TABLE>
329&nbsp;<A NAME="methods_inherited_from_class_com.sleepycat.db.DatabaseConfig"><!-- --></A>
330<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
331<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
332<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>
333</TR>
334<TR BGCOLOR="white" CLASS="TableRowColor">
335<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#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#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#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#getPageSize()">getPageSize</A>, <A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getPanicHandler()">getPanicHandler</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#getXACreate()">getXACreate</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#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#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#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#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#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>, <A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setXACreate(boolean)">setXACreate</A></CODE></TD>
336</TR>
337</TABLE>
338&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
339<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
340<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
341<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></B></TH>
342</TR>
343<TR BGCOLOR="white" CLASS="TableRowColor">
344<TD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
345</TR>
346</TABLE>
347&nbsp;
348<P>
349
350<!-- ============ FIELD DETAIL =========== -->
351
352<A NAME="field_detail"><!-- --></A>
353<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
354<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
355<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
356<B>Field Detail</B></FONT></TH>
357</TR>
358</TABLE>
359
360<A NAME="DEFAULT"><!-- --></A><H3>
361DEFAULT</H3>
362<PRE>
363public static final <A HREF="../../../com/sleepycat/db/SecondaryConfig.html" title="class in com.sleepycat.db">SecondaryConfig</A> <B>DEFAULT</B></PRE>
364<DL>
365<DL>
366</DL>
367</DL>
368
369<!-- ========= CONSTRUCTOR DETAIL ======== -->
370
371<A NAME="constructor_detail"><!-- --></A>
372<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
373<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
374<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
375<B>Constructor Detail</B></FONT></TH>
376</TR>
377</TABLE>
378
379<A NAME="SecondaryConfig()"><!-- --></A><H3>
380SecondaryConfig</H3>
381<PRE>
382public <B>SecondaryConfig</B>()</PRE>
383<DL>
384<DD>Creates an instance with the system's default settings.
385<P>
386</DL>
387
388<!-- ============ METHOD DETAIL ========== -->
389
390<A NAME="method_detail"><!-- --></A>
391<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
392<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
393<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
394<B>Method Detail</B></FONT></TH>
395</TR>
396</TABLE>
397
398<A NAME="setAllowPopulate(boolean)"><!-- --></A><H3>
399setAllowPopulate</H3>
400<PRE>
401public void <B>setAllowPopulate</B>(boolean&nbsp;allowPopulate)</PRE>
402<DL>
403<DD>Specifies whether automatic population of the secondary is allowed.
404    <p>
405    If automatic population is allowed, when the secondary database is
406    opened it is checked to see if it is empty.  If it is empty, the
407    primary database is read in its entirety and keys are added to the
408    secondary database using the information read from the primary.
409    <p>
410    If this property is set to true and the database is transactional, the
411    population of the secondary will be done within the explicit or auto-commit
412    transaction that is used to open the database.
413    <p>
414<P>
415<DD><DL>
416</DL>
417</DD>
418<DD><DL>
419<DT><B>Parameters:</B><DD><CODE>allowPopulate</CODE> - whether automatic population of the secondary is
420    allowed.</DL>
421</DD>
422</DL>
423<HR>
424
425<A NAME="getAllowPopulate()"><!-- --></A><H3>
426getAllowPopulate</H3>
427<PRE>
428public boolean <B>getAllowPopulate</B>()</PRE>
429<DL>
430<DD>Returns whether automatic population of the secondary is allowed.  If
431    <A HREF="../../../com/sleepycat/db/SecondaryConfig.html#setAllowPopulate(boolean)"><CODE>setAllowPopulate(boolean)</CODE></A> has not been called, this method returns
432    false.
433    <p>
434<P>
435<DD><DL>
436</DL>
437</DD>
438<DD><DL>
439
440<DT><B>Returns:</B><DD>whether automatic population of the secondary is allowed.
441    <p><DT><B>See Also:</B><DD><A HREF="../../../com/sleepycat/db/SecondaryConfig.html#setAllowPopulate(boolean)"><CODE>setAllowPopulate(boolean)</CODE></A></DL>
442</DD>
443</DL>
444<HR>
445
446<A NAME="setImmutableSecondaryKey(boolean)"><!-- --></A><H3>
447setImmutableSecondaryKey</H3>
448<PRE>
449public void <B>setImmutableSecondaryKey</B>(boolean&nbsp;immutableSecondaryKey)</PRE>
450<DL>
451<DD>Specifies whether the secondary key is immutable.
452    <p>
453    Specifying that a secondary key is immutable can be used to optimize
454    updates when the secondary key in a primary record will never be changed
455    after that primary record is inserted.  For immutable secondary keys, a
456    best effort is made to avoid calling
457    <code>SecondaryKeyCreator.createSecondaryKey</code> when a primary record
458    is updated.  This optimization may reduce the overhead of an update
459    operation significantly if the <code>createSecondaryKey</code> operation is
460    expensive.
461    <p>
462    Be sure to set this property to true only if the secondary key in the
463    primary record is never changed.  If this rule is violated, the secondary
464    index will become corrupted, that is, it will become out of sync with the
465    primary.
466    <p>
467<P>
468<DD><DL>
469</DL>
470</DD>
471<DD><DL>
472<DT><B>Parameters:</B><DD><CODE>immutableSecondaryKey</CODE> - whether the secondary key is immutable.</DL>
473</DD>
474</DL>
475<HR>
476
477<A NAME="getImmutableSecondaryKey()"><!-- --></A><H3>
478getImmutableSecondaryKey</H3>
479<PRE>
480public boolean <B>getImmutableSecondaryKey</B>()</PRE>
481<DL>
482<DD>Returns whether the secondary key is immutable.  If
483    <A HREF="../../../com/sleepycat/db/SecondaryConfig.html#setImmutableSecondaryKey(boolean)"><CODE>setImmutableSecondaryKey(boolean)</CODE></A> has not been called, this method returns
484    false.
485    <p>
486<P>
487<DD><DL>
488</DL>
489</DD>
490<DD><DL>
491
492<DT><B>Returns:</B><DD>whether the secondary key is immutable.
493    <p><DT><B>See Also:</B><DD><A HREF="../../../com/sleepycat/db/SecondaryConfig.html#setImmutableSecondaryKey(boolean)"><CODE>setImmutableSecondaryKey(boolean)</CODE></A></DL>
494</DD>
495</DL>
496<HR>
497
498<A NAME="setKeyCreator(com.sleepycat.db.SecondaryKeyCreator)"><!-- --></A><H3>
499setKeyCreator</H3>
500<PRE>
501public void <B>setKeyCreator</B>(<A HREF="../../../com/sleepycat/db/SecondaryKeyCreator.html" title="interface in com.sleepycat.db">SecondaryKeyCreator</A>&nbsp;keyCreator)</PRE>
502<DL>
503<DD>Specifies the user-supplied object used for creating single-valued
504    secondary keys.
505    <p>
506    Unless the primary database is read-only, a key creator is required
507    when opening a secondary database.  Either a KeyCreator or MultiKeyCreator
508    must be specified, but both may not be specified.
509    <p>
510    Unless the primary database is read-only, a key creator is required
511    when opening a secondary database.
512    <p>
513<P>
514<DD><DL>
515</DL>
516</DD>
517<DD><DL>
518<DT><B>Parameters:</B><DD><CODE>keyCreator</CODE> - the user-supplied object used for creating single-valued
519    secondary keys.</DL>
520</DD>
521</DL>
522<HR>
523
524<A NAME="getKeyCreator()"><!-- --></A><H3>
525getKeyCreator</H3>
526<PRE>
527public <A HREF="../../../com/sleepycat/db/SecondaryKeyCreator.html" title="interface in com.sleepycat.db">SecondaryKeyCreator</A> <B>getKeyCreator</B>()</PRE>
528<DL>
529<DD>Returns the user-supplied object used for creating single-valued secondary
530    keys.
531    <p>
532<P>
533<DD><DL>
534</DL>
535</DD>
536<DD><DL>
537
538<DT><B>Returns:</B><DD>the user-supplied object used for creating single-valued secondary
539    keys.
540    <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>
541</DD>
542</DL>
543<HR>
544
545<A NAME="setMultiKeyCreator(com.sleepycat.db.SecondaryMultiKeyCreator)"><!-- --></A><H3>
546setMultiKeyCreator</H3>
547<PRE>
548public void <B>setMultiKeyCreator</B>(<A HREF="../../../com/sleepycat/db/SecondaryMultiKeyCreator.html" title="interface in com.sleepycat.db">SecondaryMultiKeyCreator</A>&nbsp;multiKeyCreator)</PRE>
549<DL>
550<DD>Specifies the user-supplied object used for creating multi-valued
551    secondary keys.
552    <p>
553    Unless the primary database is read-only, a key creator is required
554    when opening a secondary database.  Either a KeyCreator or MultiKeyCreator
555    must be specified, but both may not be specified.
556    <p>
557<P>
558<DD><DL>
559</DL>
560</DD>
561<DD><DL>
562<DT><B>Parameters:</B><DD><CODE>multiKeyCreator</CODE> - the user-supplied object used for creating multi-valued
563    secondary keys.</DL>
564</DD>
565</DL>
566<HR>
567
568<A NAME="getMultiKeyCreator()"><!-- --></A><H3>
569getMultiKeyCreator</H3>
570<PRE>
571public <A HREF="../../../com/sleepycat/db/SecondaryMultiKeyCreator.html" title="interface in com.sleepycat.db">SecondaryMultiKeyCreator</A> <B>getMultiKeyCreator</B>()</PRE>
572<DL>
573<DD>Returns the user-supplied object used for creating multi-valued secondary
574    keys.
575    <p>
576<P>
577<DD><DL>
578</DL>
579</DD>
580<DD><DL>
581
582<DT><B>Returns:</B><DD>the user-supplied object used for creating multi-valued secondary
583    keys.
584    <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>
585</DD>
586</DL>
587<HR>
588
589<A NAME="setForeignKeyDatabase(com.sleepycat.db.Database)"><!-- --></A><H3>
590setForeignKeyDatabase</H3>
591<PRE>
592public void <B>setForeignKeyDatabase</B>(<A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</A>&nbsp;foreignDb)</PRE>
593<DL>
594<DD><DL>
595</DL>
596</DD>
597<DD><DL>
598</DL>
599</DD>
600</DL>
601<HR>
602
603<A NAME="getForeignKeyDatabase()"><!-- --></A><H3>
604getForeignKeyDatabase</H3>
605<PRE>
606public com.sleepycat.db.internal.Db <B>getForeignKeyDatabase</B>()</PRE>
607<DL>
608<DD><DL>
609</DL>
610</DD>
611<DD><DL>
612</DL>
613</DD>
614</DL>
615<HR>
616
617<A NAME="setForeignKeyDeleteAction(com.sleepycat.db.ForeignKeyDeleteAction)"><!-- --></A><H3>
618setForeignKeyDeleteAction</H3>
619<PRE>
620public void <B>setForeignKeyDeleteAction</B>(<A HREF="../../../com/sleepycat/db/ForeignKeyDeleteAction.html" title="class in com.sleepycat.db">ForeignKeyDeleteAction</A>&nbsp;action)</PRE>
621<DL>
622<DD><DL>
623</DL>
624</DD>
625<DD><DL>
626</DL>
627</DD>
628</DL>
629<HR>
630
631<A NAME="getForeignKeyDeleteAction()"><!-- --></A><H3>
632getForeignKeyDeleteAction</H3>
633<PRE>
634public <A HREF="../../../com/sleepycat/db/ForeignKeyDeleteAction.html" title="class in com.sleepycat.db">ForeignKeyDeleteAction</A> <B>getForeignKeyDeleteAction</B>()</PRE>
635<DL>
636<DD><DL>
637</DL>
638</DD>
639<DD><DL>
640</DL>
641</DD>
642</DL>
643<HR>
644
645<A NAME="setForeignKeyNullifier(com.sleepycat.db.ForeignKeyNullifier)"><!-- --></A><H3>
646setForeignKeyNullifier</H3>
647<PRE>
648public void <B>setForeignKeyNullifier</B>(<A HREF="../../../com/sleepycat/db/ForeignKeyNullifier.html" title="interface in com.sleepycat.db">ForeignKeyNullifier</A>&nbsp;keyNullifier)</PRE>
649<DL>
650<DD><DL>
651</DL>
652</DD>
653<DD><DL>
654</DL>
655</DD>
656</DL>
657<HR>
658
659<A NAME="getForeignKeyNullifier()"><!-- --></A><H3>
660getForeignKeyNullifier</H3>
661<PRE>
662public <A HREF="../../../com/sleepycat/db/ForeignKeyNullifier.html" title="interface in com.sleepycat.db">ForeignKeyNullifier</A> <B>getForeignKeyNullifier</B>()</PRE>
663<DL>
664<DD><DL>
665</DL>
666</DD>
667<DD><DL>
668</DL>
669</DD>
670</DL>
671<HR>
672
673<A NAME="setForeignMultiKeyNullifier(com.sleepycat.db.ForeignMultiKeyNullifier)"><!-- --></A><H3>
674setForeignMultiKeyNullifier</H3>
675<PRE>
676public void <B>setForeignMultiKeyNullifier</B>(<A HREF="../../../com/sleepycat/db/ForeignMultiKeyNullifier.html" title="interface in com.sleepycat.db">ForeignMultiKeyNullifier</A>&nbsp;multiKeyNullifier)</PRE>
677<DL>
678<DD><DL>
679</DL>
680</DD>
681<DD><DL>
682</DL>
683</DD>
684</DL>
685<HR>
686
687<A NAME="getForeignMultiKeyNullifier()"><!-- --></A><H3>
688getForeignMultiKeyNullifier</H3>
689<PRE>
690public <A HREF="../../../com/sleepycat/db/ForeignMultiKeyNullifier.html" title="interface in com.sleepycat.db">ForeignMultiKeyNullifier</A> <B>getForeignMultiKeyNullifier</B>()</PRE>
691<DL>
692<DD><DL>
693</DL>
694</DD>
695<DD><DL>
696</DL>
697</DD>
698</DL>
699<!-- ========= END OF CLASS DATA ========= -->
700<HR>
701
702
703<!-- ======= START OF BOTTOM NAVBAR ====== -->
704<A NAME="navbar_bottom"><!-- --></A>
705<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
706<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
707<TR>
708<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
709<A NAME="navbar_bottom_firstrow"><!-- --></A>
710<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
711  <TR ALIGN="center" VALIGN="top">
712  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
713  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
714  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
715  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/SecondaryConfig.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
716  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
717  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
718  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
719  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
720  </TR>
721</TABLE>
722</TD>
723<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
724<b>Berkeley DB</b><br><font size="-1"> version 4.7.25</font></EM>
725</TD>
726</TR>
727
728<TR>
729<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
730&nbsp;<A HREF="../../../com/sleepycat/db/RunRecoveryException.html" title="class in com.sleepycat.db"><B>PREV CLASS</B></A>&nbsp;
731&nbsp;<A HREF="../../../com/sleepycat/db/SecondaryCursor.html" title="class in com.sleepycat.db"><B>NEXT CLASS</B></A></FONT></TD>
732<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
733  <A HREF="../../../index.html?com/sleepycat/db/SecondaryConfig.html" target="_top"><B>FRAMES</B></A>  &nbsp;
734&nbsp;<A HREF="SecondaryConfig.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
735&nbsp;<SCRIPT type="text/javascript">
736  <!--
737  if(window==top) {
738    document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
739  }
740  //-->
741</SCRIPT>
742<NOSCRIPT>
743  <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
744</NOSCRIPT>
745
746
747</FONT></TD>
748</TR>
749<TR>
750<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
751  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
752<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
753DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
754</TR>
755</TABLE>
756<A NAME="skip-navbar_bottom"></A>
757<!-- ======== END OF BOTTOM NAVBAR ======= -->
758
759<HR>
760<font size=1>Copyright (c) 1996,2008 Oracle.  All rights reserved.</font>
761</BODY>
762</HTML>
763