com.communote.server.core.vo.query

Class QueryParameters

java.lang.Object

com.communote.server.core.vo.query.QueryParameters

Direct Known Subclasses:

PropertyQueryParameters

public abstract class QueryParameters
extends Object

Abstract implementation for query parameters. Can be used to configure Communote queries.

Note: QueryParameters should not be reused for multiple queries, as they can create query parameters on the fly. This could result in wrong queries.

Author:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QueryParameters.OrderDirection Enum for possible orderings in "ORDER BY" clauses.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SORT_ASCENDING sort constant for ascending
static String	SORT_DESCENDING sort constant for descending

Constructor Summary

Constructors

Constructor and Description
QueryParameters()

Method Summary

Modifier and Type	Method and Description
String	addParameter(String value) Adds a named query parameter that can be referenced when rendering the query.
void	addParameter(String name, Object value) Adds a named query parameter that can be referenced when rendering the query.
protected void	addSortField(String resultObjectPrefix, String fieldName, String sortDirection) Deprecated. Use a sort field in the parameters and do the rendering of the sortfield in the associated query
protected void	addSortField(String resultObjectPrefix, String fieldName, String sortDirection, String aggregateFunction) Deprecated. Use a sort field in the parameters and do the rendering of the sortfield in the associated query
protected String[]	createParameterNamesForSearch(String paramPrefix, String[] searchValues) Creates an array of parameter names to be used in a query that searches for the provided searchValues.
DatabaseConfiguration	getDatabaseConfiguration()
String	getLanguageCode()
PageInformation	getPageInformation(PageableList<?> resultList, int pagingInterval) Get the page information about the current page in relation to the overall count
static PageInformation	getPageInformation(PageableList<?> resultList, ResultSpecification resultSpecification, int pagingInterval) Get the page information about the current page in relation to the overall count
Map<String,Object>	getParameters() Get the parameters of this instances, the names are the keys
ResultSpecification	getResultSpecification() Get the result specification to be used
String	getSortString() get the sort string for the order by clause
boolean	isLimitResultSet()
boolean	isLimitResultSetAvodingDuplicates()
boolean	needTransformListItem() Deprecated. Use Converter instead.
protected void	putParameter(Map<String,Object> params, String paramName, Object paramValue) Put a parameter, if set, in the map
protected void	putParametersForSearch(Map<String,Object> paramMap, String[] paramNames, String[] searchValues, org.hibernate.criterion.MatchMode matchMode) Put the parameter names and values for a search into the parameter map.
protected void	putParametersForSearch(Map<String,Object> paramMap, String[] paramNames, String[] searchValues, org.hibernate.criterion.MatchMode matchMode, boolean doNotUseFulltext) Put the parameter names and values for a search into the parameter map.
void	setLanguageCode(String languageCode)
void	setLimitResultSet(boolean limitResultSet)
void	setLimitResultSetAvodingDuplicates(boolean limitResultSetAvodingDuplicates)
void	setResultSpecification(ResultSpecification resultSpecification) Set the result specification
IdentifiableEntityData	transformResultItem(Object resultItem) Deprecated. Use Converter instead.
boolean	validateLong(String value) Validates the given String, if this is not null or 0.

Methods inherited from class java.lang.Object

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

Field Detail

SORT_DESCENDING

public static final String SORT_DESCENDING

sort constant for descending

See Also:

Constant Field Values

SORT_ASCENDING

public static final String SORT_ASCENDING

sort constant for ascending

See Also:

Constant Field Values

Constructor Detail

QueryParameters

public QueryParameters()

Method Detail

getPageInformation

public static PageInformation getPageInformation(PageableList<?> resultList,
                                                 ResultSpecification resultSpecification,
                                                 int pagingInterval)

Get the page information about the current page in relation to the overall count

Parameters:

resultList - the result list with the counts

resultSpecification - the result specification

pagingInterval - the interval of how many pages to show at one time

Returns:

the page information

addParameter

public String addParameter(String value)

Adds a named query parameter that can be referenced when rendering the query.

Parameters:

value - The value of the parameter.

Returns:

The name for this parameter to be used within the query including a leading ":".

addParameter

public void addParameter(String name,
                         Object value)

Adds a named query parameter that can be referenced when rendering the query.

Parameters:

name - The name of the parameter.

value - The value of the parameter.

addSortField

@Deprecated
protected void addSortField(String resultObjectPrefix,
                                        String fieldName,
                                        String sortDirection)

Deprecated. Use a sort field in the parameters and do the rendering of the sortfield in the associated query

add a sort field

Parameters:

resultObjectPrefix - the result prefix

fieldName - the name of the field to sort

sortDirection - the sort direction

addSortField

@Deprecated
protected void addSortField(String resultObjectPrefix,
                                        String fieldName,
                                        String sortDirection,
                                        String aggregateFunction)

Deprecated. Use a sort field in the parameters and do the rendering of the sortfield in the associated query

add a sort field

Parameters:

resultObjectPrefix - the result prefix

fieldName - the name of the field to sort

sortDirection - the sort direction

aggregateFunction - the aggregate function to be performed on the sort field

createParameterNamesForSearch

protected String[] createParameterNamesForSearch(String paramPrefix,
                                                 String[] searchValues)

Creates an array of parameter names to be used in a query that searches for the provided searchValues.

Parameters:

paramPrefix - a prefix to be used for building the parameter names. Callers should assure that the prefix is unique within the query.

searchValues - the search values for which the parameter names should be created. Blank values will result in adding null to the parameter names at the index position of that search value

Returns:

an array with parameter names. The returned array will contain null at indexes at which the searchValue is blank. The result will be null if searchValues is null.

getDatabaseConfiguration

public DatabaseConfiguration getDatabaseConfiguration()

Returns:

the database configuration

getLanguageCode

public String getLanguageCode()

Returns:

the languageCode

getPageInformation

public PageInformation getPageInformation(PageableList<?> resultList,
                                          int pagingInterval)

Get the page information about the current page in relation to the overall count

Parameters:

resultList - the result list with the counts

pagingInterval - the interval of how many pages to show at one time

Returns:

the page information

getParameters

public Map<String,Object> getParameters()

Get the parameters of this instances, the names are the keys

Returns:

The parameters

getResultSpecification

public ResultSpecification getResultSpecification()

Get the result specification to be used

Returns:

the ResultSpecification

getSortString

public String getSortString()

get the sort string for the order by clause

Returns:

the sort string

isLimitResultSet

public boolean isLimitResultSet()

Returns:

the limitResultSet

isLimitResultSetAvodingDuplicates

public boolean isLimitResultSetAvodingDuplicates()

Returns:

If true the computation of the limitation based on the note list will avoid duplicates by using distinct. If false distinct will not be used, being somewhat faster. Default is true.

needTransformListItem

@Deprecated
public boolean needTransformListItem()

Deprecated. Use Converter instead.

Returns:

true if the transform list item function should be used after retrieving the objects

putParameter

protected void putParameter(Map<String,Object> params,
                            String paramName,
                            Object paramValue)

Put a parameter, if set, in the map

Parameters:

params - the map with the parameters

paramName - the parameter name

paramValue - the parameter value

putParametersForSearch

protected void putParametersForSearch(Map<String,Object> paramMap,
                                      String[] paramNames,
                                      String[] searchValues,
                                      org.hibernate.criterion.MatchMode matchMode)

Put the parameter names and values for a search into the parameter map.

Parameters:

paramMap - the parameter map to extend

paramNames - the names of the parameters to be added to the map. Blank names will be ignored. It is expected that the names and the values array are consistent with respect to size and blank values. So if for instance a value is blank the name at the same array position must also be blank or null. To achieve this the createParameterNamesForSearch(String, String[]) can be invoked on the values array.

searchValues - an array of values to be passed the parameterized query

matchMode - the mode for matching against the values

putParametersForSearch

protected void putParametersForSearch(Map<String,Object> paramMap,
                                      String[] paramNames,
                                      String[] searchValues,
                                      org.hibernate.criterion.MatchMode matchMode,
                                      boolean doNotUseFulltext)

Put the parameter names and values for a search into the parameter map.

Parameters:

paramMap - the parameter map to extend

paramNames - the names of the parameters to be added to the map. Blank names will be ignored. It is expected that the names and the values array are consistent with respect to size and blank values. So if for instance a value is blank the name at the same array position must also be blank or null. To achieve this the createParameterNamesForSearch(String, String[]) can be invoked on the values array.

searchValues - an array of values to be passed the parameterized query

matchMode - the mode for matching against the values

doNotUseFulltext - true if like wildcard syntax should be used even if fulltext would be available

setLanguageCode

public void setLanguageCode(String languageCode)

Parameters:

languageCode - the languageCode to set

setLimitResultSet

public void setLimitResultSet(boolean limitResultSet)

Parameters:

limitResultSet - the limitResultSet to set

setLimitResultSetAvodingDuplicates

public void setLimitResultSetAvodingDuplicates(boolean limitResultSetAvodingDuplicates)

Parameters:

limitResultSetAvodingDuplicates - If true the computation of the limitation based on the note list will avoid duplicates by using distinct. If false distinct will not be used, being somewhat faster. Default is true.

setResultSpecification

public void setResultSpecification(ResultSpecification resultSpecification)

Set the result specification

Parameters:

resultSpecification - the result specification

transformResultItem

@Deprecated
public IdentifiableEntityData transformResultItem(Object resultItem)

Deprecated. Use Converter instead.

transform the list item after it has been loaded and filled by the query definition

Parameters:

resultItem - the item to transform

Returns:

the transformed list item

validateLong

public boolean validateLong(String value)

Validates the given String, if this is not null or 0.

Parameters:

value - Value to check.

Returns:

True, if the given String is not null or 0, otherwise false.