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