Package org.ametys.plugins.externaldata.data

Class ExternalSearchGenerator

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.plugins.externaldata.data.ExternalSearchGenerator

All Implemented Interfaces:

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

public class ExternalSearchGenerator
extends ServiceableGenerator

Generator for external data search service

Field Summary

Fields

Modifier and Type	Field	Description
private static String	__SEARCH_CRITERIA_PREFIX
protected DataSourceFactoryExtensionPoint	_dataSourceFactoryEP	Datasource factory handler
protected QueryDao	_queryDao	The Query DAO.

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	Description
ExternalSearchGenerator()

Method Summary

Modifier and Type	Method	Description
protected void	executeQuery(Query query, Map<String,String> parameterValues, int nbResultsPerPage, int page)	Execute ldap query
void	generate()
protected int	getPageIndex(Request request)	Get the page index
protected Map<String,String>	getParameterValues(Request request, Query query)	Get the search criteria values from request
protected void	saxFormFields(Query query)	SAX the form search criteria
protected void	saxFormParameters(Request request, Query query, Map<String,String> values)	SAX the search parameters from the request parameters and query
protected void	saxFormValues(Request request, Map<String,String> values)	SAX the form search criteria values
protected void	saxPagination(int page, int offset, int limit, int nbResult, boolean hasMoreResult)	SAX the pagination
protected void	saxResult(Query query, QueryResult result)	Sax a query result.
void	service(ServiceManager smanager)

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

dispose

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

recycle, setup

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

setConsumer, setContentHandler, setLexicalHandler

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

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

setConsumer

Field Detail

__SEARCH_CRITERIA_PREFIX

private static final String __SEARCH_CRITERIA_PREFIX

See Also:

Constant Field Values

_queryDao

protected QueryDao _queryDao

The Query DAO.

_dataSourceFactoryEP

protected DataSourceFactoryExtensionPoint _dataSourceFactoryEP

Datasource factory handler

Constructor Detail

ExternalSearchGenerator

public ExternalSearchGenerator()

Method Detail

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class ServiceableGenerator

Throws:

ServiceException

generate

public void generate()
              throws IOException,
                     SAXException,
                     ProcessingException

Throws:

IOException

SAXException

ProcessingException

getParameterValues

protected Map<String,String> getParameterValues(Request request,
                                                      Query query)

Get the search criteria values from request

Parameters:

request - The request

query - The LDAP query

Returns:

the values

saxFormParameters

protected void saxFormParameters(Request request,
                                 Query query,
                                 Map<String,String> values)
                          throws SAXException

SAX the search parameters from the request parameters and query

Parameters:

request - The request

query - The LDAP query

values - The extracted form values

Throws:

SAXException - If an error occurs while SAXing

saxFormFields

protected void saxFormFields(Query query)
                      throws SAXException

SAX the form search criteria

Parameters:

query - The LDAP query

Throws:

SAXException - if an error occurs while SAXing

saxFormValues

protected void saxFormValues(Request request,
                             Map<String,String> values)
                      throws SAXException

SAX the form search criteria values

Parameters:

request - The request

values - The extracted form values

Throws:

SAXException - if an error occurs while SAXing

executeQuery

protected void executeQuery(Query query,
                            Map<String,String> parameterValues,
                            int nbResultsPerPage,
                            int page)
                     throws DataInclusionException,
                            SAXException

Execute ldap query

Parameters:

query - the ldap query

parameterValues - the search criteria

nbResultsPerPage - the number of result per page

page - the page number

Throws:

DataInclusionException - if an error occurred

SAXException - If an error occurred

saxPagination

protected void saxPagination(int page,
                             int offset,
                             int limit,
                             int nbResult,
                             boolean hasMoreResult)
                      throws SAXException

SAX the pagination

Parameters:

page - the current page

offset - the offset

limit - the number of results per page

nbResult - the number result of the page

hasMoreResult - true if there are less one page more

Throws:

SAXException - if an error occurred

saxResult

protected void saxResult(Query query,
                         QueryResult result)
                  throws SAXException

Sax a query result.

Parameters:

query - the query.

result - the result to generate.

Throws:

SAXException - if an error occurs while saxing

getPageIndex

protected int getPageIndex(Request request)

Get the page index

Parameters:

request - The request

Returns:

The page index