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

Class AbstractContentBasedReturnable

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

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

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

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

All Implemented Interfaces:

LogEnabled, PluginAware, Returnable, Configurable, Contextualizable, Serviceable

Direct Known Subclasses:

ContentReturnable, CourseReturnable, ProgramReturnable

public abstract class AbstractContentBasedReturnable
extends AbstractParameterAdderReturnable
implements Contextualizable

Abstract class for all Returnable based on Contents

Field Summary

Fields

Modifier and Type	Field and Description
private static List<String>	__EXCLUDED_SYSPROP_SORT_DEFINITIONS
protected AbstractContentBasedSearchable	_associatedContentSearchable The associated content searchable
protected ContentFilterHelper	_contentFilterHelper The content filter helper
protected ContentHelper	_contentHelper The content helper
protected Context	_context The context
protected I18nizableText	_label The label

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

_manager, _pluginName

Constructor Summary

Constructors

Constructor and Description
AbstractContentBasedReturnable()

Method Summary

Modifier and Type	Method and Description
private boolean	_isExcludedSortDefinition(SearchCriterionDefinition criterionDefinition)
private boolean	_isSortable(ContentSearchCriterionDefinition criterionDefinition)
protected abstract String	associatedContentSearchableRole() The Avalon Role for the associated Content Searchable
void	configure(Configuration configuration)
void	contextualize(Context context)
Query	filterReturnedDocumentQuery(Collection<ContextQueriesWrapper> contextQueriesWrappers, AdditionalParameterValueMap additionalParameterValues) Returns the query to execute in order to filter returned objects (according to their type) during the search.
protected abstract Collection<String>	getContentTypes(AdditionalParameterValueMap additionalParameterValues) Gets the content types which will be used to construct the query to filter the returned documents
protected abstract String	getDefinitionPrefix() Gets the prefix for definitions (for facets, sorts...)
Collection<FacetDefinition>	getFacets(AdditionalParameterValueMap additionalParameterValues) Gets the facets
I18nizableText	getLabel() Gets the label of the type of result
Collection<SortDefinition>	getSorts(AdditionalParameterValueMap additionalParameterValues) Gets the sorts
Collection<Searchable>	relationsWith() Retrieves the relations the type must have with some Searchables.
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.web.frontoffice.search.metamodel.Returnable

additionalServiceParameters, getId, getSaxer, selectedByDefault

Field Detail

__EXCLUDED_SYSPROP_SORT_DEFINITIONS

private static final List<String> __EXCLUDED_SYSPROP_SORT_DEFINITIONS

_contentFilterHelper

protected ContentFilterHelper _contentFilterHelper

The content filter helper

_contentHelper

protected ContentHelper _contentHelper

The content helper

_associatedContentSearchable

protected AbstractContentBasedSearchable _associatedContentSearchable

The associated content searchable

_context

protected Context _context

The context

_label

protected I18nizableText _label

The label

Constructor Detail

AbstractContentBasedReturnable

public AbstractContentBasedReturnable()

Method Detail

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

associatedContentSearchableRole

protected abstract String associatedContentSearchableRole()

The Avalon Role for the associated Content Searchable

Returns:

The Avalon Role for the associated Content Searchable

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

getLabel

public I18nizableText getLabel()

Description copied from interface: Returnable

Gets the label of the type of result

Specified by:

getLabel in interface Returnable

Returns:

the label of the type of result

filterReturnedDocumentQuery

public Query filterReturnedDocumentQuery(Collection<ContextQueriesWrapper> contextQueriesWrappers,
                                         AdditionalParameterValueMap additionalParameterValues)

Description copied from interface: Returnable

Returns the query to execute in order to filter returned objects (according to their type) during the search.
It should call ContextQueriesWrapper#getQuery in order to make a JoinQuery on interesting parts of ContextQueriesWrappers and then constructs an AndQuery composed of a DocumentTypeQuery and the result of the call.

Specified by:

filterReturnedDocumentQuery in interface Returnable

Parameters:

contextQueriesWrappers - The context queries

additionalParameterValues - The additional parameter values

Returns:

the query to execute in order to filter returned objects (according to their type) during the search.

getContentTypes

protected abstract Collection<String> getContentTypes(AdditionalParameterValueMap additionalParameterValues)

Gets the content types which will be used to construct the query to filter the returned documents

Parameters:

additionalParameterValues - The additional parameter values

Returns:

the content types which will be used to construct the query to filter the returned documents

getFacets

public Collection<FacetDefinition> getFacets(AdditionalParameterValueMap additionalParameterValues)

Description copied from interface: Returnable

Gets the facets

Specified by:

getFacets in interface Returnable

Parameters:

additionalParameterValues - The additional parameter values

Returns:

the facets

getSorts

public Collection<SortDefinition> getSorts(AdditionalParameterValueMap additionalParameterValues)

Description copied from interface: Returnable

Gets the sorts

Specified by:

getSorts in interface Returnable

Parameters:

additionalParameterValues - The additional parameter values

Returns:

the sorts

getDefinitionPrefix

protected abstract String getDefinitionPrefix()

Gets the prefix for definitions (for facets, sorts...)

Returns:

the prefix for definitions

_isSortable

private boolean _isSortable(ContentSearchCriterionDefinition criterionDefinition)

_isExcludedSortDefinition

private boolean _isExcludedSortDefinition(SearchCriterionDefinition criterionDefinition)

relationsWith

public Collection<Searchable> relationsWith()

Description copied from interface: Returnable

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

Specified by:

relationsWith in interface Returnable

Returns:

some relations the type must have with some Searchables