Package org.ametys.cms.search.cocoon

Class ModelColumnsGenerator

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.cms.search.cocoon.ModelColumnsGenerator

All Implemented Interfaces:

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

Direct Known Subclasses:

SolrModelColumnsGenerator

public class ModelColumnsGenerator
extends ServiceableGenerator

SAX the columns of a search tool model.

Field Summary

Fields

Modifier and Type	Field	Description
protected ColumnHelper	_columnHelper	The helper for columns
protected ContentTypesHelper	_cTypeHelper	The content type helper.
protected SearchUIModelExtensionPoint	_searchModelManager	The extenstion point for search UI
protected ServerCommHelper	_serverCommHelper	The servercomm helper

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

Method Summary

Modifier and Type	Method	Description
private List<ColumnHelper.Column>	_getColumns(SearchUIModel model, Map<String,Object> jsParameters, Map<String,Object> contextualParameters)
void	generate()
protected List<ColumnHelper.Column>	getColumnsFromParameters(Map<String,Object> jsParameters, Set<String> contentTypes)	Get the columns from JS parameters
protected SearchUIModel	getSearchModel(Map<String,Object> jsParameters)	Get search model.
protected void	saxColumn(SearchUIColumn column, Optional<String> label)	Sax search column.
protected void	saxColumns(Map<String,Object> jsParameters)	Sax search columns.
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

_searchModelManager

protected SearchUIModelExtensionPoint _searchModelManager

The extenstion point for search UI

_serverCommHelper

protected ServerCommHelper _serverCommHelper

The servercomm helper

_cTypeHelper

protected ContentTypesHelper _cTypeHelper

The content type helper.

_columnHelper

protected ColumnHelper _columnHelper

The helper for columns

Constructor Detail

ModelColumnsGenerator

public ModelColumnsGenerator()

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

getSearchModel

protected SearchUIModel getSearchModel(Map<String,Object> jsParameters)

Get search model.

Parameters:

jsParameters - JS parameters

Returns:

the search model

saxColumns

protected void saxColumns(Map<String,Object> jsParameters)
                   throws SAXException

Sax search columns.

Parameters:

jsParameters - JS parameters

Throws:

SAXException - if an error occurs

_getColumns

private List<ColumnHelper.Column> _getColumns(SearchUIModel model,
                                              Map<String,Object> jsParameters,
                                              Map<String,Object> contextualParameters)

saxColumn

protected void saxColumn(SearchUIColumn column,
                         Optional<String> label)
                  throws SAXException

Sax search column.

Parameters:

column - Column to SAX

label - The label of the column. Cannot be null

Throws:

SAXException - if an error occurs

getColumnsFromParameters

protected List<ColumnHelper.Column> getColumnsFromParameters(Map<String,Object> jsParameters,
                                                             Set<String> contentTypes)

Get the columns from JS parameters

Parameters:

jsParameters - The JS parameters

contentTypes - The content type

Returns:

the requested columns