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

Class ContentSearchable

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.web.frontoffice.search.metamodel.impl.ContentSearchable

All Implemented Interfaces:

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

public class ContentSearchable
extends AbstractContentBasedSearchable

Searchable for Contents

Field Summary

Fields

Modifier and Type	Field and Description
private static String	__CRITERION_DEFINITIONS_PREFIX_ID
static String	PARAMETER_CONTENT_TYPES The additional parameter for content types
static String	ROLE Avalon Role

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

_associatedContentReturnable, _criteriaPosition, _label, _pageReturnable

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

_manager, _pluginName

Constructor Summary

Constructors

Constructor and Description
ContentSearchable()

Method Summary

Modifier and Type	Method and Description
protected String	associatedContentReturnableRole() The Avalon Role for the associated Content Returnable
protected Collection<String>	getContentTypes(AdditionalParameterValueMap additionalParameterValues) Gets the content types which will be used to retrieve the criteria relative to the Indexing Model
protected String	getCriterionDefinitionPrefix() Gets the prefix for criterion definitions
Optional<Query>	joinQuery(Query queryOnCriterion, Collection<Returnable> returnables, AdditionalParameterValueMap additionalParameters) Returns the query which joins the given one (on a criterion) with the given result types

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

configure, contextualize, criteriaPosition, dispose, getCriteria, getIndexingFieldCriterionDefinitionPrefix, getLabel, getSystemPropertyCriterionDefinitionPrefix, initialize, relationsWith, service

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.Searchable

additionalServiceParameters

Field Detail

ROLE

public static final String ROLE

Avalon Role

PARAMETER_CONTENT_TYPES

public static final String PARAMETER_CONTENT_TYPES

The additional parameter for content types

See Also:

Constant Field Values

__CRITERION_DEFINITIONS_PREFIX_ID

private static final String __CRITERION_DEFINITIONS_PREFIX_ID

See Also:

Constant Field Values

Constructor Detail

ContentSearchable

public ContentSearchable()

Method Detail

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

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,
                                 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

returnables - The returnables to join to

additionalParameters - The additional parameters

Returns:

the joined query