com.adobe.cq.social.scf.core

Class BaseQueryRequestInfo

java.lang.Object

com.adobe.cq.social.scf.core.BaseQueryRequestInfo

All Implemented Interfaces:

QueryRequestInfo

public class BaseQueryRequestInfo
extends java.lang.Object
implements QueryRequestInfo

Default implementation of the QueryRequestInfo.

Nested Class Summary

Nested classes/interfaces inherited from interface com.adobe.cq.social.scf.QueryRequestInfo

QueryRequestInfo.QueryRequestInfoFactory

Field Summary

Fields

Modifier and Type	Field and Description
static QueryRequestInfo	DEFAULT_QUERY_REQUEST

Fields inherited from interface com.adobe.cq.social.scf.QueryRequestInfo

DEFAULT_QUERY_INFO_FACTORY, GET, SCF_SELECTORS

Constructor Summary

Constructors

Constructor and Description
BaseQueryRequestInfo(boolean isQueryRequest, java.util.Map<java.lang.String,java.lang.String[]> predicates, CollectionPagination pagination) Constructor.
BaseQueryRequestInfo(boolean isQueryRequest, java.util.Map<java.lang.String,java.lang.String[]> predicates, CollectionPagination pagination, boolean isTranslateRequest) Constructor.
BaseQueryRequestInfo(boolean isQueryRequest, java.util.Map<java.lang.String,java.lang.String[]> predicates, CollectionPagination pagination, CollectionSortedOrder order) Constructor.
BaseQueryRequestInfo(boolean isQueryRequest, java.util.Map<java.lang.String,java.lang.String[]> predicates, CollectionPagination pagination, CollectionSortedOrder order, java.util.List<java.lang.String> sortBy) Constructor.
BaseQueryRequestInfo(SlingHttpServletRequest request) Constructor which parses the info from the specified SlingHttpServletRequest.
BaseQueryRequestInfo(SlingHttpServletRequest request, boolean isFilterQuery) Constructor which parses the info from the specified SlingHttpServletRequest.

Method Summary

Modifier and Type	Method and Description
CollectionPagination	getPagination() Get the request paging specification
java.util.Map<java.lang.String,java.lang.String[]>	getPredicates() Get the query predicates.
java.lang.String	getQueryString() Gets the query params.
java.util.List<java.lang.String>	getSortBy()
java.util.List<java.util.Map.Entry<java.lang.String,java.lang.Boolean>>	getSortFields() Gets the sort fields.
CollectionSortedOrder	getSortOrder()
boolean	isQuery() Is the request a query request
boolean	isSortRequest() Is the request a sort request
boolean	isTranslationRequest() Is the request a translate request
void	setPagination(CollectionPagination pagination) Set the pagination
void	setSortBy(java.util.List<java.lang.String> sortBy)
void	setSortFields(java.util.List<java.util.Map.Entry<java.lang.String,java.lang.Boolean>> sortFields) Sets the sort fields.
void	setSortOrder(CollectionSortedOrder order)
void	setSortRequest(boolean isSortRequest) Sets the property that identifies if the QueryRequest is a sort request.
void	setTranslationRequest(boolean isTranslationRequest) Set the translation request

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_QUERY_REQUEST

public static QueryRequestInfo DEFAULT_QUERY_REQUEST

Constructor Detail

BaseQueryRequestInfo

public BaseQueryRequestInfo(SlingHttpServletRequest request)

Constructor which parses the info from the specified SlingHttpServletRequest.

Parameters:

request - the http servlet request.

BaseQueryRequestInfo

public BaseQueryRequestInfo(SlingHttpServletRequest request,
                            boolean isFilterQuery)

Constructor which parses the info from the specified SlingHttpServletRequest.

Parameters:

request - the http servlet request.

isFilterQuery - true, if a query in the request is defined by the 'filter' parameter, false otherwise

BaseQueryRequestInfo

public BaseQueryRequestInfo(boolean isQueryRequest,
                            java.util.Map<java.lang.String,java.lang.String[]> predicates,
                            CollectionPagination pagination)

Constructor.

Parameters:

isQueryRequest - boolean

predicates - Map

pagination - CollectionPagination

BaseQueryRequestInfo

public BaseQueryRequestInfo(boolean isQueryRequest,
                            java.util.Map<java.lang.String,java.lang.String[]> predicates,
                            CollectionPagination pagination,
                            boolean isTranslateRequest)

Constructor.

Parameters:

isQueryRequest - boolean

predicates - Map

pagination - CollectionPagination

isTranslateRequest - boolean

BaseQueryRequestInfo

public BaseQueryRequestInfo(boolean isQueryRequest,
                            java.util.Map<java.lang.String,java.lang.String[]> predicates,
                            CollectionPagination pagination,
                            CollectionSortedOrder order)

Constructor.

Parameters:

isQueryRequest - boolean

predicates - Map

pagination - CollectionPagination

order - CollectionSortedOrder

BaseQueryRequestInfo

public BaseQueryRequestInfo(boolean isQueryRequest,
                            java.util.Map<java.lang.String,java.lang.String[]> predicates,
                            CollectionPagination pagination,
                            CollectionSortedOrder order,
                            java.util.List<java.lang.String> sortBy)

Constructor.

Parameters:

isQueryRequest - boolean

predicates - Map

pagination - CollectionPagination

order - CollectionSortedOrder

sortBy - List

Method Detail

isQuery

public boolean isQuery()

Description copied from interface: QueryRequestInfo

Is the request a query request

Specified by:

isQuery in interface QueryRequestInfo

Returns:

boolean

getPredicates

public java.util.Map<java.lang.String,java.lang.String[]> getPredicates()

Description copied from interface: QueryRequestInfo

Get the query predicates.

Specified by:

getPredicates in interface QueryRequestInfo

Returns:

null if the request is not a query request, otherwise, the method returns a map of the query predicates

getPagination

public CollectionPagination getPagination()

Description copied from interface: QueryRequestInfo

Get the request paging specification

Specified by:

getPagination in interface QueryRequestInfo

Returns:

CollectionPagination

setPagination

public void setPagination(CollectionPagination pagination)

Description copied from interface: QueryRequestInfo

Set the pagination

Specified by:

setPagination in interface QueryRequestInfo

Parameters:

pagination - the pagination setting.

setSortBy

public void setSortBy(java.util.List<java.lang.String> sortBy)

Specified by:

setSortBy in interface QueryRequestInfo

Parameters:

sortBy - list of indexes to use to sort the list by

getSortBy

public java.util.List<java.lang.String> getSortBy()

Specified by:

getSortBy in interface QueryRequestInfo

Returns:

List - the list of index names requested to sort the list by

setSortOrder

public void setSortOrder(CollectionSortedOrder order)

Specified by:

setSortOrder in interface QueryRequestInfo

Parameters:

order - for the list

getSortOrder

public CollectionSortedOrder getSortOrder()

Specified by:

getSortOrder in interface QueryRequestInfo

Returns:

the requested order to sort the list by

isTranslationRequest

public boolean isTranslationRequest()

Description copied from interface: QueryRequestInfo

Is the request a translate request

Specified by:

isTranslationRequest in interface QueryRequestInfo

Returns:

boolean

setTranslationRequest

public void setTranslationRequest(boolean isTranslationRequest)

Description copied from interface: QueryRequestInfo

Set the translation request

Specified by:

setTranslationRequest in interface QueryRequestInfo

Parameters:

isTranslationRequest - request value

getSortFields

public java.util.List<java.util.Map.Entry<java.lang.String,java.lang.Boolean>> getSortFields()

Description copied from interface: QueryRequestInfo

Gets the sort fields. Its a ordered list. For a sort field [{"subject", true},{"added", false}] like this would sort UGC based on subject in ascending order and then by create date

Specified by:

getSortFields in interface QueryRequestInfo

Returns:

the sort fields

setSortFields

public void setSortFields(java.util.List<java.util.Map.Entry<java.lang.String,java.lang.Boolean>> sortFields)

Description copied from interface: QueryRequestInfo

Sets the sort fields.

Specified by:

setSortFields in interface QueryRequestInfo

Parameters:

sortFields - the sort fields

isSortRequest

public boolean isSortRequest()

Description copied from interface: QueryRequestInfo

Is the request a sort request

Specified by:

isSortRequest in interface QueryRequestInfo

Returns:

boolean

setSortRequest

public void setSortRequest(boolean isSortRequest)

Description copied from interface: QueryRequestInfo

Sets the property that identifies if the QueryRequest is a sort request.

Specified by:

setSortRequest in interface QueryRequestInfo

Parameters:

isSortRequest - the new sort request

getQueryString

public java.lang.String getQueryString()

Description copied from interface: QueryRequestInfo

Gets the query params.

Specified by:

getQueryString in interface QueryRequestInfo

Returns:

the query params