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

Class PageSearchable

java.lang.Object

org.ametys.web.frontoffice.search.metamodel.impl.PageSearchable

All Implemented Interfaces:

PluginAware, Searchable, Configurable, Serviceable

public class PageSearchable
extends Object
implements Searchable, Serviceable, PluginAware, Configurable

Searchable for Pages

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	__CRITERION_DEFINITIONS_PREFIX_ID	The prefix for the ids of criterion definitions
protected int	_criteriaPosition	The criteria position
protected I18nizableText	_label	The label
protected Returnable	_pageReturnable	The page returnable
protected AmetysObjectResolver	_resolver	The ametys object resolver
protected SearchComponentHelper	_searchComponentHelper	The search component helper

Constructor Summary

Constructors

Constructor	Description
PageSearchable()

Method Summary

Modifier and Type	Method	Description
Query	buildQuery(AbstractTreeNode<FOSearchCriterion> criterionTree, Map<String,Object> userCriteria, Collection<Returnable> returnables, Collection<Searchable> searchables, AdditionalParameterValueMap additionalParameters, String currentLang, Map<String,Object> contextualParameters)	Builds the query of the criterion tree
void	configure(Configuration configuration)
int	criteriaPosition()	The position of the criteria provided by this Searchable among criteria provided by other Searchables.
Collection<SearchCriterionDefinition>	getCriteria(AdditionalParameterValueMap additionalParameterValues)	Gets the criteria
I18nizableText	getLabel()	Gets the label of the searchable
Optional<Query>	joinQuery(Query queryOnCriterion, SearchCriterionDefinition criterion, Collection<Returnable> returnables, AdditionalParameterValueMap additionalParameters)	Returns the query which joins the given one (on a criterion) with the given result types
Collection<Returnable>	relationsWith()	Retrieves the relations the type must have with some Returnables.
void	service(ServiceManager manager)
void	setPluginInfo(String pluginName, String featureName, String id)	Sets the plugin info relative to the current component. Note : The feature name may be null if the targeted component in declared at plugin level.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ametys.web.frontoffice.search.metamodel.Searchable

additionalServiceParameters

Field Details

__CRITERION_DEFINITIONS_PREFIX_ID

protected static final String __CRITERION_DEFINITIONS_PREFIX_ID

The prefix for the ids of criterion definitions

See Also:

• Constant Field Values

_pageReturnable

protected Returnable _pageReturnable

The page returnable

_resolver

protected AmetysObjectResolver _resolver

The ametys object resolver

_label

protected I18nizableText _label

The label

_criteriaPosition

protected int _criteriaPosition

The criteria position

_searchComponentHelper

protected SearchComponentHelper _searchComponentHelper

The search component helper

Constructor Details

PageSearchable

public PageSearchable()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

setPluginInfo

public void setPluginInfo(String pluginName,
 String featureName,
 String id)

Description copied from interface: PluginAware

Sets the plugin info relative to the current component.
Note : The feature name may be null if the targeted component in declared at plugin level.

Specified by:

setPluginInfo in interface PluginAware

Parameters:

pluginName - Unique identifier for the plugin hosting the extension

featureName - Unique feature identifier (unique for a given pluginName)

id - Unique identifier of this component

getLabel

public I18nizableText getLabel()

Description copied from interface: Searchable

Gets the label of the searchable

Specified by:

getLabel in interface Searchable

Returns:

the label of the searchable

getCriteria

public Collection<SearchCriterionDefinition> getCriteria(AdditionalParameterValueMap additionalParameterValues)

Description copied from interface: Searchable

Gets the criteria

Specified by:

getCriteria in interface Searchable

Parameters:

additionalParameterValues - The additional parameter values

Returns:

the criteria

criteriaPosition

public int criteriaPosition()

Description copied from interface: Searchable

The position of the criteria provided by this Searchable among criteria provided by other Searchables.
All criteria provided by the same Searchable are always packed together, this integer just affects the relative position compared to other Searchable criteria.
The lowest the integer, the higher it will appear in the UI.

Specified by:

criteriaPosition in interface Searchable

Returns:

The position of the criteria of this Searchable

joinQuery

public Optional<Query> joinQuery(Query queryOnCriterion,
 SearchCriterionDefinition criterion,
 Collection<Returnable> returnables,
 AdditionalParameterValueMap additionalParameters)

Description copied from interface: Searchable

Returns the query which joins the given one (on a criterion) with the given result types

Specified by:

joinQuery in interface Searchable

Parameters:

queryOnCriterion - The query on the criterion to join from

criterion - the criterion

returnables - The returnables to join to

additionalParameters - The additional parameters

Returns:

the joined query

relationsWith

public Collection<Returnable> relationsWith()

Description copied from interface: Searchable

Retrieves the relations the type must have with some Returnables.
It does not have to be exhaustive (for instance if Returnable.relationsWith() declares the relation, it is useless to declare it twice)

Specified by:

relationsWith in interface Searchable

Returns:

some relations the type must have with some Returnables

buildQuery

public Query buildQuery(AbstractTreeNode<FOSearchCriterion> criterionTree,
 Map<String,Object> userCriteria,
 Collection<Returnable> returnables,
 Collection<Searchable> searchables,
 AdditionalParameterValueMap additionalParameters,
 String currentLang,
 Map<String,Object> contextualParameters)

Description copied from interface: Searchable

Builds the query of the criterion tree

Specified by:

buildQuery in interface Searchable

Parameters:

criterionTree - The criterion tree of the service instance

userCriteria - The user input criteria

returnables - The returnables of the service instance

searchables - The searchables of the service instance

additionalParameters - The values of additional parameters of the service instance

currentLang - The current lang

contextualParameters - the search contextual parameters.

Returns:

The query of the criterion tree