Package org.ametys.plugins.tagcloud.generators

Class TagCloudOnWordsGenerator

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.tagcloud.generators.AbstractTagCloudGenerator

org.ametys.plugins.tagcloud.generators.TagCloudOnWordsGenerator

All Implemented Interfaces:

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

public class TagCloudOnWordsGenerator
extends AbstractTagCloudGenerator

Generates a tag cloud based upon words

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	TagCloudOnWordsGenerator.WordTagCloudItem

Nested classes/interfaces inherited from class org.ametys.plugins.tagcloud.generators.AbstractTagCloudGenerator

AbstractTagCloudGenerator.ItemOccurrenceComparator, AbstractTagCloudGenerator.TagCloudItem

Field Summary

Fields inherited from class org.ametys.plugins.tagcloud.generators.AbstractTagCloudGenerator

_cacheManager, _context, _resolver, _solrClient, _solrClientProvider, OCCURRENCE_COMPARATOR

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

Method Summary

Modifier and Type	Method	Description
private void	_addTextFieldQuery(Collection<Query> queries, String language, String keyword)
protected Query	getQuery(String siteName, String language, String keyword, String[] contentTypes, String[] pages)	Get the query
protected List<AbstractTagCloudGenerator.TagCloudItem>	getTagCloudItems(String siteName, String lang, ModelAwareDataHolder serviceParameters)	Get the tag cloud items

Methods inherited from class org.ametys.plugins.tagcloud.generators.AbstractTagCloudGenerator

_addContentTypeQuery, _addPagesQuery, _getFontSize, _saxAdditionalAttributes, _saxContentTypeCriteria, _saxFormParameters, _saxSitemapCriteria, build, contextualize, generate, saxTagCloudItem, service

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

Constructor Detail

TagCloudOnWordsGenerator

public TagCloudOnWordsGenerator()

Method Detail

getTagCloudItems

protected List<AbstractTagCloudGenerator.TagCloudItem> getTagCloudItems(String siteName,
                                                                        String lang,
                                                                        ModelAwareDataHolder serviceParameters)
                                                                 throws IOException,
                                                                        ProcessingException

Description copied from class: AbstractTagCloudGenerator

Get the tag cloud items

Specified by:

getTagCloudItems in class AbstractTagCloudGenerator

Parameters:

siteName - The site name

lang - The language

serviceParameters - The service parameters

Returns:

The list og tag cloud item

Throws:

IOException - if an error occurs when manipulating files

ProcessingException - if an error occurs during the retrieving of the tag cloud items

getQuery

protected Query getQuery(String siteName,
                         String language,
                         String keyword,
                         String[] contentTypes,
                         String[] pages)
                  throws IllegalArgumentException

Get the query

Parameters:

siteName - The site name.

language - The current language.

keyword - The key word

contentTypes - The content types

pages - The pages

Returns:

the query object.

Throws:

IllegalArgumentException - If the search field is invalid

_addTextFieldQuery

private void _addTextFieldQuery(Collection<Query> queries,
                                String language,
                                String keyword)
                         throws IllegalArgumentException

Throws:

IllegalArgumentException