org.ametys.web.frontoffice.search.requesttime

Class SearchServiceGenerator

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.apache.cocoon.xml.AbstractXMLProducer

org.apache.cocoon.generation.AbstractGenerator

org.apache.cocoon.generation.ServiceableGenerator

org.ametys.web.frontoffice.search.requesttime.SearchServiceGenerator

All Implemented Interfaces:

Poolable, Recyclable, Disposable, Component, LogEnabled, Serviceable, Generator, SitemapModelComponent, XMLProducer

public class SearchServiceGenerator
extends ServiceableGenerator

Generator for the search service.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	SearchServiceGenerator.SearchComponentError

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static String	__PAGINATION_GENERATOR_PARAM_NAME
(package private) static String	__SUBMIT_FORM_PARAM_NAME
(package private) static String	__ZONE_ITEM_GENERATOR_PARAM_NAME
(package private) static String	__ZONE_ITEM_REQUEST_PARAM_NAME
protected AmetysObjectResolver	_ametysObjectResolver The resolver for Ametys objects
protected Logger	_logger The SL4j logger
protected RenderingContextHandler	_renderingContextHandler The handler of rendering context
protected SearchServiceRequestAttributeSetter	_requestAttributeSetter The setter of request attributes
protected SearchComponentExtensionPoint	_searchComponentEP The extension point for SearchComponents
protected SearcherFactory	_searcherFactory The searcher factory
protected SearchService	_searchService The search Service
protected SearchServiceInstanceManager	_searchServiceInstanceManager The manager for SearchServiceInstances
protected SearchUserInputsRetriever	_searchUserInputsRetriever The search user inputs retriever
protected SiteManager	_siteManager The site manager

Fields inherited from class org.apache.cocoon.generation.ServiceableGenerator

manager

Fields inherited from class org.apache.cocoon.generation.AbstractGenerator

objectModel, parameters, resolver, source

Fields inherited from class org.apache.cocoon.xml.AbstractXMLProducer

contentHandler, EMPTY_CONTENT_HANDLER, lexicalHandler, xmlConsumer

Fields inherited from interface org.apache.cocoon.generation.Generator

ROLE

Constructor Summary

Constructors

Constructor and Description
SearchServiceGenerator()

Method Summary

Modifier and Type	Method and Description
protected SearchComponentArguments	_buildArguments(Request request) Builds SearchComponentArguments
protected int	_computeResultsPerPage(SearchServiceInstance serviceInstance) Computes the number of results per page
protected int	_computeStartIndex(int pageIndex, SearchServiceInstance serviceInstance) Computes the start index (i.e.
protected SearchServiceDebugModeHelper.DebugMode	_debugMode(Request request) Gets the debug mode if activated
protected String	_getRequestIdentifier(Request request) Gets the identifier of the request for display debug purposes only
protected void	_handleErrors(List<SearchServiceGenerator.SearchComponentError> errors) Handles errors of SearchComponents
protected boolean	_inputValid(Request request, SearchServiceInstance serviceInstance, SearchServiceDebugModeHelper.DebugMode debugMode) Checks if inputs are valid
protected boolean	_isFormSubmitted(Request request) Checks if the form was submitted
protected Optional<Integer>	_resultsPerPage(SearchServiceInstance serviceInstance) Gets the number of results per page
protected String	_retrieveCurrentLang(Request request, Page page) Retrieves the current lang
protected Page	_retrieveCurrentPage(Request request, String zoneItemId) Retrieves the current page
protected Site	_retrieveCurrentSite(Request request, Page page) Retrieves the current site
protected int	_retrievePageIndex(Request request) Retrieves the current page index of the search
protected String	_retrieveZoneItemId(Request request) Retrieves the current zone item id
void	enableLogging(Logger logger)
void	generate()
protected SearchServiceInstance	getInstance(Request request, String zoneItemId) Gets the SearchServiceInstance being processed
void	service(ServiceManager smanager)
void	setup(SourceResolver sourceResolver, Map objModel, String src, Parameters par)

Methods inherited from class org.apache.cocoon.generation.ServiceableGenerator

dispose

Methods inherited from class org.apache.cocoon.generation.AbstractGenerator

recycle

Methods inherited from class org.apache.cocoon.xml.AbstractXMLProducer

setConsumer, setContentHandler, setLexicalHandler

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

getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.cocoon.xml.XMLProducer

setConsumer

Field Detail

__ZONE_ITEM_REQUEST_PARAM_NAME

static final String __ZONE_ITEM_REQUEST_PARAM_NAME

See Also:

Constant Field Values

__ZONE_ITEM_GENERATOR_PARAM_NAME

static final String __ZONE_ITEM_GENERATOR_PARAM_NAME

See Also:

Constant Field Values

__PAGINATION_GENERATOR_PARAM_NAME

static final String __PAGINATION_GENERATOR_PARAM_NAME

See Also:

Constant Field Values

__SUBMIT_FORM_PARAM_NAME

static final String __SUBMIT_FORM_PARAM_NAME

See Also:

Constant Field Values

_logger

protected Logger _logger

The SL4j logger

_searchServiceInstanceManager

protected SearchServiceInstanceManager _searchServiceInstanceManager

The manager for SearchServiceInstances

_searchService

protected SearchService _searchService

The search Service

_siteManager

protected SiteManager _siteManager

The site manager

_searcherFactory

protected SearcherFactory _searcherFactory

The searcher factory

_searchComponentEP

protected SearchComponentExtensionPoint _searchComponentEP

The extension point for SearchComponents

_renderingContextHandler

protected RenderingContextHandler _renderingContextHandler

The handler of rendering context

_ametysObjectResolver

protected AmetysObjectResolver _ametysObjectResolver

The resolver for Ametys objects

_searchUserInputsRetriever

protected SearchUserInputsRetriever _searchUserInputsRetriever

The search user inputs retriever

_requestAttributeSetter

protected SearchServiceRequestAttributeSetter _requestAttributeSetter

The setter of request attributes

Constructor Detail

SearchServiceGenerator

public SearchServiceGenerator()

Method Detail

enableLogging

public void enableLogging(Logger logger)

Specified by:

enableLogging in interface LogEnabled

Overrides:

enableLogging in class AbstractLogEnabled

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class ServiceableGenerator

Throws:

ServiceException

setup

public void setup(SourceResolver sourceResolver,
                  Map objModel,
                  String src,
                  Parameters par)
           throws ProcessingException,
                  SAXException,
                  IOException

Specified by:

setup in interface SitemapModelComponent

Overrides:

setup in class AbstractGenerator

Throws:

ProcessingException

SAXException

IOException

_buildArguments

protected SearchComponentArguments _buildArguments(Request request)
                                            throws ProcessingException

Builds SearchComponentArguments

Parameters:

request - The request

Returns:

The built SearchComponentArguments

Throws:

ProcessingException - If an error occured when processing the request

generate

public void generate()
              throws IOException,
                     SAXException,
                     ProcessingException

Throws:

IOException

SAXException

ProcessingException

_retrieveZoneItemId

protected String _retrieveZoneItemId(Request request)

Retrieves the current zone item id

Parameters:

request - the request

Returns:

the zone item id

getInstance

protected SearchServiceInstance getInstance(Request request,
                                            String zoneItemId)

Gets the SearchServiceInstance being processed

Parameters:

request - the request

zoneItemId - The zone item id

Returns:

the SearchServiceInstance being processed

_retrievePageIndex

protected int _retrievePageIndex(Request request)
                          throws ProcessingException

Retrieves the current page index of the search

Parameters:

request - the request

Returns:

the current page index of the search

Throws:

ProcessingException - If an error occured when retrieving the page index

_resultsPerPage

protected Optional<Integer> _resultsPerPage(SearchServiceInstance serviceInstance)

Gets the number of results per page

Parameters:

serviceInstance - the search service instance

Returns:

the real number of results per page

_computeStartIndex

protected int _computeStartIndex(int pageIndex,
                                 SearchServiceInstance serviceInstance)

Computes the start index (i.e. offset) of the search

Parameters:

pageIndex - the page index

serviceInstance - the search service instance

Returns:

the start index

_computeResultsPerPage

protected int _computeResultsPerPage(SearchServiceInstance serviceInstance)

Computes the number of results per page

Parameters:

serviceInstance - the search service instance

Returns:

the number of results per page

_retrieveCurrentPage

protected Page _retrieveCurrentPage(Request request,
                                    String zoneItemId)

Retrieves the current page

Parameters:

request - the request

zoneItemId - The zone item id

Returns:

the current page

_retrieveCurrentSite

protected Site _retrieveCurrentSite(Request request,
                                    Page page)

Retrieves the current site

Parameters:

request - the request

page - the page

Returns:

the current site

_retrieveCurrentLang

protected String _retrieveCurrentLang(Request request,
                                      Page page)

Retrieves the current lang

Parameters:

request - the request

page - the page

Returns:

the current lang

_isFormSubmitted

protected boolean _isFormSubmitted(Request request)

Checks if the form was submitted

Parameters:

request - The request

Returns:

true if the form was submitted

_inputValid

protected boolean _inputValid(Request request,
                              SearchServiceInstance serviceInstance,
                              SearchServiceDebugModeHelper.DebugMode debugMode)

Checks if inputs are valid

Parameters:

request - The request

serviceInstance - The service instance being processed

debugMode - The debug mode

Returns:

true if inputs are valid

_debugMode

protected SearchServiceDebugModeHelper.DebugMode _debugMode(Request request)

Gets the debug mode if activated

Parameters:

request - The request

Returns:

the debug mode if activated

_getRequestIdentifier

protected String _getRequestIdentifier(Request request)

Gets the identifier of the request for display debug purposes only

Parameters:

request - the request

Returns:

the identifier of the request for display debug purposes only

_handleErrors

protected void _handleErrors(List<SearchServiceGenerator.SearchComponentError> errors)
                      throws ProcessingException

Handles errors of SearchComponents

Parameters:

errors - The errors

Throws:

ProcessingException - if the SearchServiceGenerator.SearchComponentErrors lead to a need to throw an exception