Package org.ametys.plugins.queriesdirectory

Class QueryHelper

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.queriesdirectory.QueryHelper

All Implemented Interfaces:

LogEnabled, Component, Serviceable

public class QueryHelper
extends AbstractLogEnabled
implements Serviceable, Component

Helper for manipulating Query

Field Summary

Fields

Modifier and Type	Field	Description
protected ContentSearcherFactory	_contentSearcherFactory	Content Searcher Factory
protected JSONUtils	_jsonUtils	JSON Utils
protected ServiceManager	_manager	The service manager
protected AmetysObjectResolver	_resolver	The Ametys object resolver
protected SearchUIModelExtensionPoint	_searchUiEP	SearchUI Model Extension Point
static final String	ROLE	Avalon Role

Constructor Summary

Constructors

Constructor	Description
QueryHelper()

Method Summary

Modifier and Type	Method	Description
AmetysObjectIterable<Content>	executeQuery(String queryId)	Execute a query
AmetysObjectIterable<Content>	executeQuery(Query query)	Execute a query
List<String>	getContentTypesForQuery(Map<String,Object> exportParams)	Get the Content Types of the query based on exportParams
Map<String,Object>	getContextualParametersForQuery(Map<String,Object> exportParams)	Get the contextual parameters of the query based on exportParams
Map<String,Object>	getExportParams(Query query)	Get the export params of the query
int	getLimitForQuery(Map<String,Object> exportParams)	Get the limit of results stored in a query, or -1 if none is found
String	getModelForQuery(Map<String,Object> exportParams)	Get the model of the query based on exportParams
String	getQueryStringForQuery(Map<String,Object> exportParams)	Get the solr query string of the query based on exportParams
String	getSearchModeForQuery(Map<String,Object> exportParams)	Get the search model of the query based on exportParams
List<ContentSearcherFactory.ContentSearchSort>	getSortForQuery(Map<String,Object> exportParams)	Get the sort of the query based on exportParams
Map<String,Object>	getValuesForQuery(Map<String,Object> exportParams)	Get the values of the query based on exportParams
void	service(ServiceManager manager)

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Details

ROLE

public static final String ROLE

Avalon Role

_resolver

protected AmetysObjectResolver _resolver

The Ametys object resolver

_jsonUtils

protected JSONUtils _jsonUtils

JSON Utils

_searchUiEP

protected SearchUIModelExtensionPoint _searchUiEP

SearchUI Model Extension Point

_contentSearcherFactory

protected ContentSearcherFactory _contentSearcherFactory

Content Searcher Factory

_manager

protected ServiceManager _manager

The service manager

Constructor Details

QueryHelper

public QueryHelper()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

executeQuery

public AmetysObjectIterable<Content> executeQuery(String queryId)
                                           throws Exception

Execute a query

Parameters:

queryId - id of the query to execute

Returns:

the results of the query

Throws:

Exception - something went wrong

executeQuery

public AmetysObjectIterable<Content> executeQuery(Query query)
                                           throws Exception

Execute a query

Parameters:

query - the query to execute

Returns:

the results of the query, can be null

Throws:

Exception - if failed to execute query

getLimitForQuery

public int getLimitForQuery(Map<String,Object> exportParams)

Get the limit of results stored in a query, or -1 if none is found

Parameters:

exportParams - export params of the query, available via getExportParams(Query)

Returns:

the maximum number of results that this query should return, -1 if no limit

getModelForQuery

public String getModelForQuery(Map<String,Object> exportParams)

Get the model of the query based on exportParams

Parameters:

exportParams - export params of the query, available via getExportParams(Query)

Returns:

the model of the query

getValuesForQuery

public Map<String,Object> getValuesForQuery(Map<String,Object> exportParams)

Get the values of the query based on exportParams

Parameters:

exportParams - export params of the query, available via getExportParams(Query)

Returns:

the values of the query

getContextualParametersForQuery

public Map<String,Object> getContextualParametersForQuery(Map<String,Object> exportParams)

Get the contextual parameters of the query based on exportParams

Parameters:

exportParams - export params of the query, available via getExportParams(Query)

Returns:

the contextual parameters of the query

getSortForQuery

public List<ContentSearcherFactory.ContentSearchSort> getSortForQuery(Map<String,Object> exportParams)

Get the sort of the query based on exportParams

Parameters:

exportParams - export params of the query, available via getExportParams(Query)

Returns:

the sort of the query

getContentTypesForQuery

public List<String> getContentTypesForQuery(Map<String,Object> exportParams)

Get the Content Types of the query based on exportParams

Parameters:

exportParams - export params of the query, available via getExportParams(Query)

Returns:

the Content Types of the query

getQueryStringForQuery

public String getQueryStringForQuery(Map<String,Object> exportParams)

Get the solr query string of the query based on exportParams

Parameters:

exportParams - export params of the query, available via getExportParams(Query)

Returns:

the solr query string of the query

getSearchModeForQuery

public String getSearchModeForQuery(Map<String,Object> exportParams)

Get the search model of the query based on exportParams

Parameters:

exportParams - export params of the query, available via getExportParams(Query)

Returns:

the search model of the query

getExportParams

public Map<String,Object> getExportParams(Query query)

Get the export params of the query

Parameters:

query - the query

Returns:

the export params of the query