Package org.ametys.cms.indexing.solr

Interface DocumentProvider

All Known Implementing Classes:

ProjectDocumentProvider

public interface DocumentProvider

Provides additional documents when indexing a workspace.

Method Summary

Modifier and Type	Method	Description
I18nizableText	getLabel()	The label of the document provider
void	indexDocuments(String workspaceName, org.apache.solr.client.solrj.SolrClient solrClient)	Index additional documents for the given workspace.
void	indexDocuments(String workspaceName, org.apache.solr.client.solrj.SolrClient solrClient, ContainerProgressionTracker progressionTracker)	Index additional documents for the given workspace.

Method Details

getLabel

I18nizableText getLabel()

The label of the document provider

Returns:

The label

indexDocuments

void indexDocuments(String workspaceName,
 org.apache.solr.client.solrj.SolrClient solrClient)
             throws IndexingException

Index additional documents for the given workspace.

Parameters:

workspaceName - The workspace name.

solrClient - The solr client to use

Throws:

IndexingException - If an error occurs indexing the documents.

indexDocuments

void indexDocuments(String workspaceName,
 org.apache.solr.client.solrj.SolrClient solrClient,
 ContainerProgressionTracker progressionTracker)
             throws IndexingException

Index additional documents for the given workspace.

Parameters:

workspaceName - The workspace name.

solrClient - The solr client to use

progressionTracker - The progression tracker

Throws:

IndexingException - If an error occurs indexing the documents.