Package org.ametys.web.frontoffice

Interface QueryAdapterFOSearch

All Known Implementing Classes:

WorkspacesQueryAdapterFOSearch

public interface QueryAdapterFOSearch

Modify the FO search query.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX_PRIORITY	Maximum priority.
static final int	MIN_PRIORITY	Minimum priority.

Method Summary

Modifier and Type	Method	Description
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.

Field Details

MIN_PRIORITY

static final int MIN_PRIORITY

Minimum priority.

See Also:

• Constant Field Values

MAX_PRIORITY

static final int MAX_PRIORITY

Maximum priority.

See Also:

• Constant Field Values

Method Details

modifyQuery

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

Modify the FO search query.

Parameters:

query - the initial query

request - The request

siteNames - The site names.

language - The language

Returns:

the new modify query

modifySiteQueryFilter

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

Modify the site query.

Parameters:

siteQuery - the initial site query

request - The request

siteNames - The site names.

language - The language

Returns:

the new modify site query

modifySitemapQueryFilter

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

Modify the sitemap query.

Parameters:

sitemapQuery - the initial sitemap query

request - The request

siteNames - The site names.

language - The language

Returns:

the new modify site query

modifyQueryFacets

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

Modify the query facets

Parameters:

queryFacets - the initial query facets

request - the request

Returns:

the new query facets

addDocumentType

void addDocumentType(List<String> documentTypes)

Add document type

Parameters:

documentTypes - the document types

getPriority

int getPriority()

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

Returns:

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