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

Class AbstractUserQuery<R,I extends UserQueryParameters>

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<R,I>

Type Parameters:

R - Type of the result for this query.

I - Type the QueryParameters for this query.

Direct Known Subclasses:

BlogMemberManagementQuery, BlogMemberQuery, CommunoteEntityQuery, TaggingCoreItemQueryDefinition, UserManagementQuery, UserQuery, UserTagQuery

public abstract class AbstractUserQuery<R,I extends UserQueryParameters>
extends PropertyQuery<R,I>

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALIAS_TAGS alias for tag entity in query
static String	FILTER_STATUS_ALL The Constant FILTER_STATUS_ALL defines the filter value to include all user status in list.

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

AND, OR

Constructor Summary

Constructors

Constructor and Description
AbstractUserQuery()

Method Summary

Modifier and Type	Method and Description
String	buildQuery(I queryInstance) Build the query
void	buildSelectQuery(StringBuilder query, I queryInstance)
String	getUserAlias() Get the query prefix for the user
protected String[]	getUserSearchFields(I queryInstance)
protected void	matchOnlyIfUserQuery(StringBuilder whereQuery, StringBuilder helpWhere, String prefix) It takes the help where query and wraps it in such a way that it will only match if the class is a user
protected boolean	needTagInQuery(I queryInstance) Whether the tag entity is needed in the query.
protected boolean	renderCommonFilters(StringBuilder whereQuery, String userObjectAlias, String prefix, I queryInstance) Renders a restriction to exclude users having specific status.
protected boolean	renderExcludeStatusFilter(StringBuilder whereQuery, String userObjectAlias, String prefix, I queryInstance) Renders a restriction to exclude users having specific status.
void	renderGroupByClause(StringBuilder query, I queryInstance) Renders the grouping for this query.
protected boolean	renderIncludeStatusFilter(StringBuilder whereQuery, String userObjectAlias, String prefix, I queryInstance) Renders a restriction to only include users having specific status.
protected void	renderOrderbyClause(StringBuilder mainQuery, I queryParameters) Render the order by clause
protected boolean	renderRoleFilter(StringBuilder mainQuery, StringBuilder whereQuery, String prefix, I queryInstance) Render the role filter.
String	renderSubQueryTags(I queryInstance, StringBuilder whereQuery, String prefix) Renders the subquery for tag filterings.
protected boolean	renderUserSearch(StringBuilder whereQuery, String prefix, I queryInstance) Renders the user search query.
protected void	setupQueries() Setup the query constants.

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

renderPropertyFilters

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

createInstance, postQueryExecution, renderSearch

Methods inherited from class java.lang.Object

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

Field Detail

FILTER_STATUS_ALL

public static final String FILTER_STATUS_ALL

The Constant FILTER_STATUS_ALL defines the filter value to include all user status in list.

See Also:

Constant Field Values

ALIAS_TAGS

public static final String ALIAS_TAGS

alias for tag entity in query

See Also:

Constant Field Values

Constructor Detail

AbstractUserQuery

public AbstractUserQuery()

Method Detail

buildQuery

public String buildQuery(I queryInstance)

Description copied from class: Query

Build the query

Specified by:

buildQuery in class Query<R,I extends UserQueryParameters>

Parameters:

queryInstance - The query instance containing the necessary parameters and configuration

Returns:

the query string with named parameters

buildSelectQuery

public void buildSelectQuery(StringBuilder query,
                             I queryInstance)

Parameters:

query - The query to append the constructor to.

queryInstance - the current query instance

getUserAlias

public String getUserAlias()

Get the query prefix for the user

Returns:

the user alias in the querz

getUserSearchFields

protected String[] getUserSearchFields(I queryInstance)

Parameters:

queryInstance - the query instance

Returns:

the search fields for the user data

matchOnlyIfUserQuery

protected void matchOnlyIfUserQuery(StringBuilder whereQuery,
                                    StringBuilder helpWhere,
                                    String prefix)

It takes the help where query and wraps it in such a way that it will only match if the class is a user

Parameters:

whereQuery - the where query to append it all to

helpWhere - the hel where

prefix - the prefix to use

needTagInQuery

protected boolean needTagInQuery(I queryInstance)

Whether the tag entity is needed in the query.

Parameters:

queryInstance - the current query instance

Returns:

true if the query returns tags or the result is filtered by a tag prefix or a single tag

renderCommonFilters

protected boolean renderCommonFilters(StringBuilder whereQuery,
                                      String userObjectAlias,
                                      String prefix,
                                      I queryInstance)

Renders a restriction to exclude users having specific status.

Parameters:

whereQuery - the whereQuery to which the restriction will be added

userObjectAlias - alias used in query to identify user object (e.g. 'user')

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

queryInstance - the query instance

Returns:

whether something was written

renderExcludeStatusFilter

protected boolean renderExcludeStatusFilter(StringBuilder whereQuery,
                                            String userObjectAlias,
                                            String prefix,
                                            I queryInstance)

Renders a restriction to exclude users having specific status.

Parameters:

whereQuery - the whereQuery to which the restriction will be added

userObjectAlias - alias used in query to identify user object (e.g. 'user')

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

queryInstance - the query instance

Returns:

whether something was written

renderGroupByClause

public void renderGroupByClause(StringBuilder query,
                                I queryInstance)

Renders the grouping for this query.

Parameters:

query - The query.

queryInstance - The query instance.

renderIncludeStatusFilter

protected boolean renderIncludeStatusFilter(StringBuilder whereQuery,
                                            String userObjectAlias,
                                            String prefix,
                                            I queryInstance)

Renders a restriction to only include users having specific status.

Parameters:

whereQuery - the whereQuery to which the restriction will be added

userObjectAlias - alias used in query to identify user object (e.g. 'user')

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

queryInstance - the query instance

Returns:

whether something was written

renderOrderbyClause

protected void renderOrderbyClause(StringBuilder mainQuery,
                                   I queryParameters)

Render the order by clause

Overrides:

renderOrderbyClause in class Query<R,I extends UserQueryParameters>

Parameters:

mainQuery - the main query

queryParameters - the query instance

renderRoleFilter

protected boolean renderRoleFilter(StringBuilder mainQuery,
                                   StringBuilder whereQuery,
                                   String prefix,
                                   I queryInstance)

Render the role filter.

Parameters:

mainQuery - the main query containing the selection clause

whereQuery - the whereQuery to which the restriction will be added

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

queryInstance - the query instance

Returns:

whether something was rendered

renderSubQueryTags

public String renderSubQueryTags(I queryInstance,
                                 StringBuilder whereQuery,
                                 String prefix)

Renders the subquery for tag filterings.

Parameters:

queryInstance - The query instance.

whereQuery - The where query to append.

prefix - The prefix.

Returns:

The next prefix.

renderUserSearch

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

Renders the user search query.

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

setupQueries

protected void setupQueries()

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

Specified by:

setupQueries in class Query<R,I extends UserQueryParameters>