net.akaish.kitty.orm

Class KittyDatabase<M extends KittyModel>

java.lang.Object

net.akaish.kitty.orm.KittyDatabase<M>

public abstract class KittyDatabase<M extends KittyModel>
extends java.lang.Object

Abstract class to be used with KittyKitty sqlite Child must be annotated with KITTY_DATABASE annotation. Also it can be annotated with KITTY_DATABASE_HELPER annotation.

Author:

akaish (Denis Bogomolov)

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	AME_NO_KDB_ANNO_PRESENT
protected static java.lang.String	AME_NULLED
protected android.content.Context	context
protected KittyDatabaseConfiguration	databaseConfiguration
protected KittyDatabaseHelper	databaseHelper
protected java.lang.String	databasePassword
protected static java.lang.String	DBB_INFO
protected static java.lang.String	DBH_NOT_ACQUIRE_YET
protected KittyDBHelperConfiguration	helperConfiguration
protected static java.lang.String	LI_DB_CONFIGURATION_ACQUIRED
protected static java.lang.String	LI_DB_HELPER_ACQUIRED
protected static java.lang.String	LI_DB_HELPER_ACQUIRING
protected static java.lang.String	LI_DB_MMFACTORY_INITIATED
protected static java.lang.String	LI_DB_PWD_SET
protected static java.lang.String	LI_HC_INFO
protected static java.lang.String	LI_MM_INSTANCE_STORAGE_GENERATED
protected static java.lang.String	LI_MM_INSTANCE_STORAGE_GENERATING
protected static java.lang.String	LI_SETTING_AUTOGENERATED_REGISTRY
protected static java.lang.String	LI_STATIC_MM_SET
protected static java.lang.String	LI_STATIC_REGISTRY_SET
protected boolean	logOn
protected java.lang.String	logTag
protected KittyMMEntryFactory	modelMapperEntryFactory
protected java.util.Map<java.lang.Class<M>,KittyMMEntry>	modelMapperInstanceStorage Map of Model classes as keys and ready to use pairs of instances of Models and Mappers May be generated automatically or set manually for faster initialization by implementing getStaticRegistry()
protected static java.lang.String	PR_MESSAGE
protected java.util.Map<java.lang.Class<M>,java.lang.Class<KittyMapper>>	registry Map of Models\Mappers classes to be used with this instance of KittyDatabase May be generated automatically or set manually for faster initialization by implementing getStaticModelMapperInstancesStorage()
protected static java.lang.String	SN_NOT_ACQUIRE_YET
protected static java.lang.String	SV_NOT_ACQUIRE_YET

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	KittyDatabase(android.content.Context ctx) KittyORM main database class that represents bootstrap and holder for all related with database components.
protected	KittyDatabase(android.content.Context ctx, java.lang.String databasePassword) KittyORM main database class that represents bootstrap and holder for all related with database components.

Method Summary

Modifier and Type	Method and Description
KittySQLiteDumpScript	afterCreateScript() Override this method if you want to run custom script SQLite sequence after schema creation This method has higher priority than script that may be returned from any stored script
KittySQLiteDumpScript	afterMigrateScript() Override this method of you want to run custom script sequence after schema migration This method has higher priority than script that may be returned from any stored script
boolean	deleteDatabase() Deletes current database, make sure that all connections would be closed
boolean	deleteDatabase(java.lang.String schemaName) Deletes requested database, make sure that all connections to this database would be closed
protected <M extends KittyModel> java.util.Map<java.lang.Class<M>,KittyMMEntry>	generateMMInstanceStorageFromRegistry(java.util.Map<java.lang.Class<M>,java.lang.Class<KittyMapper>> registry, KittyMMEntryFactory entryFactory, KittyDatabaseConfiguration databaseConfiguration)
protected KittyConfigurator	getConfigurator(android.content.Context ctx, java.util.Map<java.lang.Class<M>,java.lang.Class<KittyMapper>> registry) Returns KittyConfigurator to be used with this database By default would be created KittyConfiguratorADC, however you can implement any configuration storage you want.
protected KittyDBHelperConfiguration	getDBHelperConfiguration()
<D extends KittyMapper,M extends KittyModel> D	getMapper(java.lang.Class<M> recordClass)
<M extends KittyModel> M	getModel(java.lang.Class<M> recordClass)
protected KittyMMEntryFactory	getModelMapperFactory(KittyDatabaseConfiguration configuration, java.lang.String dbPwd)
protected java.util.LinkedList<KittySQLiteQuery>	getPreGeneratedCreateStatements(KittyDatabaseConfiguration dbConf) By implementing this vias static collection of queries you would speed up KittyORM initialization.
protected java.util.LinkedList<KittySQLiteQuery>	getPreGeneratedDropStatements(KittyDatabaseConfiguration dbConf) By implementing this via static collection of queries you would speed up KittyORM initialization.
protected java.util.Map<java.lang.Class<M>,KittyMMEntry>	getStaticModelMapperInstancesStorage() Returns static map where keys are model's classes and entries are pairs of models and mappers instances.
protected java.util.Map<java.lang.Class<M>,java.lang.Class<KittyMapper>>	getStaticRegistry() Method used for getting static registry of mappers.
protected java.lang.String	log(KittyLog.LOG_LEVEL level, java.lang.String message, boolean useDefaultFormatter, java.lang.Throwable tr) Simple method for logging in this db class if log is on.
protected KittyDatabaseHelper	newDatabaseHelper()
void	printPregeneratedCreateSchemaToLog(java.lang.String logTag)
void	printPregeneratedDropSchemaToLog(java.lang.String logTag)
void	printRegistryToLog(KittyLog.LOG_LEVEL logLevel) Prints registry to serial if logOn = true

Methods inherited from class java.lang.Object

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

Field Detail

registry

protected java.util.Map<java.lang.Class<M extends KittyModel>,java.lang.Class<KittyMapper>> registry

Map of Models\Mappers classes to be used with this instance of KittyDatabase May be generated automatically or set manually for faster initialization by implementing getStaticModelMapperInstancesStorage()

modelMapperInstanceStorage

protected java.util.Map<java.lang.Class<M extends KittyModel>,KittyMMEntry> modelMapperInstanceStorage

Map of Model classes as keys and ready to use pairs of instances of Models and Mappers May be generated automatically or set manually for faster initialization by implementing getStaticRegistry()

AME_NULLED

protected static final java.lang.String AME_NULLED

See Also:

Constant Field Values

AME_NO_KDB_ANNO_PRESENT

protected static final java.lang.String AME_NO_KDB_ANNO_PRESENT

See Also:

Constant Field Values

LI_DB_PWD_SET

protected static java.lang.String LI_DB_PWD_SET

LI_STATIC_REGISTRY_SET

protected static java.lang.String LI_STATIC_REGISTRY_SET

LI_STATIC_MM_SET

protected static java.lang.String LI_STATIC_MM_SET

LI_DB_CONFIGURATION_ACQUIRED

protected static java.lang.String LI_DB_CONFIGURATION_ACQUIRED

LI_DB_HELPER_ACQUIRING

protected static java.lang.String LI_DB_HELPER_ACQUIRING

LI_DB_HELPER_ACQUIRED

protected static java.lang.String LI_DB_HELPER_ACQUIRED

LI_DB_MMFACTORY_INITIATED

protected static java.lang.String LI_DB_MMFACTORY_INITIATED

LI_SETTING_AUTOGENERATED_REGISTRY

protected static java.lang.String LI_SETTING_AUTOGENERATED_REGISTRY

LI_MM_INSTANCE_STORAGE_GENERATING

protected static java.lang.String LI_MM_INSTANCE_STORAGE_GENERATING

LI_MM_INSTANCE_STORAGE_GENERATED

protected static java.lang.String LI_MM_INSTANCE_STORAGE_GENERATED

LI_HC_INFO

protected static java.lang.String LI_HC_INFO

databaseConfiguration

protected final KittyDatabaseConfiguration databaseConfiguration

helperConfiguration

protected final KittyDBHelperConfiguration helperConfiguration

databaseHelper

protected KittyDatabaseHelper databaseHelper

context

protected final android.content.Context context

modelMapperEntryFactory

protected final KittyMMEntryFactory modelMapperEntryFactory

databasePassword

protected final java.lang.String databasePassword

logOn

protected final boolean logOn

logTag

protected final java.lang.String logTag

PR_MESSAGE

protected static java.lang.String PR_MESSAGE

SN_NOT_ACQUIRE_YET

protected static java.lang.String SN_NOT_ACQUIRE_YET

SV_NOT_ACQUIRE_YET

protected static java.lang.String SV_NOT_ACQUIRE_YET

DBH_NOT_ACQUIRE_YET

protected static java.lang.String DBH_NOT_ACQUIRE_YET

DBB_INFO

protected static java.lang.String DBB_INFO

Constructor Detail

KittyDatabase

protected KittyDatabase(android.content.Context ctx)

KittyORM main database class that represents bootstrap and holder for all related with database components.
See KittyDatabase(Context, String) for more info.

Parameters:

ctx -

KittyDatabase

protected KittyDatabase(android.content.Context ctx,
                        java.lang.String databasePassword)

KittyORM main database class that represents bootstrap and holder for all related with database components.
What happens here?
1) Setting database password if not null. (!) Database encryption not implemented in basic KittyORM KittyDatabaseHelper, so, you have to implement it yourself.
2) Call of getStaticRegistry(). his method is not implemented here, you have to implement it yourself. It just sets registry storage to null, so it can be filled via reflection at database configuration routine. But it is expensive operation and after designing your database it would be good point to optimise it and create registry storage manually via overriding getStaticRegistry().
3) Call of getStaticModelMapperInstancesStorage(). This method is not implemented here, you have to implement it yourself. It just sets Model-Mapper storage to null, so it can be filled via reflection with generateMMInstanceStorageFromRegistry(Map, KittyMMEntryFactory, KittyDatabaseConfiguration). But it is expensive operation and after designing your database it would be good point to optimise it and create model mapper instance storage manually via overriding getStaticModelMapperInstancesStorage().
4) Setting KittyDatabaseConfiguration from getConfigurator(Context, Map). If you want to use your own configurator than you should override getConfigurator(Context, Map) in your implementation to use your own implementation of KittyConfigurator.
5) Setting helper configuration with getDBHelperConfiguration(). You can also override it for your personal purposes if necessary.
6) Setting model mapper entry factory. This factory would be used for creating instances of model\mapper via reflection for autogenerated mm instance storage.
7) Setting registry from database configuration that was generated before. Would be called only if getStaticRegistry() returned null before.
8) Setting model\mapper instance storage with generateMMInstanceStorageFromRegistry(Map, KittyMMEntryFactory, KittyDatabaseConfiguration). Would be called only if getStaticModelMapperInstancesStorage() returned null before;
9) Setting new database helper with newDatabaseHelper(). If you want to use your own implementation of KittyDatabaseHelper, for example, for implementing database encryption, override newDatabaseHelper().
10) Setting predefined creation script to helper via getPreGeneratedCreateStatements(KittyDatabaseConfiguration). If you want some performance optimisation, you can override it to use static collection of create schema statements sequence.
11) Setting predefined drop script to helper via getPreGeneratedDropStatements(KittyDatabaseConfiguration). If you want some performance optimisation, you can override it to use static collection of drop schema statements sequence.

Parameters:

ctx - Anroid context, not null.

databasePassword - database password, note that you have to use your own implementation of KittyDatabaseHelper that supports database encryption as well as you have to override newDatabaseHelper() to pass it into KittyDatabase implementation.

Method Detail

getConfigurator

protected KittyConfigurator getConfigurator(android.content.Context ctx,
                                            java.util.Map<java.lang.Class<M>,java.lang.Class<KittyMapper>> registry)

Returns KittyConfigurator to be used with this database By default would be created KittyConfiguratorADC, however you can implement any configuration storage you want.
This method used at KittyDatabase initialization

Parameters:

ctx - application context

registry - application registry

Returns:

KittyConfigurator

newDatabaseHelper

protected KittyDatabaseHelper newDatabaseHelper()

getStaticModelMapperInstancesStorage

protected java.util.Map<java.lang.Class<M>,KittyMMEntry> getStaticModelMapperInstancesStorage()

Returns static map where keys are model's classes and entries are pairs of models and mappers instances. Not implemented here, should be implemented by developer in order to avoid generating this map with reflection.
Having static map filled up with normally initiated mappers would speed up KittyORM quite a bit.

Returns:

getStaticRegistry

protected java.util.Map<java.lang.Class<M>,java.lang.Class<KittyMapper>> getStaticRegistry()

Method used for getting static registry of mappers. Not implemented here, should be implemented by developer in order to avoid generating registry with reflection.
Having static registry filled up with normally initiated mappers would speed up KittyORM quite a bit.

Returns:

static registry of mappers, where keys are model classes.

getDBHelperConfiguration

protected KittyDBHelperConfiguration getDBHelperConfiguration()

getModelMapperFactory

protected KittyMMEntryFactory getModelMapperFactory(KittyDatabaseConfiguration configuration,
                                                    java.lang.String dbPwd)

getModel

public final <M extends KittyModel> M getModel(java.lang.Class<M> recordClass)

getMapper

public final <D extends KittyMapper,M extends KittyModel> D getMapper(java.lang.Class<M> recordClass)

generateMMInstanceStorageFromRegistry

protected <M extends KittyModel> java.util.Map<java.lang.Class<M>,KittyMMEntry> generateMMInstanceStorageFromRegistry(java.util.Map<java.lang.Class<M>,java.lang.Class<KittyMapper>> registry,
                                                                                                                      KittyMMEntryFactory entryFactory,
                                                                                                                      KittyDatabaseConfiguration databaseConfiguration)

getPreGeneratedCreateStatements

protected java.util.LinkedList<KittySQLiteQuery> getPreGeneratedCreateStatements(KittyDatabaseConfiguration dbConf)

By implementing this vias static collection of queries you would speed up KittyORM initialization.
Also
Be sure that create statements that would be returned by this method would not have schema name before table name cause for some reason on some (maybe most or all) Androids you for some reason would receive unknown database SQLite error at schema generation. E.g. use CREATE TABLE table_name instead of CREATE TABLE database_name.table_name here.

Parameters:

dbConf -

Returns:

afterCreateScript

public KittySQLiteDumpScript afterCreateScript()

Override this method if you want to run custom script SQLite sequence after schema creation
This method has higher priority than script that may be returned from any stored script

Returns:

afterMigrateScript

public KittySQLiteDumpScript afterMigrateScript()

Override this method of you want to run custom script sequence after schema migration
This method has higher priority than script that may be returned from any stored script

Returns:

printPregeneratedCreateSchemaToLog

public void printPregeneratedCreateSchemaToLog(java.lang.String logTag)

printPregeneratedDropSchemaToLog

public void printPregeneratedDropSchemaToLog(java.lang.String logTag)

getPreGeneratedDropStatements

protected java.util.LinkedList<KittySQLiteQuery> getPreGeneratedDropStatements(KittyDatabaseConfiguration dbConf)

By implementing this via static collection of queries you would speed up KittyORM initialization.
Also
Be sure to implement it with such drop statements order to avoid FK constraints, cause there is no way to avoid it without overcomplicated queries.
And be sure that all tables in drop sequence starts with table name, i.e. Drop table SOMEDB.sometable;

Parameters:

dbConf -

Returns:

printRegistryToLog

public final void printRegistryToLog(KittyLog.LOG_LEVEL logLevel)

Prints registry to serial if logOn = true

Parameters:

logLevel -

deleteDatabase

public final boolean deleteDatabase()

Deletes current database, make sure that all connections would be closed

Returns:

deleteDatabase

public final boolean deleteDatabase(java.lang.String schemaName)

Deletes requested database, make sure that all connections to this database would be closed

Parameters:

schemaName -

Returns:

log

protected java.lang.String log(KittyLog.LOG_LEVEL level,
                               java.lang.String message,
                               boolean useDefaultFormatter,
                               java.lang.Throwable tr)

Simple method for logging in this db class if log is on. Returns message parameter if no formatting should be used or formatted string where:
{0} is value for Object.getClass() canonical name
{1} is value for KittyDBHelperConfiguration.schemaName
{2} is value for KittyDBHelperConfiguration.schemaVersion
{4} is value for KittyDatabaseHelper used with this bootstrap class.
TODO: I know that is the same method with just different formatter option as used in KittyDatabaseHelper, so I would rewrite it without CP (copy-paste, lol) in future.

Parameters:

level -

message -

useDefaultFormatter -

tr - any throwable, may be null

Returns: