net.sf.btb

Class Bridge<A>

java.lang.Object

net.sf.btb.Bridge<A>

public class Bridge<A>
extends Object

Defines a data bridge that is responsible for object persistence to a database. This object relational mapper is optimised to work with POJOs respecting these behaviors:

1. The class must provide a public default (parameterless) constructor (but you can define any constructor you wish thereafter).
2. The class must provide both read and write methods for each of its properties (but they don't have to be public).

When an object is passed to any of the Bridge's insert, update, delete of fill method, the object is assumed to be a persistable entity. The name of the class is assumed to be the name of a table and the object's properties are assumed to be the table's columns.

Note for case sensitive RDBMS
Do not forget to match the capitalization from your class names to your table names. Further more properties are camelcased. For example, take the hypotetic property "first name" (getFirstName() and setFirstName() methods). This property is assumed to match the column name "firstName".

Author:

Jean-Philippe Gravel

Constructor Summary

Constructors

Constructor and Description
Bridge(Class<A> type, String... ignoredProperties) Creates a new Bridge using the default connection string as defined in the "bridge.xml" file.
Bridge(Connection connection, Class<A> type, String... ignoredProperties) Creates a new Bridge using the default connection string as defined in the "bridge.xml" file.

Method Summary

Methods

Modifier and Type	Method and Description
static <A> Bridge<A>	create(Class<A> type, String... ignoredProperties) Shortcut method used to create a Bridge.
static <A> Bridge<A>	create(Connection connection, Class<A> type, String... ignoredProperties) Shortcut method used to create a Bridge.
void	delete(A item) Deletes the specified item from the database.
Connection	getConnection() Gets the actual bridge connection.
protected SqlDescriptor	getDescriptor()
Set<String>	getIgnoredProperties()
protected String	getSelectQuery()
Class<A>	getType() Gets the type bridged by the current object.
void	insert(A item) Insert the specified item in the database.
Query<A>	newQuery()
<I extends A> Query<I>	newQuery(Class<I> desiredType)
void	setConnection(Connection connection) Deprecated. This method cannot be used anymore and does nothing. Use the singleton instance from the Connector class instead.
void	update(A item) Updates the specified item in the database.

Methods inherited from class java.lang.Object

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

Constructor Detail

Bridge

public Bridge(Class<A> type,
      String... ignoredProperties)
       throws SQLException

Creates a new Bridge using the default connection string as defined in the "bridge.xml" file. See net.sf.btb.ConnectionManager for more informations about this file.

Parameters:

type - The type of the class to be bridged.

Throws:

SQLException

See Also:

ConnectionManager

Bridge

public Bridge(Connection connection,
      Class<A> type,
      String... ignoredProperties)
       throws SQLException

Creates a new Bridge using the default connection string as defined in the "bridge.xml" file. See net.sf.btb.ConnectionManager for more informations about this file.

Parameters:

connection - The connection to the database.

type - The type of the class to be bridged.

Throws:

SQLException

See Also:

ConnectionManager

Method Detail

create

public static <A> Bridge<A> create(Class<A> type,
                   String... ignoredProperties)
                        throws SQLException

Shortcut method used to create a Bridge.

Type Parameters:

A - The type of the corresponding object to create. Automatically inferred from the type parameter.

Parameters:

type - The type of the class to be bridged.

Returns:

A Bridge instance.

Throws:

SQLException

create

public static <A> Bridge<A> create(Connection connection,
                   Class<A> type,
                   String... ignoredProperties)
                        throws SQLException

Shortcut method used to create a Bridge.

Type Parameters:

A - The type of the corresponding object to create. Automatically inferred from the type parameter.

Parameters:

connection - The connection to the database.

type - The type of the class to be bridged.

Returns:

A Bridge instance.

Throws:

SQLException

getType

public Class<A> getType()

Gets the type bridged by the current object.

Returns:

the type bridged.

getDescriptor

protected SqlDescriptor getDescriptor()

getIgnoredProperties

public Set<String> getIgnoredProperties()

Returns:

an unmodifiable set containing all ignored properties by the current bridge.

getSelectQuery

protected String getSelectQuery()

Returns:

the select query.

getConnection

public Connection getConnection()

Gets the actual bridge connection. Null if no connection have been passed to the bridge.

Returns:

null or a connection, depending on the constructor used.

setConnection

public void setConnection(Connection connection)

Deprecated. This method cannot be used anymore and does nothing. Use the singleton instance from the Connector class instead.

Sets the current connection. If the bridge should use the default connection, set it to null.

Parameters:

connection - The connection to use to get data.

newQuery

public Query<A> newQuery()

newQuery

public <I extends A> Query<I> newQuery(Class<I> desiredType)

insert

public void insert(A item)
            throws SQLException

Insert the specified item in the database.

Parameters:

item - The item to insert.

Throws:

SQLException - if a problem occurs during database operations.

update

public void update(A item)
            throws SQLException

Updates the specified item in the database.

Parameters:

item - The item to update.

Throws:

SQLException - if a problem occurs during database operations.

delete

public void delete(A item)
            throws SQLException

Deletes the specified item from the database.

Parameters:

item - The item to delete.

Throws:

SQLException - if a problem occurs during database operations.