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:50 EDT 2010 --> 6<TITLE> 7StoreConfig (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="StoreConfig (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/StoreConfig.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/persist/SecondaryIndex.html" title="class in com.sleepycat.persist"><B>PREV CLASS</B></A> 59 <A HREF="../../../com/sleepycat/persist/StoreExistsException.html" title="class in com.sleepycat.persist"><B>NEXT CLASS</B></A></FONT></TD> 60<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 61 <A HREF="../../../index.html?com/sleepycat/persist/StoreConfig.html" target="_top"><B>FRAMES</B></A> 62 <A HREF="StoreConfig.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.persist</FONT> 92<BR> 93Class StoreConfig</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.persist.StoreConfig</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>StoreConfig</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> 107Configuration properties used with an <A HREF="../../../com/sleepycat/persist/EntityStore.html" title="class in com.sleepycat.persist"><CODE>EntityStore</CODE></A> or <A HREF="../../../com/sleepycat/persist/raw/RawStore.html" title="class in com.sleepycat.persist.raw"><CODE>RawStore</CODE></A>. 108 109 <p><code>StoreConfig</code> objects are thread-safe. Multiple threads may safely 110 call the methods of a shared <code>StoreConfig</code> object.</p> 111 112 <p>See the <a href="package-summary.html#example">package 113 summary example</a> for an example of using a <code>StoreConfig</code>.</p> 114<P> 115 116<P> 117<HR> 118 119<P> 120<!-- =========== FIELD SUMMARY =========== --> 121 122<A NAME="field_summary"><!-- --></A> 123<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 124<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 125<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 126<B>Field Summary</B></FONT></TH> 127</TR> 128<TR BGCOLOR="white" CLASS="TableRowColor"> 129<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 130<CODE>static <A HREF="../../../com/sleepycat/persist/StoreConfig.html" title="class in com.sleepycat.persist">StoreConfig</A></CODE></FONT></TD> 131<TD><CODE><B><A HREF="../../../com/sleepycat/persist/StoreConfig.html#DEFAULT">DEFAULT</A></B></CODE> 132 133<BR> 134 The default store configuration containing properties as if the 135 configuration were constructed and not modified.</TD> 136</TR> 137</TABLE> 138 139<!-- ======== CONSTRUCTOR SUMMARY ======== --> 140 141<A NAME="constructor_summary"><!-- --></A> 142<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 143<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 144<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 145<B>Constructor Summary</B></FONT></TH> 146</TR> 147<TR BGCOLOR="white" CLASS="TableRowColor"> 148<TD><CODE><B><A HREF="../../../com/sleepycat/persist/StoreConfig.html#StoreConfig()">StoreConfig</A></B>()</CODE> 149 150<BR> 151 Creates an entity store configuration object with default properties.</TD> 152</TR> 153</TABLE> 154 155<!-- ========== METHOD SUMMARY =========== --> 156 157<A NAME="method_summary"><!-- --></A> 158<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 159<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 160<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 161<B>Method Summary</B></FONT></TH> 162</TR> 163<TR BGCOLOR="white" CLASS="TableRowColor"> 164<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 165<CODE> <A HREF="../../../com/sleepycat/persist/StoreConfig.html" title="class in com.sleepycat.persist">StoreConfig</A></CODE></FONT></TD> 166<TD><CODE><B><A HREF="../../../com/sleepycat/persist/StoreConfig.html#clone()">clone</A></B>()</CODE> 167 168<BR> 169 Returns a shallow copy of the configuration.</TD> 170</TR> 171<TR BGCOLOR="white" CLASS="TableRowColor"> 172<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 173<CODE> <A HREF="../../../com/sleepycat/persist/StoreConfig.html" title="class in com.sleepycat.persist">StoreConfig</A></CODE></FONT></TD> 174<TD><CODE><B><A HREF="../../../com/sleepycat/persist/StoreConfig.html#cloneConfig()">cloneConfig</A></B>()</CODE> 175 176<BR> 177 <B>Deprecated.</B> <I>As of JE 4.0.13, replaced by <A HREF="../../../com/sleepycat/persist/StoreConfig.html#clone()"><CODE>clone()</CODE></A>.</p></I></TD> 178</TR> 179<TR BGCOLOR="white" CLASS="TableRowColor"> 180<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 181<CODE> boolean</CODE></FONT></TD> 182<TD><CODE><B><A HREF="../../../com/sleepycat/persist/StoreConfig.html#getAllowCreate()">getAllowCreate</A></B>()</CODE> 183 184<BR> 185 Returns whether creation of a new store is allowed.</TD> 186</TR> 187<TR BGCOLOR="white" CLASS="TableRowColor"> 188<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 189<CODE> <A HREF="../../../com/sleepycat/persist/DatabaseNamer.html" title="interface in com.sleepycat.persist">DatabaseNamer</A></CODE></FONT></TD> 190<TD><CODE><B><A HREF="../../../com/sleepycat/persist/StoreConfig.html#getDatabaseNamer()">getDatabaseNamer</A></B>()</CODE> 191 192<BR> 193 Returns the object reponsible for naming of files and databases.</TD> 194</TR> 195<TR BGCOLOR="white" CLASS="TableRowColor"> 196<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 197<CODE> boolean</CODE></FONT></TD> 198<TD><CODE><B><A HREF="../../../com/sleepycat/persist/StoreConfig.html#getExclusiveCreate()">getExclusiveCreate</A></B>()</CODE> 199 200<BR> 201 Returns whether opening an existing store is prohibited.</TD> 202</TR> 203<TR BGCOLOR="white" CLASS="TableRowColor"> 204<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 205<CODE> <A HREF="../../../com/sleepycat/persist/model/EntityModel.html" title="class in com.sleepycat.persist.model">EntityModel</A></CODE></FONT></TD> 206<TD><CODE><B><A HREF="../../../com/sleepycat/persist/StoreConfig.html#getModel()">getModel</A></B>()</CODE> 207 208<BR> 209 Returns the entity model that defines entity classes and index keys.</TD> 210</TR> 211<TR BGCOLOR="white" CLASS="TableRowColor"> 212<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 213<CODE> <A HREF="../../../com/sleepycat/persist/evolve/Mutations.html" title="class in com.sleepycat.persist.evolve">Mutations</A></CODE></FONT></TD> 214<TD><CODE><B><A HREF="../../../com/sleepycat/persist/StoreConfig.html#getMutations()">getMutations</A></B>()</CODE> 215 216<BR> 217 Returns the configured mutations for performing lazy evolution of stored 218 instances.</TD> 219</TR> 220<TR BGCOLOR="white" CLASS="TableRowColor"> 221<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 222<CODE> boolean</CODE></FONT></TD> 223<TD><CODE><B><A HREF="../../../com/sleepycat/persist/StoreConfig.html#getReadOnly()">getReadOnly</A></B>()</CODE> 224 225<BR> 226 Returns the read-only configuration property.</TD> 227</TR> 228<TR BGCOLOR="white" CLASS="TableRowColor"> 229<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 230<CODE> boolean</CODE></FONT></TD> 231<TD><CODE><B><A HREF="../../../com/sleepycat/persist/StoreConfig.html#getSecondaryBulkLoad()">getSecondaryBulkLoad</A></B>()</CODE> 232 233<BR> 234 Returns the bulk-load-secondaries configuration property.</TD> 235</TR> 236<TR BGCOLOR="white" CLASS="TableRowColor"> 237<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 238<CODE> boolean</CODE></FONT></TD> 239<TD><CODE><B><A HREF="../../../com/sleepycat/persist/StoreConfig.html#getTransactional()">getTransactional</A></B>()</CODE> 240 241<BR> 242 Returns the transactional configuration property.</TD> 243</TR> 244<TR BGCOLOR="white" CLASS="TableRowColor"> 245<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 246<CODE> void</CODE></FONT></TD> 247<TD><CODE><B><A HREF="../../../com/sleepycat/persist/StoreConfig.html#setAllowCreate(boolean)">setAllowCreate</A></B>(boolean allowCreate)</CODE> 248 249<BR> 250 Specifies whether creation of a new store is allowed.</TD> 251</TR> 252<TR BGCOLOR="white" CLASS="TableRowColor"> 253<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 254<CODE> void</CODE></FONT></TD> 255<TD><CODE><B><A HREF="../../../com/sleepycat/persist/StoreConfig.html#setDatabaseNamer(com.sleepycat.persist.DatabaseNamer)">setDatabaseNamer</A></B>(<A HREF="../../../com/sleepycat/persist/DatabaseNamer.html" title="interface in com.sleepycat.persist">DatabaseNamer</A> databaseNamer)</CODE> 256 257<BR> 258 Specifies the object reponsible for naming of files and databases.</TD> 259</TR> 260<TR BGCOLOR="white" CLASS="TableRowColor"> 261<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 262<CODE> void</CODE></FONT></TD> 263<TD><CODE><B><A HREF="../../../com/sleepycat/persist/StoreConfig.html#setExclusiveCreate(boolean)">setExclusiveCreate</A></B>(boolean exclusiveCreate)</CODE> 264 265<BR> 266 Specifies whether opening an existing store is prohibited.</TD> 267</TR> 268<TR BGCOLOR="white" CLASS="TableRowColor"> 269<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 270<CODE> void</CODE></FONT></TD> 271<TD><CODE><B><A HREF="../../../com/sleepycat/persist/StoreConfig.html#setModel(com.sleepycat.persist.model.EntityModel)">setModel</A></B>(<A HREF="../../../com/sleepycat/persist/model/EntityModel.html" title="class in com.sleepycat.persist.model">EntityModel</A> model)</CODE> 272 273<BR> 274 Sets the entity model that defines entity classes and index keys.</TD> 275</TR> 276<TR BGCOLOR="white" CLASS="TableRowColor"> 277<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 278<CODE> void</CODE></FONT></TD> 279<TD><CODE><B><A HREF="../../../com/sleepycat/persist/StoreConfig.html#setMutations(com.sleepycat.persist.evolve.Mutations)">setMutations</A></B>(<A HREF="../../../com/sleepycat/persist/evolve/Mutations.html" title="class in com.sleepycat.persist.evolve">Mutations</A> mutations)</CODE> 280 281<BR> 282 Configures mutations for performing lazy evolution of stored instances.</TD> 283</TR> 284<TR BGCOLOR="white" CLASS="TableRowColor"> 285<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 286<CODE> void</CODE></FONT></TD> 287<TD><CODE><B><A HREF="../../../com/sleepycat/persist/StoreConfig.html#setReadOnly(boolean)">setReadOnly</A></B>(boolean readOnly)</CODE> 288 289<BR> 290 Sets the read-only configuration property.</TD> 291</TR> 292<TR BGCOLOR="white" CLASS="TableRowColor"> 293<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 294<CODE> void</CODE></FONT></TD> 295<TD><CODE><B><A HREF="../../../com/sleepycat/persist/StoreConfig.html#setSecondaryBulkLoad(boolean)">setSecondaryBulkLoad</A></B>(boolean secondaryBulkLoad)</CODE> 296 297<BR> 298 Sets the bulk-load-secondaries configuration property.</TD> 299</TR> 300<TR BGCOLOR="white" CLASS="TableRowColor"> 301<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 302<CODE> void</CODE></FONT></TD> 303<TD><CODE><B><A HREF="../../../com/sleepycat/persist/StoreConfig.html#setTransactional(boolean)">setTransactional</A></B>(boolean transactional)</CODE> 304 305<BR> 306 Sets the transactional configuration property.</TD> 307</TR> 308</TABLE> 309 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> 310<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 311<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 312<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> 313</TR> 314<TR BGCOLOR="white" CLASS="TableRowColor"> 315<TD><CODE><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> 316</TR> 317</TABLE> 318 319<P> 320 321<!-- ============ FIELD DETAIL =========== --> 322 323<A NAME="field_detail"><!-- --></A> 324<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 325<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 326<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 327<B>Field Detail</B></FONT></TH> 328</TR> 329</TABLE> 330 331<A NAME="DEFAULT"><!-- --></A><H3> 332DEFAULT</H3> 333<PRE> 334public static final <A HREF="../../../com/sleepycat/persist/StoreConfig.html" title="class in com.sleepycat.persist">StoreConfig</A> <B>DEFAULT</B></PRE> 335<DL> 336<DD>The default store configuration containing properties as if the 337 configuration were constructed and not modified. 338<P> 339<DL> 340</DL> 341</DL> 342 343<!-- ========= CONSTRUCTOR DETAIL ======== --> 344 345<A NAME="constructor_detail"><!-- --></A> 346<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 347<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 348<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 349<B>Constructor Detail</B></FONT></TH> 350</TR> 351</TABLE> 352 353<A NAME="StoreConfig()"><!-- --></A><H3> 354StoreConfig</H3> 355<PRE> 356public <B>StoreConfig</B>()</PRE> 357<DL> 358<DD>Creates an entity store configuration object with default properties. 359<P> 360</DL> 361 362<!-- ============ METHOD DETAIL ========== --> 363 364<A NAME="method_detail"><!-- --></A> 365<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 366<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 367<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 368<B>Method Detail</B></FONT></TH> 369</TR> 370</TABLE> 371 372<A NAME="cloneConfig()"><!-- --></A><H3> 373cloneConfig</H3> 374<PRE> 375public <A HREF="../../../com/sleepycat/persist/StoreConfig.html" title="class in com.sleepycat.persist">StoreConfig</A> <B>cloneConfig</B>()</PRE> 376<DL> 377<DD><B>Deprecated.</B> <I>As of JE 4.0.13, replaced by <A HREF="../../../com/sleepycat/persist/StoreConfig.html#clone()"><CODE>clone()</CODE></A>.</p></I> 378<P> 379<DD>Returns a shallow copy of the configuration. 380<P> 381<DD><DL> 382</DL> 383</DD> 384<DD><DL> 385</DL> 386</DD> 387</DL> 388<HR> 389 390<A NAME="clone()"><!-- --></A><H3> 391clone</H3> 392<PRE> 393public <A HREF="../../../com/sleepycat/persist/StoreConfig.html" title="class in com.sleepycat.persist">StoreConfig</A> <B>clone</B>()</PRE> 394<DL> 395<DD>Returns a shallow copy of the configuration. 396<P> 397<DD><DL> 398<DT><B>Overrides:</B><DD><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></CODE> in class <CODE><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></CODE></DL> 399</DD> 400<DD><DL> 401</DL> 402</DD> 403</DL> 404<HR> 405 406<A NAME="setAllowCreate(boolean)"><!-- --></A><H3> 407setAllowCreate</H3> 408<PRE> 409public void <B>setAllowCreate</B>(boolean allowCreate)</PRE> 410<DL> 411<DD>Specifies whether creation of a new store is allowed. By default this 412 property is false. 413 414 <p>If this property is false and the internal store metadata database 415 does not exist, <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><CODE>DatabaseException</CODE></A> will be thrown when the store 416 is opened.</p> 417<P> 418<DD><DL> 419</DL> 420</DD> 421<DD><DL> 422</DL> 423</DD> 424</DL> 425<HR> 426 427<A NAME="getAllowCreate()"><!-- --></A><H3> 428getAllowCreate</H3> 429<PRE> 430public boolean <B>getAllowCreate</B>()</PRE> 431<DL> 432<DD>Returns whether creation of a new store is allowed. 433<P> 434<DD><DL> 435</DL> 436</DD> 437<DD><DL> 438</DL> 439</DD> 440</DL> 441<HR> 442 443<A NAME="setExclusiveCreate(boolean)"><!-- --></A><H3> 444setExclusiveCreate</H3> 445<PRE> 446public void <B>setExclusiveCreate</B>(boolean exclusiveCreate)</PRE> 447<DL> 448<DD>Specifies whether opening an existing store is prohibited. By default 449 this property is false. 450 451 <p>If this property is true and the internal store metadata database 452 already exists, <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><CODE>DatabaseException</CODE></A> will be thrown when the store 453 is opened.</p> 454<P> 455<DD><DL> 456</DL> 457</DD> 458<DD><DL> 459</DL> 460</DD> 461</DL> 462<HR> 463 464<A NAME="getExclusiveCreate()"><!-- --></A><H3> 465getExclusiveCreate</H3> 466<PRE> 467public boolean <B>getExclusiveCreate</B>()</PRE> 468<DL> 469<DD>Returns whether opening an existing store is prohibited. 470<P> 471<DD><DL> 472</DL> 473</DD> 474<DD><DL> 475</DL> 476</DD> 477</DL> 478<HR> 479 480<A NAME="setTransactional(boolean)"><!-- --></A><H3> 481setTransactional</H3> 482<PRE> 483public void <B>setTransactional</B>(boolean transactional)</PRE> 484<DL> 485<DD>Sets the transactional configuration property. By default this property 486 is false. 487 488 <p>This property is true to open all store indices for transactional 489 access. True may not be specified if the environment is not also 490 transactional.</p> 491<P> 492<DD><DL> 493</DL> 494</DD> 495<DD><DL> 496</DL> 497</DD> 498</DL> 499<HR> 500 501<A NAME="getTransactional()"><!-- --></A><H3> 502getTransactional</H3> 503<PRE> 504public boolean <B>getTransactional</B>()</PRE> 505<DL> 506<DD>Returns the transactional configuration property. 507<P> 508<DD><DL> 509</DL> 510</DD> 511<DD><DL> 512</DL> 513</DD> 514</DL> 515<HR> 516 517<A NAME="setReadOnly(boolean)"><!-- --></A><H3> 518setReadOnly</H3> 519<PRE> 520public void <B>setReadOnly</B>(boolean readOnly)</PRE> 521<DL> 522<DD>Sets the read-only configuration property. By default this property is 523 false. 524 525 <p>This property is true to open all store indices for read-only access, 526 or false to open them for read-write access. False may not be specified 527 if the environment is read-only.</p> 528<P> 529<DD><DL> 530</DL> 531</DD> 532<DD><DL> 533</DL> 534</DD> 535</DL> 536<HR> 537 538<A NAME="getReadOnly()"><!-- --></A><H3> 539getReadOnly</H3> 540<PRE> 541public boolean <B>getReadOnly</B>()</PRE> 542<DL> 543<DD>Returns the read-only configuration property. 544<P> 545<DD><DL> 546</DL> 547</DD> 548<DD><DL> 549</DL> 550</DD> 551</DL> 552<HR> 553 554<A NAME="setSecondaryBulkLoad(boolean)"><!-- --></A><H3> 555setSecondaryBulkLoad</H3> 556<PRE> 557public void <B>setSecondaryBulkLoad</B>(boolean secondaryBulkLoad)</PRE> 558<DL> 559<DD>Sets the bulk-load-secondaries configuration property. By default this 560 property is false. 561 562 <p>This property is true to cause the initial creation of secondary 563 indices to be performed as a bulk load. If this property is true and 564 <A HREF="../../../com/sleepycat/persist/EntityStore.html#getSecondaryIndex(com.sleepycat.persist.PrimaryIndex, java.lang.Class, java.lang.String)"><CODE>EntityStore.getSecondaryIndex</CODE></A> has 565 never been called for a secondary index, that secondary index will not 566 be created or written as records are written to the primary index. In 567 addition, if that secondary index defines a foreign key constraint, the 568 constraint will not be enforced.</p> 569 570 <p>The secondary index will be populated later when the {code 571 getSecondaryIndex} method is called for the first time for that index, 572 or when the store is closed and re-opened with this property set to 573 false and the primary index is obtained. In either case, the secondary 574 index is populated by reading through the entire primary index and 575 adding records to the secondary index as needed. While populating the 576 secondary, foreign key constraints will be enforced and an exception is 577 thrown if a constraint is violated.</p> 578 579 <p>When loading a primary index along with secondary indexes from a 580 large input data set, configuring a bulk load of the secondary indexes 581 is sometimes more performant than updating the secondary indexes each 582 time the primary index is updated. The absence of foreign key 583 constraints during the load also provides more flexibility.</p> 584<P> 585<DD><DL> 586</DL> 587</DD> 588<DD><DL> 589</DL> 590</DD> 591</DL> 592<HR> 593 594<A NAME="getSecondaryBulkLoad()"><!-- --></A><H3> 595getSecondaryBulkLoad</H3> 596<PRE> 597public boolean <B>getSecondaryBulkLoad</B>()</PRE> 598<DL> 599<DD>Returns the bulk-load-secondaries configuration property. 600<P> 601<DD><DL> 602</DL> 603</DD> 604<DD><DL> 605</DL> 606</DD> 607</DL> 608<HR> 609 610<A NAME="setModel(com.sleepycat.persist.model.EntityModel)"><!-- --></A><H3> 611setModel</H3> 612<PRE> 613public void <B>setModel</B>(<A HREF="../../../com/sleepycat/persist/model/EntityModel.html" title="class in com.sleepycat.persist.model">EntityModel</A> model)</PRE> 614<DL> 615<DD>Sets the entity model that defines entity classes and index keys. 616 617 <p>If null is specified or this method is not called, an <A HREF="../../../com/sleepycat/persist/model/AnnotationModel.html" title="class in com.sleepycat.persist.model"><CODE>AnnotationModel</CODE></A> instance is used by default.</p> 618<P> 619<DD><DL> 620</DL> 621</DD> 622<DD><DL> 623</DL> 624</DD> 625</DL> 626<HR> 627 628<A NAME="getModel()"><!-- --></A><H3> 629getModel</H3> 630<PRE> 631public <A HREF="../../../com/sleepycat/persist/model/EntityModel.html" title="class in com.sleepycat.persist.model">EntityModel</A> <B>getModel</B>()</PRE> 632<DL> 633<DD>Returns the entity model that defines entity classes and index keys. 634<P> 635<DD><DL> 636</DL> 637</DD> 638<DD><DL> 639</DL> 640</DD> 641</DL> 642<HR> 643 644<A NAME="setMutations(com.sleepycat.persist.evolve.Mutations)"><!-- --></A><H3> 645setMutations</H3> 646<PRE> 647public void <B>setMutations</B>(<A HREF="../../../com/sleepycat/persist/evolve/Mutations.html" title="class in com.sleepycat.persist.evolve">Mutations</A> mutations)</PRE> 648<DL> 649<DD>Configures mutations for performing lazy evolution of stored instances. 650 Existing mutations for this store are not cleared, so the mutations 651 required are only those changes that have been made since the store was 652 last opened. Some new mutations may override existing specifications, 653 and some may be supplemental. 654 655 <p>If null is specified and the store already exists, the previously 656 specified mutations are used. The mutations are stored persistently in 657 serialized form.</p> 658 659 <p>Mutations must be available to handle all changes to classes that are 660 incompatible with the class definitions known to this store. See <A HREF="../../../com/sleepycat/persist/evolve/Mutations.html" title="class in com.sleepycat.persist.evolve"><CODE>Mutations</CODE></A> and <A HREF="../../../com/sleepycat/persist/evolve/package-summary.html"><CODE>Class Evolution</CODE></A> for 661 more information.</p> 662 663 <p>If an incompatible class change has been made and mutations are not 664 available for handling the change, <A HREF="../../../com/sleepycat/persist/evolve/IncompatibleClassException.html" title="class in com.sleepycat.persist.evolve"><CODE>IncompatibleClassException</CODE></A> 665 will be thrown when creating an <A HREF="../../../com/sleepycat/persist/EntityStore.html" title="class in com.sleepycat.persist"><CODE>EntityStore</CODE></A>.</p> 666<P> 667<DD><DL> 668</DL> 669</DD> 670<DD><DL> 671</DL> 672</DD> 673</DL> 674<HR> 675 676<A NAME="getMutations()"><!-- --></A><H3> 677getMutations</H3> 678<PRE> 679public <A HREF="../../../com/sleepycat/persist/evolve/Mutations.html" title="class in com.sleepycat.persist.evolve">Mutations</A> <B>getMutations</B>()</PRE> 680<DL> 681<DD>Returns the configured mutations for performing lazy evolution of stored 682 instances. 683<P> 684<DD><DL> 685</DL> 686</DD> 687<DD><DL> 688</DL> 689</DD> 690</DL> 691<HR> 692 693<A NAME="setDatabaseNamer(com.sleepycat.persist.DatabaseNamer)"><!-- --></A><H3> 694setDatabaseNamer</H3> 695<PRE> 696public void <B>setDatabaseNamer</B>(<A HREF="../../../com/sleepycat/persist/DatabaseNamer.html" title="interface in com.sleepycat.persist">DatabaseNamer</A> databaseNamer)</PRE> 697<DL> 698<DD>Specifies the object reponsible for naming of files and databases. 699 700 By default this property is <A HREF="../../../com/sleepycat/persist/DatabaseNamer.html#DEFAULT"><CODE>DatabaseNamer.DEFAULT</CODE></A>. 701<P> 702<DD><DL> 703</DL> 704</DD> 705<DD><DL> 706 707<DT><B>Throws:</B> 708<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</A></CODE> - if a null parameter value is passed.</DL> 709</DD> 710</DL> 711<HR> 712 713<A NAME="getDatabaseNamer()"><!-- --></A><H3> 714getDatabaseNamer</H3> 715<PRE> 716public <A HREF="../../../com/sleepycat/persist/DatabaseNamer.html" title="interface in com.sleepycat.persist">DatabaseNamer</A> <B>getDatabaseNamer</B>()</PRE> 717<DL> 718<DD>Returns the object reponsible for naming of files and databases. 719<P> 720<DD><DL> 721</DL> 722</DD> 723<DD><DL> 724</DL> 725</DD> 726</DL> 727<!-- ========= END OF CLASS DATA ========= --> 728<HR> 729 730 731<!-- ======= START OF BOTTOM NAVBAR ====== --> 732<A NAME="navbar_bottom"><!-- --></A> 733<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 734<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 735<TR> 736<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 737<A NAME="navbar_bottom_firstrow"><!-- --></A> 738<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 739 <TR ALIGN="center" VALIGN="top"> 740 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 741 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 742 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 743 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/StoreConfig.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 744 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 745 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 746 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 747 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 748 </TR> 749</TABLE> 750</TD> 751<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 752<b>Berkeley DB</b><br><font size="-1"> version 4.8.30</font></EM> 753</TD> 754</TR> 755 756<TR> 757<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 758 <A HREF="../../../com/sleepycat/persist/SecondaryIndex.html" title="class in com.sleepycat.persist"><B>PREV CLASS</B></A> 759 <A HREF="../../../com/sleepycat/persist/StoreExistsException.html" title="class in com.sleepycat.persist"><B>NEXT CLASS</B></A></FONT></TD> 760<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 761 <A HREF="../../../index.html?com/sleepycat/persist/StoreConfig.html" target="_top"><B>FRAMES</B></A> 762 <A HREF="StoreConfig.html" target="_top"><B>NO FRAMES</B></A> 763 <SCRIPT type="text/javascript"> 764 <!-- 765 if(window==top) { 766 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); 767 } 768 //--> 769</SCRIPT> 770<NOSCRIPT> 771 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> 772</NOSCRIPT> 773 774 775</FONT></TD> 776</TR> 777<TR> 778<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 779 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> 780<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 781DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> 782</TR> 783</TABLE> 784<A NAME="skip-navbar_bottom"></A> 785<!-- ======== END OF BOTTOM NAVBAR ======= --> 786 787<HR> 788<font size=1>Copyright (c) 1996-2009 Oracle. All rights reserved.</font> 789</BODY> 790</HTML> 791