Package org.ametys.cms.search

Class GetQueryFromJSONHelper

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.cms.search.GetQueryFromJSONHelper

All Implemented Interfaces:

Component, Contextualizable, LogEnabled, Serviceable

public class GetQueryFromJSONHelper
extends AbstractLogEnabled
implements Component, Serviceable, Contextualizable

Helper to get query infos from JSON object

Field Summary

Fields

Modifier and Type	Field	Description
private ContentTypeExtensionPoint	_contentTypeExtensionPoint
private Context	_context
private JSONUtils	_jsonUtils
private QueryBuilder	_queryBuilder
private SearchUIModelExtensionPoint	_searchUIModelExtensionPoint
private ServiceManager	_serviceManager
static String	ROLE	The Avalon role name

Constructor Summary

Constructors

Constructor	Description
GetQueryFromJSONHelper()

Method Summary

Modifier and Type	Method	Description
void	contextualize(Context context)
List<String>	getColumnsFromSearchModel(SearchUIModel model, Map<String,Object> contextualParameters)	Retrieves a list of column ids
Query	getQueryFromModel(SearchUIModel model, Map<String,Object> parameters, List<String> contentTypes)	Retrieves a Query object from the SearchUIModel and the JSON parameters
SearchUIModel	getSearchUIModel(Map<String,Object> parameters)	Retrieves the search UI model
SearchUIModel	getSearchUIModel(Map<String,Object> parameters, String modelKeyName)	Retrieves the search UI model
List<Sort>	getSort(String sortString, String groupString)	Retrieves the sort criteria from a sort string.
List<Sort>	getSort(Map<String,Object> parameters)	Retrieves the sort criteria from a sort string.
void	service(ServiceManager serviceManager)

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Field Detail

ROLE

public static final String ROLE

The Avalon role name

_searchUIModelExtensionPoint

private SearchUIModelExtensionPoint _searchUIModelExtensionPoint

_contentTypeExtensionPoint

private ContentTypeExtensionPoint _contentTypeExtensionPoint

_queryBuilder

private QueryBuilder _queryBuilder

_jsonUtils

private JSONUtils _jsonUtils

_serviceManager

private ServiceManager _serviceManager

_context

private Context _context

Constructor Detail

GetQueryFromJSONHelper

public GetQueryFromJSONHelper()

Method Detail

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

getSearchUIModel

public SearchUIModel getSearchUIModel(Map<String,Object> parameters)

Retrieves the search UI model

Parameters:

parameters - The JS parameters

Returns:

the search UI model

getSearchUIModel

public SearchUIModel getSearchUIModel(Map<String,Object> parameters,
                                      String modelKeyName)

Retrieves the search UI model

Parameters:

parameters - The JS parameters

modelKeyName - key name of the model parameter

Returns:

the search UI model

getQueryFromModel

public Query getQueryFromModel(SearchUIModel model,
                               Map<String,Object> parameters,
                               List<String> contentTypes)
                        throws QuerySyntaxException

Retrieves a Query object from the SearchUIModel and the JSON parameters

Parameters:

model - Model

parameters - JSON parameters

contentTypes - List of content types to fill

Returns:

the created Query object

Throws:

QuerySyntaxException - If an error occurs during the query parsing

getColumnsFromSearchModel

public List<String> getColumnsFromSearchModel(SearchUIModel model,
                                              Map<String,Object> contextualParameters)

Retrieves a list of column ids

Parameters:

model - search model containing result fields

contextualParameters - JSON object containing the contextual parameters

Returns:

a list of columns ids

getSort

public List<Sort> getSort(Map<String,Object> parameters)

Retrieves the sort criteria from a sort string.

Parameters:

parameters - The parameters (containing sort and optionally group keys)

Returns:

the sort criteria as a List of Sort.

getSort

public List<Sort> getSort(String sortString,
                          String groupString)

Retrieves the sort criteria from a sort string.

Parameters:

sortString - The sort criteria as a JSON-encoded string.

groupString - The group criteria as a JSON-encoded string (for server-side grouping feature). Can be null.

Returns:

the sort criteria as a List of Sort.