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.6.0_03) on Mon Apr 12 16:25:47 EDT 2010 --> 6<TITLE> 7JoinConfig (Oracle - Berkeley DB Java API) 8</TITLE> 9 10<META NAME="date" CONTENT="2010-04-12"> 11 12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../style.css" TITLE="Style"> 13 14<SCRIPT type="text/javascript"> 15function windowTitle() 16{ 17 if (location.href.indexOf('is-external=true') == -1) { 18 parent.document.title="JoinConfig (Oracle - Berkeley DB Java API)"; 19 } 20} 21</SCRIPT> 22<NOSCRIPT> 23</NOSCRIPT> 24 25</HEAD> 26 27<BODY BGCOLOR="white" onload="windowTitle();"> 28<HR> 29 30 31<!-- ========= START OF TOP NAVBAR ======= --> 32<A NAME="navbar_top"><!-- --></A> 33<A HREF="#skip-navbar_top" title="Skip navigation links"></A> 34<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 35<TR> 36<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 37<A NAME="navbar_top_firstrow"><!-- --></A> 38<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 39 <TR ALIGN="center" VALIGN="top"> 40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 42 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/JoinConfig.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 46 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 47 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 48 </TR> 49</TABLE> 50</TD> 51<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 52<b>Berkeley DB</b><br><font size="-1"> version 4.8.30</font></EM> 53</TD> 54</TR> 55 56<TR> 57<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 58 <A HREF="../../../com/sleepycat/db/HashStats.html" title="class in com.sleepycat.db"><B>PREV CLASS</B></A> 59 <A HREF="../../../com/sleepycat/db/JoinCursor.html" title="class in com.sleepycat.db"><B>NEXT CLASS</B></A></FONT></TD> 60<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 61 <A HREF="../../../index.html?com/sleepycat/db/JoinConfig.html" target="_top"><B>FRAMES</B></A> 62 <A HREF="JoinConfig.html" target="_top"><B>NO FRAMES</B></A> 63 <SCRIPT type="text/javascript"> 64 <!-- 65 if(window==top) { 66 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); 67 } 68 //--> 69</SCRIPT> 70<NOSCRIPT> 71 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> 72</NOSCRIPT> 73 74 75</FONT></TD> 76</TR> 77<TR> 78<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 79 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> 80<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 81DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> 82</TR> 83</TABLE> 84<A NAME="skip-navbar_top"></A> 85<!-- ========= END OF TOP NAVBAR ========= --> 86 87<HR> 88<!-- ======== START OF CLASS DATA ======== --> 89<H2> 90<FONT SIZE="-1"> 91com.sleepycat.db</FONT> 92<BR> 93Class JoinConfig</H2> 94<PRE> 95<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A> 96 <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>com.sleepycat.db.JoinConfig</B> 97</PRE> 98<DL> 99<DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</A></DD> 100</DL> 101<HR> 102<DL> 103<DT><PRE>public class <B>JoinConfig</B><DT>extends <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A><DT>implements <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</A></DL> 104</PRE> 105 106<P> 107The configuration properties of a <code>JoinCursor</code>. 108The join cursor configuration is specified when calling <A HREF="../../../com/sleepycat/db/Database.html#join(com.sleepycat.db.Cursor[], com.sleepycat.db.JoinConfig)"><CODE>Database.join</CODE></A>. 109<p> 110To create a configuration object with default attributes: 111<pre> 112 JoinConfig config = new JoinConfig(); 113</pre> 114To set custom attributes: 115<pre> 116 JoinConfig config = new JoinConfig(); 117 config.setNoSort(true); 118</pre> 119<p> 120<P> 121 122<P> 123<DL> 124<DT><B>See Also:</B><DD><A HREF="../../../com/sleepycat/db/Database.html#join(com.sleepycat.db.Cursor[], com.sleepycat.db.JoinConfig)"><CODE>Database.join</CODE></A>, 125<A HREF="../../../com/sleepycat/db/JoinCursor.html" title="class in com.sleepycat.db"><CODE>JoinCursor</CODE></A></DL> 126<HR> 127 128<P> 129<!-- =========== FIELD SUMMARY =========== --> 130 131<A NAME="field_summary"><!-- --></A> 132<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 133<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 134<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 135<B>Field Summary</B></FONT></TH> 136</TR> 137<TR BGCOLOR="white" CLASS="TableRowColor"> 138<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 139<CODE>static <A HREF="../../../com/sleepycat/db/JoinConfig.html" title="class in com.sleepycat.db">JoinConfig</A></CODE></FONT></TD> 140<TD><CODE><B><A HREF="../../../com/sleepycat/db/JoinConfig.html#DEFAULT">DEFAULT</A></B></CODE> 141 142<BR> 143 Default configuration used if null is passed to <A HREF="../../../com/sleepycat/db/Database.html#join(com.sleepycat.db.Cursor[], com.sleepycat.db.JoinConfig)"><CODE>Database.join</CODE></A></TD> 144</TR> 145</TABLE> 146 147<!-- ======== CONSTRUCTOR SUMMARY ======== --> 148 149<A NAME="constructor_summary"><!-- --></A> 150<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 151<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 152<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 153<B>Constructor Summary</B></FONT></TH> 154</TR> 155<TR BGCOLOR="white" CLASS="TableRowColor"> 156<TD><CODE><B><A HREF="../../../com/sleepycat/db/JoinConfig.html#JoinConfig()">JoinConfig</A></B>()</CODE> 157 158<BR> 159 Creates an instance with the system's default settings.</TD> 160</TR> 161</TABLE> 162 163<!-- ========== METHOD SUMMARY =========== --> 164 165<A NAME="method_summary"><!-- --></A> 166<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 167<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 168<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 169<B>Method Summary</B></FONT></TH> 170</TR> 171<TR BGCOLOR="white" CLASS="TableRowColor"> 172<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 173<CODE> boolean</CODE></FONT></TD> 174<TD><CODE><B><A HREF="../../../com/sleepycat/db/JoinConfig.html#getNoSort()">getNoSort</A></B>()</CODE> 175 176<BR> 177 Returns whether automatic sorting of the input cursors is disabled.</TD> 178</TR> 179<TR BGCOLOR="white" CLASS="TableRowColor"> 180<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 181<CODE> void</CODE></FONT></TD> 182<TD><CODE><B><A HREF="../../../com/sleepycat/db/JoinConfig.html#setNoSort(boolean)">setNoSort</A></B>(boolean noSort)</CODE> 183 184<BR> 185 Specifies whether automatic sorting of the input cursors is disabled.</TD> 186</TR> 187</TABLE> 188 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> 189<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 190<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 191<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?is-external=true" title="class or interface in java.lang">Object</A></B></TH> 192</TR> 193<TR BGCOLOR="white" CLASS="TableRowColor"> 194<TD><CODE><A HREF="http://java.sun.com/j2se/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://java.sun.com/j2se/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://java.sun.com/j2se/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://java.sun.com/j2se/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://java.sun.com/j2se/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://java.sun.com/j2se/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://java.sun.com/j2se/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://java.sun.com/j2se/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://java.sun.com/j2se/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://java.sun.com/j2se/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://java.sun.com/j2se/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> 195</TR> 196</TABLE> 197 198<P> 199 200<!-- ============ FIELD DETAIL =========== --> 201 202<A NAME="field_detail"><!-- --></A> 203<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 204<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 205<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 206<B>Field Detail</B></FONT></TH> 207</TR> 208</TABLE> 209 210<A NAME="DEFAULT"><!-- --></A><H3> 211DEFAULT</H3> 212<PRE> 213public static final <A HREF="../../../com/sleepycat/db/JoinConfig.html" title="class in com.sleepycat.db">JoinConfig</A> <B>DEFAULT</B></PRE> 214<DL> 215<DD>Default configuration used if null is passed to <A HREF="../../../com/sleepycat/db/Database.html#join(com.sleepycat.db.Cursor[], com.sleepycat.db.JoinConfig)"><CODE>Database.join</CODE></A> 216<P> 217<DL> 218</DL> 219</DL> 220 221<!-- ========= CONSTRUCTOR DETAIL ======== --> 222 223<A NAME="constructor_detail"><!-- --></A> 224<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 225<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 226<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 227<B>Constructor Detail</B></FONT></TH> 228</TR> 229</TABLE> 230 231<A NAME="JoinConfig()"><!-- --></A><H3> 232JoinConfig</H3> 233<PRE> 234public <B>JoinConfig</B>()</PRE> 235<DL> 236<DD>Creates an instance with the system's default settings. 237<P> 238</DL> 239 240<!-- ============ METHOD DETAIL ========== --> 241 242<A NAME="method_detail"><!-- --></A> 243<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 244<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 245<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 246<B>Method Detail</B></FONT></TH> 247</TR> 248</TABLE> 249 250<A NAME="setNoSort(boolean)"><!-- --></A><H3> 251setNoSort</H3> 252<PRE> 253public void <B>setNoSort</B>(boolean noSort)</PRE> 254<DL> 255<DD>Specifies whether automatic sorting of the input cursors is disabled. 256 <p> 257 Joined values are retrieved by doing a sequential iteration over the 258 first cursor in the cursor array, and a nested iteration over each 259 following cursor in the order they are specified in the array. This 260 requires database traversals to search for the current datum in all the 261 cursors after the first. For this reason, the best join performance 262 normally results from sorting the cursors from the one that refers to 263 the least number of data items to the one that refers to the most. 264 Unless this method is called with true, <code>Database.join</code> does 265 this sort on behalf of its caller. 266 <p> 267 If the data are structured so that cursors with many data items also 268 share many common elements, higher performance will result from listing 269 those cursors before cursors with fewer data items; that is, a sort 270 order other than the default. Calling this method permits applications 271 to perform join optimization prior to calling 272 <code>Database.join</code>. 273 <p> 274<P> 275<DD><DL> 276</DL> 277</DD> 278<DD><DL> 279<DT><B>Parameters:</B><DD><CODE>noSort</CODE> - whether automatic sorting of the input cursors is disabled. 280 <p><DT><B>See Also:</B><DD><A HREF="../../../com/sleepycat/db/Database.html#join(com.sleepycat.db.Cursor[], com.sleepycat.db.JoinConfig)"><CODE>Database.join</CODE></A></DL> 281</DD> 282</DL> 283<HR> 284 285<A NAME="getNoSort()"><!-- --></A><H3> 286getNoSort</H3> 287<PRE> 288public boolean <B>getNoSort</B>()</PRE> 289<DL> 290<DD>Returns whether automatic sorting of the input cursors is disabled. 291 <p> 292<P> 293<DD><DL> 294</DL> 295</DD> 296<DD><DL> 297 298<DT><B>Returns:</B><DD>whether automatic sorting of the input cursors is disabled. 299 <p><DT><B>See Also:</B><DD><A HREF="../../../com/sleepycat/db/JoinConfig.html#setNoSort(boolean)"><CODE>setNoSort(boolean)</CODE></A></DL> 300</DD> 301</DL> 302<!-- ========= END OF CLASS DATA ========= --> 303<HR> 304 305 306<!-- ======= START OF BOTTOM NAVBAR ====== --> 307<A NAME="navbar_bottom"><!-- --></A> 308<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 309<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 310<TR> 311<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 312<A NAME="navbar_bottom_firstrow"><!-- --></A> 313<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 314 <TR ALIGN="center" VALIGN="top"> 315 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 316 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 317 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 318 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/JoinConfig.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 319 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 320 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 321 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 322 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 323 </TR> 324</TABLE> 325</TD> 326<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 327<b>Berkeley DB</b><br><font size="-1"> version 4.8.30</font></EM> 328</TD> 329</TR> 330 331<TR> 332<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 333 <A HREF="../../../com/sleepycat/db/HashStats.html" title="class in com.sleepycat.db"><B>PREV CLASS</B></A> 334 <A HREF="../../../com/sleepycat/db/JoinCursor.html" title="class in com.sleepycat.db"><B>NEXT CLASS</B></A></FONT></TD> 335<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 336 <A HREF="../../../index.html?com/sleepycat/db/JoinConfig.html" target="_top"><B>FRAMES</B></A> 337 <A HREF="JoinConfig.html" target="_top"><B>NO FRAMES</B></A> 338 <SCRIPT type="text/javascript"> 339 <!-- 340 if(window==top) { 341 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); 342 } 343 //--> 344</SCRIPT> 345<NOSCRIPT> 346 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> 347</NOSCRIPT> 348 349 350</FONT></TD> 351</TR> 352<TR> 353<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 354 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> 355<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 356DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> 357</TR> 358</TABLE> 359<A NAME="skip-navbar_bottom"></A> 360<!-- ======== END OF BOTTOM NAVBAR ======= --> 361 362<HR> 363<font size=1>Copyright (c) 1996-2009 Oracle. All rights reserved.</font> 364</BODY> 365</HTML> 366
