Package org.ametys.web.frontoffice.search.instance.model

Class SearchContext

java.lang.Object

org.ametys.web.frontoffice.search.instance.model.SearchContext

public class SearchContext
extends Object

A search context

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	SearchContext.ContextLangAndCurrentLang	Class wrapping a ContextLang and the current lang.
static final class	SearchContext.LangQueryProducer	Class wrapping an implementation of Query in order to SearchContext.LangQueryProducer.produce(org.ametys.web.frontoffice.search.instance.model.SearchContext.ContextLangAndCurrentLang) the final query executed for limiting the context language for a given Returnable.

Constructor Summary

Constructors

Constructor	Description
SearchContext(SiteContext sites, SitemapContext sitemap, ContextLang langs, List<String> tags, boolean tagAutoposting)	Creates a SearchContext

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
SearchContext.ContextLangAndCurrentLang	getContextLang(String currentLang)	Gets the ContextLang and the current lang
Query	getSitemapQuery(SitemapElement currentPage)	Gets the query corresponding to the sitemap part of the context
Query	getSiteQuery(Site currentSite)	Gets the query corresponding to the site part of the context
Query	getTagQuery()	Gets the query corresponding to the tag part of the context
int	hashCode()
ContextLang	langContext()	Gets the lang context
SiteContext	siteContext()	Gets the site context
SitemapContext	sitemapContext()	Gets the sitemap context
Pair<List<String>,Boolean>	tagContext()	Gets the tag context

Methods inherited from class java.lang.Object

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

Constructor Details

SearchContext

public SearchContext(SiteContext sites,
 SitemapContext sitemap,
 ContextLang langs,
 List<String> tags,
 boolean tagAutoposting)

Creates a SearchContext

Parameters:

sites - The site context

sitemap - The sitemap context

langs - The lang of the context

tags - The tags of the context

tagAutoposting - true if search on tags should be with autoposting

Method Details

siteContext

public SiteContext siteContext()

Gets the site context

Returns:

the site context

sitemapContext

public SitemapContext sitemapContext()

Gets the sitemap context

Returns:

the sitemap context

langContext

public ContextLang langContext()

Gets the lang context

Returns:

the lang context

tagContext

public Pair<List<String>,Boolean> tagContext()

Gets the tag context

Returns:

the tag context

getSiteQuery

public Query getSiteQuery(Site currentSite)

Gets the query corresponding to the site part of the context

Parameters:

currentSite - the current site

Returns:

the query corresponding to the site part of the context

getSitemapQuery

public Query getSitemapQuery(SitemapElement currentPage)

Gets the query corresponding to the sitemap part of the context

Parameters:

currentPage - the current page

Returns:

the query corresponding to the sitemap part of the context

getContextLang

public SearchContext.ContextLangAndCurrentLang getContextLang(String currentLang)

Gets the ContextLang and the current lang

Parameters:

currentLang - The current lang

Returns:

the wrapper of the ContextLang and the current lang

getTagQuery

public Query getTagQuery()

Gets the query corresponding to the tag part of the context

Returns:

the query corresponding to the tag part of the context

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object