Package de.hybris.platform.solrfacetsearch.solr

Interface SolrIndexService

  • All Known Implementing Classes:
    DefaultSolrIndexService
    public interface SolrIndexService
    Service for managing indexes.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      SolrIndexModel activateIndex​(java.lang.String facetSearchConfig, java.lang.String indexedType, java.lang.String qualifier)
      Activates an index.
      SolrIndexModel createIndex​(java.lang.String facetSearchConfig, java.lang.String indexedType, java.lang.String qualifier)
      Creates an index.
      void deleteIndex​(java.lang.String facetSearchConfig, java.lang.String indexedType, java.lang.String qualifier)
      Deletes an index.
      SolrIndexModel getActiveIndex​(java.lang.String facetSearchConfig, java.lang.String indexedType)
      Returns the active index for a specific facet search configuration and indexed type.
      java.util.List<SolrIndexModel> getAllIndexes()
      Returns all indexes.
      SolrIndexModel getIndex​(java.lang.String facetSearchConfig, java.lang.String indexedType, java.lang.String qualifier)
      Finds an index by facet search configuration, indexed type and qualifier.
      java.util.List<SolrIndexModel> getIndexesForConfigAndType​(java.lang.String facetSearchConfig, java.lang.String indexedType)
      Returns all indexes for a specific facet search configuration and indexed type.
      SolrIndexModel getOrCreateIndex​(java.lang.String facetSearchConfig, java.lang.String indexedType, java.lang.String qualifier)
      Gets or creates an index (if it does not exist yet).

    • Method Detail

      • createIndex

        SolrIndexModel createIndex​(java.lang.String facetSearchConfig,
                           java.lang.String indexedType,
                           java.lang.String qualifier)
                    throws SolrServiceException
        Creates an index.
        Parameters:
        facetSearchConfig - - the facet search configuration name
        indexedType - - the indexed type name
        qualifier - - the qualifier
        Returns:
        the index
        Throws:
        SolrServiceException - if an error occurs

      • getIndexesForConfigAndType

        java.util.List<SolrIndexModel> getIndexesForConfigAndType​(java.lang.String facetSearchConfig,
                                                          java.lang.String indexedType)
                                                   throws SolrServiceException
        Returns all indexes for a specific facet search configuration and indexed type.
        Parameters:
        facetSearchConfig - - the facet search configuration name
        indexedType - - the indexed type name
        Returns:
        the indexes
        Throws:
        SolrServiceException - if an error occurs

      • getIndex

        SolrIndexModel getIndex​(java.lang.String facetSearchConfig,
                        java.lang.String indexedType,
                        java.lang.String qualifier)
                 throws SolrServiceException
        Finds an index by facet search configuration, indexed type and qualifier.
        Parameters:
        facetSearchConfig - - the facet search configuration name
        indexedType - - the indexed type name
        qualifier - - the qualifier
        Returns:
        the index
        Throws:
        SolrIndexNotFoundException - if an index cannot be found
        SolrServiceException - if an error occurs

      • getOrCreateIndex

        SolrIndexModel getOrCreateIndex​(java.lang.String facetSearchConfig,
                                java.lang.String indexedType,
                                java.lang.String qualifier)
                         throws SolrServiceException
        Gets or creates an index (if it does not exist yet).
        Parameters:
        facetSearchConfig - - the facet search configuration name
        indexedType - - the indexed type name
        qualifier - - the qualifier
        Returns:
        the index
        Throws:
        SolrServiceException - if an error occurs

      • deleteIndex

        void deleteIndex​(java.lang.String facetSearchConfig,
                 java.lang.String indexedType,
                 java.lang.String qualifier)
          throws SolrServiceException
        Deletes an index.
        Parameters:
        facetSearchConfig - - the facet search configuration name
        indexedType - - the indexed type name
        qualifier - - the qualifier
        Throws:
        SolrIndexNotFoundException - if an index cannot be found
        SolrServiceException - if an error occurs

      • activateIndex

        SolrIndexModel activateIndex​(java.lang.String facetSearchConfig,
                             java.lang.String indexedType,
                             java.lang.String qualifier)
                      throws SolrServiceException
        Activates an index. All other indexes within facet search configuration and indexed type combination will be deactivated.
        Parameters:
        facetSearchConfig - - the facet search configuration name
        indexedType - - the indexed type name
        qualifier - - the qualifier
        Returns:
        the active index
        Throws:
        SolrIndexNotFoundException - if an index cannot be found
        SolrServiceException - if an error occurs

      • getActiveIndex

        SolrIndexModel getActiveIndex​(java.lang.String facetSearchConfig,
                              java.lang.String indexedType)
                       throws SolrServiceException
        Returns the active index for a specific facet search configuration and indexed type.
        Parameters:
        facetSearchConfig - - the facet search configuration name
        indexedType - - the indexed type name
        Returns:
        the active index
        Throws:
        SolrIndexNotFoundException - if an index cannot be found
        SolrServiceException - if an error occurs