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. --- .../java/com/sleepycat/persist/SecondaryIndex.html | 1952 ++++++++++---------- 1 file changed, 939 insertions(+), 1013 deletions(-) (limited to 'docs/java/com/sleepycat/persist/SecondaryIndex.html') diff --git a/docs/java/com/sleepycat/persist/SecondaryIndex.html b/docs/java/com/sleepycat/persist/SecondaryIndex.html index 5c45b20c..78742379 100644 --- a/docs/java/com/sleepycat/persist/SecondaryIndex.html +++ b/docs/java/com/sleepycat/persist/SecondaryIndex.html @@ -1,119 +1,118 @@ - - - - - -SecondaryIndex (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 SecondaryIndex<SK,PK,E>

-
-java.lang.Object
-  extended by com.sleepycat.persist.SecondaryIndex<SK,PK,E>
-
-
-
All Implemented Interfaces:
EntityIndex<SK,E>
-
-
-
-
public class SecondaryIndex<SK,PK,E>
extends Object
- - -

-The secondary index for an entity class and a secondary key. +

+
com.sleepycat.persist
+

Class SecondaryIndex<SK,PK,E>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    EntityIndex<SK,E>
    +
    +
    +
    +
    public class SecondaryIndex<SK,PK,E>
+extends java.lang.Object
    +
    The secondary index for an entity class and a secondary key.

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

    -

    SecondaryIndex implements EntityIndex to map the +

    SecondaryIndex implements EntityIndex to map the secondary key type (SK) to the entity type (E). In other words, entities are accessed by secondary key values.

    -

    The SecondaryKey annotation may be used to define a secondary key +

    The SecondaryKey annotation may be used to define a secondary key as shown in the following example.

    @@ -131,9 +130,9 @@ The secondary index for an entity class and a secondary key.
      private Employee() {}
  }
    -

    Before obtaining a SecondaryIndex, the PrimaryIndex must +

    Before obtaining a SecondaryIndex, the PrimaryIndex must be obtained for the entity class. To obtain the SecondaryIndex call - EntityStore.getSecondaryIndex, passing + EntityStore.getSecondaryIndex, passing the primary index, the secondary key class and the secondary key name. For example:

    @@ -146,16 +145,16 @@ The secondary index for an entity class and a secondary key. SecondaryIndex<String, Long, Employee> secondaryIndex = store.getSecondaryIndex(primaryIndex, String.class, "department"); -

    Since SecondaryIndex implements the EntityIndex +

    Since SecondaryIndex implements the EntityIndex interface, it shares the common index methods for retrieving and deleting - entities, opening cursors and using transactions. See EntityIndex + entities, opening cursors and using transactions. See EntityIndex for more information on these topics.

    SecondaryIndex does not provide methods for inserting - and updating entities. That must be done using the PrimaryIndex.

    + and updating entities. That must be done using the PrimaryIndex.

    Note that a SecondaryIndex has three type parameters <SK, - PK, E> or in the example <String, Long, Employee> while a PrimaryIndex has only two type parameters <PK, E> or <Long, + PK, E> or in the example <String, Long, Employee> while a PrimaryIndex has only two type parameters <PK, E> or <Long, Employee>. This is because a SecondaryIndex has an extra level of mapping: It maps from secondary key to primary key, and then from primary key to entity. For example, consider this entity:

    @@ -165,7 +164,7 @@ The secondary index for an entity class and a secondary key. 1EngineeringJane Smith

    -

    The PrimaryIndex maps from id directly to the entity, or from +

    The PrimaryIndex maps from id directly to the entity, or from primary key 1 to the "Jane Smith" entity in the example. The SecondaryIndex maps from department to id, or from secondary key "Engineering" to primary key 1 in the example, and then uses the PrimaryIndex to map from the primary key to the entity.

    @@ -178,7 +177,7 @@ The secondary index for an entity class and a secondary key.

    The second mapping provided by SecondaryIndex is from secondary key (SK) to primary key (PK), or in the example, from the String department - key to the Long id key. The keysIndex method provides this + key to the Long id key. The keysIndex method provides this mapping. When accessing the keys index, the primary key is returned rather than the entity. When only the primary key is needed and not the entire entity, using the keys index is less expensive than using the secondary @@ -186,13 +185,13 @@ The secondary index for an entity class and a secondary key.

    The third mapping provided by SecondaryIndex is from primary key (PK) to entity (E), for the subset of entities having a given secondary key - (SK). This mapping is provided by the subIndex(SK) method. A + (SK). This mapping is provided by the subIndex(SK) method. A sub-index is convenient when you are interested in working with the subset of entities having a particular secondary key value, for example, all employees in a given department.

    -

    All three mappings, along with the mapping provided by the PrimaryIndex, are shown using example data in the EntityIndex - interface documentation. See EntityIndex for more information.

    +

    All three mappings, along with the mapping provided by the PrimaryIndex, are shown using example data in the EntityIndex + interface documentation. See EntityIndex for more information.

    Note that when using an index, keys and values are stored and retrieved by value not by reference. In other words, if an entity object is stored @@ -208,7 +207,7 @@ The secondary index for an entity class and a secondary key.

    One-to-One Relationships

    -

    A ONE_TO_ONE relationship, although less +

    A ONE_TO_ONE relationship, although less common than other types of relationships, is the simplest type of relationship. A single entity is related to a single secondary key value. For example:

    @@ -231,20 +230,20 @@ The secondary index for an entity class and a secondary key. SecondaryIndex<String, Long, Employee> employeeBySsn = store.getSecondaryIndex(primaryIndex, String.class, "ssn"); -

    With a ONE_TO_ONE relationship, the +

    With a ONE_TO_ONE relationship, the secondary key must be unique; in other words, no two entities may have the same secondary key value. If an attempt is made to store an entity having - the same secondary key value as another existing entity, a DatabaseException will be thrown.

    + the same secondary key value as another existing entity, a DatabaseException will be thrown.

    Because the secondary key is unique, it is useful to lookup entities by - secondary key using EntityIndex.get(K). For example:

    + secondary key using EntityIndex.get(K). For example:

      Employee employee = employeeBySsn.get(mySsn);

    Many-to-One Relationships

    -

    A MANY_TO_ONE relationship is the most +

    A MANY_TO_ONE relationship is the most common type of relationship. One or more entities is related to a single secondary key value. For example:

    @@ -266,7 +265,7 @@ The secondary index for an entity class and a secondary key. SecondaryIndex<String, Long, Employee> employeeByDepartment = store.getSecondaryIndex(primaryIndex, String.class, "department"); -

    With a MANY_TO_ONE relationship, the +

    With a MANY_TO_ONE relationship, the secondary key is not required to be unique; in other words, more than one entity may have the same secondary key value. In this example, more than one employee may belong to the same department.

    @@ -287,7 +286,7 @@ The secondary index for an entity class and a secondary key.

    One-to-Many Relationships

    -

    In a ONE_TO_MANY relationship, a single +

    In a ONE_TO_MANY relationship, a single entity is related to one or more secondary key values. For example:

    @@ -308,19 +307,19 @@ The secondary index for an entity class and a secondary key.
  SecondaryIndex<String, Long, Employee> employeeByEmail =
      store.getSecondaryIndex(primaryIndex, String.class, "emailAddresses");
    -

    With a ONE_TO_MANY relationship, the +

    With a ONE_TO_MANY relationship, the secondary key must be unique; in other words, no two entities may have the same secondary key value. In this example, no two employees may have the same email address. If an attempt is made to store an entity having the - same secondary key value as another existing entity, a DatabaseException will be thrown.

    + same secondary key value as another existing entity, a DatabaseException will be thrown.

    Because the secondary key is unique, it is useful to lookup entities by - secondary key using EntityIndex.get(K). For example:

    + secondary key using EntityIndex.get(K). For example:

      Employee employee = employeeByEmail.get(myEmailAddress);
    -

    The secondary key field for a ONE_TO_MANY relationship must be an array or collection type. To access +

    The secondary key field for a ONE_TO_MANY relationship must be an array or collection type. To access the email addresses of an employee, simply access the collection field directly. For example:

    @@ -331,7 +330,7 @@ The secondary index for an entity class and a secondary key.

    Many-to-Many Relationships

    -

    In a MANY_TO_MANY relationship, one +

    In a MANY_TO_MANY relationship, one or more entities is related to one or more secondary key values. For example:

    @@ -353,7 +352,7 @@ The secondary index for an entity class and a secondary key. SecondaryIndex<String, Long, Employee> employeeByOrganization = store.getSecondaryIndex(primaryIndex, String.class, "organizations"); -

    With a MANY_TO_MANY relationship, the +

    With a MANY_TO_MANY relationship, the secondary key is not required to be unique; in other words, more than one entity may have the same secondary key value. In this example, more than one employee may belong to the same organization.

    @@ -372,7 +371,7 @@ The secondary index for an entity class and a secondary key. cursor.close(); } -

    The secondary key field for a MANY_TO_MANY relationship must be an array or collection type. To access +

    The secondary key field for a MANY_TO_MANY relationship must be an array or collection type. To access the organizations of an employee, simply access the collection field directly. For example:

    @@ -445,7 +444,7 @@ The secondary index for an entity class and a secondary key. field as a foreign key that refers to a Department entity. Whenever a Employee entity is stored, its department field value will be checked to ensure that a Department entity exists with that value as its primary key. - If no such Department entity exists, then a DatabaseException is + If no such Department entity exists, then a DatabaseException is thrown, causing the transaction to be aborted (assuming that transactions are used).

    @@ -457,15 +456,15 @@ The secondary index for an entity class and a secondary key. department that does not exist.

    By default, when this situation arises the system does not allow the - department to be deleted. Instead, a DatabaseException is thrown, + department to be deleted. Instead, a DatabaseException is thrown, causing the transaction to be aborted. In this case, in order to delete a department, the department field of all Employee entities must first be updated to refer to a different existing department, or set to null. This is the responsibility of the application.

    There are two additional ways of handling deletion of a Department - entity. These alternatives are configured using the SecondaryKey.onRelatedEntityDelete() annotation property. Setting this - property to DeleteAction.NULLIFY causes the Employee department + entity. These alternatives are configured using the SecondaryKey.onRelatedEntityDelete() annotation property. Setting this + property to DeleteAction.NULLIFY causes the Employee department field to be automatically set to null when the department they refer to is deleted. This may or may not be desirable, depending on application policies. For example:

    @@ -486,7 +485,7 @@ The secondary index for an entity class and a secondary key. private Employee() {} } -

    The DeleteAction.CASCADE value, on the other hand, causes the +

    The DeleteAction.CASCADE value, on the other hand, causes the Employee entities to be automatically deleted when the department they refer to is deleted. This is probably not desirable in this particular example, but is useful for parent-child relationships. For example:

    @@ -522,7 +521,7 @@ The secondary index for an entity class and a secondary key. Order entity is deleted, it may be useful to automatically delete its "child" OrderItem entities.

    -

    For more information, see SecondaryKey.onRelatedEntityDelete().

    +

    For more information, see SecondaryKey.onRelatedEntityDelete().

    One-to-Many versus Many-to-One for Related Entities

    @@ -824,400 +823,342 @@ The secondary index for an entity class and a secondary key.

    Be aware that the relationship entity approach adds overhead compared to Many-to-Many. There is one additional entity and one additional secondary key. These factors should be weighed against its advantages and the - relevant application access patterns should be considered.

    -

    - -

    -

    - -

    - + relevant application access patterns should be considered.

    +
    • +
+
+
+
    +
  • - - - - - - - - - -
    -Constructor Summary
    SecondaryIndex(SecondaryDatabase database, - Database keysDatabase, - PrimaryIndex<PK,E> primaryIndex, - Class<SK> secondaryKeyClass, - EntryBinding<SK> secondaryKeyBinding) - -
    -          Creates a secondary index without using an EntityStore.
    -  + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -Method Summary
    - booleancontains(K key) - -
    -          Checks for existence of a key in this index.
    - booleancontains(Transaction txn, - K key, - LockMode lockMode) - -
    -          Checks for existence of a key in this index.
    - longcount() - -
    -          Returns a non-transactional count of the entities in this index.
    - booleandelete(K key) - -
    -          Deletes all entities with a given index key.
    - booleandelete(Transaction txn, - K key) - -
    -          Deletes all entities with a given index key.
    - EntityCursor<E>entities() - -
    -          Opens a cursor for traversing all entities in this index.
    - EntityCursor<E>entities(K fromKey, - boolean fromInclusive, - K toKey, - boolean toInclusive) - -
    -          Opens a cursor for traversing entities in a key range.
    - EntityCursor<E>entities(Transaction txn, - CursorConfig config) - -
    -          Opens a cursor for traversing all entities in this index.
    - EntityCursor<E>entities(Transaction txn, - K fromKey, - boolean fromInclusive, - K toKey, - boolean toInclusive, - CursorConfig config) - -
    -          Opens a cursor for traversing entities in a key range.
    - Eget(SK key) - -
    -          Gets an entity via a key of this index.
    - Eget(Transaction txn, - SK key, - LockMode lockMode) - -
    -          Gets an entity via a key of this index.
    - SecondaryDatabasegetDatabase() - -
    -          Returns the underlying secondary database for this index.
    - EntryBinding<SK>getKeyBinding() - -
    -          Returns the secondary key binding for the index.
    - Class<SK>getKeyClass() - -
    -          Returns the secondary key class for this index.
    - DatabasegetKeysDatabase() - -
    -          Returns the underlying secondary database that is not associated with - the primary database and is used for the keysIndex.
    - PrimaryIndex<PK,E>getPrimaryIndex() - -
    -          Returns the primary index associated with this secondary index.
    - EntityCursor<K>keys() - -
    -          Opens a cursor for traversing all keys in this index.
    - EntityCursor<K>keys(K fromKey, - boolean fromInclusive, - K toKey, - boolean toInclusive) - -
    -          Opens a cursor for traversing keys in a key range.
    - EntityCursor<K>keys(Transaction txn, - CursorConfig config) - -
    -          Opens a cursor for traversing all keys in this index.
    - EntityCursor<K>keys(Transaction txn, - K fromKey, - boolean fromInclusive, - K toKey, - boolean toInclusive, - CursorConfig config) - -
    -          Opens a cursor for traversing keys in a key range.
    - EntityIndex<SK,PK>keysIndex() - -
    -          Returns a read-only keys index that maps secondary key to primary key.
    - Map<SK,E>map() - -
    -          Returns a standard Java map based on this entity index.
    - SortedMap<SK,E>sortedMap() - -
    -          Returns a standard Java sorted map based on this entity index.
    - EntityIndex<PK,E>subIndex(SK key) - -
    -          Returns an index that maps primary key to entity for the subset of - entities having a given secondary key (duplicates).
    -  - - - - - - - -
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    -  -

    - +

      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      booleancontains(K key) +
      Checks for existence of a key in this index.
      +
      booleancontains(Transaction txn, + K key, + LockMode lockMode) +
      Checks for existence of a key in this index.
      +
      longcount() +
      Returns a non-transactional count of the entities in this index.
      +
      booleandelete(K key) +
      Deletes all entities with a given index key.
      +
      booleandelete(Transaction txn, + K key) +
      Deletes all entities with a given index key.
      +
      EntityCursor<E>entities() +
      Opens a cursor for traversing all entities in this index.
      +
      EntityCursor<E>entities(K fromKey, + boolean fromInclusive, + K toKey, + boolean toInclusive) +
      Opens a cursor for traversing entities in a key range.
      +
      EntityCursor<E>entities(Transaction txn, + CursorConfig config) +
      Opens a cursor for traversing all entities in this index.
      +
      EntityCursor<E>entities(Transaction txn, + K fromKey, + boolean fromInclusive, + K toKey, + boolean toInclusive, + CursorConfig config) +
      Opens a cursor for traversing entities in a key range.
      +
      Eget(SK key) +
      Gets an entity via a key of this index.
      +
      Eget(Transaction txn, + SK key, + LockMode lockMode) +
      Gets an entity via a key of this index.
      +
      SecondaryDatabasegetDatabase() +
      Returns the underlying secondary database for this index.
      +
      EntryBinding<SK>getKeyBinding() +
      Returns the secondary key binding for the index.
      +
      java.lang.Class<SK>getKeyClass() +
      Returns the secondary key class for this index.
      +
      DatabasegetKeysDatabase() +
      Returns the underlying secondary database that is not associated with + the primary database and is used for the keysIndex.
      +
      PrimaryIndex<PK,E>getPrimaryIndex() +
      Returns the primary index associated with this secondary index.
      +
      EntityCursor<K>keys() +
      Opens a cursor for traversing all keys in this index.
      +
      EntityCursor<K>keys(K fromKey, + boolean fromInclusive, + K toKey, + boolean toInclusive) +
      Opens a cursor for traversing keys in a key range.
      +
      EntityCursor<K>keys(Transaction txn, + CursorConfig config) +
      Opens a cursor for traversing all keys in this index.
      +
      EntityCursor<K>keys(Transaction txn, + K fromKey, + boolean fromInclusive, + K toKey, + boolean toInclusive, + CursorConfig config) +
      Opens a cursor for traversing keys in a key range.
      +
      EntityIndex<SK,PK>keysIndex() +
      Returns a read-only keys index that maps secondary key to primary key.
      +
      java.util.Map<SK,E>map() +
      Returns a standard Java map based on this entity index.
      +
      java.util.SortedMap<SK,E>sortedMap() +
      Returns a standard Java sorted map based on this entity index.
      +
      EntityIndex<PK,E>subIndex(SK key) +
      Returns an index that maps primary key to entity for the subset of + entities having a given secondary key (duplicates).
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

    -SecondaryIndex

    -
    -public SecondaryIndex(SecondaryDatabase database,
-                      Database keysDatabase,
-                      PrimaryIndex<PK,E> primaryIndex,
-                      Class<SK> secondaryKeyClass,
-                      EntryBinding<SK> secondaryKeyBinding)
-               throws DatabaseException
    -
    -
    Creates a secondary index without using an EntityStore. - When using an EntityStore, call getSecondaryIndex instead. +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        SecondaryIndex

        +
        public SecondaryIndex(SecondaryDatabase database,
+              Database keysDatabase,
+              PrimaryIndex<PK,E> primaryIndex,
+              java.lang.Class<SK> secondaryKeyClass,
+              EntryBinding<SK> secondaryKeyBinding)
+               throws DatabaseException
        +
        Creates a secondary index without using an EntityStore. + When using an EntityStore, call getSecondaryIndex instead.

        This constructor is not normally needed and is provided for applications that wish to use custom bindings along with the Direct - Persistence Layer. Normally, getSecondaryIndex is used instead.

        -

        -

        -
        Parameters:
        database - the secondary database used for all access other than - via a keysIndex.
        keysDatabase - another handle on the secondary database, opened + Persistence Layer. Normally, getSecondaryIndex is used instead.

        +
        Parameters:
        database - the secondary database used for all access other than + via a keysIndex.
        keysDatabase - another handle on the secondary database, opened without association to the primary, and used only for access via a - keysIndex. If this argument is null and the keysIndex + keysIndex. If this argument is null and the keysIndex method is called, then the keys database will be opened automatically; however, the user is then responsible for closing the keys database. To - get the keys database in order to close it, call getKeysDatabase().
        primaryIndex - the primary index associated with this secondary - index.
        secondaryKeyClass - the class of the secondary key.
        secondaryKeyBinding - the binding to be used for secondary keys. -
        Throws: -
        DatabaseException - the base class for all BDB exceptions.
        -
    - + get the keys database in order to close it, call getKeysDatabase().
    primaryIndex - the primary index associated with this secondary + index.
    secondaryKeyClass - the class of the secondary key.
    secondaryKeyBinding - the binding to be used for secondary keys.
    +
    Throws:
    +
    DatabaseException - the base class for all BDB exceptions.
    +
    • +
+ + - - - - - - -
-Method Detail
- -

-getDatabase

-
-public SecondaryDatabase getDatabase()
-
-
Returns the underlying secondary database for this index. -

-

- -
Returns:
the secondary database.
-
-
-
- -

-getKeysDatabase

-
-public Database getKeysDatabase()
-
-
Returns the underlying secondary database that is not associated with - the primary database and is used for the keysIndex. -

-

- -
Returns:
the keys database.
-
-
-
- -

-getPrimaryIndex

-
-public PrimaryIndex<PK,E> getPrimaryIndex()
-
-
Returns the primary index associated with this secondary index. -

-

- -
Returns:
the primary index.
-
-
-
- -

-getKeyClass

-
-public Class<SK> getKeyClass()
-
-
Returns the secondary key class for this index. -

-

- -
Returns:
the class.
-
-
-
- -

-getKeyBinding

-
-public EntryBinding<SK> getKeyBinding()
-
-
Returns the secondary key binding for the index. -

-

- -
Returns:
the key binding.
-
-
-
- -

-keysIndex

-
-public EntityIndex<SK,PK> keysIndex()
-                             throws DatabaseException
-
-
Returns a read-only keys index that maps secondary key to primary key. +
    +
  • + + +

    Method Detail

    + + + +
      +
    • +

      getDatabase

      +
      public SecondaryDatabase getDatabase()
      +
      Returns the underlying secondary database for this index.
      +
      Returns:
      the secondary database.
      +
      • +
    + + + +
      +
    • +

      getKeysDatabase

      +
      public Database getKeysDatabase()
      +
      Returns the underlying secondary database that is not associated with + the primary database and is used for the keysIndex.
      +
      Returns:
      the keys database.
      +
      • +
    + + + +
      +
    • +

      getPrimaryIndex

      +
      public PrimaryIndex<PK,E> getPrimaryIndex()
      +
      Returns the primary index associated with this secondary index.
      +
      Returns:
      the primary index.
      +
      • +
    + + + +
      +
    • +

      getKeyClass

      +
      public java.lang.Class<SK> getKeyClass()
      +
      Returns the secondary key class for this index.
      +
      Returns:
      the class.
      +
      • +
    + + + +
      +
    • +

      getKeyBinding

      +
      public EntryBinding<SK> getKeyBinding()
      +
      Returns the secondary key binding for the index.
      +
      Returns:
      the key binding.
      +
      • +
    + + + +
      +
    • +

      keysIndex

      +
      public EntityIndex<SK,PK> keysIndex()
+                             throws DatabaseException
      +
      Returns a read-only keys index that maps secondary key to primary key. When accessing the keys index, the primary key is returned rather than the entity. When only the primary key is needed and not the entire entity, using the keys index is less expensive than using the secondary @@ -1228,551 +1169,536 @@ public getKeysDatabase() before closing the + database returned by getKeysDatabase() before closing the environment. If you are using an EntityStore, the - keys database will be closed automatically by EntityStore.close().

      -

      -

      - -
      Returns:
      the keys index. -
      Throws: -
      DatabaseException - the base class for all BDB exceptions.
      -
      -
-
- -

-subIndex

-
-public EntityIndex<PK,E> subIndex(SK key)
-                           throws DatabaseException
-
-
Returns an index that maps primary key to entity for the subset of + keys database will be closed automatically by EntityStore.close().

+
Returns:
the keys index.
+
Throws:
+
DatabaseException - the base class for all BDB exceptions.
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ -
- - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - -
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