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