Package org.ametys.plugins.workspaces.search.module

Class NewsSearchModuleGenerator

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.workspaces.search.module.AbstractSearchModuleGenerator

org.ametys.plugins.workspaces.search.module.AbstractSolrSearchModuleGenerator

org.ametys.plugins.workspaces.search.module.AbstractContentSolrSearchModuleGenerator

org.ametys.plugins.workspaces.search.module.NewsSearchModuleGenerator

All Implemented Interfaces:

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

public class NewsSearchModuleGenerator
extends AbstractContentSolrSearchModuleGenerator

Generator for posts search module

Field Summary

Fields inherited from class org.ametys.plugins.workspaces.search.module.AbstractContentSolrSearchModuleGenerator

_contentSearcherFactory, _cTypesHelper, _tagProviderEP

Fields inherited from class org.ametys.plugins.workspaces.search.module.AbstractSearchModuleGenerator

_categoryHelper, _categoryProviderEP, _currentUserProvider, _projectManager, _projectMembers, _resolver, _rightManager, _siteManager, _userHelper, _workspaceModuleEP

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

Method Summary

Modifier and Type	Method	Description
protected Query	getCatalogNewsQuery(Request request, String siteName)	Get the query for catalog's news
protected Query	getProjectNewsQuery(Request request, String lang, List<Project> projects)	Get the query for projects' news
protected Query	getQuery(String siteName, String lang, String textfield, Request request)	Get the search query
protected ContentSearcherFactory.SimpleContentSearcher	getSearcher()	Get the searcher
protected List<String>	getSiteNames(List<Project> projects)	Get the list of sites linked to the list of projects
protected Query	getSiteQuery(List<Project> projects)	Create a query to match the sites corresponding to the projects If projects is empty or null, then it will match nothing Else it will match the sites linked to the projects
protected String	getSortFieldName()	The sort field name
protected Sort.Order	getSortOrder()	The sort order
protected void	saxAdditionalInformation(Content content)	SAX additional information on content
protected void	saxCategory(Content content)	SAX category
void	service(ServiceManager smanager)

Methods inherited from class org.ametys.plugins.workspaces.search.module.AbstractContentSolrSearchModuleGenerator

getSearchResults, saxHit, saxPage, saxTags

Methods inherited from class org.ametys.plugins.workspaces.search.module.AbstractSolrSearchModuleGenerator

saxHits

Methods inherited from class org.ametys.plugins.workspaces.search.module.AbstractSearchModuleGenerator

filterProjectsForModule, generate, getCategories, getProject, getProjects, saxCategory, saxCategoryColor, saxHits, saxProject, saxUser

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 Details

NewsSearchModuleGenerator

public NewsSearchModuleGenerator()

Method Details

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractContentSolrSearchModuleGenerator

Throws:

ServiceException

getSearcher

protected ContentSearcherFactory.SimpleContentSearcher getSearcher()

Description copied from class: AbstractContentSolrSearchModuleGenerator

Get the searcher

Specified by:

getSearcher in class AbstractContentSolrSearchModuleGenerator

Returns:

the searcher

getSortFieldName

protected String getSortFieldName()

Description copied from class: AbstractContentSolrSearchModuleGenerator

The sort field name

Specified by:

getSortFieldName in class AbstractContentSolrSearchModuleGenerator

Returns:

the sort field name

getSortOrder

protected Sort.Order getSortOrder()

Description copied from class: AbstractContentSolrSearchModuleGenerator

The sort order

Specified by:

getSortOrder in class AbstractContentSolrSearchModuleGenerator

Returns:

the sort order

getQuery

protected Query getQuery(String siteName,
 String lang,
 String textfield,
 Request request)

Description copied from class: AbstractContentSolrSearchModuleGenerator

Get the search query

Specified by:

getQuery in class AbstractContentSolrSearchModuleGenerator

Parameters:

siteName - the current site name

lang - the current language

textfield - the search input

request - the request

Returns:

the search query

getProjectNewsQuery

protected Query getProjectNewsQuery(Request request,
 String lang,
 List<Project> projects)

Get the query for projects' news

Parameters:

request - the request

lang - the language

projects - the targeted projects

Returns:

the query

getCatalogNewsQuery

protected Query getCatalogNewsQuery(Request request,
 String siteName)

Get the query for catalog's news

Parameters:

request - the request

siteName - the current site name

Returns:

the query

getSiteQuery

protected Query getSiteQuery(List<Project> projects)

Create a query to match the sites corresponding to the projects If projects is empty or null, then it will match nothing Else it will match the sites linked to the projects

Parameters:

projects - projects to filter

Returns:

a Query to match the sites linked to the projects

getSiteNames

protected List<String> getSiteNames(List<Project> projects)

Get the list of sites linked to the list of projects

Parameters:

projects - a list of projects where we want to get the list of sites

Returns:

a list of site names, or null if the projects were null;

saxAdditionalInformation

protected void saxAdditionalInformation(Content content)
                                 throws SAXException

Description copied from class: AbstractContentSolrSearchModuleGenerator

SAX additional information on content

Overrides:

saxAdditionalInformation in class AbstractContentSolrSearchModuleGenerator

Parameters:

content - the content

Throws:

SAXException - if an error occurs while saxing

saxCategory

protected void saxCategory(Content content)
                    throws SAXException

SAX category

Parameters:

content - the news content

Throws:

SAXException - if an error occured while saxing