org.opencms.search.galleries

类 CmsGallerySearchIndex

java.lang.Object

org.opencms.search.CmsSearchIndex

org.opencms.search.galleries.CmsGallerySearchIndex

所有已实现的接口:

I_CmsConfigurationParameterHandler

public class CmsGallerySearchIndex
extends CmsSearchIndex

Implements the search within a the gallery index.

从以下版本开始:

8.0.0

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	FOLDER_SYSTEM The system folder.
static java.lang.String	FOLDER_SYSTEM_GALLERIES The system galleries path.
static java.lang.String	FOLDER_SYTEM_MODULES The system modules folder path.
static java.lang.String	GALLERY_INDEX_NAME The advanced gallery index name.
static java.lang.String	TYPE_XMLCONTENT_GALLERIES The gallery document type name for xml-contents.
static java.lang.String	TYPE_XMLPAGE_GALLERIES The gallery document type name for xml-pages.

从类继承的字段 org.opencms.search.CmsSearchIndex

A_PARAM_PREFIX, BACKUP_REINDEXING, DATES, DOC_META_FIELDS, EXCERPT, EXTRACT_CONTENT, IGNORE_EXPIRATION, LANGUAGEDETECTION, LUCENE_AUTO_COMMIT, LUCENE_RAM_BUFFER_SIZE_MB, LUCENE_VERSION, MAX_HITS, MAX_HITS_DEFAULT, MAX_YEAR_RANGE, PERMISSIONS, PRIORITY, PROPERTY_SEARCH_EXCLUDE_VALUE_ALL, PROPERTY_SEARCH_EXCLUDE_VALUE_GALLERY, REBUILD_MODE_AUTO, REBUILD_MODE_MANUAL, REBUILD_MODE_OFFLINE, TIME_RANGE, TYPE_XMLCONTENT, USE_ALL_LOCALE, VISITOR

从接口继承的字段 org.opencms.configuration.I_CmsConfigurationParameterHandler

ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD

构造器概要

构造器

构造器和说明
CmsGallerySearchIndex() Default constructor only intended to be used by the XML configuration.
CmsGallerySearchIndex(java.lang.String name) Creates a new gallery search index with the given name.

方法概要

方法

限定符和类型	方法和说明
protected org.apache.lucene.queries.BooleanFilter	appendContainerTypeFilter(CmsObject cms, org.apache.lucene.queries.BooleanFilter filter, java.util.List<java.lang.String> containers) Appends a container type filter to the given filter clause that matches all given container types.
protected org.apache.lucene.queries.BooleanFilter	appendIgnoreSearchExclude(org.apache.lucene.queries.BooleanFilter filter, boolean ignoreSearchExclude) Appends the ignore search exclude property filter.
protected org.apache.lucene.queries.BooleanFilter	appendLocaleFilter(CmsObject cms, org.apache.lucene.queries.BooleanFilter filter, java.lang.String locale) Appends the locale filter to the given filter clause that matches the given locale.
protected org.apache.lucene.queries.BooleanFilter	appendPathFilter(CmsObject cms, org.apache.lucene.queries.BooleanFilter filter, java.util.List<java.lang.String> roots) Appends the a VFS path filter to the given filter clause that matches all given root paths.
java.util.List<java.lang.String>	computeScopeFolders(CmsObject cms, CmsGallerySearchParameters params) Computes the search root folders for the given search parameters based on the search scope.
protected org.apache.lucene.queries.TermsFilter	createPathFilter(java.util.Collection<java.lang.String> roots) Creates a search filter for the given search root paths.
protected boolean	excludeFromIndex(CmsObject cms, CmsResource resource) Checks if the provided resource should be excluded from this search index.
I_CmsSearchDocument	getDocument(CmsUUID structureId) 已过时。 Use CmsSearchIndex.getDocument(String, String) instead and provide CmsGallerySearchFieldMapping.FIELD_RESOURCE_STRUCTURE_ID as field to search in
I_CmsDocumentFactory	getDocumentFactory(CmsResource res) Returns the document type factory used for the given resource in this index, or null in case the resource is not indexed by this index.
protected java.util.List<java.lang.String>	getLocaleExtendedFields(java.util.List<java.lang.String> fields, java.util.Locale locale) Returns a list of locale extended field names.
java.util.Locale	getLocaleForResource(CmsObject cms, CmsResource resource, java.util.List<java.util.Locale> availableLocales) Returns the language locale for the given resource in this index.
protected CmsResource	getResource(CmsObject cms, I_CmsSearchDocument doc) We are overriding getResource since the default implementation uses the path to read the resource, which doesn't work for resources in a different site.
java.util.List<java.lang.String>	getSearchRootsForScope(CmsGallerySearchScope scope, java.lang.String siteParam, java.lang.String subSiteParam) Gets the search roots to use for the given site/subsite parameters.
CmsGallerySearchResultList	searchGallery(CmsObject cms, CmsGallerySearchParameters params) Performs a search on the gallery index.

从类继承的方法 org.opencms.search.CmsSearchIndex

addConfigurationParameter, addSourceName, appendCategoryFilter, appendDateCreatedFilter, appendDateLastModifiedFilter, appendResourceTypeFilter, checkConfiguration, createDateRangeFilter, createEmptyDocument, createIndexBackup, createIndexWriter, equals, extendPathFilter, generateIndexDirectory, getAnalyzer, getConfiguration, getDateRangeSpan, getDocument, getDocument, getDocument, getFieldConfiguration, getFieldConfigurationName, getIndexWriter, getLocale, getLocaleString, getMaxHits, getMultiTermQueryFilter, getMultiTermQueryFilter, getMultiTermQueryFilter, getName, getPath, getPriority, getProject, getRebuildMode, getSearcher, getSourceNames, getSources, getTermQueryFilter, hashCode, hasReadPermission, indexSearcherClose, indexSearcherClose, indexSearcherOpen, indexSearcherUpdate, indexWriterUnlock, initConfiguration, initialize, isBackupReindexing, isCheckingPermissions, isCheckingTimeRange, isCheckPermissions, isCreatingExcerpt, isEnabled, isExtractingContent, isIgnoreExpiration, isInTimeRange, isLanguageDetection, isRequireViewPermission, isSortScoring, isUpdatedIncremental, needsPermissionCheck, removeIndexBackup, removeSourceName, search, setAnalyzer, setCheckPermissions, setEnabled, setFieldConfiguration, setFieldConfigurationName, setIgnoreExpiration, setIndexWriter, setLanguageDetection, setLocale, setLocaleString, setMaxHits, setName, setProject, setRebuildMode, setRequireViewPermission, shutDown, toString

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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

字段详细资料

FOLDER_SYSTEM

public static final java.lang.String FOLDER_SYSTEM

The system folder.

另请参阅:

常量字段值

FOLDER_SYSTEM_GALLERIES

public static final java.lang.String FOLDER_SYSTEM_GALLERIES

The system galleries path.

另请参阅:

常量字段值

FOLDER_SYTEM_MODULES

public static final java.lang.String FOLDER_SYTEM_MODULES

The system modules folder path.

另请参阅:

常量字段值

GALLERY_INDEX_NAME

public static final java.lang.String GALLERY_INDEX_NAME

The advanced gallery index name.

另请参阅:

常量字段值

TYPE_XMLCONTENT_GALLERIES

public static final java.lang.String TYPE_XMLCONTENT_GALLERIES

The gallery document type name for xml-contents.

另请参阅:

常量字段值

TYPE_XMLPAGE_GALLERIES

public static final java.lang.String TYPE_XMLPAGE_GALLERIES

The gallery document type name for xml-pages.

另请参阅:

常量字段值

构造器详细资料

CmsGallerySearchIndex

public CmsGallerySearchIndex()

Default constructor only intended to be used by the XML configuration.

It is recommended to use the constructor CmsGallerySearchIndex(String) as it enforces the mandatory name argument.

CmsGallerySearchIndex

public CmsGallerySearchIndex(java.lang.String name)
                      throws CmsIllegalArgumentException

Creates a new gallery search index with the given name.

参数:

name - the system-wide unique name for the search index

抛出:

CmsIllegalArgumentException - if the given name is null, empty or already taken by another search index

方法详细资料

computeScopeFolders

public java.util.List<java.lang.String> computeScopeFolders(CmsObject cms,
                                                   CmsGallerySearchParameters params)

Computes the search root folders for the given search parameters based on the search scope.

参数:

cms - the current CMS context

params - the current search parameters

返回:

the search root folders based on the search scope

getDocument

@Deprecated
public I_CmsSearchDocument getDocument(CmsUUID structureId)

已过时。 Use CmsSearchIndex.getDocument(String, String) instead and provide CmsGallerySearchFieldMapping.FIELD_RESOURCE_STRUCTURE_ID as field to search in

Returns the Lucene document with the given structure id from the index.

参数:

structureId - the structure id of the document to retrieve

返回:

the Lucene document with the given root path from the index

getDocumentFactory

public I_CmsDocumentFactory getDocumentFactory(CmsResource res)

从类复制的说明: CmsSearchIndex

Returns the document type factory used for the given resource in this index, or null in case the resource is not indexed by this index.

A resource is indexed if the following is all true:

1. The index contains at last one index source matching the root path of the given resource.
2. For this matching index source, the document type factory needed by the resource is also configured.

覆盖:

getDocumentFactory 在类中 CmsSearchIndex

参数:

res - the resource to check

返回:

he document type factory used for the given resource in this index, or null in case the resource is not indexed by this index

另请参阅:

CmsSearchIndex.getDocumentFactory(org.opencms.file.CmsResource)

getLocaleForResource

public java.util.Locale getLocaleForResource(CmsObject cms,
                                    CmsResource resource,
                                    java.util.List<java.util.Locale> availableLocales)

Returns the language locale for the given resource in this index.

覆盖:

getLocaleForResource 在类中 CmsSearchIndex

参数:

cms - the current OpenCms user context

resource - the resource to check

availableLocales - a list of locales supported by the resource

返回:

the language locale for the given resource in this index

getSearchRootsForScope

public java.util.List<java.lang.String> getSearchRootsForScope(CmsGallerySearchScope scope,
                                                      java.lang.String siteParam,
                                                      java.lang.String subSiteParam)

Gets the search roots to use for the given site/subsite parameters.

参数:

scope - the search scope

siteParam - the current site

subSiteParam - the current subsite

返回:

the list of search roots for that option

searchGallery

public CmsGallerySearchResultList searchGallery(CmsObject cms,
                                       CmsGallerySearchParameters params)
                                         throws CmsSearchException

Performs a search on the gallery index.

参数:

cms - the current users OpenCms context

params - the parameters to use for the search

返回:

the List of results found

抛出:

CmsSearchException - if something goes wrong

appendContainerTypeFilter

protected org.apache.lucene.queries.BooleanFilter appendContainerTypeFilter(CmsObject cms,
                                                                org.apache.lucene.queries.BooleanFilter filter,
                                                                java.util.List<java.lang.String> containers)

Appends a container type filter to the given filter clause that matches all given container types.

In case the provided List is null or empty, the original filter is left unchanged.

The original filter parameter is extended and also provided as return value.

参数:

cms - the current OpenCms search context

filter - the filter to extend

containers - the containers that will compose the filter

返回:

the extended filter clause

appendIgnoreSearchExclude

protected org.apache.lucene.queries.BooleanFilter appendIgnoreSearchExclude(org.apache.lucene.queries.BooleanFilter filter,
                                                                boolean ignoreSearchExclude)

Appends the ignore search exclude property filter.

参数:

filter - the filter to extend

ignoreSearchExclude - true if the search exclude property should be ignored

返回:

the extended filter clause

appendLocaleFilter

protected org.apache.lucene.queries.BooleanFilter appendLocaleFilter(CmsObject cms,
                                                         org.apache.lucene.queries.BooleanFilter filter,
                                                         java.lang.String locale)

Appends the locale filter to the given filter clause that matches the given locale.

In case the provided List is null or empty, the original filter is left unchanged.

The original filter parameter is extended and also provided as return value.

参数:

cms - the current OpenCms search context

filter - the filter to extend

locale - the locale that will compose the filter

返回:

the extended filter clause

appendPathFilter

protected org.apache.lucene.queries.BooleanFilter appendPathFilter(CmsObject cms,
                                                       org.apache.lucene.queries.BooleanFilter filter,
                                                       java.util.List<java.lang.String> roots)

Appends the a VFS path filter to the given filter clause that matches all given root paths.

In case the provided List is null or empty, the current request context site root is appended.

The original filter parameter is extended and also provided as return value.

覆盖:

appendPathFilter 在类中 CmsSearchIndex

参数:

cms - the current OpenCms search context

filter - the filter to extend

roots - the VFS root paths that will compose the filter

返回:

the extended filter clause

createPathFilter

protected org.apache.lucene.queries.TermsFilter createPathFilter(java.util.Collection<java.lang.String> roots)

Creates a search filter for the given search root paths.

参数:

roots - the search root paths

返回:

the filter which filters for the given search roots

excludeFromIndex

protected boolean excludeFromIndex(CmsObject cms,
                       CmsResource resource)

Checks if the provided resource should be excluded from this search index.

覆盖:

excludeFromIndex 在类中 CmsSearchIndex

参数:

cms - the OpenCms context used for building the search index

resource - the resource to index

返回:

true if the resource should be excluded, false if it should be included in this index

getLocaleExtendedFields

protected java.util.List<java.lang.String> getLocaleExtendedFields(java.util.List<java.lang.String> fields,
                                                       java.util.Locale locale)

Returns a list of locale extended field names.

参数:

fields - the field name to extend

locale - the locale to extend the field names with

返回:

a list of locale extended field names

getResource

protected CmsResource getResource(CmsObject cms,
                      I_CmsSearchDocument doc)

We are overriding getResource since the default implementation uses the path to read the resource, which doesn't work for resources in a different site.

覆盖:

getResource 在类中 CmsSearchIndex

参数:

cms - the OpenCms user context to use for permission testing

doc - the search result document to check

返回:

the referenced CmsResource or null if the user is not permitted

另请参阅:

CmsSearchIndex.getResource(org.opencms.file.CmsObject, org.opencms.search.I_CmsSearchDocument)