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

-Interface Summary
DatabaseNamer	Determines the file names to use for primary and secondary databases.
EntityCursor<V>	Traverses entity values or key values and allows deleting or updating the - entity at the current cursor position.
EntityIndex<K,V>	The interface for accessing keys and entities via a primary or secondary - index.
ForwardCursor<V>	Cursor operations limited to traversing forward.

- - -

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

-Class Summary
EntityJoin<PK,E>	Performs an equality join on two or more secondary keys.
EntityStore	A store for managing persistent entity objects.
PrimaryIndex<PK,E>	The primary index for an entity class and its primary key.
SecondaryIndex<SK,PK,E>	The secondary index for an entity class and a secondary key.
StoreConfig	Configuration properties used with an `EntityStore` or `RawStore`.
StoreConfigBeanInfo

- - -

-Package com.sleepycat.persist Description -

-Exception Summary
IndexNotAvailableException	Thrown by the `getPrimaryIndex`, `getSecondaryIndex` and `getSubclassIndex` when an index has not yet - been created.
StoreExistsException	Thrown by the `EntityStore` constructor when the `ExclusiveCreate` configuration parameter is - true and the store's internal catalog database already exists.
StoreNotFoundException	Thrown by the `EntityStore` constructor when the `AllowCreate` configuration parameter is false and - the store's internal catalog database does not exist.

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

Interface Summary
Interface	Description
DatabaseNamer	+ Determines the file names to use for primary and secondary databases. +
EntityCursor<V>	+ Traverses entity values or key values and allows deleting or updating the + entity at the current cursor position. +
EntityIndex<K,V>	+ The interface for accessing keys and entities via a primary or secondary + index. +
ForwardCursor<V>	+ Cursor operations limited to traversing forward. +

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

Class Summary
Class	Description
EntityJoin<PK,E>	+ Performs an equality join on two or more secondary keys. +
EntityStore	+ A store for managing persistent entity objects. +
PrimaryIndex<PK,E>	+ The primary index for an entity class and its primary key. +
SecondaryIndex<SK,PK,E>	+ The secondary index for an entity class and a secondary key. +
StoreConfig	+ Configuration properties used with an `EntityStore` or `RawStore`. +
StoreConfigBeanInfo

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

Exception Summary
Exception	Description
IndexNotAvailableException	+ Thrown by the `getPrimaryIndex`, `getSecondaryIndex` and `getSubclassIndex` when an index has not yet + been created. +
StoreExistsException	+ Thrown by the `EntityStore` constructor when the `ExclusiveCreate` configuration parameter is + true and the store's internal catalog database already exists. +
StoreNotFoundException	+ Thrown by the `EntityStore` constructor when the `AllowCreate` configuration parameter is false and + the store's internal catalog database does not exist. +

+ + + +

Package com.sleepycat.persist Description

The Direct Persistence Layer (DPL) adds a persistent object model to the Berkeley DB transactional engine.

Package Specification

@@ -270,7 +281,7 @@ class Address { private Address() {} } Many incompatible class changes, such as renaming fields or refactoring a -single class, can be performed using Mutations. Mutations are automatically +single class, can be performed using Mutations. Mutations are automatically applied lazily as data is accessed, avoiding downtime to convert large databases during a software upgrade.

Complex refactoring involving multiple classes may be performed using the a @@ -282,9 +293,9 @@ changes have been made to persistent classes.

The performance of the Berkeley DB transactional engine is not compromised. Operations are internally mapped directly to the engine API, object bindings are lightweight, and all engine tuning parameters are available. For example, -a "dirty read" may be performed using an optional LockMode parameter: +a "dirty read" may be performed using an optional LockMode parameter:

Employer employer = employerByName.get(null, "Gizmo Inc", LockMode.READ_UNCOMMITTED);

-For high performance applications, DatabaseConfig parameters may be used to tune the performance of the Berkeley +For high performance applications, DatabaseConfig parameters may be used to tune the performance of the Berkeley DB engine. For example, the size of an internal Btree node can be specified as follows:

@@ -302,9 +313,9 @@ that has a primary key and is stored and accessed using a primary index.  It
 may also have any number of secondary keys, and entities may be accessed by
 secondary key using a secondary index.
 
-An entity class may be defined with the Entity annotation.  For each entity class,
-its primary key may be defined using the PrimaryKey annotation and any number of
-secondary keys may be defined using the SecondaryKey annotation.
+An entity class may be defined with the Entity annotation.  For each entity class,
+its primary key may be defined using the PrimaryKey annotation and any number of
+secondary keys may be defined using the SecondaryKey annotation.
 
 In the following example, the Person.ssn (social security number)
 field is the primary key and the Person.employerIds field is a
@@ -327,7 +338,7 @@ class Person {
 
 
A set of entity classes constitutes an entity model.  In addition
 to isolated entity classes, an entity model may contain relationships between
-entities.  Relationships may be defined using the SecondaryKey annotation.
+entities.  Relationships may be defined using the SecondaryKey annotation.
 Many-to-one, one-to-many, many-to-many and one-to-one relationships are
 supported, as well as foreign key constraints.
 
@@ -336,9 +347,9 @@ supported, as well as foreign key constraints.
 key constraints to guarantee that every element of the employerIds set
 is a valid Employer primary key.
 
-For more information on the entity model, see the AnnotationModel and the Entity annotation.
+For more information on the entity model, see the AnnotationModel and the Entity annotation.
 
-The root object in the DPL is the EntityStore.  An entity store manages any number of objects for each entity
+
The root object in the DPL is the EntityStore.  An entity store manages any number of objects for each entity
 class defined in the model.  The store provides access to the primary and
 secondary indices for each entity class, for example:
 
@@ -623,7 +634,7 @@ Btree operations of the Berkeley DB engine.  Unlike other persistence
 approaches, keys and indices are exposed for direct access and performance
 tuning.
 Queries are implemented by calling methods of the primary and secondary
-indices.  An EntityJoin class is also
+indices.  An EntityJoin class is also
 available for performing equality joins.  For example, the following code
 queries all of Bob's children that work for Gizmo Inc:
 
@@ -644,7 +655,7 @@ try {
 Object relationships are based on keys.  When a Person with a given
 employer ID in its employerIds set is stored, the Person object
 becomes part of the collection of employees for that employer.  This collection
-of employees is accessed using a SecondaryIndex.subIndex for the
+of employees is accessed using a SecondaryIndex.subIndex for the
 employer ID, as shown below:
  EntityCursor<Person> employees =
@@ -667,7 +678,7 @@ bindings, provides maximum performance.
 
 Which API to use?
 
-The Berkeley DB engine has a Base API, a Collections API and a Direct Persistence Layer (DPL).  Follow these guidelines if you are not sure
+
The Berkeley DB engine has a Base API, a Collections API and a Direct Persistence Layer (DPL).  Follow these guidelines if you are not sure
 which API to use:
 
 When Java classes are used to represent domain objects in an application,
@@ -694,7 +705,7 @@ for doing so.
 
 Generic Types
 
-Generic types are used to provide type safety, especially for the PrimaryIndex, SecondaryIndex, and EntityCursor classes.  If you don't wish to
+
Generic types are used to provide type safety, especially for the PrimaryIndex, SecondaryIndex, and EntityCursor classes.  If you don't wish to
 use generic types, you can simply not declare your index and cursor objects
 using generic type parameters.  This is the same as using the Java 1.5
 Collections Framework without using generic types.
@@ -702,7 +713,7 @@ Collections Framework without using generic types.
 Annotations
 
 If you don't wish to use annotations, you can provide another source of
-metadata by implementing an EntityModel class.  For example, naming conventions, static members, or an XML
+metadata by implementing an EntityModel class.  For example, naming conventions, static members, or an XML
 configuration file might be used as a source of metadata.  However, if you
 don't use annotations then you won't be able to use bytecode enhancement, which
 is described next.
@@ -724,12 +735,12 @@ files are enhanced during a post-compilation step.
 Enhanced classes are used to efficiently access all fields and default
 constructors, including non-public members.
 
-See ClassEnhancer for
+
See ClassEnhancer for
 bytecode enhancement configuration details.
 
 If bytecode enhancement is not used as described above, the DPL will use
 reflection for accessing persistent fields and the default constructor.  The
-AccessibleObject.setAccessible method is called by the DPL to enable access to
+AccessibleObject.setAccessible method is called by the DPL to enable access to
 non-public fields and constructors.  If you are running under a Java security
 manager you must configure your security policy to allow the following
 permission:
@@ -757,66 +768,54 @@ However, this performance difference may or may not impact a given application
 since it may be overshadowed by other factors.  Performance testing in a
 realistic usage scenario is the best way to determine the impact.  If you are
 determined to avoid the use of reflection then option 3 above is
-recommended.
-
-
-

-

-
-
-
-
+recommended.

-Package com.sleepycat.persist -

-Package com.sleepycat.persist Description -

Package com.sleepycat.persist

Package com.sleepycat.persist Description

Package Specification

Which API to use?

Generic Types

Annotations