org.opencms.search.solr

类 CmsSolrIndex

java.lang.Object

org.opencms.search.CmsSearchIndex

org.opencms.search.solr.CmsSolrIndex

所有已实现的接口:

I_CmsConfigurationParameterHandler

public class CmsSolrIndex
extends CmsSearchIndex

Implements the search within an Solr index.

从以下版本开始:

8.5.0

字段概要

字段

限定符和类型	字段和说明
protected static int	DEBUG_PADDING_RIGHT A constant for debug formatting output.
static java.lang.String	DEFAULT_INDEX_NAME_OFFLINE The name of the default Solr Offline index.
static java.lang.String	DEFAULT_INDEX_NAME_ONLINE The name of the default Solr Online index.
static java.lang.String	POST_PROCESSOR Constant for additional parameter to set the post processor class name.
static java.lang.String	PROPERTY_SEARCH_EXCLUDE_VALUE_SOLR The solr exclude property.
static int	ROWS_MAX Indicates the maximum number of documents from the complete result set to return.

从类继承的字段 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

构造器概要

构造器

构造器和说明
CmsSolrIndex() Default constructor.
CmsSolrIndex(java.lang.String name) Public constructor to create a Solr index.

方法概要

方法

限定符和类型	方法和说明
void	addConfigurationParameter(java.lang.String key, java.lang.String value) Adds a parameter.
I_CmsSearchDocument	createEmptyDocument(CmsResource resource) Creates an empty document that can be used by this search field configuration.
protected java.lang.String	createIndexBackup() Creates a backup of this index for optimized re-indexing of the whole content.
I_CmsIndexWriter	createIndexWriter(boolean create, I_CmsReport report) Creates a new index writer.
protected boolean	excludeFromIndex(CmsObject cms, CmsResource resource) Checks if the provided resource should be excluded from this search index.
CmsParameterConfiguration	getConfiguration() Returns the parameters of this configurable class instance, or null if the class does not need any parameters.
I_CmsSearchDocument	getDocument(java.lang.String fieldname, java.lang.String term) Returns the first document where the given term matches the selected index field.
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.
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.
I_CmsSolrPostSearchProcessor	getPostProcessor() Returns the search post processor.
static java.lang.String	getType(CmsObject cms, java.lang.String rootPath) Returns the resource type for the given root path.
protected void	indexSearcherClose() Closes the index searcher for this index.
protected void	indexSearcherOpen(java.lang.String path) Initializes the index searcher for this index.
protected void	indexSearcherUpdate() Reopens the index search reader for this index, required after the index has been changed.
void	initialize() Initializes the search index.
protected boolean	isIndexing(CmsResource res) Checks if the given resource should be indexed by this index or not.
CmsSearchResultList	search(CmsObject cms, CmsSearchParameters params) 已过时。
CmsSolrResultList	search(CmsObject cms, CmsSolrQuery query) Default search method.
CmsSolrResultList	search(CmsObject cms, CmsSolrQuery query, boolean ignoreMaxRows) Performs a search on the Solr index Returns a list of 'OpenCms resource documents' (CmsSearchResource) encapsulated within the class CmsSolrResultList.
CmsSolrResultList	search(CmsObject cms, org.apache.solr.client.solrj.SolrQuery query) Default search method.
CmsSolrResultList	search(CmsObject cms, java.lang.String solrQuery) Performs a search.
void	select(javax.servlet.ServletResponse response, CmsObject cms, CmsSolrQuery query, boolean ignoreMaxRows) Writes the response into the writer.
void	setPostProcessor(I_CmsSolrPostSearchProcessor postProcessor) Sets the search post processor.
void	setSolrServer(org.apache.solr.client.solrj.SolrServer server) Sets the Solr server used by this index.
void	shutDown() Shuts down the search index.
void	spellCheck(javax.servlet.ServletResponse res, CmsObject cms, CmsSolrQuery q) Executes a spell checking Solr query and returns the Solr query response.

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

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

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

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

字段详细资料

DEFAULT_INDEX_NAME_OFFLINE

public static final java.lang.String DEFAULT_INDEX_NAME_OFFLINE

The name of the default Solr Offline index.

另请参阅:

常量字段值

DEFAULT_INDEX_NAME_ONLINE

public static final java.lang.String DEFAULT_INDEX_NAME_ONLINE

The name of the default Solr Online index.

另请参阅:

常量字段值

POST_PROCESSOR

public static final java.lang.String POST_PROCESSOR

Constant for additional parameter to set the post processor class name.

另请参阅:

常量字段值

PROPERTY_SEARCH_EXCLUDE_VALUE_SOLR

public static final java.lang.String PROPERTY_SEARCH_EXCLUDE_VALUE_SOLR

The solr exclude property.

另请参阅:

常量字段值

ROWS_MAX

public static final int ROWS_MAX

Indicates the maximum number of documents from the complete result set to return.

另请参阅:

常量字段值

DEBUG_PADDING_RIGHT

protected static final int DEBUG_PADDING_RIGHT

A constant for debug formatting output.

另请参阅:

常量字段值

构造器详细资料

CmsSolrIndex

public CmsSolrIndex()

Default constructor.

CmsSolrIndex

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

Public constructor to create a Solr index.

参数:

name - the name for this index.

抛出:

CmsIllegalArgumentException - if something goes wrong

方法详细资料

getType

public static final java.lang.String getType(CmsObject cms,
                       java.lang.String rootPath)

Returns the resource type for the given root path.

参数:

cms - the current CMS context

rootPath - the root path of the resource to get the type for

返回:

the resource type for the given root path

addConfigurationParameter

public void addConfigurationParameter(java.lang.String key,
                             java.lang.String value)

从类复制的说明: CmsSearchIndex

Adds a parameter.

指定者:

addConfigurationParameter 在接口中 I_CmsConfigurationParameterHandler

覆盖:

addConfigurationParameter 在类中 CmsSearchIndex

参数:

key - the key/name of the parameter

value - the value of the parameter

另请参阅:

CmsSearchIndex.addConfigurationParameter(java.lang.String, java.lang.String)

createEmptyDocument

public I_CmsSearchDocument createEmptyDocument(CmsResource resource)

从类复制的说明: CmsSearchIndex

Creates an empty document that can be used by this search field configuration.

覆盖:

createEmptyDocument 在类中 CmsSearchIndex

参数:

resource - the resource to create the document for

返回:

a new and empty document

另请参阅:

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

createIndexWriter

public I_CmsIndexWriter createIndexWriter(boolean create,
                                 I_CmsReport report)

从类复制的说明: CmsSearchIndex

Creates a new index writer.

覆盖:

createIndexWriter 在类中 CmsSearchIndex

参数:

create - if true a whole new index is created, if false an existing index is updated

report - the report

返回:

the created new index writer

另请参阅:

CmsSearchIndex.createIndexWriter(boolean, org.opencms.report.I_CmsReport)

getConfiguration

public CmsParameterConfiguration getConfiguration()

从接口复制的说明: I_CmsConfigurationParameterHandler

Returns the parameters of this configurable class instance, or null if the class does not need any parameters.

指定者:

getConfiguration 在接口中 I_CmsConfigurationParameterHandler

覆盖:

getConfiguration 在类中 CmsSearchIndex

返回:

the parameters of this configurable class instance, or null if the class does not need any parameters

另请参阅:

CmsSearchIndex.getConfiguration()

getDocument

public I_CmsSearchDocument getDocument(java.lang.String fieldname,
                              java.lang.String term)

从类复制的说明: CmsSearchIndex

Returns the first document where the given term matches the selected index field.

Use this method to search for documents which have unique field values, like a unique id.

覆盖:

getDocument 在类中 CmsSearchIndex

参数:

fieldname - the field to search in

term - the term to search for

返回:

the first document where the given term matches the selected index field

另请参阅:

CmsSearchIndex.getDocument(java.lang.String, java.lang.String)

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

getPostProcessor

public I_CmsSolrPostSearchProcessor getPostProcessor()

Returns the search post processor.

返回:

the post processor to use

initialize

public void initialize()
                throws CmsSearchException

从类复制的说明: CmsSearchIndex

Initializes the search index.

覆盖:

initialize 在类中 CmsSearchIndex

抛出:

CmsSearchException - if the index source association failed or a configuration error occurred

另请参阅:

CmsSearchIndex.initialize()

search

@Deprecated
public CmsSearchResultList search(CmsObject cms,
                                    CmsSearchParameters params)

已过时。

Not yet implemented for Solr.

#################
### DON'T USE ###
#################


覆盖:

search 在类中 CmsSearchIndex

参数:

cms - the current user's Cms object

params - the parameters to use for the search

返回:

the List of results found or an empty list

search

public CmsSolrResultList search(CmsObject cms,
                       CmsSolrQuery query)
                         throws CmsSearchException

Default search method.

参数:

cms - the current CMS object

query - the query

返回:

the results

抛出:

CmsSearchException - if something goes wrong

另请参阅:

search(CmsObject, String)

search

public CmsSolrResultList search(CmsObject cms,
                       CmsSolrQuery query,
                       boolean ignoreMaxRows)
                         throws CmsSearchException

Performs a search on the Solr index

Returns a list of 'OpenCms resource documents' (CmsSearchResource) encapsulated within the class CmsSolrResultList. This list can be accessed exactly like an List which entries are CmsSearchResource that extend CmsResource and holds the Solr implementation of I_CmsSearchDocument as member. This enables you to deal with the resulting list as you do with well known List and work on it's entries like you do on CmsResource.

What will be done with the Solr search result?

• Although it can happen, that there are less results returned than rows were requested (imagine an index containing less documents than requested rows) we try to guarantee the requested amount of search results and to provide a working pagination with security check.
• To be sure we get enough documents left even the permission check reduces the amount of found documents, the rows are multiplied by '5' and the current page additionally the offset is added. The count of documents we don't have enough permissions for grows with increasing page number, that's why we also multiply the rows by the current page count.
• Also make sure we perform the permission check for all found documents, so start with the first found doc.

NOTE: If latter pages than the current one are containing protected documents the total hit count will be incorrect, because the permission check ends if we have enough results found for the page to display. With other words latter pages than the current can contain documents that will first be checked if those pages are requested to be displayed, what causes a incorrect hit count.

参数:

cms - the current OpenCms context

ignoreMaxRows - true to return all all requested rows, false to use max rows

query - the OpenCms Solr query

返回:

the list of found documents

抛出:

CmsSearchException - if something goes wrong

另请参阅:

CmsSolrResultList, CmsSearchResource, I_CmsSearchDocument, CmsSolrQuery

search

public CmsSolrResultList search(CmsObject cms,
                       org.apache.solr.client.solrj.SolrQuery query)
                         throws CmsSearchException

Default search method.

参数:

cms - the current CMS object

query - the query

返回:

the results

抛出:

CmsSearchException - if something goes wrong

另请参阅:

search(CmsObject, String)

search

public CmsSolrResultList search(CmsObject cms,
                       java.lang.String solrQuery)
                         throws CmsSearchException

Performs a search.

参数:

cms - the cms object

solrQuery - the Solr query

返回:

a list of documents

抛出:

CmsSearchException - if something goes wrong

另请参阅:

search(CmsObject, CmsSolrQuery, boolean)

select

public void select(javax.servlet.ServletResponse response,
          CmsObject cms,
          CmsSolrQuery query,
          boolean ignoreMaxRows)
            throws java.lang.Exception

Writes the response into the writer.

NOTE: Currently not available for HTTP server.

参数:

response - the servlet response

cms - the CMS object to use for search

query - the Solr query

ignoreMaxRows - if to return unlimited results

抛出:

java.lang.Exception - if there is no embedded server

setPostProcessor

public void setPostProcessor(I_CmsSolrPostSearchProcessor postProcessor)

Sets the search post processor.

参数:

postProcessor - the search post processor to set

setSolrServer

public void setSolrServer(org.apache.solr.client.solrj.SolrServer server)

Sets the Solr server used by this index.

参数:

server - the server to set

shutDown

public void shutDown()

从类复制的说明: CmsSearchIndex

Shuts down the search index.

This will close the local Lucene index searcher instance.

覆盖:

shutDown 在类中 CmsSearchIndex

另请参阅:

CmsSearchIndex.shutDown()

spellCheck

public void spellCheck(javax.servlet.ServletResponse res,
              CmsObject cms,
              CmsSolrQuery q)
                throws CmsSearchException

Executes a spell checking Solr query and returns the Solr query response.

参数:

res - the servlet response

cms - the CMS object

q - the query

抛出:

CmsSearchException - if something goes wrong

createIndexBackup

protected java.lang.String createIndexBackup()

从类复制的说明: CmsSearchIndex

Creates a backup of this index for optimized re-indexing of the whole content.

覆盖:

createIndexBackup 在类中 CmsSearchIndex

返回:

the path to the backup folder, or null in case no backup was created

另请参阅:

CmsSearchIndex.createIndexBackup()

excludeFromIndex

protected boolean excludeFromIndex(CmsObject cms,
                       CmsResource resource)

从类复制的说明: CmsSearchIndex

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

另请参阅:

CmsSearchIndex.excludeFromIndex(CmsObject, CmsResource)

indexSearcherClose

protected void indexSearcherClose()

从类复制的说明: CmsSearchIndex

Closes the index searcher for this index.

覆盖:

indexSearcherClose 在类中 CmsSearchIndex

另请参阅:

CmsSearchIndex.indexSearcherClose()

indexSearcherOpen

protected void indexSearcherOpen(java.lang.String path)

从类复制的说明: CmsSearchIndex

Initializes the index searcher for this index.

In case there is an index searcher still open, it is closed first.

For performance reasons, one instance of the index searcher should be kept for all searches. However, if the index is updated or changed this searcher instance needs to be re-initialized.

覆盖:

indexSearcherOpen 在类中 CmsSearchIndex

参数:

path - the path to the index directory

另请参阅:

CmsSearchIndex.indexSearcherOpen(java.lang.String)

indexSearcherUpdate

protected void indexSearcherUpdate()

从类复制的说明: CmsSearchIndex

Reopens the index search reader for this index, required after the index has been changed.

覆盖:

indexSearcherUpdate 在类中 CmsSearchIndex

另请参阅:

CmsSearchIndex.indexSearcherUpdate()

isIndexing

protected boolean isIndexing(CmsResource res)

Checks if the given resource should be indexed by this index or not.

参数:

res - the resource candidate

返回:

true if the given resource should be indexed or false if not