gov.nih.nlm.nls.dbm
Interface JDbmInterface

All Known Implementing Classes:

BerkeleyBtreeJ, InMemory, MysqlJDbm, StoreJDbm, UncommonJDbm

public interface JDbmInterface

JDbmInterface is intended to be the interface to jdbm, jgdbm, and berkeley btree Tue Dec 04 12:00:16 EST 2001, divita Initial Version

Method Summary

java.util.ArrayList	beginsWith(java.lang.String pKey) Method beginsWith [TBD]
java.util.ArrayList	beginsWithWord(java.lang.String pString) Method beginsWithWord [TBD]
void	close() Method close closes the db.
java.util.Enumeration	elements() Method elements
int	get(long pRowId) Method get retrieves an int from the datastore using an int as the key This method returns a -1 if nothing was found.
byte[]	getBytes(int pRowId) Method getBytes
byte[]	getBytes(java.lang.String pRowId) Method getBytes
int	getInt(java.lang.String pKey) Method getInt gets an int back from the datastore, using a string as the key This method will return -1 if nothing is found.
int[]	getInts(int pKey) Method getInts retrieves an array of ints from the datastore using an int as the key
int[]	getInts(java.lang.String pKey) Method getInts retrieves an array of ints from the datastore using a string as the key
int[]	getNonUniqInts(java.lang.String pKey) Method getNonUniqInts retrieves an array of ints from the datastore using a string as the key
long	getNumberOfRecords() Method getNumberOfRecords retrieves the number of records from the table that is keyed by a record id.
long	getNumberOfStringKeyedRows() Method getNumberOfStringKeyedRows retrieves the number of rows in the table that contains strings as keys.
java.lang.Object	getObject(int pRowId) Method get
java.lang.Object	getObject(java.lang.String pRowId) Method getObject
java.lang.String	getString(int pRowId) Method getString retrieves UTF-8 Strings from the datastore using an int as the key
java.lang.String	getString(java.lang.String pKey) Method getString retrieves from the datastore using a String as the key
java.lang.String[]	getStrings(java.lang.String pKey) Method getStrings retrieves an array of String from the datastore using a string as the key
java.util.Iterator	keyIterator() Method keyIterator
java.util.Enumeration	keys() Method keys
void	open(java.lang.String pFileName) Method open opens the database
void	put(int pKey, int pValue) Method put
void	put(java.lang.String pKey, int pValue) Method put
void	put(java.lang.String pKey, java.lang.String pValue) Method put
void	putAString(java.lang.String pKey, java.lang.String pValue) Method putStrings add a value to the key|values[] set
void	putBytes(int pKey, byte[] pValue) Method putBytes
void	putBytes(java.lang.String pKey, byte[] pValue) Method putBytes
void	putInts(int pKey, int[] pValue) Method putInts
void	putInts(java.lang.String pKey, int[] pValue) Method putInts
void	putNonUniqInts(java.lang.String pKey, int pValue) Method putNonUniqInts
void	putObject(int pKey, java.lang.Object pValue) Method put
void	putObject(java.lang.String pKey, java.lang.Object pValue) Method putObject
void	putString(int pRowID, java.lang.String pValue) Method putString
void	putStrings(java.lang.String pKey, java.lang.String[] pValue) Method putStrings sets a key|values[] set.
void	reorganize() Method reorganize reorganizes the db into an optimized or balanced btree and does a save as a side effect.
void	save() Method save [TBD] writes out the current state to disk.

Method Detail

open

public void open(java.lang.String pFileName)
          throws java.lang.Exception

Method open opens the database

Parameters:

pFileName -

Throws:

java.lang.Exception

close

public void close()
           throws java.lang.Exception

Method close closes the db. This method does do a flush and a save before closing when opened with write modes.

Throws:

java.lang.Exception

save

public void save()
          throws java.lang.Exception

Method save [TBD] writes out the current state to disk. This does not close the db, but makes sure the current state is saved.

Throws:

java.lang.Exception

reorganize

public void reorganize()
                throws java.lang.Exception

Method reorganize reorganizes the db into an optimized or balanced btree and does a save as a side effect. This method is useful when you've done some substantial number of updates where the underlying tree could get out of balance.

Throws:

java.lang.Exception

putObject

public void putObject(java.lang.String pKey,
                      java.lang.Object pValue)
               throws java.lang.Exception

Method putObject

Parameters:

pKey -

pValue -

Throws:

java.lang.Exception

putBytes

public void putBytes(java.lang.String pKey,
                     byte[] pValue)
              throws java.lang.Exception

Method putBytes

Parameters:

pKey -

pValue -

Throws:

java.lang.Exception

putBytes

public void putBytes(int pKey,
                     byte[] pValue)
              throws java.lang.Exception

Method putBytes

Parameters:

pKey -

pValue -

Throws:

java.lang.Exception

put

public void put(java.lang.String pKey,
                java.lang.String pValue)
         throws java.lang.Exception

Method put

Parameters:

pKey -

pValue -

Throws:

java.lang.Exception

putObject

public void putObject(int pKey,
                      java.lang.Object pValue)
               throws java.lang.Exception

Method put

Parameters:

pKey -

pValue -

Throws:

java.lang.Exception

put

public void put(int pKey,
                int pValue)
         throws java.lang.Exception

Method put

Parameters:

pKey -

pValue -

Throws:

java.lang.Exception

putInts

public void putInts(java.lang.String pKey,
                    int[] pValue)
             throws java.lang.Exception

Method putInts

Parameters:

pKey -

pValue -

Throws:

java.lang.Exception

putInts

public void putInts(int pKey,
                    int[] pValue)
             throws java.lang.Exception

Method putInts

Parameters:

pKey -

pValue -

Throws:

java.lang.Exception

putNonUniqInts

public void putNonUniqInts(java.lang.String pKey,
                           int pValue)
                    throws java.lang.Exception

Method putNonUniqInts

Parameters:

pKey -

pValue -

Throws:

java.lang.Exception

putString

public void putString(int pRowID,
                      java.lang.String pValue)
               throws java.lang.Exception

Method putString

Parameters:

pRowID -

pValue -

Throws:

java.lang.Exception

put

public void put(java.lang.String pKey,
                int pValue)
         throws java.lang.Exception

Method put

Parameters:

pKey -

pValue -

Throws:

java.lang.Exception

putAString

public void putAString(java.lang.String pKey,
                       java.lang.String pValue)
                throws java.lang.Exception

Method putStrings add a value to the key|values[] set

Parameters:

pKey -

pValue -

Throws:

java.lang.Exception

putStrings

public void putStrings(java.lang.String pKey,
                       java.lang.String[] pValue)
                throws java.lang.Exception

Method putStrings sets a key|values[] set.

Parameters:

pKey -

pValue -

Throws:

java.lang.Exception

getObject

public java.lang.Object getObject(java.lang.String pRowId)
                           throws java.lang.Exception

Method getObject

Parameters:

pRowId -

Returns:

Object

Throws:

java.lang.Exception

getBytes

public byte[] getBytes(java.lang.String pRowId)
                throws java.lang.Exception

Method getBytes

Parameters:

pRowId -

Returns:

byte[]

Throws:

java.lang.Exception

getBytes

public byte[] getBytes(int pRowId)
                throws java.lang.Exception

Method getBytes

Parameters:

pRowId -

Returns:

byte[]

Throws:

java.lang.Exception

getInt

public int getInt(java.lang.String pKey)
           throws java.lang.Exception

Method getInt gets an int back from the datastore, using a string as the key This method will return -1 if nothing is found.

Parameters:

pKey -

Returns:

int

Throws:

java.lang.Exception

getObject

public java.lang.Object getObject(int pRowId)
                           throws java.lang.Exception

Method get

Parameters:

pRowId -

Returns:

Object

Throws:

java.lang.Exception

getInts

public int[] getInts(java.lang.String pKey)
              throws java.lang.Exception

Method getInts retrieves an array of ints from the datastore using a string as the key

Parameters:

pKey -

Returns:

int[]

Throws:

java.lang.Exception

getInts

public int[] getInts(int pKey)
              throws java.lang.Exception

Method getInts retrieves an array of ints from the datastore using an int as the key

Parameters:

pKey -

Returns:

int[]

Throws:

java.lang.Exception

getNonUniqInts

public int[] getNonUniqInts(java.lang.String pKey)
                     throws java.lang.Exception

Method getNonUniqInts retrieves an array of ints from the datastore using a string as the key

Parameters:

pKey -

Returns:

int[]

Throws:

java.lang.Exception

get

public int get(long pRowId)
        throws java.lang.Exception

Method get retrieves an int from the datastore using an int as the key This method returns a -1 if nothing was found.

Parameters:

pRowId - ( (long) needs to be distinguished from the other get(int) signature)

Returns:

int

Throws:

java.lang.Exception

getString

public java.lang.String getString(int pRowId)
                           throws java.lang.Exception

Method getString retrieves UTF-8 Strings from the datastore using an int as the key

Parameters:

pRowId -

Returns:

String pValue

Throws:

java.lang.Exception

getString

public java.lang.String getString(java.lang.String pKey)
                           throws java.lang.Exception

Method getString retrieves from the datastore using a String as the key

Parameters:

pKey -

Returns:

String pValue

Throws:

java.lang.Exception

getStrings

public java.lang.String[] getStrings(java.lang.String pKey)
                              throws java.lang.Exception

Method getStrings retrieves an array of String from the datastore using a string as the key

Parameters:

pKey -

Returns:

String[]

Throws:

java.lang.Exception

elements

public java.util.Enumeration elements()
                               throws java.lang.Exception

Method elements

Returns:

Enumeration

Throws:

java.lang.Exception

keys

public java.util.Enumeration keys()
                           throws java.lang.Exception

Method keys

Returns:

Enumeration

Throws:

java.lang.Exception

keyIterator

public java.util.Iterator keyIterator()
                               throws java.lang.Exception

Method keyIterator

Returns:

Iterator

Throws:

java.lang.Exception

getNumberOfRecords

public long getNumberOfRecords()

Method getNumberOfRecords retrieves the number of records from the table that is keyed by a record id.

Returns:

long

getNumberOfStringKeyedRows

public long getNumberOfStringKeyedRows()

Method getNumberOfStringKeyedRows retrieves the number of rows in the table that contains strings as keys.

Returns:

long

beginsWith

public java.util.ArrayList beginsWith(java.lang.String pKey)
                               throws java.lang.Exception

Method beginsWith [TBD]

Parameters:

pKey -

Returns:

ArrayList

Throws:

java.lang.Exception

beginsWithWord

public java.util.ArrayList beginsWithWord(java.lang.String pString)
                                   throws java.lang.Exception

Method beginsWithWord [TBD]

Parameters:

pString -

Returns:

ArrayList (Of Objects)

Throws:

java.lang.Exception