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

Class PrivateContentSearchable

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

All Implemented Interfaces:

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

public class PrivateContentSearchable
extends AbstractContentBasedSearchable

This class is a generic searchable to be used to search on a private ContentType.
You must associate it with a Returnable which is or extends PrivateContentReturnable

 <extension point="org.ametys.web.frontoffice.search.metamodel.SearchableExtensionPoint"
         id="my.searchable.id"
         class="org.ametys.web.frontoffice.search.metamodel.impl.PrivateContentSearchable">
     <label i18n="true">...</label>
     <criteriaPosition>11</criteriaPosition>
     <associatedReturnable>my.returnable.id</associatedReturnable>
     <baseContentType>my.content.type.1</baseContentType>
     <baseContentType>my.content.type.2</baseContentType>
     <contentTypeParameter order="99">
         <label i18n="true">...</label>
         <description i18n="true">...</description>
     </contentTypeParameter>
 </extension>
 

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 String	_associatedContentReturnableRole	The associated content returnable role
protected String	_avalonRole	The Avalon role of this Searchable
protected Collection<String>	_baseContentTypes	The base private content types of this searchable
protected String	_criterionDefinitionPrefix	The prefix for criterion definitions
protected String	_parameterSubContentTypeUniqueName	The unique name accross the whole application for the parameter for this searchable to select the sub content types.
protected String	_shortAvalonRole	The "short version" of the Avalon role of this Searchable

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
PrivateContentSearchable()

Method Summary

Modifier and Type	Method	Description
protected void	_configureAssociatedContentReturnableRole(Configuration configuration)	Initializes _associatedContentReturnableRole field from configuration
protected void	_configureBaseContentTypes(Configuration configuration)	Initializes _baseContentTypes field from configuration
protected void	_initAvalonRole(Configuration configuration)	Initializes _avalonRole field from configuration
protected void	_initCriterionDefinitionPrefix()	Initializes _criterionDefinitionPrefix field
protected void	_initParameterSubContentTypeUniqueName()	Initializes _parameterSubContentTypeUniqueName field
protected void	_initShortAvalonRole()	Initializes _shortAvalonRole field
protected String	associatedContentReturnableRole()	The Avalon Role for the associated Content Returnable
protected Configuration	buildFinalConfiguration(Configuration initialConfiguration)	Builds the final configuration object which will be passed to the superclass, from the "real" XML configuration
protected Configuration	buildParametersConfiguration(Configuration initialConfiguration)	Builds the configuration object for parameters
void	configure(Configuration configuration)
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
void	initialize()
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.

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

_setAssociatedContentReturnable, buildQuery, contextualize, criteriaPosition, dispose, getCacheManager, getCriteria, getIndexingFieldCriterionDefinitionPrefix, getLabel, getManagedCaches, getSystemPropertyCriterionDefinitionPrefix, hasComputableSize, 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.core.util.Cacheable

createCaches, getCache, isCachingEnabled, removeCaches

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

additionalServiceParameters

Field Details

_avalonRole

protected String _avalonRole

The Avalon role of this Searchable

_shortAvalonRole

protected String _shortAvalonRole

The "short version" of the Avalon role of this Searchable

_parameterSubContentTypeUniqueName

protected String _parameterSubContentTypeUniqueName

The unique name accross the whole application for the parameter for this searchable to select the sub content types.

_associatedContentReturnableRole

protected String _associatedContentReturnableRole

The associated content returnable role

_criterionDefinitionPrefix

protected String _criterionDefinitionPrefix

The prefix for criterion definitions

_baseContentTypes

protected Collection<String> _baseContentTypes

The base private content types of this searchable

Constructor Details

PrivateContentSearchable

public PrivateContentSearchable()

Method Details

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Overrides:

configure in class AbstractContentBasedSearchable

Throws:

ConfigurationException

buildFinalConfiguration

protected Configuration buildFinalConfiguration(Configuration initialConfiguration)
                                         throws ConfigurationException

Builds the final configuration object which will be passed to the superclass, from the "real" XML configuration

Parameters:

initialConfiguration - The source configuration

Returns:

the built configuration object

Throws:

ConfigurationException - If some values or attributes cannot be retrieved

buildParametersConfiguration

protected Configuration buildParametersConfiguration(Configuration initialConfiguration)
                                              throws ConfigurationException

Builds the configuration object for parameters

Parameters:

initialConfiguration - The source configuration

Returns:

the configuration object for parameters

Throws:

ConfigurationException - If some values or attributes cannot be retrieved

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Overrides:

initialize in class AbstractContentBasedSearchable

Throws:

Exception

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

_initAvalonRole

protected void _initAvalonRole(Configuration configuration)
                        throws ConfigurationException

Initializes _avalonRole field from configuration

Parameters:

configuration - The configuration

Throws:

ConfigurationException - If a configuration value cannot be retrieved

_initShortAvalonRole

protected void _initShortAvalonRole()

Initializes _shortAvalonRole field

_initParameterSubContentTypeUniqueName

protected void _initParameterSubContentTypeUniqueName()

Initializes _parameterSubContentTypeUniqueName field

_configureAssociatedContentReturnableRole

protected void _configureAssociatedContentReturnableRole(Configuration configuration)
                                                  throws ConfigurationException

Initializes _associatedContentReturnableRole field from configuration

Parameters:

configuration - The configuration

Throws:

ConfigurationException - If a configuration value cannot be retrieved

_configureBaseContentTypes

protected void _configureBaseContentTypes(Configuration configuration)
                                   throws ConfigurationException

Initializes _baseContentTypes field from configuration

Parameters:

configuration - The configuration

Throws:

ConfigurationException - If a configuration value cannot be retrieved

_initCriterionDefinitionPrefix

protected void _initCriterionDefinitionPrefix()

Initializes _criterionDefinitionPrefix field