net.zer0bandwidth.android.lib.database.sqlitehouse

Class SQLiteHouse.Factory

java.lang.Object

net.zer0bandwidth.android.lib.database.sqlitehouse.SQLiteHouse.Factory

Enclosing class:

SQLiteHouse<DSC extends SQLiteHouse>

public static class SQLiteHouse.Factory
extends java.lang.Object

Creates instances of a SQLiteHouse. Because we have to have all our ducks in a row before the SQLiteHouse calls its ancestor's constructor, the factory needs to parse the SQLiteDatabaseSpec in advance, and feed that information into the constructor as parameters.

Usage

Given a Context ctx and SQLiteDatabase.CursorFactory cf (which may be null):

     MyDatabaseClass dbh = SQLiteHouse.Factory.init().getInstance(
             MyDatabaseClass.class, ctx, cf ) ;
 

See SQLiteHouse for detailed information regarding how this fits into the overall lifecycle of the object instance.

Since:

zer0bandwidth-net/android 0.1.4 (#26)

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.ArrayList<java.lang.Class<? extends SQLightable>>	m_aclsSchema The array of classes which, in aggregate, define the schema for the database.
protected android.database.sqlite.SQLiteDatabase.CursorFactory	m_cf The cursor factory to be used with the SQLiteHouse instance, if any.
protected android.content.Context	m_ctx The context in which the SQLiteHouse will operate.
protected int	m_nSchemaVersion The current schema version of the database.
protected java.lang.String	m_sDatabaseName The name of the database to be created.

Constructor Summary

Constructors

Constructor and Description
Factory()

Method Summary

Modifier and Type	Method and Description
<FDSC extends SQLiteHouse> FDSC	getInstance(java.lang.Class<FDSC> cls, android.content.Context ctx) Uses annotations found in a SQLiteHouse descendant to construct an instance of the database class.
<FDSC extends SQLiteHouse> FDSC	getInstance(java.lang.Class<FDSC> cls, android.content.Context ctx, android.database.sqlite.SQLiteDatabase.CursorFactory cf) Uses annotations found in a SQLiteHouse descendant to construct an instance of the database class.
static SQLiteHouse.Factory	init() Simply an alias for the default constructor, to allow for a cleaner grammar when creating a factory instance to obtain a reference to a database.

Methods inherited from class java.lang.Object

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

Field Detail

m_ctx

protected android.content.Context m_ctx

The context in which the SQLiteHouse will operate.

m_sDatabaseName

protected java.lang.String m_sDatabaseName

The name of the database to be created. The factory will glean this from the SQLiteDatabaseSpec annotation of the class that is passed into the getInstance(java.lang.Class<FDSC>, android.content.Context) method. The SQLiteHouse.SQLiteHouse(Factory) constructor retrieves this value from the factory to pass it to the parent class's constructor, SQLitePortal.SQLitePortal(android.content.Context, java.lang.String, android.database.sqlite.SQLiteDatabase.CursorFactory, int).

m_cf

protected android.database.sqlite.SQLiteDatabase.CursorFactory m_cf

The cursor factory to be used with the SQLiteHouse instance, if any. This is passed as an argument to getInstance(java.lang.Class<FDSC>, android.content.Context). The SQLiteHouse.SQLiteHouse(Factory) constructor retrieves this value from the factory to pass it to the parent class's constructor, SQLitePortal.SQLitePortal(android.content.Context, java.lang.String, android.database.sqlite.SQLiteDatabase.CursorFactory, int).

m_nSchemaVersion

protected int m_nSchemaVersion

The current schema version of the database. The factory will glean this from the SQLiteDatabaseSpec annotation of the class that is passed into the getInstance(java.lang.Class<FDSC>, android.content.Context) method. The SQLiteHouse.SQLiteHouse(Factory) constructor retrieves this value from the factory to pass it to the parent class's constructor, SQLitePortal.SQLitePortal(android.content.Context, java.lang.String, android.database.sqlite.SQLiteDatabase.CursorFactory, int).

m_aclsSchema

protected java.util.ArrayList<java.lang.Class<? extends SQLightable>> m_aclsSchema

The array of classes which, in aggregate, define the schema for the database. The factory will glean this list from the SQLiteDatabaseSpec annotation of the class that is passed to the getInstance(java.lang.Class<FDSC>, android.content.Context) method. The SQLiteHouse.SQLiteHouse(Factory) constructor uses this list to construct the schema; see SQLiteHouse.setSchemaClasses(List).

Constructor Detail

Factory

public Factory()

Method Detail

init

public static SQLiteHouse.Factory init()

Simply an alias for the default constructor, to allow for a cleaner grammar when creating a factory instance to obtain a reference to a database.

Returns:

an instance of the factory

getInstance

public <FDSC extends SQLiteHouse> FDSC getInstance(java.lang.Class<FDSC> cls,
                                                   android.content.Context ctx)
                                            throws IntrospectionException

Uses annotations found in a SQLiteHouse descendant to construct an instance of the database class. Since this method is templatized on the class that is being instantiated, there is no need for the SQLiteHouse descendant to provide its own extension of SQLiteHouse.Factory; this method will return an instance of the descendant class.

Type Parameters:

FDSC - the SQLiteHouse descendant being created; this matches the class sent in the cls argument.

Parameters:

cls - the SQLiteHouse descendant class being created

ctx - the context in which the object will operate

Returns:

an instance of the SQLiteHouse descendant, initialized with the database attributes found in the class's SQLiteDatabaseSpec annotation

Throws:

IntrospectionException - if something goes wrong while processing the descendant class. When invoking the descendant's constructor, there are several possible failure states; use .getCause() to determine which one applies.

Since:

zer0bandwidth-net/android 0.1.7 (#50)

getInstance

public <FDSC extends SQLiteHouse> FDSC getInstance(java.lang.Class<FDSC> cls,
                                                   android.content.Context ctx,
                                                   android.database.sqlite.SQLiteDatabase.CursorFactory cf)
                                            throws IntrospectionException

Uses annotations found in a SQLiteHouse descendant to construct an instance of the database class. Since this method is templatized on the class that is being instantiated, there is no need for the SQLiteHouse descendant to provide its own extension of SQLiteHouse.Factory; this method will return an instance of the descendant class.

Type Parameters:

FDSC - the SQLiteHouse descendant being created; this matches the class sent in the cls argument.

Parameters:

cls - the SQLiteHouse descendant class being created

ctx - the context in which the object will operate

cf - a cursor factory as allowed by the SQLiteOpenHelper constructor (may be null)

Returns:

an instance of the SQLiteHouse descendant, initialized with the database attributes found in the class's SQLiteDatabaseSpec annotation

Throws:

IntrospectionException - if something goes wrong while processing the descendant class. When invoking the descendant's constructor, there are several possible failure states; use .getCause() to determine which one applies.