net.sf.btb

Class Query<I>

java.lang.Object

net.sf.btb.Query<I>

public class Query<I>
extends Object

Instances of this class are used to define a query and it's parameters.

Author:

Jean-Philippe Gravel

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Query(Connection connection, SqlDescriptor descriptor)
	Query(Connection connection, String string, Class<I> type) Creates a new query object using the specified string and parameters.
	Query(Connection connection, String string, Class<I> assignationType, Class<I> instanciationType) Creates a new query object using the specified string and parameters.
	Query(String string, Class<I> type) Creates a new query object using the specified string and parameters.
	Query(String string, Class<I> assignationType, Class<I> instanciationType) Creates a new query object using the specified string and parameters.

Method Summary

Methods

Modifier and Type	Method and Description
void	addCreatedHandler(QueryEventHandler<I> handler) Adds a post initialization handler.
void	addCreatingHandler(QueryEventHandler<I> handler) Adds a creating handler.
int	count() Counts the number of rows that will be returned by the current query.
List<I>	execute() Execute the query and returns the resulting object list.
void	executeFill(Collection<? super I> col) Executes the query and fills the specified list.
Class<I>	getAssignationType() Gets the type that will used to set values to the class instance during operations.
Connection	getConnection() Gets the connection.
QueryEventHandlerSet<I>	getCreatedHandler()
QueryEventHandlerSet<I>	getCreatingHandler()
Filter	getFilter() Gets the filter.
Class<I>	getInstanciationType() Gets the type that will be created during fill operations.
List<Join>	getJoins()
String	getOrderBy() Gets the orderBy clause.
String	getPrimaryKey() Gets the primary key for the current query.
protected void	onCreated(QueryEvent<I> action) This method is called each time an object has been initialized with the current row data.
protected <E extends I> void	onCreating(QueryEvent<E> action) This method is called before the creation of a new object.
void	removeCreatedHandler(QueryEventHandler<I> handler) Removes a post initialization handler.
void	removeCreatingHandler(QueryEventHandler<I> handler) Removes a creating handler.
void	setFilter(Filter filter) Sets the filter.
void	setOrderBy(String orderBy) Sets the order by clause.
void	setPrimaryKey(String value) Sets the primary key for the current query.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Query

protected Query(Connection connection,
     SqlDescriptor descriptor)

Query

public Query(String string,
     Class<I> type)

Creates a new query object using the specified string and parameters.

Parameters:

string - The select query string.

type - The class type to be used for operations.

Query

public Query(Connection connection,
     String string,
     Class<I> type)

Creates a new query object using the specified string and parameters.

Parameters:

connection - The connection to the database.

string - The select query string.

type - The class type to be used for operations.

Query

public Query(String string,
     Class<I> assignationType,
     Class<I> instanciationType)

Creates a new query object using the specified string and parameters.

Parameters:

string - The select query string.

assignationType - The class type to be used for assignation operations.

instanciationType - The class type to be used for instantiations operations.

Query

public Query(Connection connection,
     String string,
     Class<I> assignationType,
     Class<I> instanciationType)

Creates a new query object using the specified string and parameters.

Parameters:

connection - The connection to the database.

string - The select query string.

assignationType - The class type to be used for assignation operations.

instanciationType - The class type to be used for instantiations operations.

Method Detail

addCreatedHandler

public void addCreatedHandler(QueryEventHandler<I> handler)

Adds a post initialization handler.

Parameters:

handler - the handler to add.

removeCreatedHandler

public void removeCreatedHandler(QueryEventHandler<I> handler)

Removes a post initialization handler.

Parameters:

handler - the handler to remove.

getCreatedHandler

public QueryEventHandlerSet<I> getCreatedHandler()

Returns:

the postInitializeHandler set.

addCreatingHandler

public void addCreatingHandler(QueryEventHandler<I> handler)

Adds a creating handler. This handle is called before the initialization of the object.

Parameters:

handler - the handler to add.

removeCreatingHandler

public void removeCreatingHandler(QueryEventHandler<I> handler)

Removes a creating handler.

Parameters:

handler - the handler to remove.

getCreatingHandler

public QueryEventHandlerSet<I> getCreatingHandler()

Returns:

the CreatingHandler set.

getPrimaryKey

public String getPrimaryKey()

Gets the primary key for the current query.

Returns:

the query primary key, if it exists or null.

setPrimaryKey

public void setPrimaryKey(String value)

Sets the primary key for the current query. Setting a null value will reset the primaryKey value to the default value set from the bridge.

Parameters:

value - the primary key property name.

getAssignationType

public Class<I> getAssignationType()

Gets the type that will used to set values to the class instance during operations.

Returns:

a Class object representing the type that will be used to set values to the class instance during operations.

getInstanciationType

public Class<I> getInstanciationType()

Gets the type that will be created during fill operations.

Returns:

a Class object representing the type that will be created during fill operations.

getJoins

public List<Join> getJoins()

Returns:

the joins list associated to this query.

getConnection

public Connection getConnection()

Gets the connection.

Returns:

the connection

setFilter

public void setFilter(Filter filter)

Sets the filter.

Parameters:

filter - A filter object.

getFilter

public Filter getFilter()

Gets the filter.

Returns:

the filter object.

setOrderBy

public void setOrderBy(String orderBy)

Sets the order by clause.

Parameters:

orderBy - The orderBy clause.

getOrderBy

public String getOrderBy()

Gets the orderBy clause.

Returns:

the order by clause.

count

public int count()
          throws SQLException

Counts the number of rows that will be returned by the current query. Execute a SELECT COUNT on the underlying table using the current filters.

Returns:

The number of rows that will be returned by the executeFill methods.

Throws:

SQLException - if an error occurs during the SELECT COUNT operation.

execute

public List<I> execute()
                throws SQLException

Execute the query and returns the resulting object list.

Returns:

the list containing the result of the query.

Throws:

SQLException - if an error occurs during the query execution.

BrokenRuleException

executeFill

public void executeFill(Collection<? super I> col)
                 throws SQLException

Executes the query and fills the specified list. If the collection isn't empty, contained elements will be updated.

Parameters:

col - the collection to be filled.

Throws:

SQLException - if an error occurs during the query execution.

BrokenRuleException

onCreating

protected <E extends I> void onCreating(QueryEvent<E> action)

This method is called before the creation of a new object. This event gives the occasion to the user to take control of the object creation. Using this event, it's possible to seek a cache for example. Override to control the event propagation.

Parameters:

action - The action containing the event data.

onCreated

protected void onCreated(QueryEvent<I> action)

This method is called each time an object has been initialized with the current row data. Override to control the event propagation.

Parameters:

action - The action containing the event data.

toString

public String toString()

Overrides:

toString in class Object