com.viaoa.ds.jdbc

Class OADataSourceJDBC

java.lang.Object

com.viaoa.ds.OADataSource

com.viaoa.ds.jdbc.OADataSourceJDBC

All Implemented Interfaces:

OADataSourceInterface

public class OADataSourceJDBC
extends OADataSource

OADataSource object that uses JDBC and connection pools to communicate with Relational Databases. Uses settings to know what type of database that is being used so that SQL statements can be customized to fit the particular database.

OADataSourceJDBC has a lot of settings that can be used to set up how the JDBC Driver and SQL needs to work. By setting the type of Database, these values will automatically be set.

Field Summary

Fields

Modifier and Type	Field and Description
protected ConnectionPool	connectionPool
protected Database	database
protected DBMetaData	dbmd

Fields inherited from class com.viaoa.ds.OADataSource

bAssignNumberOnCreate, bEnable, bLast, dataSourceChangeCnter, guid, name

Constructor Summary

Constructors

Constructor and Description
OADataSourceJDBC(Database database, DBMetaData dbmd) Create new OADataSourceJDBC using a Database mapping object.

Method Summary

Modifier and Type	Method and Description
void	assignId(OAObject object) Set all properties that are mapped to a column to NULL
void	close() Close all Connections.
void	closeAllConnections() Close all Connections.
int	count(Class selectClass, String queryWhere, Object[] params, OAObject whereObject, String propertyFromWhereObject, String extraWhere, int max) Perform a count on the DataSource using a query.
int	countPassthru(Class selectClass, String queryWhere, int max) Performs a count using native query language for DataSource.
void	delete(OAObject object) Remove an Object from a DataSource.
Object	execute(String command) Execute a command on the dataSource.
boolean	getAllowIdChange() returns false
Connection	getConnection() Get a jdbc Connection from Connection Pool.
Connection	getConnection(boolean bExclusive)
ConnectionPool	getConnectionPool()
Database	getDatabase() Returns database mapping object.
DBMetaData	getDBMetaData()
void	getInfo(Vector vec) Adds Strings to Vector, listing information about DataSource.
ArrayList<ManyToMany>	getManyToMany(OALinkInfo linkInfo) Select the objectKeys from a link table.
int	getMaxLength(Class c, String propertyName) Returns max length allowed for a property.
Object	getObject(OAObjectInfo oi, Class clazz, OAObjectKey key, boolean bDirty)
PreparedStatement	getPreparedStatement(String sql) Returns a JDBC PreparedStatement from connection pool.
PreparedStatement	getPreparedStatement(String sql, boolean bHasAutoGenerated)
byte[]	getPropertyBlobValue(OAObject obj, String propertyName) Select BLOB (large byte[]) property
Statement	getStatement() Returns a JDBC Statement from connection pool.
Statement	getStatement(String message) Returns a JDBC Statement from connection pool.
void	insert(OAObject object) Add/Insert a new Object into DataSource.
void	insertWithoutReferences(OAObject obj) Add/Insert a new Object into DataSource, without references (fkeys).
boolean	isAvailable() Used to know is datasoure is currently available.
boolean	isClassSupported(Class clazz, OAFilter filter) Returns true if Database has Table that is mapped to Class.
void	releaseConnection(Connection connection)
void	releasePreparedStatement(PreparedStatement ps) Releases a JDBC PreparedStatement from connection pool.
void	releasePreparedStatement(PreparedStatement ps, boolean bCanBeReused)
void	releaseStatement(Statement statement) release a JDBC Statement from connection pool.
void	reopen(int pos) This can be called after a close has been done to make the datasoruce available again.
OADataSourceIterator	select(Class selectClass, String queryWhere, Object[] params, String queryOrder, OAObject whereObject, String propertyFromWhereObject, String extraWhere, int max, OAFilter filter, boolean bDirty) Perform a query to retrieve objects from DataSource.
OADataSourceIterator	selectPassthru(Class selectClass, String queryWhere, String queryOrder, int max, OAFilter filter, boolean bDirty) Performs a select using native query language for DataSource.
void	setDBMetaData(DBMetaData dbmd)
void	setGuid(String guid) Seed value to use when creating GUID for seq assigned object keys.
void	setNextNumber(Class c, int nextNumberToUse)
boolean	supportsStorage() Returns true, this datasource supports selecting/storing/deleting
void	update(OAObject object, String[] includeProperties, String[] excludeProperties) Update an existing Object to DataSource.
void	updateMany2ManyLinks(OAObject masterObject, OAObject[] adds, OAObject[] removes, String propFromMaster) Used by dataSources to update special requirements for handling Many2Many relationships (ex:Link Table).
boolean	verify()
boolean	willCreatePropertyValue(OAObject object, String propertyName) Called by OAObject.getRequiredProperties() to find required properties that are unassigned.

Methods inherited from class com.viaoa.ds.OADataSource

closeAll, count, count, count, count, count, count, count, count, count, count, countPassthru, countPassthru, finalize, getAssignIdOnCreate, getChangeCounter, getDataSource, getDataSource, getDataSources, getEnabled, getGuid, getInfo, getName, getObject, getObject, getObject, getObject, getObject, getPosition, getSupportsPreCount, isClassSupported, removeFromList, save, select, select, select, select, select, select, select, select, select, select, select, select, select, select, select, select, select, select, selectPassthru, selectPassthru, selectPassthru, selectPassthru, selectPassthru, setAssignIdOnCreate, setEnabled, setLast, setName, setPosition, toString, update

Methods inherited from class java.lang.Object

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

Field Detail

dbmd

protected DBMetaData dbmd

database

protected Database database

connectionPool

protected ConnectionPool connectionPool

Constructor Detail

OADataSourceJDBC

public OADataSourceJDBC(Database database,
                        DBMetaData dbmd)

Create new OADataSourceJDBC using a Database mapping object.

Method Detail

getDatabase

public Database getDatabase()

Returns database mapping object.

getDBMetaData

public DBMetaData getDBMetaData()

setDBMetaData

public void setDBMetaData(DBMetaData dbmd)

getConnectionPool

public ConnectionPool getConnectionPool()

supportsStorage

public boolean supportsStorage()

Returns true, this datasource supports selecting/storing/deleting

Specified by:

supportsStorage in interface OADataSourceInterface

Specified by:

supportsStorage in class OADataSource

isAvailable

public boolean isAvailable()

Description copied from class: OADataSource

Used to know is datasoure is currently available.

Specified by:

isAvailable in interface OADataSourceInterface

Overrides:

isAvailable in class OADataSource

getAllowIdChange

public boolean getAllowIdChange()

returns false

Specified by:

getAllowIdChange in interface OADataSourceInterface

Overrides:

getAllowIdChange in class OADataSource

isClassSupported

public boolean isClassSupported(Class clazz,
                                OAFilter filter)

Returns true if Database has Table that is mapped to Class.

Specified by:

isClassSupported in interface OADataSourceInterface

Specified by:

isClassSupported in class OADataSource

Parameters:

clazz - class

filter - used to query the datasource

getInfo

public void getInfo(Vector vec)

Adds Strings to Vector, listing information about DataSource.

Overrides:

getInfo in class OADataSource

assignId

public void assignId(OAObject object)

Set all properties that are mapped to a column to NULL

Specified by:

assignId in interface OADataSourceInterface

Specified by:

assignId in class OADataSource

setNextNumber

public void setNextNumber(Class c,
                          int nextNumberToUse)

update

public void update(OAObject object,
                   String[] includeProperties,
                   String[] excludeProperties)

Description copied from class: OADataSource

Update an existing Object to DataSource.

Called directly by OAObject.save()

Specified by:

update in interface OADataSourceInterface

Specified by:

update in class OADataSource

insert

public void insert(OAObject object)

Description copied from class: OADataSource

Add/Insert a new Object into DataSource.

Called directly by OAObject.save()

Specified by:

insert in interface OADataSourceInterface

Specified by:

insert in class OADataSource

insertWithoutReferences

public void insertWithoutReferences(OAObject obj)

Description copied from class: OADataSource

Add/Insert a new Object into DataSource, without references (fkeys).

Called directly by OAObject.saveWithoutReferences() to save a reference while saving another Object.

Specified by:

insertWithoutReferences in interface OADataSourceInterface

Specified by:

insertWithoutReferences in class OADataSource

See Also:

OAObject.save()

delete

public void delete(OAObject object)

Description copied from class: OADataSource

Remove an Object from a DataSource.

Specified by:

delete in interface OADataSourceInterface

Specified by:

delete in class OADataSource

updateMany2ManyLinks

public void updateMany2ManyLinks(OAObject masterObject,
                                 OAObject[] adds,
                                 OAObject[] removes,
                                 String propFromMaster)

Description copied from class: OADataSource

Used by dataSources to update special requirements for handling Many2Many relationships (ex:Link Table).

Uses the hub.masterObject, Hub.getRemovedObjects(), Hub.getAddedObjects() to find out which objects were added or removed.
This is called by OAObject.cascadeSave/Delete methods

Specified by:

updateMany2ManyLinks in interface OADataSourceInterface

Specified by:

updateMany2ManyLinks in class OADataSource

willCreatePropertyValue

public boolean willCreatePropertyValue(OAObject object,
                                       String propertyName)

Called by OAObject.getRequiredProperties() to find required properties that are unassigned.

Specified by:

willCreatePropertyValue in interface OADataSourceInterface

Overrides:

willCreatePropertyValue in class OADataSource

Returns:

true if the datasource will set the property value before saving.

select

public OADataSourceIterator select(Class selectClass,
                                   String queryWhere,
                                   Object[] params,
                                   String queryOrder,
                                   OAObject whereObject,
                                   String propertyFromWhereObject,
                                   String extraWhere,
                                   int max,
                                   OAFilter filter,
                                   boolean bDirty)

Description copied from class: OADataSource

Perform a query to retrieve objects from DataSource.

See OASelect for complete description on selects/queriess.

Specified by:

select in interface OADataSourceInterface

Specified by:

select in class OADataSource

Parameters:

filter - not used, since the jdbc ds supports queries.

selectClass - Class of object to create and return

queryWhere - query String using property paths based on Object structure. DataSource

params - list of values to replace '?' in queryWhere clause.

queryOrder - sort order

whereObject - master object to select from.

extraWhere - added to the query.

bDirty - true if objects should be fully populated, even if they are already loaded (in cache, etc).

Returns:

OADataSourceIterator that is used to return objects of type selectClass

See Also:

OASelect

selectPassthru

public OADataSourceIterator selectPassthru(Class selectClass,
                                           String queryWhere,
                                           String queryOrder,
                                           int max,
                                           OAFilter filter,
                                           boolean bDirty)

Description copied from class: OADataSource

Performs a select using native query language for DataSource.

Specified by:

selectPassthru in interface OADataSourceInterface

Specified by:

selectPassthru in class OADataSource

Parameters:

selectClass - Class of object to create and return

queryWhere - query based on DataSource structure.

Returns:

OADataSourceIterator that is used to return objects of type selectClass

See Also:

OASelect

execute

public Object execute(String command)

Description copied from class: OADataSource

Execute a command on the dataSource.

Specified by:

execute in interface OADataSourceInterface

Specified by:

execute in class OADataSource

Parameters:

command - DataSource native command.

count

public int count(Class selectClass,
                 String queryWhere,
                 Object[] params,
                 OAObject whereObject,
                 String propertyFromWhereObject,
                 String extraWhere,
                 int max)

Description copied from class: OADataSource

Perform a count on the DataSource using a query.

Specified by:

count in interface OADataSourceInterface

Specified by:

count in class OADataSource

Parameters:

selectClass - Class to perform query on

queryWhere - query using property paths based on Object structure.

See Also:

OASelect

countPassthru

public int countPassthru(Class selectClass,
                         String queryWhere,
                         int max)

Description copied from class: OADataSource

Performs a count using native query language for DataSource.

Specified by:

countPassthru in interface OADataSourceInterface

Specified by:

countPassthru in class OADataSource

queryWhere - query based on DataSource structure.

See Also:

OASelect

getStatement

public Statement getStatement()

Returns a JDBC Statement from connection pool. Note: you must call releaseStatement() to return the Statement to the Connection Pool

getStatement

public Statement getStatement(String message)

Returns a JDBC Statement from connection pool. Note: you must call releaseStatement() to return the Statement to the Connection Pool

releaseStatement

public void releaseStatement(Statement statement)

release a JDBC Statement from connection pool.

getPreparedStatement

public PreparedStatement getPreparedStatement(String sql)

Returns a JDBC PreparedStatement from connection pool. Note: you must call releasePreparedStatement() to return the PreparedStatement to the Connection Pool

getPreparedStatement

public PreparedStatement getPreparedStatement(String sql,
                                              boolean bHasAutoGenerated)

releasePreparedStatement

public void releasePreparedStatement(PreparedStatement ps)

Releases a JDBC PreparedStatement from connection pool.

releasePreparedStatement

public void releasePreparedStatement(PreparedStatement ps,
                                     boolean bCanBeReused)

close

public void close()

Close all Connections.

Specified by:

close in interface OADataSourceInterface

Overrides:

close in class OADataSource

reopen

public void reopen(int pos)

Description copied from class: OADataSource

This can be called after a close has been done to make the datasoruce available again.

Specified by:

reopen in interface OADataSourceInterface

Overrides:

reopen in class OADataSource

Parameters:

pos - search location in list of datasources.

closeAllConnections

public void closeAllConnections()

Close all Connections.

getConnection

public Connection getConnection()
                         throws Exception

Get a jdbc Connection from Connection Pool.

Throws:

Exception

getConnection

public Connection getConnection(boolean bExclusive)
                         throws Exception

Throws:

Exception

releaseConnection

public void releaseConnection(Connection connection)

verify

public boolean verify()
               throws Exception

Throws:

Exception

getPropertyBlobValue

public byte[] getPropertyBlobValue(OAObject obj,
                                   String propertyName)

Description copied from class: OADataSource

Select BLOB (large byte[]) property

Specified by:

getPropertyBlobValue in interface OADataSourceInterface

Specified by:

getPropertyBlobValue in class OADataSource

getObject

public Object getObject(OAObjectInfo oi,
                        Class clazz,
                        OAObjectKey key,
                        boolean bDirty)

Specified by:

getObject in interface OADataSourceInterface

Overrides:

getObject in class OADataSource

getMaxLength

public int getMaxLength(Class c,
                        String propertyName)

Description copied from class: OADataSource

Returns max length allowed for a property. returns "-1" for any length.

Specified by:

getMaxLength in interface OADataSourceInterface

Overrides:

getMaxLength in class OADataSource

setGuid

public void setGuid(String guid)

Description copied from class: OADataSource

Seed value to use when creating GUID for seq assigned object keys. Autonumber properties will prefix new values with the value plus a "-" to separator.

Overrides:

setGuid in class OADataSource

getManyToMany

public ArrayList<ManyToMany> getManyToMany(OALinkInfo linkInfo)

Select the objectKeys from a link table.