com.communote.server.core.vo.query

Class Query<R,I extends QueryParameters>

java.lang.Object

com.communote.server.core.vo.query.Query<R,I>

Type Parameters:

I - The Query Instance which is valid for this definition

R - Type of the resulting items.

Direct Known Subclasses:

PropertyQuery

public abstract class Query<R,I extends QueryParameters>
extends Object

Abstract implementation for Communote queries.

Author:

Communote GmbH - http://www.communote.com/

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	AND
protected static String	OR

Constructor Summary

Constructors

Constructor and Description
Query() The constructor doing some initialization

Method Summary

Modifier and Type	Method and Description
abstract String	buildQuery(I queryInstance) Build the query
abstract I	createInstance() Create an empty instance for this definition
PageableList	postQueryExecution(I queryParameters, PageableList result) Deprecated. Use Converter instead.
protected void	renderOrderbyClause(StringBuilder mainQuery, I queryInstance) Render the order by clause
protected void	renderSearch(StringBuilder whereQuery, String[] fields, String[] paramNames, boolean encloseInParenthesis, boolean useFulltext) Render a search condition that will search in one or several fields for one ore more values.
protected abstract void	setupQueries() Setup the query constants.

Methods inherited from class java.lang.Object

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

Field Detail

AND

protected static final String AND

See Also:

Constant Field Values

OR

protected static final String OR

See Also:

Constant Field Values

Constructor Detail

Query

public Query()

The constructor doing some initialization

Method Detail

buildQuery

public abstract String buildQuery(I queryInstance)

Build the query

Parameters:

queryInstance - The query instance containing the necessary parameters and configuration

Returns:

the query string with named parameters

createInstance

public abstract I createInstance()

Create an empty instance for this definition

Returns:

the instance created

postQueryExecution

@Deprecated
public PageableList postQueryExecution(I queryParameters,
                                                   PageableList result)

Deprecated. Use Converter instead.

This function is called after executing the query for further augmentations. By default this function just returns the result given. However the result object can be changed to different instances.

Parameters:

queryParameters - the query instance

result - the result containing the items returned by executed query

Returns:

the maybe new list

renderOrderbyClause

protected void renderOrderbyClause(StringBuilder mainQuery,
                                   I queryInstance)

Render the order by clause

Parameters:

mainQuery - the main query

queryInstance - the query instance

renderSearch

protected void renderSearch(StringBuilder whereQuery,
                            String[] fields,
                            String[] paramNames,
                            boolean encloseInParenthesis,
                            boolean useFulltext)

Render a search condition that will search in one or several fields for one ore more values. The fields are OR and the values are AND connected. Thus, the resulting query will search for items which have for each value at least one field that matches it.

Parameters:

whereQuery - the where part of the query to extend

fields - the fields that should be searched

paramNames - the parameter names that substitute the search values. Blank values will be skipped.

encloseInParenthesis - whether to enclose the rendered search condition in parenthesis

useFulltext - true if the fulltext search should be used (if the database is supporting it)

setupQueries

protected abstract void setupQueries()

Setup the query constants. Do not forget to call super.setupQueries