Package org.ametys.plugins.forms.indexing.solr

Class FormEntryDocumentProvider

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.forms.indexing.solr.FormEntryDocumentProvider

All Implemented Interfaces:

LogEnabled, SiteDocumentProvider, Contextualizable, Serviceable

public class FormEntryDocumentProvider
extends AbstractLogEnabled
implements SiteDocumentProvider, Serviceable, Contextualizable

DocumentProvider for indexing form entries during workspace indexation

Field Summary

Fields

Modifier and Type	Field	Description
protected Context	_context	The context
protected SolrFormEntryIndexer	_solrFormEntryIndexer	The Solr form entry indexer.
static final List<String>	SOLR_WORKSPACES	The list of Solr repositories to index form entries into.

Constructor Summary

Constructors

Constructor	Description
FormEntryDocumentProvider()

Method Summary

Modifier and Type	Method	Description
void	contextualize(Context context)
I18nizableText	getLabel()	The label of the document provider
void	indexSiteDocuments(Site site, String workspaceName, org.apache.solr.client.solrj.SolrClient solrClient, ContainerProgressionTracker progressionTracker)	Add documents to the index.
void	indexSitemapDocuments(Sitemap sitemap, String workspaceName, org.apache.solr.client.solrj.SolrClient solrClient)	Add documents to the index.
void	service(ServiceManager manager)

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

SOLR_WORKSPACES

public static final List<String> SOLR_WORKSPACES

The list of Solr repositories to index form entries into. By default, form entries are indexed in the default and live workspaces.

_solrFormEntryIndexer

protected SolrFormEntryIndexer _solrFormEntryIndexer

The Solr form entry indexer.

_context

protected Context _context

The context

Constructor Details

FormEntryDocumentProvider

public FormEntryDocumentProvider()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

getLabel

public I18nizableText getLabel()

Description copied from interface: SiteDocumentProvider

The label of the document provider

Specified by:

getLabel in interface SiteDocumentProvider

Returns:

The label

indexSitemapDocuments

public void indexSitemapDocuments(Sitemap sitemap,
 String workspaceName,
 org.apache.solr.client.solrj.SolrClient solrClient)
                           throws Exception

Description copied from interface: SiteDocumentProvider

Add documents to the index.

Specified by:

indexSitemapDocuments in interface SiteDocumentProvider

Parameters:

sitemap - the sitemap to index.

workspaceName - The workspace name.

solrClient - The solr client to use

Throws:

Exception - if an error occurs.

indexSiteDocuments

public void indexSiteDocuments(Site site,
 String workspaceName,
 org.apache.solr.client.solrj.SolrClient solrClient,
 ContainerProgressionTracker progressionTracker)
                        throws Exception

Description copied from interface: SiteDocumentProvider

Add documents to the index.

Specified by:

indexSiteDocuments in interface SiteDocumentProvider

Parameters:

site - the site to index.

workspaceName - The workspace name.

solrClient - The solr client to use

progressionTracker - The progression tracker

Throws:

Exception - if an error occurs.