Package org.silverpeas.core.jcr.util

Interface SilverpeasJCRIndexation

  • All Known Implementing Classes:
    JCRIndexDefinitionCreation
    public interface SilverpeasJCRIndexation
    The indexation mechanism to use for indexing the content of Silverpeas in the JCR. The indexation can be included in the JCR implementation used by Silverpeas; otherwise it has to be implemented by the Silverpeas wrapper of the JCR implementation.

    The implementation of this interface has to be a singleton.

    The indexation of the Silverpeas content in the JCR is required in order to be retrieved fastly. This is why in the case the underlying implementation of the JCR doesn't take it in charge, it has to be implemented by the Silverpeas wrapper of this JCR implementation. Whatever, an implementation of this interface has to be defined and, in the case the indexation is already taken in charge, it can does nothing.

    Usually, when the indexation isn't taken in charge by the JCR implementation, its initialization or setting is done in fact by the Silverpeas installer itself (as it does for the SQL database). Nevertheless, beside that, the indexation should be also set in tests in which the JCR is used in order to speed up them. This is why an implementation of this interface has to be provided with the indexation initialization or setting.

    Author:
    mmoquillon

    • Method Detail

      • get

        static SilverpeasJCRIndexation get()
        Gets the single instance of this class.
        Returns:
        the single instance of SilverpeasJCRIndexation.

      • initialize

        void initialize()
        Initializes the indexation mechanism for the JCR in order to index the content of Silverpeas in the JCR.