|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.mf.kennewick.broker.DatabaseBroker
Base broker for mapping layers that use a relational database. Provides helpful utilities for formatting SQL strings and assembles the SQL for the most common SQL statements. Implementors should create a seperate subclass for each domain object and subclass BrokerRegistry to locate and instantiate the correct brokers.
Constructor Summary | |
DatabaseBroker()
|
Method Summary | |
boolean |
asBoolean(java.lang.String aValue)
|
java.lang.Boolean |
asBooleanWrapper(java.lang.String aValue)
|
java.lang.String |
asColumnName(java.lang.String propertyName)
|
static java.lang.String |
asColumnName(java.lang.String propertyName,
java.lang.Class domainClass)
|
static java.lang.String |
asColumnName(java.lang.String propertyName,
KennewickObject anObject)
|
static ObjectIdentifier |
asIdentifier(java.lang.String aValue)
|
java.lang.String |
asQueryString(boolean aValue)
|
java.lang.String |
asQueryString(double aNumber)
|
java.lang.String |
asQueryString(float aNumber)
|
java.lang.String |
asQueryString(int aNumber)
|
java.lang.String |
asQueryString(KennewickObject anObject)
|
java.lang.String |
asQueryString(long aNumber)
|
java.lang.String |
asQueryString(ObjectIdentifier anId)
|
java.lang.String |
asQueryString(java.lang.String aString)
|
void |
delete(KennewickObject anObject,
ITransaction trans)
|
java.sql.ResultSet |
executeQuery(java.lang.String sql,
java.sql.Connection conn)
Performs a non-transactional SQL query using the first available connection. |
int |
executeUpdate(java.lang.String sql)
Performs a non-transactional SQL update using the first available connection. |
protected java.lang.String |
generateTableQualifier()
|
abstract java.util.Map |
getColumnMappings()
Returns a Map associating property names from the corresponding domain object with their column names in the database. |
abstract java.util.Map |
getColumnValues(KennewickObject anObject)
Retuns a map of property names associated with SQL safe strings for each of the property values for the given KennewickObject. |
abstract java.lang.String |
getDatasourceId()
|
protected java.lang.String |
getIdentityColumn()
|
protected java.lang.String |
getIdentityWhereClause(KennewickObject anObject)
|
protected java.lang.String |
getIdentityWhereClause(java.util.Map columnMap,
java.util.Map valueMap)
|
java.lang.String |
getSchemaQualifier()
|
abstract java.lang.String |
getTableName()
Returns the table name used to store data for this broker's corresponding domain object. |
void |
insert(KennewickObject anObject,
ITransaction trans)
|
abstract KennewickObject |
lazyLoadChildObject(KennewickObject anObject,
java.lang.String fieldName)
|
abstract java.util.Collection |
lazyLoadCollection(KennewickObject anObject,
java.lang.String fieldName)
|
java.util.Map |
lazyLoadMap(KennewickObject anObject,
java.lang.String fieldName)
|
abstract KennewickObject |
map(java.sql.ResultSet rs)
|
java.util.Collection |
retrieveAll(java.lang.Class objectClass,
ITransaction aTransaction)
|
java.util.Collection |
retrieveObjectIdentifiers(java.lang.Class objectClass,
java.lang.String aWhereClause,
java.lang.String anOrderByClause,
ITransaction trans)
|
java.util.Collection |
retrieveObjects(java.lang.Class objectClass,
java.lang.String aWhereClause,
java.lang.String anOrderByClause,
ITransaction trans)
|
KennewickObject |
retrieveSingleObject(java.lang.Class objectClass,
java.lang.String aWhereClause,
ITransaction trans)
|
KennewickObject |
retrieveSingleObjectByID(java.lang.Class objectClass,
ObjectIdentifier anId,
ITransaction trans)
|
void |
save(KennewickObject anObject,
ITransaction trans)
Saves the object passed in to the database using the given transaction. |
java.lang.String |
translateClause(java.lang.String rawClause)
Given a clause that contains property names, replaces the property names with column names. |
static java.lang.String |
translateClause(java.lang.String rawClause,
java.lang.Class queriedClass)
|
void |
update(KennewickObject anObject,
DatabaseTransaction aTransaction)
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.mf.kennewick.broker.IBroker |
searchObjects |
Constructor Detail |
public DatabaseBroker()
Method Detail |
public abstract java.lang.String getDatasourceId()
public abstract java.lang.String getTableName()
public abstract java.util.Map getColumnMappings()
public abstract java.util.Map getColumnValues(KennewickObject anObject)
anObject
-
public abstract KennewickObject map(java.sql.ResultSet rs) throws java.lang.Exception
java.lang.Exception
public abstract java.util.Collection lazyLoadCollection(KennewickObject anObject, java.lang.String fieldName) throws java.lang.Exception
lazyLoadCollection
in interface IBroker
java.lang.Exception
public abstract KennewickObject lazyLoadChildObject(KennewickObject anObject, java.lang.String fieldName) throws java.lang.Exception
lazyLoadChildObject
in interface IBroker
java.lang.Exception
public java.lang.String getSchemaQualifier()
protected java.lang.String getIdentityWhereClause(KennewickObject anObject)
protected java.lang.String getIdentityColumn()
protected java.lang.String getIdentityWhereClause(java.util.Map columnMap, java.util.Map valueMap)
public void save(KennewickObject anObject, ITransaction trans) throws java.lang.Exception
IBroker
save
in interface IBroker
anObject
- trans
-
java.lang.Exception
public int executeUpdate(java.lang.String sql) throws java.lang.Exception
sql
-
java.lang.Exception
public java.sql.ResultSet executeQuery(java.lang.String sql, java.sql.Connection conn) throws java.lang.Exception
sql
-
java.lang.Exception
public KennewickObject retrieveSingleObjectByID(java.lang.Class objectClass, ObjectIdentifier anId, ITransaction trans) throws java.lang.Exception
retrieveSingleObjectByID
in interface IBroker
java.lang.Exception
public KennewickObject retrieveSingleObject(java.lang.Class objectClass, java.lang.String aWhereClause, ITransaction trans) throws java.lang.Exception
java.lang.Exception
public java.util.Collection retrieveObjectIdentifiers(java.lang.Class objectClass, java.lang.String aWhereClause, java.lang.String anOrderByClause, ITransaction trans) throws java.lang.Exception
java.lang.Exception
public java.util.Collection retrieveObjects(java.lang.Class objectClass, java.lang.String aWhereClause, java.lang.String anOrderByClause, ITransaction trans) throws java.lang.Exception
java.lang.Exception
public void update(KennewickObject anObject, DatabaseTransaction aTransaction) throws java.lang.Exception
java.lang.Exception
public void delete(KennewickObject anObject, ITransaction trans) throws java.lang.Exception
delete
in interface IBroker
java.lang.Exception
public void insert(KennewickObject anObject, ITransaction trans) throws java.lang.Exception
java.lang.Exception
public java.lang.String asQueryString(ObjectIdentifier anId)
public java.lang.String asQueryString(KennewickObject anObject)
public java.lang.String asQueryString(java.lang.String aString)
public java.lang.String asQueryString(int aNumber)
public java.lang.String asQueryString(long aNumber)
public java.lang.String asQueryString(float aNumber)
public java.lang.String asQueryString(double aNumber)
public java.lang.String asQueryString(boolean aValue)
public boolean asBoolean(java.lang.String aValue)
public java.lang.Boolean asBooleanWrapper(java.lang.String aValue)
public static java.lang.String asColumnName(java.lang.String propertyName, java.lang.Class domainClass)
public static java.lang.String asColumnName(java.lang.String propertyName, KennewickObject anObject)
public java.lang.String asColumnName(java.lang.String propertyName)
public static ObjectIdentifier asIdentifier(java.lang.String aValue) throws java.lang.Exception
java.lang.Exception
public java.lang.String translateClause(java.lang.String rawClause)
rawClause
-
public static java.lang.String translateClause(java.lang.String rawClause, java.lang.Class queriedClass)
protected java.lang.String generateTableQualifier() throws java.lang.Exception
java.lang.Exception
public java.util.Collection retrieveAll(java.lang.Class objectClass, ITransaction aTransaction) throws java.lang.Exception
retrieveAll
in interface IBroker
java.lang.Exception
public java.util.Map lazyLoadMap(KennewickObject anObject, java.lang.String fieldName) throws java.lang.Exception
lazyLoadMap
in interface IBroker
java.lang.Exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |