-StoreConfig (Oracle - Berkeley DB Java API) -

java.lang.Object
+
- com.sleepycat.persist.StoreConfig
+

+
+
All Implemented Interfaces:
+
java.lang.Cloneable
+
+
+
+
```
public class StoreConfig
+extends java.lang.Object
+implements java.lang.Cloneable
```
+
Configuration properties used with an EntityStore or RawStore.
StoreConfig objects are thread-safe. Multiple threads may safely call the methods of a shared StoreConfig object.

See the package - summary example for an example of using a StoreConfig.
-
- -
-
- -
+ summary example for an example of using a StoreConfig.
+

- - - - - - - - - - -

-Field Summary
-`static StoreConfig`	`DEFAULT` - - - The default store configuration containing properties as if the - configuration were constructed and not modified.

- +

+ + +
Field Summary
+ + + + + + + + + + +
Fields
Modifier and Type Field and Description
static StoreConfig DEFAULT +
The default store configuration containing properties as if the + configuration were constructed and not modified.
+
+

Fields
Modifier and Type	Field and Description
`static StoreConfig`	`DEFAULT` + The default store configuration containing properties as if the + configuration were constructed and not modified. +

- - - - - - - - - -

-Constructor Summary
`StoreConfig()` - - - Creates an entity store configuration object with default properties.

- +

+ + +
Constructor Summary
+ + + + + + + + +
Constructors
Constructor and Description
StoreConfig() +
Creates an entity store configuration object with default properties.
+
+

Constructors
Constructor and Description
`StoreConfig()` + Creates an entity store configuration object with default properties. +

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

-Method Summary
- `StoreConfig`	`clone()` - - - Returns a shallow copy of the configuration.
- `StoreConfig`	`cloneConfig()` - - - Deprecated. As of JE 4.0.13, replaced by `clone()`.
- `boolean`	`getAllowCreate()` - - - Returns whether creation of a new store is allowed.
- `DatabaseNamer`	`getDatabaseNamer()` - - - Returns the object reponsible for naming of files and databases.
- `boolean`	`getExclusiveCreate()` - - - Returns whether opening an existing store is prohibited.
- `EntityModel`	`getModel()` - - - Returns the entity model that defines entity classes and index keys.
- `Mutations`	`getMutations()` - - - Returns the configured mutations for performing lazy evolution of stored - instances.
- `boolean`	`getReadOnly()` - - - Returns the read-only configuration property.
- `boolean`	`getSecondaryBulkLoad()` - - - Returns the bulk-load-secondaries configuration property.
- `boolean`	`getTransactional()` - - - Returns the transactional configuration property.
- `StoreConfig`	`setAllowCreate(boolean allowCreate)` - - - Specifies whether creation of a new store is allowed.
- `void`	`setAllowCreateVoid(boolean allowCreate)` - - -
- `StoreConfig`	`setDatabaseNamer(DatabaseNamer databaseNamer)` - - - Specifies the object reponsible for naming of files and databases.
- `void`	`setDatabaseNamerVoid(DatabaseNamer databaseNamer)` - - -
- `StoreConfig`	`setExclusiveCreate(boolean exclusiveCreate)` - - - Specifies whether opening an existing store is prohibited.
- `void`	`setExclusiveCreateVoid(boolean exclusiveCreate)` - - -
- `StoreConfig`	`setModel(EntityModel model)` - - - Sets the entity model that defines entity classes and index keys.
- `void`	`setModelVoid(EntityModel model)` - - -
- `StoreConfig`	`setMutations(Mutations mutations)` - - - Configures mutations for performing lazy evolution of stored instances.
- `void`	`setMutationsVoid(Mutations mutations)` - - -
- `StoreConfig`	`setReadOnly(boolean readOnly)` - - - Sets the read-only configuration property.
- `void`	`setReadOnlyVoid(boolean readOnly)` - - -
- `StoreConfig`	`setSecondaryBulkLoad(boolean secondaryBulkLoad)` - - - Sets the bulk-load-secondaries configuration property.
- `void`	`setSecondaryBulkLoadVoid(boolean secondaryBulkLoad)` - - -
- `StoreConfig`	`setTransactional(boolean transactional)` - - - Sets the transactional configuration property.
- `void`	`setTransactionalVoid(boolean transactional)` - - -

- - - - - - - - -

Methods inherited from class java.lang.Object
`equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- -

- +

+ + +

Method Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Methods
Modifier and Type	Method and Description
`StoreConfig`	`clone()` + Returns a shallow copy of the configuration. +
`StoreConfig`	`cloneConfig()` + Deprecated. + As of JE 4.0.13, replaced by `clone()`. + +
`boolean`	`getAllowCreate()` + Returns whether creation of a new store is allowed. +
`DatabaseNamer`	`getDatabaseNamer()` + Returns the object reponsible for naming of files and databases. +
`boolean`	`getExclusiveCreate()` + Returns whether opening an existing store is prohibited. +
`EntityModel`	`getModel()` + Returns the entity model that defines entity classes and index keys. +
`Mutations`	`getMutations()` + Returns the configured mutations for performing lazy evolution of stored + instances. +
`boolean`	`getReadOnly()` + Returns the read-only configuration property. +
`boolean`	`getSecondaryBulkLoad()` + Returns the bulk-load-secondaries configuration property. +
`boolean`	`getTransactional()` + Returns the transactional configuration property. +
`StoreConfig`	`setAllowCreate(boolean allowCreate)` + Specifies whether creation of a new store is allowed. +
`void`	`setAllowCreateVoid(boolean allowCreate)` + The void return setter for use by Bean editors. +
`StoreConfig`	`setDatabaseNamer(DatabaseNamer databaseNamer)` + Specifies the object reponsible for naming of files and databases. +
`void`	`setDatabaseNamerVoid(DatabaseNamer databaseNamer)` + The void return setter for use by Bean editors. +
`StoreConfig`	`setExclusiveCreate(boolean exclusiveCreate)` + Specifies whether opening an existing store is prohibited. +
`void`	`setExclusiveCreateVoid(boolean exclusiveCreate)` + The void return setter for use by Bean editors. +
`StoreConfig`	`setModel(EntityModel model)` + Sets the entity model that defines entity classes and index keys. +
`void`	`setModelVoid(EntityModel model)` + The void return setter for use by Bean editors. +
`StoreConfig`	`setMutations(Mutations mutations)` + Configures mutations for performing lazy evolution of stored instances. +
`void`	`setMutationsVoid(Mutations mutations)` + The void return setter for use by Bean editors. +
`StoreConfig`	`setReadOnly(boolean readOnly)` + Sets the read-only configuration property. +
`void`	`setReadOnlyVoid(boolean readOnly)` + The void return setter for use by Bean editors. +
`StoreConfig`	`setSecondaryBulkLoad(boolean secondaryBulkLoad)` + Sets the bulk-load-secondaries configuration property. +
`void`	`setSecondaryBulkLoadVoid(boolean secondaryBulkLoad)` + The void return setter for use by Bean editors. +
`StoreConfig`	`setTransactional(boolean transactional)` + Sets the transactional configuration property. +
`void`	`setTransactionalVoid(boolean transactional)` + The void return setter for use by Bean editors. +

+ + +
Methods inherited from class java.lang.Object
+equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- - - - - - -
-Field Detail
- -
-DEFAULT
-
```
-public static final StoreConfig DEFAULT
```
-
-
The default store configuration containing properties as if the - configuration were constructed and not modified. -
-
-
-
- +
- + + +
  Field Detail
  + + + +
  - +
    DEFAULT
    +
```
public static final StoreConfig DEFAULT
```
    +
    The default store configuration containing properties as if the + configuration were constructed and not modified.
    +
  +
- - - - - - -
-Constructor Detail
- -
-StoreConfig
-
```
-public StoreConfig()
```
-
-
Creates an entity store configuration object with default properties. -
-
- +
- + + +
  Constructor Detail
  + + + +
  - +
    StoreConfig
    +
```
public StoreConfig()
```
    +
    Creates an entity store configuration object with default properties.
    +
  +
- - - - - - -
-Method Detail
- -
-cloneConfig
-
```
-public StoreConfig cloneConfig()
```
-
-
Deprecated. As of JE 4.0.13, replaced by clone().
-
-
Returns a shallow copy of the configuration. -
-
-
-
-
-
-
-
-
- -
-clone
-
```
-public StoreConfig clone()
```
-
-
Returns a shallow copy of the configuration. -
-
-
Overrides:
clone in class Object
-
-
-
-
-
-
- -
-setAllowCreate
-
```
-public StoreConfig setAllowCreate(boolean allowCreate)
```
-
-
Specifies whether creation of a new store is allowed. By default this +
- + + +
  Method Detail
  + + + +
  - +
    cloneConfig
    +
    public StoreConfig cloneConfig()
    +
    Deprecated. As of JE 4.0.13, replaced by clone().
    +
    Returns a shallow copy of the configuration.
    +
  + + + +
  - +
    clone
    +
    public StoreConfig clone()
    +
    Returns a shallow copy of the configuration.
    +
    +
    Overrides:
    +
    clone in class java.lang.Object
    +
    +
  + + + +
  - +
    setAllowCreate
    +
    public StoreConfig setAllowCreate(boolean allowCreate)
    +
    Specifies whether creation of a new store is allowed. By default this property is false.
    If this property is false and the internal store metadata database - does not exist, DatabaseException will be thrown when the store - is opened.
    -
    -
    -
    -
    -
    -
    -
    -
-
- -
-setAllowCreateVoid
-
```
-public void setAllowCreateVoid(boolean allowCreate)
```
-
-
-
-
-
-
-
-
-
- -
-getAllowCreate
-
```
-public boolean getAllowCreate()
```
-
-
Returns whether creation of a new store is allowed. -
-
-
-
-
-
-
-
-
- -
-setExclusiveCreate
-
```
-public StoreConfig setExclusiveCreate(boolean exclusiveCreate)
```
-
-
Specifies whether opening an existing store is prohibited. By default + does not exist, DatabaseException will be thrown when the store + is opened.

+ + + + + +

+
setAllowCreateVoid
+
```
public void setAllowCreateVoid(boolean allowCreate)
```
+
The void return setter for use by Bean editors.
+

+ + + +

+
getAllowCreate
+
```
public boolean getAllowCreate()
```
+
Returns whether creation of a new store is allowed.
+

+ + + +

+
setExclusiveCreate
+
```
public StoreConfig setExclusiveCreate(boolean exclusiveCreate)
```
+
Specifies whether opening an existing store is prohibited. By default this property is false.
If this property is true and the internal store metadata database - already exists, DatabaseException will be thrown when the store - is opened.
-
-
-
-
-
-
-
- -
- -
-setExclusiveCreateVoid
-
```
-public void setExclusiveCreateVoid(boolean exclusiveCreate)
```
-
-
-
-
-
-
-
-
-
- -
-getExclusiveCreate
-
```
-public boolean getExclusiveCreate()
```
-
-
Returns whether opening an existing store is prohibited. -
-
-
-
-
-
-
-
-
- -
-setTransactional
-
```
-public StoreConfig setTransactional(boolean transactional)
```
-
-
Sets the transactional configuration property. By default this property + already exists, DatabaseException will be thrown when the store + is opened.
+

+ + + +

+
setExclusiveCreateVoid
+
```
public void setExclusiveCreateVoid(boolean exclusiveCreate)
```
+
The void return setter for use by Bean editors.
+

+ + + +

+
getExclusiveCreate
+
```
public boolean getExclusiveCreate()
```
+
Returns whether opening an existing store is prohibited.
+

+ + + +

+
setTransactional
+
```
public StoreConfig setTransactional(boolean transactional)
```
+
Sets the transactional configuration property. By default this property is false.
This property is true to open all store indices for transactional access. True may not be specified if the environment is not also - transactional.
-
-
-
-
-
-
-
- -
- -
-setTransactionalVoid
-
```
-public void setTransactionalVoid(boolean transactional)
```
-
-
-
-
-
-
-
-
-
- -
-getTransactional
-
```
-public boolean getTransactional()
```
-
-
Returns the transactional configuration property. -
-
-
-
-
-
-
-
-
- -
-setReadOnly
-
```
-public StoreConfig setReadOnly(boolean readOnly)
```
-
-
Sets the read-only configuration property. By default this property is + transactional.
+

+ + + +

+
setTransactionalVoid
+
```
public void setTransactionalVoid(boolean transactional)
```
+
The void return setter for use by Bean editors.
+

+ + + +

+
getTransactional
+
```
public boolean getTransactional()
```
+
Returns the transactional configuration property.
+

+ + + +

+
setReadOnly
+
```
public StoreConfig setReadOnly(boolean readOnly)
```
+
Sets the read-only configuration property. By default this property is false.
This property is true to open all store indices for read-only access, or false to open them for read-write access. False may not be specified - if the environment is read-only.
-
-
-
-
-
-
-
- -
- -
-setReadOnlyVoid
-
```
-public void setReadOnlyVoid(boolean readOnly)
```
-
-
-
-
-
-
-
-
-
- -
-getReadOnly
-
```
-public boolean getReadOnly()
```
-
-
Returns the read-only configuration property. -
-
-
-
-
-
-
-
-
- -
-setSecondaryBulkLoad
-
```
-public StoreConfig setSecondaryBulkLoad(boolean secondaryBulkLoad)
```
-
-
Sets the bulk-load-secondaries configuration property. By default this + if the environment is read-only.
+

+ + + +

+
setReadOnlyVoid
+
```
public void setReadOnlyVoid(boolean readOnly)
```
+
The void return setter for use by Bean editors.
+

+ + + +

+
getReadOnly
+
```
public boolean getReadOnly()
```
+
Returns the read-only configuration property.
+

+ + + +

+
setSecondaryBulkLoad
+
```
public StoreConfig setSecondaryBulkLoad(boolean secondaryBulkLoad)
```
+
Sets the bulk-load-secondaries configuration property. By default this property is false.
This property is true to cause the initial creation of secondary indices to be performed as a bulk load. If this property is true and - EntityStore.getSecondaryIndex has + EntityStore.getSecondaryIndex has never been called for a secondary index, that secondary index will not be created or written as records are written to the primary index. In addition, if that secondary index defines a foreign key constraint, the @@ -699,101 +583,69 @@ public
-setSecondaryBulkLoadVoid
-
```
-public void setSecondaryBulkLoadVoid(boolean secondaryBulkLoad)
```
-
-
-
-
-
-
-
-
-
- -
-getSecondaryBulkLoad
-
```
-public boolean getSecondaryBulkLoad()
```
-
-
Returns the bulk-load-secondaries configuration property. -
-
-
-
-
-
-
-
-
- -
-setModel
-
```
-public StoreConfig setModel(EntityModel model)
```
-
-
Sets the entity model that defines entity classes and index keys. - -
If null is specified or this method is not called, an AnnotationModel instance is used by default.
-
-
-
-
-
-
-
-
-
- -
-setModelVoid
-
```
-public void setModelVoid(EntityModel model)
```
-
-
-
-
-
-
-
-
-
- -
-getModel
-
```
-public EntityModel getModel()
```
-
-
Returns the entity model that defines entity classes and index keys. -
-
-
-
-
-
-
-
-
- -
-setMutations
-
```
-public StoreConfig setMutations(Mutations mutations)
```
-
-
Configures mutations for performing lazy evolution of stored instances. + constraints during the load also provides more flexibility.
+

+ + + +

+
setSecondaryBulkLoadVoid
+
```
public void setSecondaryBulkLoadVoid(boolean secondaryBulkLoad)
```
+
The void return setter for use by Bean editors.
+

+ + + +

+
getSecondaryBulkLoad
+
```
public boolean getSecondaryBulkLoad()
```
+
Returns the bulk-load-secondaries configuration property.
+

+ + + +

+
setModel
+
```
public StoreConfig setModel(EntityModel model)
```
+
Sets the entity model that defines entity classes and index keys. + +
If null is specified or this method is not called, an AnnotationModel instance is used by default.
+

+ + + +

+
setModelVoid
+
```
public void setModelVoid(EntityModel model)
```
+
The void return setter for use by Bean editors.
+

+ + + +

+
getModel
+
```
public EntityModel getModel()
```
+
Returns the entity model that defines entity classes and index keys.
+

+ + + +

+
setMutations
+
```
public StoreConfig setMutations(Mutations mutations)
```
+
Configures mutations for performing lazy evolution of stored instances. Existing mutations for this store are not cleared, so the mutations required are only those changes that have been made since the store was last opened. Some new mutations may override existing specifications, @@ -804,162 +656,137 @@ public Mutations and Class Evolution for + incompatible with the class definitions known to this store. See Mutations and Class Evolution for more information.

If an incompatible class change has been made and mutations are not - available for handling the change, IncompatibleClassException - will be thrown when creating an EntityStore.
-
-
-
-
-
-
-
- -
- -
-setMutationsVoid
-
```
-public void setMutationsVoid(Mutations mutations)
```
-
-
-
-
-
-
-
-
-
- -
-getMutations
-
```
-public Mutations getMutations()
```
-
-
Returns the configured mutations for performing lazy evolution of stored - instances. -
-
-
-
-
-
-
-
-
- -
-setDatabaseNamer
-
```
-public StoreConfig setDatabaseNamer(DatabaseNamer databaseNamer)
```
-
-
Specifies the object reponsible for naming of files and databases. - - By default this property is DatabaseNamer.DEFAULT. -
-
-
-
-
- -
Throws: -
NullPointerException - if a null parameter value is passed.
-
-
-
- -
-setDatabaseNamerVoid
-
```
-public void setDatabaseNamerVoid(DatabaseNamer databaseNamer)
```
-
-
-
-
-
-
-
-
-
- -
-getDatabaseNamer
-
```
-public DatabaseNamer getDatabaseNamer()
```
-
-
Returns the object reponsible for naming of files and databases. -
-
-
-
-
-
-
-
+ available for handling the change, IncompatibleClassException + will be thrown when creating an EntityStore.
+

+ + + +

+
setMutationsVoid
+
```
public void setMutationsVoid(Mutations mutations)
```
+
The void return setter for use by Bean editors.
+

+ + + +

+
getMutations
+
```
public Mutations getMutations()
```
+
Returns the configured mutations for performing lazy evolution of stored + instances.
+

+ + + +

+
setDatabaseNamer
+
```
public StoreConfig setDatabaseNamer(DatabaseNamer databaseNamer)
```
+
Specifies the object reponsible for naming of files and databases. + + By default this property is DatabaseNamer.DEFAULT.
+
Throws:
+
java.lang.NullPointerException - if a null parameter value is passed.
+

+ + + +

+
setDatabaseNamerVoid
+
```
public void setDatabaseNamerVoid(DatabaseNamer databaseNamer)
```
+
The void return setter for use by Bean editors.
+

+ + + +

+
getDatabaseNamer
+
```
public DatabaseNamer getDatabaseNamer()
```
+
Returns the object reponsible for naming of files and databases.
+

+ + + + +

- -com.sleepycat.persist - -Class StoreConfig

Class StoreConfig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

-DEFAULT

Field Detail

DEFAULT

-StoreConfig

Constructor Detail

StoreConfig

-cloneConfig

-clone

-setAllowCreate

Method Detail

cloneConfig

clone

setAllowCreate

-setAllowCreateVoid

-getAllowCreate

-setExclusiveCreate

setAllowCreateVoid

getAllowCreate

setExclusiveCreate

-setExclusiveCreateVoid

-getExclusiveCreate

-setTransactional

setExclusiveCreateVoid

getExclusiveCreate

setTransactional

-setTransactionalVoid

-getTransactional

-setReadOnly

setTransactionalVoid

getTransactional

setReadOnly

-setReadOnlyVoid

-getReadOnly

-setSecondaryBulkLoad

setReadOnlyVoid

getReadOnly

setSecondaryBulkLoad

-setSecondaryBulkLoadVoid

-getSecondaryBulkLoad

-setModel

-setModelVoid

-getModel

-setMutations

setSecondaryBulkLoadVoid

getSecondaryBulkLoad

setModel

setModelVoid

getModel

setMutations

-setMutationsVoid

-getMutations

-setDatabaseNamer

-setDatabaseNamerVoid

-getDatabaseNamer

setMutationsVoid

getMutations

setDatabaseNamer

setDatabaseNamerVoid

getDatabaseNamer

- -com.sleepycat.persist -
-Class StoreConfig