org.equanda.persistence.query
Interface EquandaQuery

All Superinterfaces:

Serializable

All Known Implementing Classes:

EquandaQueryImpl

public interface EquandaQuery
extends Serializable

Allow the building of custom queries

Author:

NetRom team, Andrei Chiritescu

Method Summary

void	addExtra(String name, Object value) Allows adding extra parameters which can be cleared from the query.
void	clearExtra() Clear the extra parameters
String	getCountQueryString()
int	getFirstResult() Gives the starting results index.
int	getMaxResults() Gives the maximum number of results.
Map<String,Object>	getParameters()
String	getQueryString()
ObjectType	getTypeFilter() This will be used as a filter(@see isParentType()).
EquandaQuery	setFirstResult(int firstResult) Sets the starting results index.
EquandaQuery	setMaxResults(int maxResults) Sets the maximum number of results.
EquandaQuery	setParameter(String name, Object value) Add one parameter (would have been more logical to call this "addParameter", but this is more in line with the AJPA/Hibernate Query interface).
EquandaQuery	setParameters(Map<String,Object> parameters) Add a list of parameters
EquandaQuery	setTypeFilter(ObjectType typeFilter)

Method Detail

getQueryString

String getQueryString()

Returns:

the query string to be used.

getCountQueryString

String getCountQueryString()

Returns:

the count query to be used.

getMaxResults

int getMaxResults()

Gives the maximum number of results. If a value <=0 then it will be ignored.

Returns:

the maximum number of results.

setMaxResults

EquandaQuery setMaxResults(int maxResults)

Sets the maximum number of results. If a value lt;=0 then it will be ignored.

Parameters:

maxResults - max number of results

Returns:

the EquandaQuery object.

getFirstResult

int getFirstResult()

Gives the starting results index. If a value <0 then it will be ignored.

Returns:

the starting results index.

setFirstResult

EquandaQuery setFirstResult(int firstResult)

Sets the starting results index. If a value <0 then it will be ignored.

Parameters:

firstResult - number of first record which needs to be fetched

Returns:

the starting results index.

getParameters

Map<String,Object> getParameters()

Returns:

the parameters for this query

setParameters

EquandaQuery setParameters(Map<String,Object> parameters)

Add a list of parameters

Parameters:

parameters - parameters nam/value pairs

Returns:

query object itself

setParameter

EquandaQuery setParameter(String name,
                          Object value)

Add one parameter (would have been more logical to call this "addParameter", but this is more in line with the AJPA/Hibernate Query interface).

Parameters:

name - parameter name

value - parameter value

Returns:

query object itself

getTypeFilter

ObjectType getTypeFilter()

This will be used as a filter(@see isParentType()). If this returns null no filtering is done.

Returns:

an ObjectType

setTypeFilter

EquandaQuery setTypeFilter(ObjectType typeFilter)

addExtra

void addExtra(String name,
              Object value)

Allows adding extra parameters which can be cleared from the query. This is used internally for adding the parameters to the filters.

Parameters:

name - extra parameter name

value - extra parameter value

clearExtra

void clearExtra()

Clear the extra parameters