Package org.silverpeas.core.web.index.components

Interface ComponentIndexation

All Known Implementing Classes:

ComponentIndexerAdapter

public interface ComponentIndexation

Indexation of the data managed by a given component instance. Each Application in Silverpeas should provide an implementation of this interface as it knows how to index it own data. This implementation must be qualified by a unique name starting by the application name and ending by the QUALIFIER_SUFFIX constant value (aka annotated by Named). The implementation will be then lookable by the index engine by their qualification name.

Field Summary

Fields

Modifier and Type	Field	Description
static String	QUALIFIER_SUFFIX

Method Summary

Modifier and Type	Method	Description
void	index(SilverpeasComponentInstance componentInst)	Indexes the data managed by the specified component instance.
default void	index(SilverpeasComponentInstance componentInst, boolean deleteAllBefore)	Indexes the data managed by the specified component instance.

Field Detail

QUALIFIER_SUFFIX

static final String QUALIFIER_SUFFIX

See Also:

Constant Field Values

Method Detail

index

void index(SilverpeasComponentInstance componentInst)
    throws SilverpeasException

Indexes the data managed by the specified component instance.

Parameters:

componentInst - the instance of the component managing the data to index or to reindex.

Throws:

SilverpeasException - if an error occurs during the indexation.

index

default void index(SilverpeasComponentInstance componentInst,
                   boolean deleteAllBefore)
            throws SilverpeasException

Indexes the data managed by the specified component instance.

Parameters:

componentInst - the instance of the component managing the data to index or to reindex.

deleteAllBefore - true to delete all indexes linked to the content of a component. instance, otherwise nothing is deleted.

Throws:

SilverpeasException - if an error occurs during the indexation.