io.stallion.dataAccess.db

Class DB

java.lang.Object

io.stallion.dataAccess.db.DB

public class DB
extends Object

A singleton that stores the database connection pool, registered model schemas, and provides a bunch of helper methods for actually talking to the database.

Constructor Summary

Constructors

Constructor and Description
DB()

Method Summary

Modifier and Type	Method and Description
Schema	addDynamicModelDefinition(DynamicModelDefinition def) Add a dynamicModelDefinition to the internal registry of schemas
Schema	addModel(Class cls) Add a model to the internal registry of schemas.
static boolean	available()
protected String	buildCacheKey(Class model, String sql, Object... args) Turns a SQL query into a unique md5 hash to be used as a cache key.
<T extends Model> List<T>	cachedQuery(Class<T> model, String sql, Object... args) Find a list of objects via arbitrary SQL, checking the cache first, and storing to the cache if retrieved fromt he database.
<T> T	cachedScalar(Class model, String sql, Object... params) Find a single value based on the given model, from arbitrary SQL, and use the cache.
<T extends Model> List<T>	cachedWhere(Class<T> model, String where, Object... args) Select from the given model, using just an arbitrary WHERE ...
boolean	columnExists(String tableName, String column)
Object	convertColumnArg(Model o, Col col, Object arg) Trys to convert java type into what is needed by JDBC to store to the database.
void	delete(Model obj) Delete the object from the database.
int	execute(String sql, Object... params) Execute an arbitrary SQL command, return the affected rows.
<T extends Model> List<T>	fetchAll(Class<? extends T> model, String field, Object value) Fetch all objects where column field is of value
<T extends Model> List<T>	fetchAll(Class<T> model) Fetch all objects of the given model.
<T extends Model> List<T>	fetchAllSorted(Class<? extends T> model, String sortField, String sortDirection) Fetch all objects, sorted
<T> T	fetchOne(Class<? extends T> model, Object id) Fetch the object with the given id.
<T> T	fetchOne(Class<? extends T> model, String field, Object value) Fetch an object where field==value
Map<String,Object>	findRecord(String sql, Object... args) Find one record via arbitrary SQL and return it as a hashmap
List<Map<String,Object>>	findRecords(String sql, Object... args) Find a list of rows via arbitrary SQL, and return those rows as hashmaps
AttributeConverter	getConverter(String className) Get or instantiate an AttributeConverter instance based on the converter className
DataSource	getDataSource() Get the underlying database connection pool
DbImplementation	getDbImplementation()
Class	getDefaultPersisterClass()
Schema	getSchema(Class cls) Get the table schema for a given model class
Schema	getSchema(String name) Get the table schema for a model name
List<Schema>	getSchemas()
Tickets	getTickets() Get the Tickets service for generating new IDS
void	initialize(DbConfig config) Intialize the database based on the passed in configuration object.
Model	insert(Model obj) Insert the object into the database.
static DB	instance()
static boolean	isUseDummyPersisterForSqlGenerationMode() If true, internally, DalRegistry.register() will never use a DbPersister, instead it will use a DummyPersister.
static DB	load() Load the database based on the configuration defined in the stallion.toml settings.
Schema	modelToSchema(Class cls)
org.apache.commons.dbutils.QueryRunner	newQuery() Returns a QueryRunner instance associated with the underlying dataSource
Tickets	newTicketsGeneratorInstance() Instantiate an instance of a Tickets subclass, based on the database type
<T extends Model> List<T>	query(Class<T> model, String sql, Object... args) Find a list of objects of the given model via arbitrary SQL
<T> List<T>	queryBean(Class<T> model, String sql, Object... args) Find a list of objects of the given model via arbitrary SQL.
<T extends Model> T	queryForOne(Class<T> model, String sql, Object... args) Find one object of the given model via arbitrary SQL
<T> T	queryScalar(String sql, Object... params) Query the database with arbitrary SQL and return a scalar object (a string, number, boolean, etc).
DB	registerConverter(AttributeConverter converter)
Model	save(Model obj) Update the database with this object, or insert it if it does not exist.
void	setDataSource(DataSource dataSource)
static void	setUseDummyPersisterForSqlGenerationMode(boolean useDummyPersisterForSqlGenerationMode)
static void	shutdown() Close the datasource pool, null out the singleton instance.
boolean	tableExists(String tableName)
int	update(Model obj) Update the object
int	update(Model obj, Map<String,Object> values) Update only the passed in key values
Object	where(Class model, String where, Object... args) Find an object using an arbitrary SQL WHERE ...

Methods inherited from class java.lang.Object

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

Constructor Detail

DB

public DB()

Method Detail

instance

public static DB instance()

available

public static boolean available()

load

public static DB load()

Load the database based on the configuration defined in the stallion.toml settings.

Returns:

shutdown

public static void shutdown()

Close the datasource pool, null out the singleton instance.

initialize

public void initialize(DbConfig config)

Intialize the database based on the passed in configuration object.

Parameters:

config -

newTicketsGeneratorInstance

public Tickets newTicketsGeneratorInstance()

Instantiate an instance of a Tickets subclass, based on the database type

Returns:

getDefaultPersisterClass

public Class getDefaultPersisterClass()

registerConverter

public DB registerConverter(AttributeConverter converter)

newQuery

public org.apache.commons.dbutils.QueryRunner newQuery()

Returns a QueryRunner instance associated with the underlying dataSource

Returns:

save

public Model save(Model obj)

Update the database with this object, or insert it if it does not exist.

Parameters:

obj -

Returns:

queryScalar

public <T> T queryScalar(String sql,
                         Object... params)

Query the database with arbitrary SQL and return a scalar object (a string, number, boolean, etc).

Type Parameters:

T -

Parameters:

sql -

params -

Returns:

fetchAll

public <T extends Model> List<T> fetchAll(Class<T> model)

Fetch all objects of the given model.

Type Parameters:

T -

Parameters:

model -

Returns:

fetchOne

public <T> T fetchOne(Class<? extends T> model,
                      Object id)

Fetch the object with the given id.

Type Parameters:

T -

Parameters:

model -

id -

Returns:

fetchOne

public <T> T fetchOne(Class<? extends T> model,
                      String field,
                      Object value)

Fetch an object where field==value

Type Parameters:

T -

Parameters:

model -

field -

value -

Returns:

fetchAll

public <T extends Model> List<T> fetchAll(Class<? extends T> model,
                                          String field,
                                          Object value)

Fetch all objects where column field is of value

Type Parameters:

T -

Parameters:

model -

field -

value -

Returns:

fetchAllSorted

public <T extends Model> List<T> fetchAllSorted(Class<? extends T> model,
                                                String sortField,
                                                String sortDirection)

Fetch all objects, sorted

Type Parameters:

T -

Parameters:

model -

Returns:

findRecords

public List<Map<String,Object>> findRecords(String sql,
                                            Object... args)

Find a list of rows via arbitrary SQL, and return those rows as hashmaps

Parameters:

sql -

args -

Returns:

findRecord

public Map<String,Object> findRecord(String sql,
                                     Object... args)

Find one record via arbitrary SQL and return it as a hashmap

Parameters:

sql -

args -

Returns:

queryForOne

public <T extends Model> T queryForOne(Class<T> model,
                                       String sql,
                                       Object... args)

Find one object of the given model via arbitrary SQL

Type Parameters:

T -

Parameters:

model -

sql -

args -

Returns:

query

public <T extends Model> List<T> query(Class<T> model,
                                       String sql,
                                       Object... args)

Find a list of objects of the given model via arbitrary SQL

Type Parameters:

T -

Parameters:

model -

sql -

args -

Returns:

queryBean

public <T> List<T> queryBean(Class<T> model,
                             String sql,
                             Object... args)

Find a list of objects of the given model via arbitrary SQL. Accepts any java bean, does not require a Stallion Model

Type Parameters:

T -

Parameters:

model -

sql -

args -

Returns:

cachedQuery

public <T extends Model> List<T> cachedQuery(Class<T> model,
                                             String sql,
                                             Object... args)

Find a list of objects via arbitrary SQL, checking the cache first, and storing to the cache if retrieved fromt he database.

Type Parameters:

T -

Parameters:

model -

sql -

args -

Returns:

cachedScalar

public <T> T cachedScalar(Class model,
                          String sql,
                          Object... params)

Find a single value based on the given model, from arbitrary SQL, and use the cache.

Type Parameters:

T -

Parameters:

model -

sql -

params -

Returns:

cachedWhere

public <T extends Model> List<T> cachedWhere(Class<T> model,
                                             String where,
                                             Object... args)

Select from the given model, using just an arbitrary WHERE ... clause, and use the cache.

Type Parameters:

T -

Parameters:

model -

where -

args -

Returns:

buildCacheKey

protected String buildCacheKey(Class model,
                               String sql,
                               Object... args)

Turns a SQL query into a unique md5 hash to be used as a cache key.

Parameters:

model -

sql -

args -

Returns:

where

public Object where(Class model,
                    String where,
                    Object... args)

Find an object using an arbitrary SQL WHERE ... clause

Parameters:

model -

where -

args -

Returns:

delete

public void delete(Model obj)

Delete the object from the database.

Parameters:

obj -

update

public int update(Model obj)

Update the object

Parameters:

obj -

Returns:

rows affected

update

public int update(Model obj,
                  Map<String,Object> values)

Update only the passed in key values

Parameters:

obj -

Returns:

rows affected

insert

public Model insert(Model obj)

Insert the object into the database.

Parameters:

obj -

Returns:

convertColumnArg

public Object convertColumnArg(Model o,
                               Col col,
                               Object arg)

Trys to convert java type into what is needed by JDBC to store to the database.

Parameters:

o -

col -

arg -

Returns:

addModel

public Schema addModel(Class cls)

Add a model to the internal registry of schemas.

Parameters:

cls -

Returns:

addDynamicModelDefinition

public Schema addDynamicModelDefinition(DynamicModelDefinition def)

Add a dynamicModelDefinition to the internal registry of schemas

Parameters:

def -

Returns:

modelToSchema

public Schema modelToSchema(Class cls)

getSchemas

public List<Schema> getSchemas()

execute

public int execute(String sql,
                   Object... params)

Execute an arbitrary SQL command, return the affected rows.

Parameters:

sql -

params -

Returns:

getConverter

public AttributeConverter getConverter(String className)

Get or instantiate an AttributeConverter instance based on the converter className

Parameters:

className -

Returns:

tableExists

public boolean tableExists(String tableName)

columnExists

public boolean columnExists(String tableName,
                            String column)

getSchema

public Schema getSchema(Class cls)

Get the table schema for a given model class

Parameters:

cls -

Returns:

getSchema

public Schema getSchema(String name)

Get the table schema for a model name

Parameters:

name -

Returns:

getDataSource

public DataSource getDataSource()

Get the underlying database connection pool

Returns:

setDataSource

public void setDataSource(DataSource dataSource)

getTickets

public Tickets getTickets()

Get the Tickets service for generating new IDS

Returns:

getDbImplementation

public DbImplementation getDbImplementation()

isUseDummyPersisterForSqlGenerationMode

public static boolean isUseDummyPersisterForSqlGenerationMode()

If true, internally, DalRegistry.register() will never use a DbPersister, instead it will use a DummyPersister. This flag is set to true if we are running the command sql-generate, in which case we need to register all models, but the models will fail because the table does not actually exist. So by using a DummyPersister, we avoid hard failures, allowing model registry to execute, then we can get a list of all registered models and generate the correct SQL.

Returns:

setUseDummyPersisterForSqlGenerationMode

public static void setUseDummyPersisterForSqlGenerationMode(boolean useDummyPersisterForSqlGenerationMode)