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

Class AbstractContentBasedSearchable

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

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

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

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

All Implemented Interfaces:

Cacheable, LogEnabled, PluginAware, Searchable, Disposable, Initializable, Configurable, Contextualizable, Serviceable

Direct Known Subclasses:

ContentSearchable, CourseSearchable, PrivateContentSearchable, ProgramSearchable

public abstract class AbstractContentBasedSearchable
extends AbstractParameterAdderSearchable
implements Initializable, Contextualizable, Disposable, Cacheable

Abstract class for all Searchable based on Contents

Nested Class Summary

Nested classes/interfaces inherited from interface org.ametys.core.util.Cacheable

Cacheable.SingleCacheConfiguration

Field Summary

Fields

Modifier and Type	Field	Description
protected Returnable	_associatedContentReturnable	The associated content returnable
protected ContentHelper	_contentHelper	The content helper
protected int	_criteriaPosition	The criteria position
protected ContentTypeExtensionPoint	_cTypeEP	The extension point for content types
protected String	_id	The id of extension point
protected I18nizableText	_label	The label
protected Returnable	_pageReturnable	The page returnable
protected SearchComponentHelper	_searchComponentHelper	The search component helper

Fields inherited from class org.ametys.web.frontoffice.search.metamodel.impl.AbstractParameterAdder

_manager, _pluginName

Constructor Summary

Constructors

Constructor	Description
AbstractContentBasedSearchable()

Method Summary

Modifier and Type	Method	Description
protected void	_setAssociatedContentReturnable()	Sets _associatedContentReturnable.
protected abstract String	associatedContentReturnableRole()	The Avalon Role for the associated Content Returnable
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)
void	contextualize(Context context)
int	criteriaPosition()	The position of the criteria provided by this Searchable among criteria provided by other Searchables.
void	dispose()
AbstractCacheManager	getCacheManager()	Returns the instance of the implementation of AbstractCacheManager to use.
protected abstract Collection<String>	getContentTypes(AdditionalParameterValueMap additionalParameterValues)	Gets the content types which will be used to retrieve the criteria relative to the Indexing Model
Collection<SearchCriterionDefinition>	getCriteria(AdditionalParameterValueMap additionalParameterValues)	Gets the criteria
protected abstract String	getCriterionDefinitionPrefix()	Gets the prefix for criterion definitions
protected String	getIndexingFieldCriterionDefinitionPrefix()	Gets the prefix for the ids of indexing field criterion definitions
I18nizableText	getLabel()	Gets the label of the searchable
Collection<Cacheable.SingleCacheConfiguration>	getManagedCaches()	Gets the managed caches.
protected String	getSystemPropertyCriterionDefinitionPrefix()	Gets the prefix for the ids of system property criterion definitions
boolean	hasComputableSize()	Determines if the cache has a computable size.
void	initialize()
Collection<Returnable>	relationsWith()	Retrieves the relations the type must have with some Returnables.
void	service(ServiceManager manager)

Methods inherited from class org.ametys.web.frontoffice.search.metamodel.impl.AbstractParameterAdder

additionalServiceParameters, setPluginInfo

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ametys.core.util.Cacheable

createCaches, getCache, isCachingEnabled, removeCaches

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

additionalServiceParameters, joinQuery

Field Details

_id

protected String _id

The id of extension point

_label

protected I18nizableText _label

The label

_criteriaPosition

protected int _criteriaPosition

The criteria position

_pageReturnable

protected Returnable _pageReturnable

The page returnable

_associatedContentReturnable

protected Returnable _associatedContentReturnable

The associated content returnable

_cTypeEP

protected ContentTypeExtensionPoint _cTypeEP

The extension point for content types

_contentHelper

protected ContentHelper _contentHelper

The content helper

_searchComponentHelper

protected SearchComponentHelper _searchComponentHelper

The search component helper

Constructor Details

AbstractContentBasedSearchable

public AbstractContentBasedSearchable()

Method Details

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Overrides:

configure in class AbstractParameterAdder

Throws:

ConfigurationException

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractParameterAdder

Throws:

ServiceException

_setAssociatedContentReturnable

protected void _setAssociatedContentReturnable()

Sets _associatedContentReturnable. Called during initialize()

associatedContentReturnableRole

protected abstract String associatedContentReturnableRole()

The Avalon Role for the associated Content Returnable

Returns:

The Avalon Role for the associated Content Returnable

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

getCacheManager

public AbstractCacheManager getCacheManager()

Description copied from interface: Cacheable

Returns the instance of the implementation of AbstractCacheManager to use.
This is not meant to be called manually.

Specified by:

getCacheManager in interface Cacheable

Returns:

The AbstractCacheManager to bind

getManagedCaches

public Collection<Cacheable.SingleCacheConfiguration> getManagedCaches()

Description copied from interface: Cacheable

Gets the managed caches.
This is meant to be implemented in order to describe the managed caches and automatically create and remove the corresponding caches in Cacheable.createCaches() and Cacheable.removeCaches() default methods.
This is not meant to be called manually.

Specified by:

getManagedCaches in interface Cacheable

Returns:

A collection of Cacheable.SingleCacheConfigurations to manage

hasComputableSize

public boolean hasComputableSize()

Description copied from interface: Cacheable

Determines if the cache has a computable size. This operation can be very slow.

Specified by:

hasComputableSize in interface Cacheable

Returns:

true if we can compute the size on the cache.

getSystemPropertyCriterionDefinitionPrefix

protected String getSystemPropertyCriterionDefinitionPrefix()

Gets the prefix for the ids of system property criterion definitions

Returns:

the prefix for the ids of system property criterion definitions

getCriterionDefinitionPrefix

protected abstract String getCriterionDefinitionPrefix()

Gets the prefix for criterion definitions

Returns:

the prefix for criterion definitions

dispose

public void dispose()

Specified by:

dispose in interface Disposable

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

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

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

getContentTypes

protected abstract Collection<String> getContentTypes(AdditionalParameterValueMap additionalParameterValues)

Gets the content types which will be used to retrieve the criteria relative to the Indexing Model

Parameters:

additionalParameterValues - The additional parameter values

Returns:

the content types which will be used to retrieve the criteria relative to the Indexing Model

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

getIndexingFieldCriterionDefinitionPrefix

protected String getIndexingFieldCriterionDefinitionPrefix()

Gets the prefix for the ids of indexing field criterion definitions

Returns:

the prefix for the ids of indexing field criterion definitions

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