com.communote.server.core.vo.query.blog

Class BlogQuery<R,I extends BlogQueryParameters>

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.blog.BlogQuery<R,I>

Type Parameters:

I - The Query Instance which is valid for this definition

R - Type of the result for this query.

Direct Known Subclasses:

AbstractBlogTagQuery, UserBlogQuery

public class BlogQuery<R,I extends BlogQueryParameters>
extends PropertyQuery<R,I>

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALIAS_BLOG blog query alias
static String	ALIAS_BLOG_GROUP blog group query alias
static String	ALIAS_BLOG_GROUP_MEMBER blog group query member alias
static String	ALIAS_BLOG_GROUP_MEMBER_USER blog group member query alias
static String	ALIAS_EXTERNAL_OBJECT alias for the external object
static String	ALIAS_TAGS tags query alias
static BlogQuery<BlogData,BlogQueryParameters>	DEFAULT_QUERY Static default query.
static String	RESULT_ALIAS_BLOG

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

AND, OR

Constructor Summary

Constructors

Constructor and Description
BlogQuery(Class<R> resultListItemType) Constructor.

Method Summary

Modifier and Type	Method and Description
String	buildQuery(I queryParameters) Build the query
I	createInstance() Create an empty instance for this definition
protected List<String>	getConstructorParameter()
protected List<String>	getGroupByParameter()
protected Class<R>	getResultListItem()
protected String	renderAccessQuery(StringBuilder where, I parameters)
protected void	renderGroupBy(StringBuilder query)
protected void	renderSelect(StringBuilder query)
protected String	renderSubQueryForTopicHierarchies(I queryParameters, String wherePrefix, StringBuilder selectQuery, StringBuilder whereQuery) Renders the where part for topic hierarchies.
protected String	renderTagPrefixQuery(I queryInstance, StringBuilder query, String prefix) Renders the tag search prefix constraint to the query
protected boolean	renderTagsQuery(I instance, StringBuilder query, String prefix) This method renders the query part for tags.
protected void	setupQueries() Setup the query constants.
protected boolean	tagEntityRequiredInQuery() defines if the tag entity is required for the query

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

renderPropertyFilters

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

postQueryExecution, renderOrderbyClause, renderSearch

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_QUERY

public static final BlogQuery<BlogData,BlogQueryParameters> DEFAULT_QUERY

Static default query.

ALIAS_BLOG

public static final String ALIAS_BLOG

blog query alias

See Also:

Constant Field Values

RESULT_ALIAS_BLOG

public static final String RESULT_ALIAS_BLOG

See Also:

Constant Field Values

ALIAS_TAGS

public static final String ALIAS_TAGS

tags query alias

See Also:

Constant Field Values

ALIAS_BLOG_GROUP

public static final String ALIAS_BLOG_GROUP

blog group query alias

See Also:

Constant Field Values

ALIAS_BLOG_GROUP_MEMBER

public static final String ALIAS_BLOG_GROUP_MEMBER

blog group query member alias

See Also:

Constant Field Values

ALIAS_BLOG_GROUP_MEMBER_USER

public static final String ALIAS_BLOG_GROUP_MEMBER_USER

blog group member query alias

See Also:

Constant Field Values

ALIAS_EXTERNAL_OBJECT

public static final String ALIAS_EXTERNAL_OBJECT

alias for the external object

See Also:

Constant Field Values

Constructor Detail

BlogQuery

public BlogQuery(Class<R> resultListItemType)

Constructor.

Parameters:

resultListItemType - Type of the result item.

Method Detail

buildQuery

public String buildQuery(I queryParameters)

Build the query

Specified by:

buildQuery in class Query<R,I extends BlogQueryParameters>

Parameters:

queryParameters - The query instance containing the necessary parameters and configuration

Returns:

the query string with named parameters

createInstance

public I createInstance()

Create an empty instance for this definition

Specified by:

createInstance in class Query<R,I extends BlogQueryParameters>

Returns:

the instance created

getConstructorParameter

protected List<String> getConstructorParameter()

Returns:

the list with constructor parameters

getGroupByParameter

protected List<String> getGroupByParameter()

Returns:

the list with group by parameters

getResultListItem

protected Class<R> getResultListItem()

Returns:

the class of list items

renderAccessQuery

protected String renderAccessQuery(StringBuilder where,
                                   I parameters)

Parameters:

where - the where clause to append to

parameters - the instance to use

Returns:

The next WHERE prefix.

renderGroupBy

protected void renderGroupBy(StringBuilder query)

Parameters:

query - The query.

renderSelect

protected void renderSelect(StringBuilder query)

Parameters:

query - The query.

renderSubQueryForTopicHierarchies

protected String renderSubQueryForTopicHierarchies(I queryParameters,
                                                   String wherePrefix,
                                                   StringBuilder selectQuery,
                                                   StringBuilder whereQuery)

Renders the where part for topic hierarchies.

Parameters:

queryParameters - The query parameters.

wherePrefix - The prefix to use.

selectQuery - The select query.

whereQuery - The query to append.

Returns:

The next prefix.

renderTagPrefixQuery

protected String renderTagPrefixQuery(I queryInstance,
                                      StringBuilder query,
                                      String prefix)

Renders the tag search prefix constraint to the query

Parameters:

queryInstance - the current query instance

query - the query to write to

prefix - the prefix to prepend before writing to the query

Returns:

whether something was appended to the query

renderTagsQuery

protected boolean renderTagsQuery(I instance,
                                  StringBuilder query,
                                  String prefix)

This method renders the query part for tags.

Parameters:

instance - the current query instance

query - the query to write to

prefix - the prefix to prepend before writing to the query

Returns:

whether something was appended to the query

setupQueries

protected void setupQueries()

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

Specified by:

setupQueries in class Query<R,I extends BlogQueryParameters>

tagEntityRequiredInQuery

protected boolean tagEntityRequiredInQuery()

defines if the tag entity is required for the query

Returns:

true if the tag entity is required