Package org.ametys.plugins.odfweb.service.search

Class ProgramSearchable

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

org.ametys.plugins.odfweb.service.search.ProgramSearchable

All Implemented Interfaces:

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

public class ProgramSearchable
extends AbstractContentBasedSearchable

Searchable for Programs

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	ProgramSearchable.ProgramThroughProgramPartsQuery	A Query that returns Programs, by querying their child ProgramParts

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

Cacheable.SingleCacheConfiguration

Field Summary

Fields

Modifier and Type	Field	Description
protected DegreeUniversityHelper	_degreeUniversityHelper	The degree university helper
static final String	CRITERION_DEFINITIONS_PREFIX_ID	The prefix for program searchable
static final String	PARAMETER_SEARCH_ON_SUBPROGRAMS	The additional parameter for indicating if search has to be made also on subprograms
static final String	PROGRAM_SEARCHEABLE_INDEXING_FIELD_PREFIX	The prefix for indexing field in program searcheable
static final String	ROLE	Avalon Role

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

_associatedContentReturnable, _contentHelper, _criteriaPosition, _cTypeEP, _id, _label, _pageReturnable, _searchComponentHelper

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

_manager, _pluginName

Constructor Summary

Constructors

Constructor	Description
ProgramSearchable()

Method Summary

Modifier and Type	Method	Description
protected 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
protected 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 String	getCriterionDefinitionPrefix()	Gets the prefix for criterion definitions
protected Query	getProgramThroughSubprogramsQuery(Query queryOnCriterion)	Gets the Query that returns Programs by querying their SubPrograms
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)

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

_setAssociatedContentReturnable, configure, contextualize, criteriaPosition, dispose, getCacheManager, getIndexingFieldCriterionDefinitionPrefix, getLabel, getManagedCaches, getSystemPropertyCriterionDefinitionPrefix, hasComputableSize, initialize

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

Field Details

ROLE

public static final String ROLE

Avalon Role

PARAMETER_SEARCH_ON_SUBPROGRAMS

public static final String PARAMETER_SEARCH_ON_SUBPROGRAMS

The additional parameter for indicating if search has to be made also on subprograms

See Also:

• Constant Field Values

CRITERION_DEFINITIONS_PREFIX_ID

public static final String CRITERION_DEFINITIONS_PREFIX_ID

The prefix for program searchable

See Also:

• Constant Field Values

PROGRAM_SEARCHEABLE_INDEXING_FIELD_PREFIX

public static final String PROGRAM_SEARCHEABLE_INDEXING_FIELD_PREFIX

The prefix for indexing field in program searcheable

See Also:

• Constant Field Values

_degreeUniversityHelper

protected DegreeUniversityHelper _degreeUniversityHelper

The degree university helper

Constructor Details

ProgramSearchable

public ProgramSearchable()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractContentBasedSearchable

Throws:

ServiceException

associatedContentReturnableRole

protected String associatedContentReturnableRole()

Description copied from class: AbstractContentBasedSearchable

The Avalon Role for the associated Content Returnable

Specified by:

associatedContentReturnableRole in class AbstractContentBasedSearchable

Returns:

The Avalon Role for the associated Content Returnable

getCriterionDefinitionPrefix

protected String getCriterionDefinitionPrefix()

Description copied from class: AbstractContentBasedSearchable

Gets the prefix for criterion definitions

Specified by:

getCriterionDefinitionPrefix in class AbstractContentBasedSearchable

Returns:

the prefix for 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

Overrides:

relationsWith in class AbstractContentBasedSearchable

Returns:

some relations the type must have with some Returnables

getContentTypes

protected Collection<String> getContentTypes(AdditionalParameterValueMap additionalParameterValues)

Description copied from class: AbstractContentBasedSearchable

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

Specified by:

getContentTypes in class AbstractContentBasedSearchable

Parameters:

additionalParameterValues - The additional parameter values

Returns:

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

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

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

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

Overrides:

buildQuery in class AbstractContentBasedSearchable

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

getProgramThroughSubprogramsQuery

protected Query getProgramThroughSubprogramsQuery(Query queryOnCriterion)

Gets the Query that returns Programs by querying their SubPrograms

Parameters:

queryOnCriterion - The query on SubPrograms

Returns:

The Query that returns Programs

getCriteria

public Collection<SearchCriterionDefinition> getCriteria(AdditionalParameterValueMap additionalParameterValues)

Description copied from interface: Searchable

Gets the criteria

Specified by:

getCriteria in interface Searchable

Overrides:

getCriteria in class AbstractContentBasedSearchable

Parameters:

additionalParameterValues - The additional parameter values

Returns:

the criteria