com.communote.server.core.vo.query.post

Class AbstractNoteQuery<R>

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>

com.communote.server.core.vo.query.TaggingCoreItemQueryDefinition<R,NoteQueryParameters>

com.communote.server.core.vo.query.post.AbstractNoteQuery<R>

Type Parameters:

R - Type of the result for this query.

Direct Known Subclasses:

CountNoteQuery, NoteQuery

public abstract class AbstractNoteQuery<R>
extends TaggingCoreItemQueryDefinition<R,NoteQueryParameters>

This query definition represents queries for notes.

Author:

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

Field Summary

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

ALIAS_USER, ALIAS_USER_NOTE_ENTITY

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
AbstractNoteQuery()

Method Summary

Modifier and Type	Method and Description
String	buildQuery(NoteQueryParameters queryParameters) Build a query depending if its to get the overall count or not
NoteQueryParameters	createInstance() Create a new empty query instance
protected abstract String[]	getConstructorParametersForRootNotes()
protected String	getDateFilterField(NoteQueryParameters parameters) Get the field for date filtering.
protected String	getRootNoteAlias()
protected String	getRootNoteAliasPrefix()
protected boolean	needDistinct(NoteQueryParameters queryParameters)
protected boolean	needUserInQuery(NoteQueryParameters queryParameters) need the user in a query?
protected void	renderOrderbyClause(StringBuilder mainQuery, NoteQueryParameters queryParameters) Render the order by clause
protected void	renderSelectClause(NoteQueryParameters queryInstance, StringBuilder mainQuery) Render the select clause based on if its the count query or not
protected void	setupQueries() Setup the query constants.

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

getConstructorParameters, getFullTextSearchFields, getNoteAlias, getResultListItem, getSelectClause, getUserAlias, includeUsersWithoutTags, needResourceInQuery, needTagInQuery, queryReturnsTags, renderLogicalTagConstraints, renderTagConstraints, renderTagPrefixConstraint, subQueryFindNoteWithTags

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

buildSelectQuery, getUserSearchFields, matchOnlyIfUserQuery, renderCommonFilters, renderExcludeStatusFilter, renderGroupByClause, renderIncludeStatusFilter, renderRoleFilter, renderSubQueryTags, renderUserSearch

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

renderPropertyFilters

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

postQueryExecution, renderSearch

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractNoteQuery

public AbstractNoteQuery()

Method Detail

buildQuery

public String buildQuery(NoteQueryParameters queryParameters)

Build a query depending if its to get the overall count or not

Overrides:

buildQuery in class AbstractUserQuery<R,NoteQueryParameters>

Parameters:

queryParameters - the QueryInstance

Returns:

the query string with named parameters

createInstance

public NoteQueryParameters createInstance()

Create a new empty query instance

Specified by:

createInstance in class Query<R,NoteQueryParameters>

Returns:

the instance

getConstructorParametersForRootNotes

protected abstract String[] getConstructorParametersForRootNotes()

Returns:

the constructor parameters to be used if the root notes filtering is active.

getDateFilterField

protected String getDateFilterField(NoteQueryParameters parameters)

Get the field for date filtering. Overrides the behavior by using the root note filter.

Overrides:

getDateFilterField in class TaggingCoreItemQueryDefinition<R,NoteQueryParameters>

Parameters:

parameters - the parameter to consult

Returns:

The qualified field that can be used for comparison (e.g. 'utr.creationDate');

getRootNoteAlias

protected String getRootNoteAlias()

Returns:

The alias of the root note

getRootNoteAliasPrefix

protected String getRootNoteAliasPrefix()

Returns:

The prefix for the root note, that is it ends with a '.'

needDistinct

protected boolean needDistinct(NoteQueryParameters queryParameters)

Overrides:

needDistinct in class TaggingCoreItemQueryDefinition<R,NoteQueryParameters>

Parameters:

queryParameters - the query parameters

Returns:

true if the query should use the distinct keyword for selects

needUserInQuery

protected boolean needUserInQuery(NoteQueryParameters queryParameters)

need the user in a query?

Specified by:

needUserInQuery in class TaggingCoreItemQueryDefinition<R,NoteQueryParameters>

Parameters:

queryParameters - the query parameters

Returns:

if the user is needed

renderOrderbyClause

protected void renderOrderbyClause(StringBuilder mainQuery,
                                   NoteQueryParameters queryParameters)

Render the order by clause

Adapted ordering for the date.

Overrides:

renderOrderbyClause in class AbstractUserQuery<R,NoteQueryParameters>

Parameters:

mainQuery - the main query

queryParameters - the query instance

renderSelectClause

protected void renderSelectClause(NoteQueryParameters queryInstance,
                                  StringBuilder mainQuery)

Render the select clause based on if its the count query or not

Overrides:

renderSelectClause in class TaggingCoreItemQueryDefinition<R,NoteQueryParameters>

Parameters:

queryInstance - the query parameters to use

mainQuery - the main query

setupQueries

protected void setupQueries()

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

Overrides:

setupQueries in class TaggingCoreItemQueryDefinition<R,NoteQueryParameters>