net.obsearch.storage.bdb
Class BDBOBStoreJeShort

java.lang.Object
  net.obsearch.storage.bdb.AbstractBDBOBStoreJe<TupleShort>
      net.obsearch.storage.bdb.BDBOBStoreJeShort

All Implemented Interfaces:

OBStore<TupleShort>, OBStoreShort

public final class BDBOBStoreJeShort
extends AbstractBDBOBStoreJe<TupleShort>
implements OBStoreShort

BDBOBStoreShort is a wrapper for Berkeley indexes that assumes that keys are shorts and values are byte[].

Author:

Arnoldo Jose Muller Molina

Nested Class Summary

Nested classes/interfaces inherited from class net.obsearch.storage.bdb.AbstractBDBOBStoreJe

AbstractBDBOBStoreJe.ByteArrayIterator, AbstractBDBOBStoreJe.CursorIterator<T>

Field Summary

Fields inherited from class net.obsearch.storage.bdb.AbstractBDBOBStoreJe

counter, db, sequence, stats

Constructor Summary

BDBOBStoreJeShort(String name, com.sleepycat.je.Database db, com.sleepycat.je.Database seq, OBStoreFactory fact, boolean duplicates)
Builds a new Storage system by receiving a Berkeley DB database that uses shorts as a primary indexing method.

Method Summary

short	bytesToValue(byte[] entry) Converts the value of the given entry into its primitive type.
OperationStatus	delete(short key) Deletes the given key and its corresponding value from the database.
byte[]	getValue(short key) Returns the associated value for the given key.
CloseIterator<TupleShort>	processAll() Process all the elements in the DB.
CloseIterator<TupleShort>	processRange(short low, short high) Process the given range of items (from low to high), including low and high.
CloseIterator<TupleShort>	processRangeNoDup(short low, short high)
CloseIterator<TupleShort>	processRangeReverse(short low, short high) Process the given range of items (from high to low), including low and high.
CloseIterator<TupleShort>	processRangeReverseNoDup(short low, short high)
OperationStatus	put(short key, byte[] value) Inserts the key value pair.

Methods inherited from class net.obsearch.storage.bdb.AbstractBDBOBStoreJe

allowsDuplicatedData, close, delete, deleteAll, getFactory, getName, getReadStats, getStats, getValue, nextId, optimize, prepareBytes, processAllKeys, processRange, processRangeNoDup, processRangeReverse, processRangeReverseNoDup, put, putIfNew, setReadStats, size

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.obsearch.storage.OBStore

close, delete, deleteAll, getFactory, getName, getReadStats, getStats, getValue, nextId, optimize, prepareBytes, processRange, processRangeNoDup, processRangeReverse, processRangeReverseNoDup, put, setReadStats, size

Constructor Detail

BDBOBStoreJeShort

public BDBOBStoreJeShort(String name,
                         com.sleepycat.je.Database db,
                         com.sleepycat.je.Database seq,
                         OBStoreFactory fact,
                         boolean duplicates)
                  throws com.sleepycat.je.DatabaseException

Builds a new Storage system by receiving a Berkeley DB database that uses shorts as a primary indexing method.

Parameters:

db - The database to be stored.

seq - Sequences database.

name - Name of the database.

Throws:

com.sleepycat.je.DatabaseException - if something goes wrong with the database.

Method Detail

delete

public OperationStatus delete(short key)
                       throws OBStorageException

Description copied from interface: OBStoreShort

Deletes the given key and its corresponding value from the database.

Specified by:

delete in interface OBStoreShort

Parameters:

key - The key that will be deleted.

Returns:

net.obsearch.OperationStatus.Status#OK if the key was found, otherwise, net.obsearch.OperationStatus.Status#NOT_EXISTS.

Throws:

OBStorageException - If an exception occurs at the underlying storage system. You can query the exception to see more details regarding the nature of the error.

bytesToValue

public short bytesToValue(byte[] entry)

Converts the value of the given entry into its primitive type.

Specified by:

bytesToValue in interface OBStoreShort

Parameters:

entry - The place where we will put the entry.

getValue

public byte[] getValue(short key)
                throws IllegalArgumentException,
                       OBStorageException

Description copied from interface: OBStoreShort

Returns the associated value for the given key. If the underlying storage system can hold repeated keys, then an IllegalArgumentException is thrown.

Specified by:

getValue in interface OBStoreShort

Parameters:

key - the key that will be searched.

Returns:

the associated value for the given key.

Throws:

IllegalArgumentException - If the underlying storage system can hold multiple keys.

OBStorageException - If an exception occurs at the underlying storage system. You can query the exception to see more details regarding the nature of the error.

put

public OperationStatus put(short key,
                           byte[] value)
                    throws IllegalArgumentException,
                           OBStorageException

Description copied from interface: OBStoreShort

Inserts the key value pair. If the key existed, it will be overwritten.

Specified by:

put in interface OBStoreShort

Parameters:

key - Key to insert

value - The value that the key will hold after this operation completes.

Returns:

net.obsearch.OperationStatus.Status#OK the record was inserted/updated successfully. net.obsearch.OperationStatus.Status#ERROR if the record could not be updated.

Throws:

OBStorageException - If an exception occurs at the underlying storage system. You can query the exception to see more details regarding the nature of the error.

IllegalArgumentException

processRange

public CloseIterator<TupleShort> processRange(short low,
                                              short high)
                                       throws OBStorageException

Description copied from interface: OBStoreShort

Process the given range of items (from low to high), including low and high. The TupleProcessor's process method will be called for each value found within the range.

Specified by:

processRange in interface OBStoreShort

Throws:

OBStorageException - If an exception occurs at the underlying storage system. You can query the exception to see more details regarding the nature of the error.

processRangeNoDup

public CloseIterator<TupleShort> processRangeNoDup(short low,
                                                   short high)
                                            throws OBStorageException

Throws:

OBStorageException

processRangeReverse

public CloseIterator<TupleShort> processRangeReverse(short low,
                                                     short high)
                                              throws OBStorageException

Description copied from interface: OBStoreShort

Process the given range of items (from high to low), including low and high. The TupleProcessor's process method will be called for each value found within the range.

Specified by:

processRangeReverse in interface OBStoreShort

Throws:

OBStorageException - If an exception occurs at the underlying storage system. You can query the exception to see more details regarding the nature of the error.

processRangeReverseNoDup

public CloseIterator<TupleShort> processRangeReverseNoDup(short low,
                                                          short high)
                                                   throws OBStorageException

Throws:

OBStorageException

processAll

public CloseIterator<TupleShort> processAll()
                                     throws OBStorageException

Description copied from interface: OBStore

Process all the elements in the DB. Useful for debugging.

Specified by:

processAll in interface OBStore<TupleShort>

Returns:

An iterator that goes through all the data in the DB.

Throws:

OBStorageException