Package org.ametys.plugins.workspaces.search.query

Class WorkspacesQueryAdapterFOSearch

java.lang.Object

org.ametys.plugins.workspaces.search.query.WorkspacesQueryAdapterFOSearch

All Implemented Interfaces:

QueryAdapterFOSearch

public class WorkspacesQueryAdapterFOSearch
extends Object
implements QueryAdapterFOSearch

The query adapter to handle the "with workspaces" FO search service parameter

Field Summary

Fields inherited from interface org.ametys.web.frontoffice.QueryAdapterFOSearch

MAX_PRIORITY, MIN_PRIORITY

Constructor Summary

Constructors

Constructor	Description
WorkspacesQueryAdapterFOSearch()

Method Summary

Modifier and Type	Method	Description
private boolean	_withWorkspaces(Request request)
void	addDocumentType(List<String> documentTypes)	Add document type
int	getPriority()	Retrieves the priority to modify the query. This can be used to process a query modification before an other.
Query	modifyQuery(Query query, Request request, Collection<String> siteNames, String language)	Modify the FO search query.
Set<FrontOfficeSearcherFactory.QueryFacet>	modifyQueryFacets(Set<FrontOfficeSearcherFactory.QueryFacet> queryFacets, Request request)	Modify the query facets
Query	modifySitemapQueryFilter(Query sitemapQuery, Request request, Collection<String> siteNames, String language)	Modify the sitemap query.
Query	modifySiteQueryFilter(Query siteQuery, Request request, Collection<String> siteNames, String language)	Modify the site query.

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkspacesQueryAdapterFOSearch

public WorkspacesQueryAdapterFOSearch()

Method Detail

getPriority

public int getPriority()

Description copied from interface: QueryAdapterFOSearch

Retrieves the priority to modify the query.
This can be used to process a query modification before an other.

Specified by:

getPriority in interface QueryAdapterFOSearch

Returns:

the priority where 0 the max priority and Integer.MAX_VALUE the min priority.

modifyQuery

public Query modifyQuery(Query query,
                         Request request,
                         Collection<String> siteNames,
                         String language)

Description copied from interface: QueryAdapterFOSearch

Modify the FO search query.

Specified by:

modifyQuery in interface QueryAdapterFOSearch

Parameters:

query - the initial query

request - The request

siteNames - The site names.

language - The language

Returns:

the new modify query

modifySiteQueryFilter

public Query modifySiteQueryFilter(Query siteQuery,
                                   Request request,
                                   Collection<String> siteNames,
                                   String language)

Description copied from interface: QueryAdapterFOSearch

Modify the site query.

Specified by:

modifySiteQueryFilter in interface QueryAdapterFOSearch

Parameters:

siteQuery - the initial site query

request - The request

siteNames - The site names.

language - The language

Returns:

the new modify site query

modifySitemapQueryFilter

public Query modifySitemapQueryFilter(Query sitemapQuery,
                                      Request request,
                                      Collection<String> siteNames,
                                      String language)

Description copied from interface: QueryAdapterFOSearch

Modify the sitemap query.

Specified by:

modifySitemapQueryFilter in interface QueryAdapterFOSearch

Parameters:

sitemapQuery - the initial sitemap query

request - The request

siteNames - The site names.

language - The language

Returns:

the new modify site query

modifyQueryFacets

public Set<FrontOfficeSearcherFactory.QueryFacet> modifyQueryFacets(Set<FrontOfficeSearcherFactory.QueryFacet> queryFacets,
                                                                    Request request)

Description copied from interface: QueryAdapterFOSearch

Modify the query facets

Specified by:

modifyQueryFacets in interface QueryAdapterFOSearch

Parameters:

queryFacets - the initial query facets

request - the request

Returns:

the new query facets

addDocumentType

public void addDocumentType(List<String> documentTypes)

Description copied from interface: QueryAdapterFOSearch

Add document type

Specified by:

addDocumentType in interface QueryAdapterFOSearch

Parameters:

documentTypes - the document types

_withWorkspaces

private boolean _withWorkspaces(Request request)