Package org.opencms.search.galleries

Class CmsGallerySearchParameters

java.lang.Object
org.opencms.search.galleries.CmsGallerySearchParameters
public class CmsGallerySearchParameters extends Object
Parameters used for the gallery search index.

Since:
8.0.0

  • Constructor Details

  • Method Details

    • getCategories

      public List<String> getCategories()
      Returns the categories that have been included in the search.

      If no categories have been set, then null is returned.

      Returns:
      the categories that have been included in the search

    • getDateCreatedRange

      public org.opencms.search.galleries.CmsGallerySearchParameters.CmsGallerySearchTimeRange getDateCreatedRange()
      Returns the time range for the date of creation that has been used for the search result.

      In case this time range has not been set, this will return an object where the start date is equal to Long.MIN_VALUE and the end date is equal to Long.MAX_VALUE.

      Returns:
      the time range for the date of creation that has been used for the search result

    • getDateLastModifiedRange

      public org.opencms.search.galleries.CmsGallerySearchParameters.CmsGallerySearchTimeRange getDateLastModifiedRange()
      Returns the time range for the dadelete examplete of last modification that has been used for the search result.

      In case this time range has not been set, this will return an object where the start date is equal to Long.MIN_VALUE and the end date is equal to Long.MAX_VALUE.

      Returns:
      the time range for the date of last modification that has been used for the search result

    • getExcludedFunctions

      public Set<CmsUUID> getExcludedFunctions()
      Gets the set of structure IDs of functions to exclude from the search result.
      Returns:
      the set of structure IDs to exclude

    • getFolders

      public List<String> getFolders()
      Returns the list of folders to search in.

      Returns:
      a list of paths of VFS folders

    • getGalleries

      public List<String> getGalleries()
      Returns the galleries that have been included in the search.

      If no galleries have been set, then null is returned.

      Returns:
      the galleries that have been included in the search

    • getIncludedFunctions

      public Set<CmsUUID> getIncludedFunctions()
      Gets the set of ids of functions to include.

      Note: If the id of a function is returned in the ID set returned by thsi method, the function may still be excluded from search results based on other parameters.

      Returns:
      the included functions

    • getLocale

      public String getLocale()
      Returns the locale that has been used for the search.

      If no locale has been set, then null is returned.

      Returns:
      the locale that has been used for the search

    • getMatchesPerPage

      public int getMatchesPerPage()
      Returns the maximum number of matches per result page.

      Returns:
      the the maximum number of matches per result page
      See Also:

    • getQuery

      public CmsSolrQuery getQuery(CmsObject cms)
      Returns a CmsSolrQuery representation of this class.
      Parameters:
      cms - the openCms object.
      Returns:
      CmsSolrQuery representation of this class.

    • getReferencePath

      public String getReferencePath()
      Gets the reference path.

      Returns:
      the gallery reference path

    • getResourceTypes

      public List<String> getResourceTypes()
      Returns the names of the resource types that have been included in the search result.

      If no resource types have been set, then null is returned.

      Returns:
      the names of the resource types that have been included in the search result

    • getResultPage

      public int getResultPage()
      Returns the index of the requested result page.

      Returns:
      the index of the requested result page
      See Also:

    • getScope

      public CmsGallerySearchScope getScope()
      The gallery search scope.

      Returns:
      the gallery search scope

    • getSearchWords

      public String getSearchWords()
      Returns the words (terms) that have been used for the full text search.

      If no search words have been set, then null is returned.

      Returns:
      the words (terms) that have been used for the full text search

    • getSortOrder

      public CmsGallerySearchParameters.CmsGallerySortParam getSortOrder()
      Returns the sort order that has been used in the search.

      If the sort parameter has not been set the default sort order defined by CmsGallerySearchParameters.CmsGallerySortParam.DEFAULT is used.

      Returns:
      the sort order that has been used in the search

    • getTemplateCompatibility

      public String getTemplateCompatibility()
      Gets the template compatibility.

      If set, matches those resources whose template.compatibility property is either empty or contains the value (possibly together with other values, separated by whitespace).

      Returns:
      the template compatibility

    • isForceEmptyResult

      public boolean isForceEmptyResult()
      If this returns true, an empty search result should be returned, regardless of other settings.
      Returns:
      true if an empty search result should be forced

    • isIgnoreSearchExclude

      public boolean isIgnoreSearchExclude()
      Returns the search exclude property ignore flag.

      Returns:
      the search exclude property ignore flag

    • isIncludeExpired

      public boolean isIncludeExpired()
      Returns a flag, indicating if release and expiration date should be ignored.

      Returns:
      a flag, indicating if release and expiration date should be ignored

    • setCategories

      public void setCategories(List<String> categories)
      Sets the categories for the search.

      Results are found only if they are contained in at least one of the given categories.

      Parameters:
      categories - the categories to set

    • setDateCreatedTimeRange

      public void setDateCreatedTimeRange(long startTime, long endTime)
      Sets the time range for the date of resource creation to consider in the search.

      Parameters:
      startTime - the start time of the time range
      endTime - the end time of the time range

    • setDateLastModifiedTimeRange

      public void setDateLastModifiedTimeRange(long startTime, long endTime)
      Sets the time range for the date of resource last modification to consider in the search.

      Parameters:
      startTime - the start time of the time range
      endTime - the end time of the time range

    • setExcludedFunctions

      public void setExcludedFunctions(Set<CmsUUID> excludedFunctions)
      Sets the structure IDs of functions to exclude from the search results.
      Parameters:
      excludedFunctions - the structure IDs of functions to exclude

    • setFolders

      public void setFolders(List<String> folders)
      Sets the folders to search in.

      Parameters:
      folders - the list of VFS folders

    • setForceEmptyResult

      public void setForceEmptyResult(boolean forceEmptyResult)
      Enables/disables the 'force empty result' flag. If this is set to true, an empty search result should be returned regardless of the other parameters.
      Parameters:
      forceEmptyResult - if true, force an empty search result

    • setFunctionAvailability

      public void setFunctionAvailability(CmsFunctionAvailability dynamicFunctionAvailability)
      Sets the dynamic function availability.
      Parameters:
      dynamicFunctionAvailability - the dynamic function availability

    • setGalleries

      public void setGalleries(List<String> galleries)
      Sets the galleries for the search.

      Results are found only if they are contained in one of the given galleries. If no gallery is set, results from all galleries will be returned in the search result.

      Parameters:
      galleries - the galleries to set

    • setIgnoreSearchExclude

      public void setIgnoreSearchExclude(boolean excludeForPageEditor)
      Sets the search exclude property ignore flag.

      Parameters:
      excludeForPageEditor - the search exclude property ignore flag

    • setIncludedFunctions

      public void setIncludedFunctions(Set<CmsUUID> includedFunctions)
      Sets the ids of functions to include.
      Parameters:
      includedFunctions - the ids of functions to include

    • setIncludeExpired

      public void setIncludeExpired(boolean includeExpired)
      Set the flag, determining if expired and unreleased resources should be shown.
      Parameters:
      includeExpired - iff true expired and unreleased resources are shown.

    • setMatchesPerPage

      public void setMatchesPerPage(int matchesPerPage)
      Sets the maximum number of matches per result page.

      Use this together with setResultPage(int) in order to split the result in more than one page.

      Parameters:
      matchesPerPage - the the maximum number of matches per result page to set
      See Also:

    • setReferencePath

      public void setReferencePath(String referencePath)
      Sets the gallery reference path.

      Parameters:
      referencePath - the gallery reference path

    • setResourceTypes

      public void setResourceTypes(List<String> resourceTypes)
      Sets the names of the resource types to include in the search result.

      Results are found only if they resources match one of the given resource type names. If no resource type name is set, all resource types will be returned in the search result.

      Parameters:
      resourceTypes - the names of the resource types to include in the search result

    • setResultPage

      public void setResultPage(int resultPage)
      Sets the index of the result page that should be returned.

      Use this together with setMatchesPerPage(int) in order to split the result in more than one page.

      Parameters:
      resultPage - the index of the result page to return
      See Also:

    • setScope

      public void setScope(CmsGallerySearchScope scope)
      Sets the search scope.

      Parameters:
      scope - the search scope

    • setSearchLocale

      public void setSearchLocale(String locale)
      Sets the locale for the search.

      Results are found only if they match the given locale. If no locale is set, results for all locales will be returned in the search result.

      Parameters:
      locale - the locale to set

    • setSearchWords

      public void setSearchWords(String words)
      Sets the words (terms) for the full text search.

      Results are found only if they text extraction for the resource contains all given search words. If no search word is set, all resources will be returned in the search result.

      Please note that this should be a list of words separated by white spaces. Simple Lucene modifiers such as (+), (-) and (*) are allowed, but anything more complex then this will be removed.

      Parameters:
      words - the words (terms) for the full text search to set

    • setSortOrder

      public void setSortOrder(CmsGallerySearchParameters.CmsGallerySortParam sortOrder)
      Sets the sort order for the search.

      Parameters:
      sortOrder - the sort order to set

    • setTemplateCompatibility

      public void setTemplateCompatibility(String compatibility)
      Sets the template compatibility string.
      Parameters:
      compatibility - the template compatibility string