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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	QueryHelper.ObjectToReturn
static class	QueryHelper.Visibility	The user and its groups for checking visibility

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 String	ROLE	Avalon Role

Constructor Summary

Constructors

Constructor	Description
QueryHelper()

Method Summary

Modifier and Type	Method	Description
private static void	_appendGroupAccessCondition(StringBuilder query, String groupId, String groupDirectory, String accessNodeName)
private static void	_appendGroupsCondition(StringBuilder query, Set<GroupIdentity> groups, boolean readAccess)
private static void	_appendPrivatePredicate(StringBuilder query, String login, String populationId)
private static void	_appendPublicPredicate(StringBuilder query)
private static void	_appendSharedPredicate(StringBuilder query, String login, String populationId, Set<GroupIdentity> groups, boolean readAccess)
private static void	_appendUserAccessCondition(StringBuilder query, String login, String populationId, String accessNodeName)
private static void	_appendUserCondition(StringBuilder query, String login, String populationId)
private static StringBuilder	_getParentPath(QueryContainer queryContainer)
private static String	_getXPathQuery(QueryContainer queryContainer, boolean onlyDirectChildren, QueryHelper.ObjectToReturn objectToReturn, Optional<QueryHelper.Visibility> visibility, Optional<String> type, Boolean readAccess)
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<Sort>	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
(package private) static String	getXPathForQueriesForAdministrator(QueryContainer queryContainer, boolean onlyDirectChildren, Optional<String> type)	Creates the XPath query to get all queries for administrator
(package private) static String	getXPathForQueriesInReadAccess(QueryContainer queryContainer, boolean onlyDirectChildren, QueryHelper.Visibility visibility, Optional<String> type)	Creates the XPath query to get all queries in READ access
(package private) static String	getXPathForQueriesInWriteAccess(QueryContainer queryContainer, boolean onlyDirectChildren, QueryHelper.Visibility visibility, Optional<String> type)	Creates the XPath query to get all queries in WRITE access
(package private) static String	getXPathForQueryContainers(QueryContainer queryContainer)	Creates the XPath query to get all query containers
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 Detail

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 Detail

QueryHelper

public QueryHelper()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getXPathForQueryContainers

static String getXPathForQueryContainers(QueryContainer queryContainer)

Creates the XPath query to get all query containers

Parameters:

queryContainer - The QueryContainer, defining the context from which getting children

Returns:

The XPath query

getXPathForQueriesForAdministrator

static String getXPathForQueriesForAdministrator(QueryContainer queryContainer,
                                                 boolean onlyDirectChildren,
                                                 Optional<String> type)

Creates the XPath query to get all queries for administrator

Parameters:

queryContainer - The QueryContainer, defining the context from which getting children

onlyDirectChildren - true in order to have only direct child queries from parent path, false otherwise to have all queries at any level underneath the parent path

type - The query type

Returns:

The XPath query

getXPathForQueriesInReadAccess

static String getXPathForQueriesInReadAccess(QueryContainer queryContainer,
                                             boolean onlyDirectChildren,
                                             QueryHelper.Visibility visibility,
                                             Optional<String> type)

Creates the XPath query to get all queries in READ access

Parameters:

queryContainer - The QueryContainer, defining the context from which getting children

onlyDirectChildren - true in order to have only direct child queries from parent path, false otherwise to have all queries at any level underneath the parent path

visibility - The user and its groups for checking visibility

type - The query type

Returns:

The XPath query

getXPathForQueriesInWriteAccess

static String getXPathForQueriesInWriteAccess(QueryContainer queryContainer,
                                              boolean onlyDirectChildren,
                                              QueryHelper.Visibility visibility,
                                              Optional<String> type)

Creates the XPath query to get all queries in WRITE access

Parameters:

queryContainer - The QueryContainer, defining the context from which getting children

onlyDirectChildren - true in order to have only direct child queries from parent path, false otherwise to have all queries at any level underneath the parent path

visibility - The user and its groups for checking visibility

type - The query type

Returns:

The XPath query

_getParentPath

private static StringBuilder _getParentPath(QueryContainer queryContainer)

_getXPathQuery

private static String _getXPathQuery(QueryContainer queryContainer,
                                     boolean onlyDirectChildren,
                                     QueryHelper.ObjectToReturn objectToReturn,
                                     Optional<QueryHelper.Visibility> visibility,
                                     Optional<String> type,
                                     Boolean readAccess)

_appendPublicPredicate

private static void _appendPublicPredicate(StringBuilder query)

_appendPrivatePredicate

private static void _appendPrivatePredicate(StringBuilder query,
                                            String login,
                                            String populationId)

_appendSharedPredicate

private static void _appendSharedPredicate(StringBuilder query,
                                           String login,
                                           String populationId,
                                           Set<GroupIdentity> groups,
                                           boolean readAccess)

_appendUserCondition

private static void _appendUserCondition(StringBuilder query,
                                         String login,
                                         String populationId)

_appendGroupsCondition

private static void _appendGroupsCondition(StringBuilder query,
                                           Set<GroupIdentity> groups,
                                           boolean readAccess)

_appendUserAccessCondition

private static void _appendUserAccessCondition(StringBuilder query,
                                               String login,
                                               String populationId,
                                               String accessNodeName)

_appendGroupAccessCondition

private static void _appendGroupAccessCondition(StringBuilder query,
                                                String groupId,
                                                String groupDirectory,
                                                String accessNodeName)

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 - something went wrong

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<Sort> 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