Package org.ametys.plugins.ai.rest

Class AbstractSearchAction

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.apache.cocoon.acting.AbstractAction

org.apache.cocoon.acting.ServiceableAction

org.ametys.plugins.ai.rest.AbstractSearchAction

All Implemented Interfaces:

Component, LogEnabled, Serviceable, Action

Direct Known Subclasses:

GetSearchModelConfigurationAction, GetSolrSearchAction

public abstract class AbstractSearchAction
extends ServiceableAction

Action that handle operation related to search

Field Summary

Fields

Modifier and Type	Field	Description
protected LocaleHelper	_localeHelper	The locale helper
protected SearchUIModelExtensionPoint	_searchModelEP	The search model extension point

Fields inherited from class org.apache.cocoon.acting.ServiceableAction

manager

Fields inherited from class org.apache.cocoon.acting.AbstractAction

EMPTY_MAP

Fields inherited from interface org.apache.cocoon.acting.Action

ROLE

Constructor Summary

Constructors

Constructor	Description
AbstractSearchAction()

Method Summary

Modifier and Type	Method	Description
protected boolean	_canBeFlattened(ViewItemAccessor accessor, ViewItemAccessor parent)	Determine if an accessor can be flatened inside a parent accessor ie, the accessor contains a single item that is a leaf with a name not already present in the parent
protected Object	_elementToJson(ModelAwareDataHolder dataHolder, ElementDefinition definition, DataContext dataContext, Map<String,Object> contextualParameters)	Serialize as JSON the value of a data holder element
Map	act(Redirector redirector, SourceResolver resolver, Map objectModel, String source, Parameters parameters)
protected abstract Map	doAct(Request request, SearchUIModel searchModel, Map<String,Object> contextualParameters)	Actual operation
protected List<SearchModelCriterionViewItem>	getCriteria(SearchModel searchModel, Map<String,Object> contextualParameters)	Get the criteria as a list instead of tree
void	service(ServiceManager serviceManager)

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

_localeHelper

protected LocaleHelper _localeHelper

The locale helper

_searchModelEP

protected SearchUIModelExtensionPoint _searchModelEP

The search model extension point

Constructor Details

AbstractSearchAction

public AbstractSearchAction()

Method Details

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class ServiceableAction

Throws:

ServiceException

act

public Map act(Redirector redirector,
 SourceResolver resolver,
 Map objectModel,
 String source,
 Parameters parameters)
        throws Exception

Throws:

Exception

doAct

protected abstract Map doAct(Request request,
 SearchUIModel searchModel,
 Map<String,Object> contextualParameters)
                      throws Exception

Actual operation

Parameters:

request - the request

searchModel - the requested search model

contextualParameters - a map of contextual parameters

Returns:

the action result

Throws:

Exception - if an error occurs

_canBeFlattened

protected boolean _canBeFlattened(ViewItemAccessor accessor,
 ViewItemAccessor parent)

Determine if an accessor can be flatened inside a parent accessor ie, the accessor contains a single item that is a leaf with a name not already present in the parent

Parameters:

accessor - the accessor to test

parent - the parent of the accessor

Returns:

true if the hierarchy of this accessor can be flatened in the parent

getCriteria

protected List<SearchModelCriterionViewItem> getCriteria(SearchModel searchModel,
 Map<String,Object> contextualParameters)

Get the criteria as a list instead of tree

Parameters:

searchModel - the search model

contextualParameters - the contextual parameters

Returns:

the list of criteria

_elementToJson

protected Object _elementToJson(ModelAwareDataHolder dataHolder,
 ElementDefinition definition,
 DataContext dataContext,
 Map<String,Object> contextualParameters)

Serialize as JSON the value of a data holder element

Parameters:

dataHolder - the data holder containing the data

definition - the definition of the element to serialize

dataContext - the data context of the data holder

contextualParameters - the contextual parameters

Returns:

the JSON value