org.ametys.cms.search.cocoon

Class SearchGenerator

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.SearchGenerator

All Implemented Interfaces:

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

public class SearchGenerator
extends ServiceableGenerator

Generate contents returned by the SearchAction.

Field Summary

Fields

Modifier and Type	Field and Description
protected ContentTypesHelper	_contentTypesHelper Helper for content types
protected AmetysObjectResolver	_resolver The AmetysObjectResolver
protected ServerCommHelper	_serverCommHelper The server comm helper
protected UserManager	_userManager The user manager.
protected ContentValuesExtractorFactory	_valuesExtractorFactory The content values extractor factory.

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

Method Summary

Modifier and Type	Method and Description
void	generate()
protected void	generateContentLabel(ResultField resultField, Object value) Generate the label of an content value.
protected void	generateEnumeratedLabel(ResultField resultField, Object value) Generate the label of an enumerated value.
protected void	generateUserLabel(ResultField resultField, Object value) Generate the label of an user value.
protected void	saxContent(Content content, Collection<SearchUIColumn> fields, Map<String,Object> values, boolean generateLabels, String language) Generate the content's values.
protected void	saxLabel(ResultField resultField, Object value, String language) Generate a human-readable representation of a result field for a content.
protected void	saxValue(ResultField resultField, Object value) Generate the value of a result field for a content.
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

_resolver

protected AmetysObjectResolver _resolver

The AmetysObjectResolver

_userManager

protected UserManager _userManager

The user manager.

_contentTypesHelper

protected ContentTypesHelper _contentTypesHelper

Helper for content types

_serverCommHelper

protected ServerCommHelper _serverCommHelper

The server comm helper

_valuesExtractorFactory

protected ContentValuesExtractorFactory _valuesExtractorFactory

The content values extractor factory.

Constructor Detail

SearchGenerator

public SearchGenerator()

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

saxContent

protected void saxContent(Content content,
                          Collection<SearchUIColumn> fields,
                          Map<String,Object> values,
                          boolean generateLabels,
                          String language)
                   throws SAXException

Generate the content's values.

Parameters:

content - The content.

fields - The model result fields.

values - The content values, extracted from the fields.

generateLabels - true to generate value labels, false to generate raw values.

language - The language.

Throws:

SAXException - If an error occurs generating the XML.

saxValue

protected void saxValue(ResultField resultField,
                        Object value)
                 throws SAXException

Generate the value of a result field for a content.

Parameters:

resultField - The result field.

value - The content value.

Throws:

SAXException - If an error occurs generating the XML.

saxLabel

protected void saxLabel(ResultField resultField,
                        Object value,
                        String language)
                 throws SAXException

Generate a human-readable representation of a result field for a content.

Parameters:

resultField - The result field.

value - The content value.

language - The language.

Throws:

SAXException - If an error occurs generating the XML.

generateUserLabel

protected void generateUserLabel(ResultField resultField,
                                 Object value)
                          throws SAXException

Generate the label of an user value.

Parameters:

resultField - The result field.

value - The content value.

Throws:

SAXException - If an error occurs generating the XML.

generateContentLabel

protected void generateContentLabel(ResultField resultField,
                                    Object value)
                             throws SAXException

Generate the label of an content value.

Parameters:

resultField - The result field.

value - The content value.

Throws:

SAXException - If an error occurs generating the XML.

generateEnumeratedLabel

protected void generateEnumeratedLabel(ResultField resultField,
                                       Object value)
                                throws SAXException

Generate the label of an enumerated value.

Parameters:

resultField - The result field.

value - The content value.

Throws:

SAXException - If an error occurs generating the XML.