com.sleepycat.persist

Class KeysIndex<SK,PK>

java.lang.Object

com.sleepycat.persist.BasicIndex<SK,PK>

com.sleepycat.persist.KeysIndex<SK,PK>

All Implemented Interfaces:

EntityIndex<SK,PK>

 class KeysIndex<SK,PK>
extends BasicIndex<SK,PK>

The EntityIndex returned by SecondaryIndex.keysIndex(). This index maps secondary key to primary key. In Berkeley DB internal terms, this is a secondary database that is opened without associating it with a primary.

Author:

Mark Hayes

Field Summary

Fields inherited from class com.sleepycat.persist.BasicIndex

concurrentDB, db, emptyRange, entityAdapter, keyAdapter, keyBinding, keyClass, locking, NO_RETURN_ENTRY, sortedDups, transactional

Constructor Summary

Constructors

Constructor and Description
KeysIndex(Database db, java.lang.Class<SK> keyClass, EntryBinding keyBinding, java.lang.Class<PK> pkeyClass, EntryBinding pkeyBinding)

Method Summary

Methods

Modifier and Type	Method and Description
PK	get(SK key) Gets an entity via a key of this index.
PK	get(Transaction txn, SK key, LockMode lockMode) Gets an entity via a key of this index.
(package private) boolean	isUpdateAllowed()
java.util.Map<SK,PK>	map() Returns a standard Java map based on this entity index.
java.util.SortedMap<SK,PK>	sortedMap() Returns a standard Java sorted map based on this entity index.

Methods inherited from class com.sleepycat.persist.BasicIndex

contains, contains, count, delete, delete, entities, entities, entities, entities, keys, keys, keys, keys

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KeysIndex

KeysIndex(Database db,
         java.lang.Class<SK> keyClass,
         EntryBinding keyBinding,
         java.lang.Class<PK> pkeyClass,
         EntryBinding pkeyBinding)
    throws DatabaseException

Throws:

DatabaseException

Method Detail

get

public PK get(SK key)
       throws DatabaseException

Description copied from interface: EntityIndex

Gets an entity via a key of this index.

The operation will not be transaction protected, and LockMode.DEFAULT is used implicitly.

Parameters:

key - the key to search for.

Returns:

the value mapped to the given key, or null if the key is not present in the index.

Throws:

OperationFailureException - if one of the Read Operation Failures occurs.

EnvironmentFailureException - if an unexpected, internal or environment-wide failure occurs.

DatabaseException - the base class for all BDB exceptions.

get

public PK get(Transaction txn,
     SK key,
     LockMode lockMode)
       throws DatabaseException

Description copied from interface: EntityIndex

Gets an entity via a key of this index.

Parameters:

txn - the transaction used to protect this operation, or null if the operation should not be transaction protected.

key - the key to search for.

lockMode - the lock mode to use for this operation, or null to use LockMode.DEFAULT.

Returns:

the value mapped to the given key, or null if the key is not present in the index.

Throws:

OperationFailureException - if one of the Read Operation Failures occurs.

EnvironmentFailureException - if an unexpected, internal or environment-wide failure occurs.

DatabaseException - the base class for all BDB exceptions.

map

public java.util.Map<SK,PK> map()

Description copied from interface: EntityIndex

Returns a standard Java map based on this entity index. The StoredMap returned is defined by the Collections API. Stored collections conform to the standard Java collections framework interface.

Returns:

the map.

sortedMap

public java.util.SortedMap<SK,PK> sortedMap()

Description copied from interface: EntityIndex

Returns a standard Java sorted map based on this entity index. The StoredSortedMap returned is defined by the Collections API. Stored collections conform to the standard Java collections framework interface.

Returns:

the map.

isUpdateAllowed

boolean isUpdateAllowed()

Specified by:

isUpdateAllowed in class BasicIndex<SK,PK>