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

Class ContentReturnable

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

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

All Implemented Interfaces:

LogEnabled, PluginAware, Returnable, Initializable, Configurable, Contextualizable, Serviceable

public class ContentReturnable
extends AbstractContentBasedReturnable

Returnable for Contents

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	__PREFIX_ID	The prefix for the ids of facets and sorts
static String	PARAMETER_VIEW	The additional parameter for the view
static String	ROLE	Avalon Role

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

_associatedContentSearchable, _contentFilterHelper, _contentHelper, _context, _label, _searchableEP

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

_manager, _pluginName

Constructor Summary

Constructors

Constructor	Description
ContentReturnable()

Method Summary

Modifier and Type	Method	Description
protected String	associatedContentSearchableRole()	The Avalon Role for the associated Content Searchable
protected Collection<String>	getContentTypes(AdditionalParameterValueMap additionalParameterValues)	Gets the content types which will be used to construct the query to filter the returned documents
protected String	getDefinitionPrefix()	Gets the prefix for definitions (for facets, sorts...)
String	getId()	Gets the id of the extension
ReturnableSaxer	getSaxer(Collection<Returnable> allReturnables, AdditionalParameterValueMap additionalParameterValues)	Returns the saxer responsible to SAX hits of this Returnable.
protected String	getViewForSax(AdditionalParameterValueMap additionalParameterValues)	Gets the view for saxing

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

_setAssociatedContentSearchable, configure, contextualize, filterReturnedDocumentQuery, getFacets, getLabel, getSorts, initialize, langQueryProducer, relationsWith, service, sitemapQueryJoiner, siteQueryJoiner, tagQueryJoiner

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

Field Detail

ROLE

public static final String ROLE

Avalon Role

PARAMETER_VIEW

public static final String PARAMETER_VIEW

The additional parameter for the view

See Also:

Constant Field Values

__PREFIX_ID

protected static final String __PREFIX_ID

The prefix for the ids of facets and sorts

See Also:

Constant Field Values

Constructor Detail

ContentReturnable

public ContentReturnable()

Method Detail

associatedContentSearchableRole

protected String associatedContentSearchableRole()

Description copied from class: AbstractContentBasedReturnable

The Avalon Role for the associated Content Searchable

Specified by:

associatedContentSearchableRole in class AbstractContentBasedReturnable

Returns:

The Avalon Role for the associated Content Searchable

getId

public String getId()

Description copied from interface: Returnable

Gets the id of the extension

Returns:

the id of the extension

getContentTypes

protected Collection<String> getContentTypes(AdditionalParameterValueMap additionalParameterValues)

Description copied from class: AbstractContentBasedReturnable

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

Specified by:

getContentTypes in class AbstractContentBasedReturnable

Parameters:

additionalParameterValues - The additional parameter values

Returns:

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

getSaxer

public ReturnableSaxer getSaxer(Collection<Returnable> allReturnables,
                                AdditionalParameterValueMap additionalParameterValues)

Description copied from interface: Returnable

Returns the saxer responsible to SAX hits of this Returnable.

Parameters:

allReturnables - All Returnables (including this)

additionalParameterValues - The additional parameter values

Returns:

the saxer responsible to SAX hits of this Returnable.

getViewForSax

protected String getViewForSax(AdditionalParameterValueMap additionalParameterValues)

Gets the view for saxing

Parameters:

additionalParameterValues - The additional parameter values

Returns:

the view for saxing

getDefinitionPrefix

protected String getDefinitionPrefix()

Description copied from class: AbstractContentBasedReturnable

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

Specified by:

getDefinitionPrefix in class AbstractContentBasedReturnable

Returns:

the prefix for definitions