From 780b92ada9afcf1d58085a83a0b9e6bc982203d1 Mon Sep 17 00:00:00 2001 From: Lorry Tar Creator Date: Tue, 17 Feb 2015 17:25:57 +0000 Subject: Imported from /home/lorry/working-area/delta_berkeleydb/db-6.1.23.tar.gz. --- docs/java/com/sleepycat/persist/EntityStore.html | 1648 ++++++++++------------ 1 file changed, 774 insertions(+), 874 deletions(-) (limited to 'docs/java/com/sleepycat/persist/EntityStore.html') diff --git a/docs/java/com/sleepycat/persist/EntityStore.html b/docs/java/com/sleepycat/persist/EntityStore.html index f0596781..cce1960c 100644 --- a/docs/java/com/sleepycat/persist/EntityStore.html +++ b/docs/java/com/sleepycat/persist/EntityStore.html @@ -1,107 +1,105 @@ - - - - - -EntityStore (Oracle - Berkeley DB Java API) - - - - - - - - - - - - -
- - +//--> + + - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - -
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
-		 -Berkeley DB
version 5.3.21 -
- PREV CLASS  - NEXT CLASS - FRAMES   - NO FRAMES   -  - - - -
- SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD
- + + +
+ + +
+ + + - -
-

- -com.sleepycat.persist -
-Class EntityStore

-
-java.lang.Object
-  extended by com.sleepycat.persist.EntityStore
-
-
-
-
public class EntityStore
extends Object
- - -

-A store for managing persistent entity objects. +

+
com.sleepycat.persist
+

Class EntityStore

+
+
+ +
+
    +
  • +
    +
    +
    public class EntityStore
+extends java.lang.Object
    +
    A store for managing persistent entity objects.

    EntityStore objects are thread-safe. Multiple threads may safely call the methods of a shared EntityStore object.

    @@ -109,549 +107,467 @@ A store for managing persistent entity objects.

    See the package summary example for an example of using an EntityStore.

    -

    Before creating an EntityStore you must create an Environment object using the Berkeley DB engine API. The environment may +

    Before creating an EntityStore you must create an Environment object using the Berkeley DB engine API. The environment may contain any number of entity stores and their associated databases, as well as other databases not associated with an entity store.

    -

    An entity store is based on an EntityModel: a data model which +

    An entity store is based on an EntityModel: a data model which defines persistent classes (entity classes), primary keys, secondary keys, and relationships between entities. A primary index is created for each entity class. An associated secondary index is created for - each secondary key. The Entity, PrimaryKey and SecondaryKey annotations may be used to define entities and keys.

    + each secondary key. The Entity, PrimaryKey and SecondaryKey annotations may be used to define entities and keys.

    -

    To use an EntityStore, first obtain PrimaryIndex and - SecondaryIndex objects by calling getPrimaryIndex and getSecondaryIndex. Then use +

    To use an EntityStore, first obtain PrimaryIndex and + SecondaryIndex objects by calling getPrimaryIndex and getSecondaryIndex. Then use these indices to store and access entity records by key.

    Although not normally needed, you can also use the entity store along - with the Base API. Methods in the PrimaryIndex and SecondaryIndex classes may be used to obtain + with the Base API. Methods in the PrimaryIndex and SecondaryIndex classes may be used to obtain databases and bindings. The databases may be used directly for accessing entity records. The bindings should be called explicitly to translate - between DatabaseEntry objects and entity model + between DatabaseEntry objects and entity model objects.

    -

    Each primary and secondary index is associated internally with a Database. With any of the above mentioned use cases, methods are provided - that may be used for database performance tuning. The setPrimaryConfig and setSecondaryConfig methods may be called anytime before a database is - opened via getPrimaryIndex or getSecondaryIndex. The setSequenceConfig method may be called anytime before getSequence is called or getPrimaryIndex is called - for a primary index associated with that sequence.

    -

    - -

    -

    - -

    - +

    Each primary and secondary index is associated internally with a Database. With any of the above mentioned use cases, methods are provided + that may be used for database performance tuning. The setPrimaryConfig and setSecondaryConfig methods may be called anytime before a database is + opened via getPrimaryIndex or getSecondaryIndex. The setSequenceConfig method may be called anytime before getSequence is called or getPrimaryIndex is called + for a primary index associated with that sequence.

    +
    • +
+
+
+
    +
  • - - - - - - - - - -
    -Constructor Summary
    EntityStore(Environment env, - String storeName, - StoreConfig config) - -
    -          Opens an entity store in a given environment.
    -  +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      EntityStore(Environment env, + java.lang.String storeName, + StoreConfig config) +
      Opens an entity store in a given environment.
      +
      +
      • +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    -Method Summary
    - voidclose() - -
    -          Closes all databases and sequences that were opened via this store.
    - voidcloseClass(Class entityClass) - -
    -          Closes the primary and secondary databases for the given entity class - that were opened via this store.
    - EvolveStatsevolve(EvolveConfig config) - -
    -          Performs conversion of unevolved objects in order to reduce lazy - conversion overhead.
    - StoreConfiggetConfig() - -
    -          Returns a copy of the entity store configuration.
    - EnvironmentgetEnvironment() - -
    -          Returns the environment associated with this store.
    - EntityModelgetModel() - -
    -          Returns the current entity model for this store.
    - MutationsgetMutations() - -
    -          Returns the set of mutations that were configured when the store was +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      Methods 
      Modifier and TypeMethod and Description
      voidclose() +
      Closes all databases and sequences that were opened via this store.
      +
      voidcloseClass(java.lang.Class entityClass) +
      Closes the primary and secondary databases for the given entity class + that were opened via this store.
      +
      EvolveStatsevolve(EvolveConfig config) +
      Performs conversion of unevolved objects in order to reduce lazy + conversion overhead.
      +
      StoreConfiggetConfig() +
      Returns a copy of the entity store configuration.
      +
      EnvironmentgetEnvironment() +
      Returns the environment associated with this store.
      +
      EntityModelgetModel() +
      Returns the current entity model for this store.
      +
      MutationsgetMutations() +
      Returns the set of mutations that were configured when the store was opened, or if none were configured, the set of mutations that were - configured and stored previously.
      - DatabaseConfiggetPrimaryConfig(Class entityClass) - -
      -          Returns the default primary database Berkeley DB engine API - configuration for an entity class.
      - - - - - -
      -<PK,E> PrimaryIndex<PK,E>
      -      		getPrimaryIndex(Class<PK> primaryKeyClass, - Class<E> entityClass) - -
      -          Returns the primary index for a given entity class, opening it if - necessary.
      - SecondaryConfiggetSecondaryConfig(Class entityClass, - String keyName) - -
      -          Returns the default secondary database Berkeley DB engine API - configuration for an entity class and key name.
      - - - - - -
      -<SK,PK,E> SecondaryIndex<SK,PK,E>
      -      		getSecondaryIndex(PrimaryIndex<PK,E> primaryIndex, - Class<SK> keyClass, - String keyName) - -
      -          Returns a secondary index for a given primary index and secondary key, - opening it if necessary.
      - SequencegetSequence(String name) - -
      -          Returns a named sequence for using Berkeley DB engine API directly, - opening it if necessary.
      - SequenceConfiggetSequenceConfig(String name) - -
      -          Returns the default Berkeley DB engine API configuration for a named key - sequence.
      - StringgetStoreName() - -
      -          Returns the name of this store.
      - - - - - -
      -<SK,PK,E1,E2 extends E1> -
      -SecondaryIndex<SK,PK,E2>
      -      		getSubclassIndex(PrimaryIndex<PK,E1> primaryIndex, - Class<E2> entitySubclass, - Class<SK> keyClass, - String keyName) - -
      -          Returns a secondary index for a secondary key in an entity subclass, - opening it if necessary.
      - voidsetPrimaryConfig(Class entityClass, - DatabaseConfig config) - -
      -          Configures the primary database for an entity class using the Berkeley - DB engine API.
      - voidsetSecondaryConfig(Class entityClass, - String keyName, - SecondaryConfig config) - -
      -          Configures a secondary database for an entity class and key name using - the Berkeley DB engine API.
      - voidsetSequenceConfig(String name, - SequenceConfig config) - -
      -          Configures a named key sequence using the Berkeley DB engine API.
      - voidtruncateClass(Class entityClass) - -
      -          Deletes all instances of this entity class and its (non-entity) - subclasses.
      - voidtruncateClass(Transaction txn, - Class entityClass) - -
      -          Deletes all instances of this entity class and its (non-entity) - subclasses.
      -  - - - - - - - -
      Methods inherited from class java.lang.Object
      clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      -  -

      - + configured and stored previously. +

    DatabaseConfiggetPrimaryConfig(java.lang.Class entityClass) +
    Returns the default primary database Berkeley DB engine API + configuration for an entity class.
    +
    <PK,E> PrimaryIndex<PK,E>getPrimaryIndex(java.lang.Class<PK> primaryKeyClass, + java.lang.Class<E> entityClass) +
    Returns the primary index for a given entity class, opening it if + necessary.
    +
    SecondaryConfiggetSecondaryConfig(java.lang.Class entityClass, + java.lang.String keyName) +
    Returns the default secondary database Berkeley DB engine API + configuration for an entity class and key name.
    +
    <SK,PK,E> SecondaryIndex<SK,PK,E>getSecondaryIndex(PrimaryIndex<PK,E> primaryIndex, + java.lang.Class<SK> keyClass, + java.lang.String keyName) +
    Returns a secondary index for a given primary index and secondary key, + opening it if necessary.
    +
    SequencegetSequence(java.lang.String name) +
    Returns a named sequence for using Berkeley DB engine API directly, + opening it if necessary.
    +
    SequenceConfiggetSequenceConfig(java.lang.String name) +
    Returns the default Berkeley DB engine API configuration for a named key + sequence.
    +
    java.lang.StringgetStoreName() +
    Returns the name of this store.
    +
    <SK,PK,E1,E2 extends E1> 
    SecondaryIndex<SK,PK,E2>    		getSubclassIndex(PrimaryIndex<PK,E1> primaryIndex, + java.lang.Class<E2> entitySubclass, + java.lang.Class<SK> keyClass, + java.lang.String keyName) +
    Returns a secondary index for a secondary key in an entity subclass, + opening it if necessary.
    +
    voidsetPrimaryConfig(java.lang.Class entityClass, + DatabaseConfig config) +
    Configures the primary database for an entity class using the Berkeley + DB engine API.
    +
    voidsetSecondaryConfig(java.lang.Class entityClass, + java.lang.String keyName, + SecondaryConfig config) +
    Configures a secondary database for an entity class and key name using + the Berkeley DB engine API.
    +
    voidsetSequenceConfig(java.lang.String name, + SequenceConfig config) +
    Configures a named key sequence using the Berkeley DB engine API.
    +
    voidtruncateClass(java.lang.Class entityClass) +
    Deletes all instances of this entity class and its (non-entity) + subclasses.
    +
    voidtruncateClass(Transaction txn, + java.lang.Class entityClass) +
    Deletes all instances of this entity class and its (non-entity) + subclasses.
    +
    +
      +
    • + + +

      Methods inherited from class java.lang.Object

      +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • +
    +
    • +
+ + +
+
+ + + - - - - - - -
-Method Detail
- -

-getEnvironment

-
-public Environment getEnvironment()
-
-
Returns the environment associated with this store. -

-

- -
Returns:
the environment.
-
-
-
- -

-getConfig

-
-public StoreConfig getConfig()
-
-
Returns a copy of the entity store configuration. -

-

- -
Returns:
the config.
-
-
-
- -

-getStoreName

-
-public String getStoreName()
-
-
Returns the name of this store. -

-

- -
Returns:
the name.
-
-
-
- -

-getModel

-
-public EntityModel getModel()
-
-
Returns the current entity model for this store. The current model is +
    +
  • + + +

    Method Detail

    + + + +
      +
    • +

      getEnvironment

      +
      public Environment getEnvironment()
      +
      Returns the environment associated with this store.
      +
      Returns:
      the environment.
      +
      • +
    + + + +
      +
    • +

      getConfig

      +
      public StoreConfig getConfig()
      +
      Returns a copy of the entity store configuration.
      +
      Returns:
      the config.
      +
      • +
    + + + +
      +
    • +

      getStoreName

      +
      public java.lang.String getStoreName()
      +
      Returns the name of this store.
      +
      Returns:
      the name.
      +
      • +
    + + + +
      +
    • +

      getModel

      +
      public EntityModel getModel()
      +
      Returns the current entity model for this store. The current model is derived from the configured entity model and the live entity class - definitions. -

      -

      - -
      Returns:
      the model.
      -
      -
-
- -

-getMutations

-
-public Mutations getMutations()
-
-
Returns the set of mutations that were configured when the store was + definitions.
+
Returns:
the model.
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
Parameters:
name - the sequence name, which is normally defined using the + PrimaryKey.sequence() annotation property.
+
Returns:
the default configuration for the given sequence name.
+ + + + + + + + + + +
Parameters:
entityClass - the entity class identifying the primary database.
+
Returns:
the default configuration for the given entity class.
+ + + + + + + + + + +
Parameters:
entityClass - the entity class containing the given secondary key + name.
keyName - the name of the secondary key field, or the SecondaryKey.name() if this name annotation property was specified.
+
Returns:
the default configuration for the given secondary key.
+ + + + + + + + + + + + -
- - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - -
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
-		 -Berkeley DB
version 5.3.21 -
- PREV CLASS  - NEXT CLASS - FRAMES   - NO FRAMES   -  - - - -
- SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD
- + + +
+ + +
+ + + - -
-Copyright (c) 1996, 2012 Oracle and/or its affiliates. All rights reserved. - - +

Copyright (c) 1996, 2015 Oracle and/or its affiliates. All rights reserved.

+ + -- cgit v1.2.1