Package org.opencms.search.galleries

Class CmsGallerySearch

java.lang.Object
org.opencms.search.galleries.CmsGallerySearch
public class CmsGallerySearch extends Object
Contains the functions for the gallery search.

Since:
8.0.0

  • Field Details

    • m_cms

      protected transient CmsObject m_cms
      The OpenCms object used for the search.

  • Constructor Details

  • Method Details

    • searchById

      public static CmsGallerySearchResult searchById(CmsObject cms, CmsUUID structureId, Locale locale) throws CmsException
      Searches by structure id.

      Parameters:
      cms - the OpenCms context to use for the search
      structureId - the structure id of the document to search for
      locale - the locale for which the search result should be returned
      Returns:
      the search result
      Throws:
      CmsException - if something goes wrong

    • searchByPath

      public static CmsGallerySearchResult searchByPath(CmsObject cms, String rootPath, Locale locale) throws CmsException
      Searches by structure id.

      Parameters:
      cms - the OpenCms context to use for the search
      rootPath - the resource root path
      locale - the locale for which the search result should be returned
      Returns:
      the search result
      Throws:
      CmsException - if something goes wrong

    • getIndex

      public String getIndex()
      Returns the name of the current search index.

      Returns:
      the name of the current search index

    • getResult

      public CmsGallerySearchResultList getResult(CmsGallerySearchParameters params) throws CmsException
      Returns the gallery search result list.

      Parameters:
      params - the gallery search parameters
      Returns:
      the gallery search result list
      Throws:
      CmsException - if the search failed

    • getSearchIndex

      public CmsSolrIndex getSearchIndex()
      Returns the current gallery search index.

      Returns:
      the current gallery search index

    • init

      public void init(CmsObject cms)
      Initializes the bean with the provided OpenCms context object.

      Parameters:
      cms - the OpenCms context to use for the search

    • searchById

      public CmsGallerySearchResult searchById(CmsUUID id, Locale locale) throws CmsException
      Searches by structure id.

      Parameters:
      id - the structure id of the document to search for
      locale - the locale for which the search result should be returned
      Returns:
      the search result
      Throws:
      CmsException - if something goes wrong

    • searchByPath

      public CmsGallerySearchResult searchByPath(String path, Locale locale) throws CmsException
      Searches by structure id.

      Parameters:
      path - the resource path
      locale - the locale for which the search result should be returned
      Returns:
      the search result
      Throws:
      CmsException - if something goes wrong

    • setIndex

      public void setIndex(String indexName) throws CmsException
      Set the name of the index to search.

      A former search result will be deleted.

      Parameters:
      indexName - the name of the index
      Throws:
      CmsException - if the index was not found

    • setIndexForProject

      public void setIndexForProject(CmsObject cms) throws CmsException
      Sets the index name according to the current project.

      Parameters:
      cms - the cms context
      Throws:
      CmsException - in case setting the index fails