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

Class DocumentSearchModuleGenerator

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

All Implemented Interfaces:

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

public class DocumentSearchModuleGenerator
extends AbstractSolrSearchModuleGenerator

Generator for posts search module

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) class	DocumentSearchModuleGenerator.EmptySearchResults<A extends AmetysObject>
(package private) class	DocumentSearchModuleGenerator.EmptySearchResultsIterable<A extends AmetysObject>
(package private) class	DocumentSearchModuleGenerator.EmptySearchResultsIterator<A extends AmetysObject>

Field Summary

Fields

Modifier and Type	Field	Description
protected ContentTypesHelper	_cTypesHelper	The content types helper
protected SearcherFactory	_searcherFactory	Searcher Factory
protected WorkspacesHelper	_workspaceHelper	Workspace Helper

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

Method Summary

Modifier and Type	Method	Description
protected SearchResults<? extends AmetysObject>	getSearchResults(String siteName, String lang, String textfield, Request request, int offset, int limit)	Get the search results
protected void	saxHit(AmetysObject object, String lang)	Sax the content hit
void	service(ServiceManager smanager)

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

Field Detail

_searcherFactory

protected SearcherFactory _searcherFactory

Searcher Factory

_cTypesHelper

protected ContentTypesHelper _cTypesHelper

The content types helper

_workspaceHelper

protected WorkspacesHelper _workspaceHelper

Workspace Helper

Constructor Detail

DocumentSearchModuleGenerator

public DocumentSearchModuleGenerator()

Method Detail

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractSolrSearchModuleGenerator

Throws:

ServiceException

getSearchResults

protected SearchResults<? extends AmetysObject> getSearchResults(String siteName,
                                                                 String lang,
                                                                 String textfield,
                                                                 Request request,
                                                                 int offset,
                                                                 int limit)
                                                          throws Exception

Description copied from class: AbstractSolrSearchModuleGenerator

Get the search results

Specified by:

getSearchResults in class AbstractSolrSearchModuleGenerator

Parameters:

siteName - the current site name

lang - the current language

textfield - the search input

request - the request

offset - the search offset

limit - the max number of results

Returns:

the search results

Throws:

Exception - if the search failed

saxHit

protected void saxHit(AmetysObject object,
                      String lang)
               throws Exception

Description copied from class: AbstractSearchModuleGenerator

Sax the content hit

Specified by:

saxHit in class AbstractSearchModuleGenerator

Parameters:

object - the AmetysObject

lang - the language

Throws:

Exception - if an error occurred while saxing result