|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.compomics.util.db.ObjectsDB
public class ObjectsDB
A database which can easily be used to store objects.
Constructor Summary | |
---|---|
ObjectsDB(java.lang.String folder,
java.lang.String dbName,
boolean deleteOldDatabase,
ObjectsCache objectsCache)
Constructor. |
Method Summary | |
---|---|
void |
addTable(java.lang.String tableName)
Adds the desired table in the database. |
void |
close()
Closes the db connection. |
java.lang.String |
correctTableName(java.lang.String tableName)
Surrounds the table name with quotation marks such that spaces etc are allowed. |
void |
deleteObject(java.lang.String tableName,
java.lang.String objectKey)
Deletes an object from the desired table. |
void |
establishConnection(java.lang.String aDbFolder,
boolean deleteOldDatabase,
ObjectsCache objectsCache)
Establishes connection to the database. |
java.lang.String |
getName()
Returns the database name. |
ObjectsCache |
getObjectsCache()
Returns the cache used by this database. |
boolean |
inDB(java.lang.String tableName,
java.lang.String objectKey,
boolean cache)
Indicates whether an object is loaded in the given table. |
void |
insertObject(java.lang.String tableName,
java.lang.String objectKey,
java.lang.Object object,
boolean inCache)
Stores an object in the desired table. |
void |
insertObjects(java.lang.String tableName,
java.util.HashMap<java.lang.String,java.lang.Object> objects,
WaitingHandler waitingHandler)
Inserts a set of objects in the given table. |
void |
loadObjects(java.lang.String tableName,
java.util.ArrayList<java.lang.String> keys,
WaitingHandler waitingHandler)
Loads some objects from a table in the cache. |
void |
loadObjects(java.lang.String tableName,
WaitingHandler waitingHandler)
Loads all objects from a table in the cache. |
java.lang.Object |
retrieveObject(java.lang.String tableName,
java.lang.String objectKey)
Retrieves an object from the desired table. |
void |
setObjectCache(ObjectsCache objectCache)
Sets the object cache to be used by this database. |
java.util.ArrayList<java.lang.String> |
tableContent(java.lang.String tableName)
Returns an arraylist with the content in the given table. |
void |
updateObject(java.lang.String tableName,
java.lang.String objectKey,
java.lang.Object object)
Updates an object in the cache or in the tables if not in cache. |
void |
updateObject(java.lang.String tableName,
java.lang.String objectKey,
java.lang.Object object,
boolean cache)
Updates an object in the cache or in the tables if not in cache or if cache is wrong. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ObjectsDB(java.lang.String folder, java.lang.String dbName, boolean deleteOldDatabase, ObjectsCache objectsCache) throws java.sql.SQLException
folder
- absolute path of the folder where to establish the databasedbName
- name of the databasedeleteOldDatabase
- if true, tries to delete the old databaseobjectsCache
-
java.sql.SQLException
Method Detail |
---|
public java.lang.String getName()
public ObjectsCache getObjectsCache()
public void setObjectCache(ObjectsCache objectCache)
objectCache
- the object cache to be used by this databasepublic void addTable(java.lang.String tableName) throws java.sql.SQLException
tableName
- the name of the table
java.sql.SQLException
- exception thrown whenever a problem occurred while
working with the databasepublic void insertObject(java.lang.String tableName, java.lang.String objectKey, java.lang.Object object, boolean inCache) throws java.sql.SQLException, java.io.IOException
tableName
- the name of the tableobjectKey
- the key of the objectobject
- the object to storeinCache
- boolean indicating whether the method shall try to put the
object in cache or not
java.sql.SQLException
- exception thrown whenever an error occurred while
storing the object
java.io.IOException
- exception thrown whenever an error occurred while
writing in the databasepublic void insertObjects(java.lang.String tableName, java.util.HashMap<java.lang.String,java.lang.Object> objects, WaitingHandler waitingHandler) throws java.sql.SQLException, java.io.IOException
tableName
- the name of the tableobjects
- map of the objects (object key -> object)waitingHandler
- a waiting handler displaying the progress (can be
null). The progress will be displayed on the secondary progress bar.
java.sql.SQLException
java.io.IOException
public void loadObjects(java.lang.String tableName, WaitingHandler waitingHandler) throws java.sql.SQLException, java.io.IOException, java.lang.ClassNotFoundException
tableName
- the table namewaitingHandler
- the waiting handler
java.sql.SQLException
- exception thrown whenever an error occurred while
interrogating the database
java.io.IOException
- exception thrown whenever an error occurred while
reading the database
java.lang.ClassNotFoundException
- exception thrown whenever the class of the
object is not found when deserializing it.public void loadObjects(java.lang.String tableName, java.util.ArrayList<java.lang.String> keys, WaitingHandler waitingHandler) throws java.sql.SQLException, java.io.IOException, java.lang.ClassNotFoundException
tableName
- the table namekeys
- the keys of the objects to loadwaitingHandler
- the waiting handler, will only be increased
java.sql.SQLException
- exception thrown whenever an error occurred while
interrogating the database
java.io.IOException
- exception thrown whenever an error occurred while
reading the database
java.lang.ClassNotFoundException
- exception thrown whenever the class of the
object is not found when deserializing it.public java.lang.Object retrieveObject(java.lang.String tableName, java.lang.String objectKey) throws java.sql.SQLException, java.io.IOException, java.lang.ClassNotFoundException
tableName
- the name of the tableobjectKey
- the object key
java.sql.SQLException
- exception thrown whenever an error occurred while
interrogating the database
java.io.IOException
- exception thrown whenever an error occurred while
reading the database
java.lang.ClassNotFoundException
- exception thrown whenever the class of the
object is not found when deserializing it.public boolean inDB(java.lang.String tableName, java.lang.String objectKey, boolean cache) throws java.sql.SQLException
tableName
- the table nameobjectKey
- the object keycache
- a boolean indicating whether the cache should be searched as
well
java.sql.SQLException
- exception thrown whenever an exception occurred
while interrogating the databasepublic java.util.ArrayList<java.lang.String> tableContent(java.lang.String tableName) throws java.sql.SQLException
tableName
- the table to get the content for
java.sql.SQLException
public void deleteObject(java.lang.String tableName, java.lang.String objectKey) throws java.sql.SQLException, java.io.IOException
tableName
- the name of the tableobjectKey
- the object key
java.sql.SQLException
- exception thrown whenever an error occurred while
interrogating the database
java.io.IOException
- exception thrown whenever an error occurred while
interrogating the databasepublic void updateObject(java.lang.String tableName, java.lang.String objectKey, java.lang.Object object) throws java.sql.SQLException, java.io.IOException
tableName
- the name of the tableobjectKey
- the key of the objectobject
- the object to store
java.sql.SQLException
- exception thrown whenever an error occurred while
storing the object
java.io.IOException
- exception thrown whenever an error occurred while
writing in the databasepublic void updateObject(java.lang.String tableName, java.lang.String objectKey, java.lang.Object object, boolean cache) throws java.sql.SQLException, java.io.IOException
tableName
- the name of the tableobjectKey
- the key of the objectobject
- the object to storecache
- a boolean indicating whether the method should look in the
cache
java.sql.SQLException
- exception thrown whenever an error occurred while
storing the object
java.io.IOException
- exception thrown whenever an error occurred while
writing in the databasepublic void close() throws java.sql.SQLException
java.sql.SQLException
- exception thrown whenever an error occurred while
closing the database connectionpublic void establishConnection(java.lang.String aDbFolder, boolean deleteOldDatabase, ObjectsCache objectsCache) throws java.sql.SQLException
aDbFolder
- the folder where the database is locateddeleteOldDatabase
- if true, tries to delete the old databaseobjectsCache
-
java.sql.SQLException
- exception thrown whenever an error occurred while
establishing the connectionpublic java.lang.String correctTableName(java.lang.String tableName)
tableName
- the table name
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |