com.obera.jasdb.android

Class AndroidDBSession

java.lang.Object

com.obera.jasdb.android.AndroidDBSession

All Implemented Interfaces:

DBSession

public class AndroidDBSession
extends Object
implements DBSession

Author:

Renze de Vries

Constructor Summary

Constructors

Constructor and Description
AndroidDBSession(android.content.Context context)
AndroidDBSession(android.content.Context context, String instanceId)

Method Summary

Modifier and Type	Method and Description
void	addAndSwitchInstance(String instanceId, String path) Adds a new instance with the given path to the DB.
void	addInstance(String instanceId, String path) Adds a new instance with the given path to the DB.
void	closeSession() Closes the session and removes used resources
EntityBag	createOrGetBag(String bagName) Creates a bag or gets an existing one if it already existed for the connected instance.
EntityBag	createOrGetBag(String instanceId, String bagName) Creates a bag or gets an existing one if it already existed for the specified instance.
Instance	deleteInstance(String instanceId) This deletes an instance all its related bags and entities permanently.
EntityBag	getBag(String bagName) Retrieves an existing bag if this exists on the connected instance, in case the bag does not exist the method will return null
EntityBag	getBag(String instanceId, String bagName) Retrieves an existing bag if this exists on the specified instance, in case the bag does not exist the method will return null
List<EntityBag>	getBags() Gets a list of all existing bags in the default database instance
List<EntityBag>	getBags(String instanceId) Gets a list of all existing bags in the specified database instance
EntityManager	getEntityManager() Gets the entity manager that can be used for entity persistence
DBInstance	getInstance(String instanceId) Gets the metadata of a specific instance
String	getInstanceId() Gets the instance id of the currently connected instance
List<Instance>	getInstances() Gets a list of all available instances
UserAdministration	getUserAdministration()
void	removeBag(String bagName) Removes a bag from the current instance if it exists and is not in use
void	removeBag(String instanceId, String bagName) Removes a bag from the specified instance if it exists and is not in use
void	switchInstance(String instanceId) Switches the current session to a new instance

Methods inherited from class java.lang.Object

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

Constructor Detail

AndroidDBSession

public AndroidDBSession(android.content.Context context)
                 throws JasDBStorageException

Throws:

JasDBStorageException

AndroidDBSession

public AndroidDBSession(android.content.Context context,
                        String instanceId)
                 throws JasDBStorageException

Throws:

JasDBStorageException

Method Detail

getUserAdministration

public UserAdministration getUserAdministration()
                                         throws JasDBStorageException

Specified by:

getUserAdministration in interface DBSession

Throws:

JasDBStorageException

getInstances

public List<Instance> getInstances()
                            throws JasDBStorageException

Description copied from interface: DBSession

Gets a list of all available instances

Specified by:

getInstances in interface DBSession

Returns:

The list of all available instances

Throws:

JasDBStorageException - If unable to load the list of available instances

addInstance

public void addInstance(String instanceId,
                        String path)
                 throws JasDBStorageException

Description copied from interface: DBSession

Adds a new instance with the given path to the DB. The session still is attached to the original connecting instance. @see switchInstance or @see addAndSwitchInstance for switching to another instance.

Specified by:

addInstance in interface DBSession

Parameters:

instanceId - The id of the instance, should not exist already

path - The path where to store the instance and bag data

Throws:

JasDBStorageException - If unable to to add an instance

addAndSwitchInstance

public void addAndSwitchInstance(String instanceId,
                                 String path)
                          throws JasDBStorageException

Description copied from interface: DBSession

Adds a new instance with the given path to the DB. The session will switch to the newly created instance.

Specified by:

addAndSwitchInstance in interface DBSession

Parameters:

instanceId - The id of the instance, should not exist already

path - The path where to store the instance and bag data

Throws:

JasDBStorageException - If unable to to add an instance

switchInstance

public void switchInstance(String instanceId)
                    throws JasDBStorageException

Description copied from interface: DBSession

Switches the current session to a new instance

Specified by:

switchInstance in interface DBSession

Parameters:

instanceId - The id of the instance

Throws:

JasDBStorageException - If unable to switch to instance

deleteInstance

public Instance deleteInstance(String instanceId)
                        throws JasDBStorageException

Description copied from interface: DBSession

This deletes an instance all its related bags and entities permanently. This operation cannot be rolled back and is permanent. If the resources are in use this operation will fail. When the session is bound to the instance to be deleted the session switches to the default instance if present.

Specified by:

deleteInstance in interface DBSession

Parameters:

instanceId - The instanceId of the instance and related resources (bags, entities) to delete

Returns:

Returns the now active session instance, in case the instance was deleted the session switches to the default instance.

Throws:

JasDBStorageException - If unable to delete the instance and related resources (bags, entities)

getEntityManager

public EntityManager getEntityManager()

Description copied from interface: DBSession

Gets the entity manager that can be used for entity persistence

Specified by:

getEntityManager in interface DBSession

Returns:

The EntityManager

getInstanceId

public String getInstanceId()
                     throws JasDBStorageException

Description copied from interface: DBSession

Gets the instance id of the currently connected instance

Specified by:

getInstanceId in interface DBSession

Returns:

The id of the instance

Throws:

JasDBStorageException - If unable to get the id of the current connected instance

createOrGetBag

public EntityBag createOrGetBag(String bagName)
                         throws JasDBStorageException

Description copied from interface: DBSession

Creates a bag or gets an existing one if it already existed for the connected instance. In case the bag does not exist it will be created in the database.

Specified by:

createOrGetBag in interface DBSession

Parameters:

bagName - The name of the bag

Returns:

The created or already existing bag

Throws:

JasDBStorageException - If unable to create or get the bag

createOrGetBag

public EntityBag createOrGetBag(String instanceId,
                                String bagName)
                         throws JasDBStorageException

Description copied from interface: DBSession

Creates a bag or gets an existing one if it already existed for the specified instance. In case the bag does not exist it will be created in the database.

Specified by:

createOrGetBag in interface DBSession

Parameters:

instanceId - The id of the instance

bagName - The name of the bag

Returns:

The created or already existing bag

Throws:

JasDBStorageException - If unable to create or get the bag

getBag

public EntityBag getBag(String bagName)
                 throws JasDBStorageException

Description copied from interface: DBSession

Retrieves an existing bag if this exists on the connected instance, in case the bag does not exist the method will return null

Specified by:

getBag in interface DBSession

Parameters:

bagName - The name of the bag

Returns:

The bag if existing in the database, will return null if it does not exist

Throws:

JasDBStorageException - If unable to retrieve the bag

getBag

public EntityBag getBag(String instanceId,
                        String bagName)
                 throws JasDBStorageException

Description copied from interface: DBSession

Retrieves an existing bag if this exists on the specified instance, in case the bag does not exist the method will return null

Specified by:

getBag in interface DBSession

Parameters:

instanceId - The id of the instance

bagName - The name of the bag

Returns:

The bag if existing in the database, will return null if it does not exist

Throws:

JasDBStorageException - If unable to retrieve the bag

getInstance

public DBInstance getInstance(String instanceId)
                       throws JasDBStorageException

Description copied from interface: DBSession

Gets the metadata of a specific instance

Specified by:

getInstance in interface DBSession

Returns:

The metadata of a specific instance

Throws:

JasDBStorageException - If unable to load the metadata of the instance

getBags

public List<EntityBag> getBags()
                        throws JasDBStorageException

Description copied from interface: DBSession

Gets a list of all existing bags in the default database instance

Specified by:

getBags in interface DBSession

Returns:

The list of entity bags

Throws:

JasDBStorageException - If unable to retrieve the list of entity bags

getBags

public List<EntityBag> getBags(String instanceId)
                        throws JasDBStorageException

Description copied from interface: DBSession

Gets a list of all existing bags in the specified database instance

Specified by:

getBags in interface DBSession

Parameters:

instanceId - The id of the instance

Returns:

The list of entity bags

Throws:

JasDBStorageException - If unable to retrieve the list of entity bags

removeBag

public void removeBag(String bagName)
               throws JasDBStorageException

Description copied from interface: DBSession

Removes a bag from the current instance if it exists and is not in use

Specified by:

removeBag in interface DBSession

Parameters:

bagName - The name of the bag

Throws:

JasDBStorageException - If unable to remove the bag when it does not exist or the bag is in use

removeBag

public void removeBag(String instanceId,
                      String bagName)
               throws JasDBStorageException

Description copied from interface: DBSession

Removes a bag from the specified instance if it exists and is not in use

Specified by:

removeBag in interface DBSession

Parameters:

instanceId - The id of the instance

bagName - The name of the bag

Throws:

JasDBStorageException - If unable to remove the bag when it does not exist or the bag is in use

closeSession

public void closeSession()
                  throws JasDBStorageException

Description copied from interface: DBSession

Closes the session and removes used resources

Specified by:

closeSession in interface DBSession

Throws:

JasDBStorageException - if unable to cleanly close the session