org.ametys.plugins.tagcloud.generators

Class TagCloudOnTagsGenerator

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

All Implemented Interfaces:

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

public class TagCloudOnTagsGenerator
extends AbstractTagCloudGenerator

Generates a tag cloud based upon content tags

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	TagCloudOnTagsGenerator.TagTagCloudItem Class representing an item of tag cloud

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

AbstractTagCloudGenerator.ItemOccurrenceComparator, AbstractTagCloudGenerator.TagCloudItem

Field Summary

Fields

Modifier and Type	Field and Description
protected TagProviderExtensionPoint	_tagExtPt The TagProviderExtensionPoint

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 and Description
TagCloudOnTagsGenerator()

Method Summary

Modifier and Type	Method and Description
private void	_addTagQuery(Collection<Query> queries, String tagName)
private List<Tag>	_getTags(String siteName, String[] tagArray)
protected void	_saxAdditionalAttributes(AbstractTagCloudGenerator.TagCloudItem item, AttributesImpl attrs) Sax additional attributes for item
protected Query	getQuery(String siteName, String language, String tagName, String[] contentTypes, String[] pages) Get the query
protected List<AbstractTagCloudGenerator.TagCloudItem>	getTagCloudItems(String siteName, String lang, CompositeMetadata serviceParameters) Get the tag cloud items
void	service(ServiceManager serviceManager)

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

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

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

_tagExtPt

protected TagProviderExtensionPoint _tagExtPt

The TagProviderExtensionPoint

Constructor Detail

TagCloudOnTagsGenerator

public TagCloudOnTagsGenerator()

Method Detail

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractTagCloudGenerator

Throws:

ServiceException

getTagCloudItems

protected List<AbstractTagCloudGenerator.TagCloudItem> getTagCloudItems(String siteName,
                                                                        String lang,
                                                                        CompositeMetadata 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

_saxAdditionalAttributes

protected void _saxAdditionalAttributes(AbstractTagCloudGenerator.TagCloudItem item,
                                        AttributesImpl attrs)
                                 throws SAXException

Description copied from class: AbstractTagCloudGenerator

Sax additional attributes for item

Overrides:

_saxAdditionalAttributes in class AbstractTagCloudGenerator

Parameters:

item - The tag cloud item

attrs - The attributes

Throws:

SAXException - if an error occurs while saxing

getQuery

protected Query getQuery(String siteName,
                         String language,
                         String tagName,
                         String[] contentTypes,
                         String[] pages)

Get the query

Parameters:

siteName - The site name.

language - The current language.

tagName - The tag name

contentTypes - The content types

pages - The pages

Returns:

the query

Throws:

IllegalArgumentException - If the search field is invalid

_addTagQuery

private void _addTagQuery(Collection<Query> queries,
                          String tagName)

_getTags

private List<Tag> _getTags(String siteName,
                           String[] tagArray)