java.lang.Object

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

Enclosing class:: SearchContext

public static final class SearchContext.LangQueryProducer extends Object

Class wrapping an implementation of Query in order to produce(org.ametys.web.frontoffice.search.instance.model.SearchContext.ContextLangAndCurrentLang) the final query executed for limiting the context language for a given Returnable.
Instances of this class should be created only in

Returnable.filterReturnedDocumentQuery(java.util.Collection<org.ametys.web.frontoffice.search.metamodel.context.ContextQueriesWrapper>, org.ametys.web.frontoffice.search.metamodel.AdditionalParameterValueMap)

methods, and then passed to

ContextQueriesWrapper.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>>)

See Also:

Constructor Summary

Constructors

Constructor

Description

LangQueryProducer(Class<? extends Query> languageQueryClass, boolean acceptDocWithNolang)

Constructs a SearchContext.LangQueryProducer
The given class must have at least two constructors: one with no arguments in order to test existence; one with an Query.Operator and an array of String values in order to test equality of the current language.
Method Summary

Modifier and Type

Method

Description

final Query

produce(SearchContext.ContextLangAndCurrentLang contextLangAndCurrentLang)

Produces the Query for testing the context language

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- LangQueryProducer
  
  public LangQueryProducer(Class<? extends Query> languageQueryClass, boolean acceptDocWithNolang)
  Constructs a SearchContext.LangQueryProducer
  The given class must have at least two constructors:
  
  one with no arguments in order to test existence;
  
  one with an Query.Operator and an array of String values in order to test equality of the current language.
  Parameters:
  
  languageQueryClass - The implementation of Query for testing the lang
  
  acceptDocWithNolang - true to accept documents with no lang
Method Details
- produce
  
  public final Query produce(SearchContext.ContextLangAndCurrentLang contextLangAndCurrentLang) throws Exception
  
  Produces the Query for testing the context language
  
  Parameters:
  
  contextLangAndCurrentLang - The wrapper of the ContextLang and the real current language
  
  Returns:
  
  a Query
  
  Throws:
  
  Exception - if an error occurs

Class SearchContext.LangQueryProducer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Details

LangQueryProducer

Method Details

produce