Package org.ametys.cms.indexing

Interface WorkspaceIndexer

All Known Implementing Classes:

SolrWebWorkspaceIndexer, SolrWorkspaceIndexer

public interface WorkspaceIndexer

Component indexing a workspace.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ROLE	The component role.

Method Summary

Modifier and Type	Method	Description
String[]	getWorkspacesNames()	Get the workspaces labels
void	index(String workspaceName)	Index a workspace.
void	index(String workspaceName, ContainerProgressionTracker progressionTracker)	Index a workspace.
void	indexAllWorkspaces()	Index all the workspaces.
void	indexAllWorkspaces(ContainerProgressionTracker progressionTracker)	Index all the workspaces.

Field Details

ROLE

static final String ROLE

The component role.

Method Details

indexAllWorkspaces

void indexAllWorkspaces()
                 throws IndexingException

Index all the workspaces.

Throws:

IndexingException - If an error occurs while indexing.

indexAllWorkspaces

void indexAllWorkspaces(ContainerProgressionTracker progressionTracker)
                 throws IndexingException

Index all the workspaces.

Parameters:

progressionTracker - The progression of the indexation

Throws:

IndexingException - If an error occurs while indexing.

index

void index(String workspaceName)
    throws IndexingException

Index a workspace.

Parameters:

workspaceName - The workspace name.

Throws:

IndexingException - If an error occurs while indexing the workspace.

index

void index(String workspaceName,
 ContainerProgressionTracker progressionTracker)
    throws IndexingException

Index a workspace.

Parameters:

workspaceName - The workspace name.

progressionTracker - The progression tracker

Throws:

IndexingException - If an error occurs while indexing the workspace.

getWorkspacesNames

String[] getWorkspacesNames()
                     throws javax.jcr.RepositoryException

Get the workspaces labels

Returns:

The list of labels

Throws:

javax.jcr.RepositoryException - If an error occurs