org.opencms.search.galleries

类 CmsGallerySearch

java.lang.Object

org.opencms.search.galleries.CmsGallerySearch

public class CmsGallerySearch
extends java.lang.Object

Contains the functions for the gallery search.

从以下版本开始:

8.0.0

字段概要

字段

限定符和类型	字段和说明
protected CmsObject	m_cms The OpenCms object used for the search.

构造器概要

构造器

构造器和说明
CmsGallerySearch()

方法概要

方法

限定符和类型	方法和说明
java.lang.String	getIndex() Returns the name of the current search index.
CmsGallerySearchResultList	getResult(CmsGallerySearchParameters params) Returns the gallery search result list.
CmsGallerySearchIndex	getSearchIndex() Returns the current gallery search index.
void	init(CmsObject cms) Initializes the bean with the provided OpenCms context object.
static CmsGallerySearchResult	searchById(CmsObject cms, CmsUUID structureId, java.util.Locale locale) Searches by structure id.
CmsGallerySearchResult	searchById(CmsUUID id, java.util.Locale locale) Searches by structure id.
static CmsGallerySearchResult	searchByPath(CmsObject cms, java.lang.String rootPath, java.util.Locale locale) Searches by structure id.
CmsGallerySearchResult	searchByPath(java.lang.String path, java.util.Locale locale) Searches by structure id.
void	setIndex(java.lang.String indexName) Set the name of the index to search.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

m_cms

protected transient CmsObject m_cms

The OpenCms object used for the search.

构造器详细资料

CmsGallerySearch

public CmsGallerySearch()

方法详细资料

searchById

public static CmsGallerySearchResult searchById(CmsObject cms,
                                CmsUUID structureId,
                                java.util.Locale locale)
                                         throws CmsException

Searches by structure id.

参数:

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

返回:

the search result

抛出:

CmsException - if something goes wrong

searchByPath

public static CmsGallerySearchResult searchByPath(CmsObject cms,
                                  java.lang.String rootPath,
                                  java.util.Locale locale)
                                           throws CmsException

Searches by structure id.

参数:

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

返回:

the search result

抛出:

CmsException - if something goes wrong

getIndex

public java.lang.String getIndex()

Returns the name of the current search index.

返回:

the name of the current search index

getResult

public CmsGallerySearchResultList getResult(CmsGallerySearchParameters params)
                                     throws CmsException

Returns the gallery search result list.

参数:

params - the gallery search parameters

返回:

the gallery search result list

抛出:

CmsException - if the search failed

getSearchIndex

public CmsGallerySearchIndex getSearchIndex()

Returns the current gallery search index.

返回:

the current gallery search index

init

public void init(CmsObject cms)

Initializes the bean with the provided OpenCms context object.

参数:

cms - the OpenCms context to use for the search

searchById

public CmsGallerySearchResult searchById(CmsUUID id,
                                java.util.Locale locale)
                                  throws CmsException

Searches by structure id.

参数:

id - the structure id of the document to search for

locale - the locale for which the search result should be returned

返回:

the search result

抛出:

CmsException - if something goes wrong

searchByPath

public CmsGallerySearchResult searchByPath(java.lang.String path,
                                  java.util.Locale locale)
                                    throws CmsException

Searches by structure id.

参数:

path - the resource path

locale - the locale for which the search result should be returned

返回:

the search result

抛出:

CmsException - if something goes wrong

setIndex

public void setIndex(java.lang.String indexName)
              throws CmsException

Set the name of the index to search.

A former search result will be deleted.

参数:

indexName - the name of the index

抛出:

CmsException - if the index was not found or was not an instance of @link CmsGallerySearchIndex