Package org.ametys.web.frontoffice.search.metamodel.context

Class ContextQueriesWrapper

java.lang.Object

org.ametys.web.frontoffice.search.metamodel.context.ContextQueriesWrapper

public class ContextQueriesWrapper
extends Object

A wrapper of queries about a search context.
Use getQuery(java.util.Collection<org.ametys.web.frontoffice.search.metamodel.context.ContextQueriesWrapper>, java.util.Optional<java.util.function.Function<org.ametys.cms.search.query.Query, org.ametys.cms.search.query.Query>>, java.util.Optional<java.util.function.Function<org.ametys.cms.search.query.Query, org.ametys.cms.search.query.Query>>, java.util.Optional<org.ametys.web.frontoffice.search.instance.model.SearchContext.LangQueryProducer>, java.util.Optional<java.util.function.Function<org.ametys.cms.search.query.Query, org.ametys.cms.search.query.Query>>) by Returnables in order to choose the part for each Context the Returnable cares about (by passing an empty optional or a joiner/producer) and transform it to a Query.

Constructor Summary

Constructors

Constructor	Description
ContextQueriesWrapper(Query siteQuery, Query sitemapQuery, SearchContext.ContextLangAndCurrentLang contextLangAndCurrentLang, Query tagQuery)	Creates a wrapper of Context Queries (site, sitemap, lang, tag).

Method Summary

Modifier and Type	Method	Description
Optional<SearchContext.ContextLangAndCurrentLang>	getContextLangAndCurrentLang()	Get the context lang and current lang
static Query	getQuery(Collection<ContextQueriesWrapper> contextQueriesWrappers, Optional<Function<Query,Query>> siteQueryJoiner, Optional<Function<Query,Query>> sitemapQueryJoiner, Optional<SearchContext.LangQueryProducer> langQueryProducer, Optional<Function<Query,Query>> tagQueryJoiner)	Gets the query corresponding to the given contexts (as a collection of ContextQueriesWrapper) By passing an empty optional or a joiner/producer, you are able to choose the part of the contexts you want to ignore/take account in the generated query.
Optional<Query>	getSitemapQuery()	Get the sitemap query
Optional<Query>	getSiteQuery()	Get the site query
Optional<Query>	getTagQuery()	Get the tag query

Methods inherited from class java.lang.Object

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

Constructor Detail

ContextQueriesWrapper

public ContextQueriesWrapper(Query siteQuery,
                             Query sitemapQuery,
                             SearchContext.ContextLangAndCurrentLang contextLangAndCurrentLang,
                             Query tagQuery)

Creates a wrapper of Context Queries (site, sitemap, lang, tag).

Parameters:

siteQuery - The site query

sitemapQuery - The sitemap query

contextLangAndCurrentLang - The wrapper of ContextLang and the current lang

tagQuery - The tag query

Method Detail

getSiteQuery

public Optional<Query> getSiteQuery()

Get the site query

Returns:

the site query

getSitemapQuery

public Optional<Query> getSitemapQuery()

Get the sitemap query

Returns:

the sitemap query

getContextLangAndCurrentLang

public Optional<SearchContext.ContextLangAndCurrentLang> getContextLangAndCurrentLang()

Get the context lang and current lang

Returns:

the context lang and current lang

getTagQuery

public Optional<Query> getTagQuery()

Get the tag query

Returns:

the tag query

getQuery

public static Query getQuery(Collection<ContextQueriesWrapper> contextQueriesWrappers,
                             Optional<Function<Query,Query>> siteQueryJoiner,
                             Optional<Function<Query,Query>> sitemapQueryJoiner,
                             Optional<SearchContext.LangQueryProducer> langQueryProducer,
                             Optional<Function<Query,Query>> tagQueryJoiner)

Gets the query corresponding to the given contexts (as a collection of ContextQueriesWrapper)
By passing an empty optional or a joiner/producer, you are able to choose the part of the contexts you want to ignore/take account in the generated query.

Parameters:

contextQueriesWrappers - The wrappers of context queries

siteQueryJoiner - The joiner for the site query

sitemapQueryJoiner - The joiner for the sitemap query

langQueryProducer - The producer of the lang query

tagQueryJoiner - The joiner for the tag query

Returns:

the query corresponding to the given contexts