com.softwareag.mobile.runtime.toolkit.persistence

Class SQLiteConnectorImpl

java.lang.Object

com.softwareag.mobile.runtime.toolkit.persistence.SQLiteConnectorImpl

All Implemented Interfaces:

ISQLiteConnector

Direct Known Subclasses:

SyncClientSQLiteConnectorImpl

public class SQLiteConnectorImpl
extends java.lang.Object
implements ISQLiteConnector

The SQLiteConnectorImpl is a simple implementation of ISQLiteConnector which handles the communication with a given SQLite table.

All instances share a common database named SQLiteConnectorImpl. The name of the underlying database can be changed by overwriting getDatabaseName().

By creating this class, clients have to deliver the names and data types of each column, passed as String arrays with the constructor. As an example:

 final String[] columnNames = new String[] { "FIRST", "SECOND" };
 final String[] columnTypes = new String[] { "TEXT", "INT" };
 final SQLiteConnectorImpl store = new SQLiteConnectorImpl("MyTable",
                columnNames, columnTypes);
 

Supported types are listed in the SQLite online documentation. The first value within rowNames (rowNames[0]) is treated as the primary key.

It's recommended to introduce subclasses to properly overwrite bindFromCursor(Cursor) to return a specific object. By default, bindFromCursor(Cursor) will return an array containing the values for each column.

Uses Logger.info(String, String) to print all executed queries.

Version:

9.7.0.0000-0116

Constructor Summary

Constructors

Constructor and Description
SQLiteConnectorImpl(java.lang.String tableName, java.lang.String[] rowNames, java.lang.String[] rowTypes) Creates a new instance and tries to create - or open - the underlying database.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	bindFromCursor(com.softwareag.mobile.runtime.database.Cursor cursor) Binds the values contained in the delivered Cursor to an array of objects.
void	createTable() Creates a new table if it's not existing.
void	delete(java.lang.Object primaryKey) Deletes a object identified by it's primary key value.
void	deleteAll() Deletes all objects from within this table.
int	getCount() Returns the number of stored elements.
java.lang.String	getDatabaseName() Returns the name of the underlying database.
java.lang.String	getTableName() Returns the name of the table.
void	insertOrUpdate(java.lang.Object[] data) Inserts, or if already existing updates, a given object.
java.lang.Object[]	selectAll() Returns all contained elements as an array of Objects.

Methods inherited from class java.lang.Object

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

Constructor Detail

SQLiteConnectorImpl

public SQLiteConnectorImpl(java.lang.String tableName,
                   java.lang.String[] rowNames,
                   java.lang.String[] rowTypes)

Creates a new instance and tries to create - or open - the underlying database.

Parameters:

tableName -

rowNames -

rowTypes -

Method Detail

getDatabaseName

public java.lang.String getDatabaseName()

Returns the name of the underlying database.
If no subclass is used, returns DATABASE_NAME.

Returns:

createTable

public void createTable()
                 throws com.softwareag.mobile.runtime.database.DatabaseException

Description copied from interface: ISQLiteConnector

Creates a new table if it's not existing. Uses ISQLiteConnector.getTableName() as the table name identifier.

Specified by:

createTable in interface ISQLiteConnector

Throws:

com.softwareag.mobile.runtime.database.DatabaseException

getTableName

public java.lang.String getTableName()

Description copied from interface: ISQLiteConnector

Returns the name of the table.

Specified by:

getTableName in interface ISQLiteConnector

Returns:

getCount

public int getCount()
             throws com.softwareag.mobile.runtime.database.DatabaseException

Description copied from interface: ISQLiteConnector

Returns the number of stored elements.

Specified by:

getCount in interface ISQLiteConnector

Returns:

Throws:

com.softwareag.mobile.runtime.database.DatabaseException

selectAll

public java.lang.Object[] selectAll()
                             throws com.softwareag.mobile.runtime.database.DatabaseException

Description copied from interface: ISQLiteConnector

Returns all contained elements as an array of Objects.

Specified by:

selectAll in interface ISQLiteConnector

Returns:

Throws:

com.softwareag.mobile.runtime.database.DatabaseException

insertOrUpdate

public void insertOrUpdate(java.lang.Object[] data)
                    throws com.softwareag.mobile.runtime.database.DatabaseException

Description copied from interface: ISQLiteConnector

Inserts, or if already existing updates, a given object. Uses data[0] as value for the primary key.

Specified by:

insertOrUpdate in interface ISQLiteConnector

Throws:

com.softwareag.mobile.runtime.database.DatabaseException

bindFromCursor

public java.lang.Object bindFromCursor(com.softwareag.mobile.runtime.database.Cursor cursor)
                                throws com.softwareag.mobile.runtime.database.DatabaseException

Binds the values contained in the delivered Cursor to an array of objects. This method is called by selectAll().
By extending, clients may overwrite this behavior to return a specific object instead of the array.

Parameters:

cursor -

Returns:

Throws:

com.softwareag.mobile.runtime.database.DatabaseException

See Also:

selectAll()

delete

public void delete(java.lang.Object primaryKey)
            throws com.softwareag.mobile.runtime.database.DatabaseException

Description copied from interface: ISQLiteConnector

Deletes a object identified by it's primary key value.

Specified by:

delete in interface ISQLiteConnector

Throws:

com.softwareag.mobile.runtime.database.DatabaseException

deleteAll

public void deleteAll()
               throws com.softwareag.mobile.runtime.database.DatabaseException

Description copied from interface: ISQLiteConnector

Deletes all objects from within this table.

Specified by:

deleteAll in interface ISQLiteConnector

Throws:

com.softwareag.mobile.runtime.database.DatabaseException