com.communote.server.core.vo.query.user

Class CommunoteEntityQuery

java.lang.Object

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

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

com.communote.server.core.vo.query.user.AbstractUserQuery<CommunoteEntityData,CommunoteEntityQueryParameters>

com.communote.server.core.vo.query.user.CommunoteEntityQuery

public class CommunoteEntityQuery
extends AbstractUserQuery<CommunoteEntityData,CommunoteEntityQueryParameters>

Author:

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

Field Summary

Fields inherited from class com.communote.server.core.vo.query.user.AbstractUserQuery

ALIAS_TAGS, FILTER_STATUS_ALL

Fields inherited from class com.communote.server.core.vo.query.Query

AND, OR

Constructor Summary

Constructors

Constructor and Description
CommunoteEntityQuery()

Method Summary

Modifier and Type	Method and Description
String	buildQuery(CommunoteEntityQueryParameters queryInstance) Build the query
CommunoteEntityQueryParameters	createInstance() Create an empty instance for this definition
String	getUserAlias() Get the query prefix for the user
protected String[]	getUserSearchFields(CommunoteEntityQueryParameters queryInstance) Search also the group fields
PageableList	postQueryExecution(CommunoteEntityQueryParameters queryInstance, PageableList result) This function is called after executing the query for further augmentations.
protected boolean	renderUserSearch(StringBuilder whereQuery, String prefix, CommunoteEntityQueryParameters queryInstance) Renders the user search query.

Methods inherited from class com.communote.server.core.vo.query.user.AbstractUserQuery

buildSelectQuery, matchOnlyIfUserQuery, needTagInQuery, renderCommonFilters, renderExcludeStatusFilter, renderGroupByClause, renderIncludeStatusFilter, renderOrderbyClause, renderRoleFilter, renderSubQueryTags, setupQueries

Methods inherited from class com.communote.server.core.vo.query.PropertyQuery

renderPropertyFilters

Methods inherited from class com.communote.server.core.vo.query.Query

renderSearch

Methods inherited from class java.lang.Object

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

Constructor Detail

CommunoteEntityQuery

public CommunoteEntityQuery()

Method Detail

buildQuery

public String buildQuery(CommunoteEntityQueryParameters queryInstance)

Description copied from class: Query

Build the query

Overrides:

buildQuery in class AbstractUserQuery<CommunoteEntityData,CommunoteEntityQueryParameters>

Parameters:

queryInstance - The query instance containing the necessary parameters and configuration

Returns:

the query string with named parameters

createInstance

public CommunoteEntityQueryParameters createInstance()

Create an empty instance for this definition

Specified by:

createInstance in class Query<CommunoteEntityData,CommunoteEntityQueryParameters>

Returns:

the instance created

getUserAlias

public String getUserAlias()

Get the query prefix for the user

Overrides:

getUserAlias in class AbstractUserQuery<CommunoteEntityData,CommunoteEntityQueryParameters>

Returns:

the user alias in the querz

getUserSearchFields

protected String[] getUserSearchFields(CommunoteEntityQueryParameters queryInstance)

Search also the group fields

Overrides:

getUserSearchFields in class AbstractUserQuery<CommunoteEntityData,CommunoteEntityQueryParameters>

Parameters:

queryInstance - the query instance

Returns:

the search fields for the user data

postQueryExecution

public PageableList postQueryExecution(CommunoteEntityQueryParameters queryInstance,
                                       PageableList result)

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.

Overrides:

postQueryExecution in class Query<CommunoteEntityData,CommunoteEntityQueryParameters>

Parameters:

queryInstance - the query instance

result - the result containing the items returned by executed query

Returns:

the maybe new list

renderUserSearch

protected boolean renderUserSearch(StringBuilder whereQuery,
                                   String prefix,
                                   CommunoteEntityQueryParameters queryInstance)

Renders the user search query.

Overrides:

renderUserSearch in class AbstractUserQuery<CommunoteEntityData,CommunoteEntityQueryParameters>

Parameters:

whereQuery - the where part

prefix - the connector prefix (e.g. 'AND')

queryInstance - the query instance holding the query parameters

Returns:

whether something was rendered