org.opencms.search.solr

类 CmsSolrFieldConfiguration

java.lang.Object

org.opencms.search.fields.CmsSearchFieldConfiguration

org.opencms.search.solr.CmsSolrFieldConfiguration

所有已实现的接口:

java.lang.Comparable<CmsSearchFieldConfiguration>, I_CmsSearchFieldAppdender

public class CmsSolrFieldConfiguration
extends CmsSearchFieldConfiguration

The search field implementation for Solr.

从以下版本开始:

8.5.0

字段概要

从类继承的字段 org.opencms.search.fields.CmsSearchFieldConfiguration

LAZY_FIELDS, STR_STANDARD

构造器概要

构造器

构造器和说明
CmsSolrFieldConfiguration() Default constructor.

方法概要

方法

限定符和类型	方法和说明
void	addAdditionalFields() Add the additional fields to the configuration.
protected void	addAdditionalFields(java.util.List<CmsSolrField> additionalFields) Adds the additional fields to the configuration, if they are not null.
protected I_CmsSearchDocument	appendDates(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched) Extends the given document by fields for date of creation, content and last modification.
protected I_CmsSearchDocument	appendFieldMapping(I_CmsSearchDocument document, CmsSearchField sfield, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched) Extends the given document by the mappings for the given field.
protected I_CmsSearchDocument	appendFieldMappings(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched) Extends the given document by the configured field mappings.
I_CmsSearchDocument	appendFields(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched) Appends the Solr specific search fields to the document.
protected I_CmsSearchDocument	appendLocales(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extraction, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched) Extends the given document by the "res_locales" field.
protected I_CmsSearchDocument	appendProperties(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extraction, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched) Appends all direct properties, that are not empty or white space only to the document.
protected java.util.List<java.util.Locale>	getContentLocales(CmsObject cms, CmsResource resource, I_CmsExtractionResult extraction) Retrieves the locales for an content, that is whether an XML content nor an XML page.
java.util.Map<java.lang.String,CmsSolrField>	getSolrFields() Returns all configured Solr fields.
protected java.util.Set<CmsSearchField>	getXSDMappings(CmsObject cms, CmsResource resource) Returns the search field mappings declared within the XSD.

从类继承的方法 org.opencms.search.fields.CmsSearchFieldConfiguration

addField, addFields, appendCategories, appendContentBlob, appendFileSize, appendPath, appendType, compareTo, createDocument, equals, getDescription, getField, getFieldNames, getFields, getIndex, getLocaleExtendedName, getLocaleExtendedName, getName, getParentFolderTokens, hashCode, init, setBoost, setDescription, setIndex, setName

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

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

构造器详细资料

CmsSolrFieldConfiguration

public CmsSolrFieldConfiguration()

Default constructor.

方法详细资料

addAdditionalFields

public void addAdditionalFields()

从接口复制的说明: I_CmsSearchFieldAppdender

Add the additional fields to the configuration.

I_CmsSearchFieldAppdender.appendFields(I_CmsSearchDocument, CmsObject, CmsResource, I_CmsExtractionResult, List, List)

指定者:

addAdditionalFields 在接口中 I_CmsSearchFieldAppdender

覆盖:

addAdditionalFields 在类中 CmsSearchFieldConfiguration

另请参阅:

CmsSearchFieldConfiguration.addAdditionalFields()

appendFields

public I_CmsSearchDocument appendFields(I_CmsSearchDocument document,
                               CmsObject cms,
                               CmsResource resource,
                               I_CmsExtractionResult extractionResult,
                               java.util.List<CmsProperty> properties,
                               java.util.List<CmsProperty> propertiesSearched)

Appends the Solr specific search fields to the document.

指定者:

appendFields 在接口中 I_CmsSearchFieldAppdender

覆盖:

appendFields 在类中 CmsSearchFieldConfiguration

参数:

document - the document to append field(s)

cms - the CMS object used during indexing process

resource - the resource that is currently indexed

extractionResult - the extraction result of this resource

properties - CmsObject.readPropertyObjects(CmsResource, boolean) with false

propertiesSearched - CmsObject.readPropertyObjects(CmsResource, boolean) with true

返回:

the document

另请参阅:

I_CmsSearchFieldAppdender.appendFields(org.opencms.search.I_CmsSearchDocument, org.opencms.file.CmsObject, org.opencms.file.CmsResource, org.opencms.search.extractors.I_CmsExtractionResult, java.util.List, java.util.List)

getSolrFields

public java.util.Map<java.lang.String,CmsSolrField> getSolrFields()

Returns all configured Solr fields.

返回:

all configured Solr fields

addAdditionalFields

protected void addAdditionalFields(java.util.List<CmsSolrField> additionalFields)

Adds the additional fields to the configuration, if they are not null.

参数:

additionalFields - the additional fields to add

appendDates

protected I_CmsSearchDocument appendDates(I_CmsSearchDocument document,
                              CmsObject cms,
                              CmsResource resource,
                              I_CmsExtractionResult extractionResult,
                              java.util.List<CmsProperty> properties,
                              java.util.List<CmsProperty> propertiesSearched)

从类复制的说明: CmsSearchFieldConfiguration

Extends the given document by fields for date of creation, content and last modification.

覆盖:

appendDates 在类中 CmsSearchFieldConfiguration

参数:

document - the document to extend

cms - the OpenCms context used for building the search index

resource - the resource that is indexed

extractionResult - the plain text extraction result from the resource

properties - the list of all properties directly attached to the resource (not searched)

propertiesSearched - the list of all searched properties of the resource

返回:

the document extended by fields for date of creation, content and last modification

另请参阅:

CmsSearchFieldConfiguration.appendDates(org.opencms.search.I_CmsSearchDocument, org.opencms.file.CmsObject, org.opencms.file.CmsResource, org.opencms.search.extractors.I_CmsExtractionResult, java.util.List, java.util.List)

appendFieldMapping

protected I_CmsSearchDocument appendFieldMapping(I_CmsSearchDocument document,
                                     CmsSearchField sfield,
                                     CmsObject cms,
                                     CmsResource resource,
                                     I_CmsExtractionResult extractionResult,
                                     java.util.List<CmsProperty> properties,
                                     java.util.List<CmsProperty> propertiesSearched)

从类复制的说明: CmsSearchFieldConfiguration

Extends the given document by the mappings for the given field.

覆盖:

appendFieldMapping 在类中 CmsSearchFieldConfiguration

参数:

document - the document to extend

sfield - the field to create the mappings for

cms - the OpenCms context used for building the search index

resource - the resource that is indexed

extractionResult - the plain text extraction result from the resource

properties - the list of all properties directly attached to the resource (not searched)

propertiesSearched - the list of all searched properties of the resource

返回:

the document extended by the mappings for the given field

另请参阅:

CmsSearchFieldConfiguration.appendFieldMapping(org.opencms.search.I_CmsSearchDocument, org.opencms.search.fields.CmsSearchField, org.opencms.file.CmsObject, org.opencms.file.CmsResource, org.opencms.search.extractors.I_CmsExtractionResult, java.util.List, java.util.List)

appendFieldMappings

protected I_CmsSearchDocument appendFieldMappings(I_CmsSearchDocument document,
                                      CmsObject cms,
                                      CmsResource resource,
                                      I_CmsExtractionResult extractionResult,
                                      java.util.List<CmsProperty> properties,
                                      java.util.List<CmsProperty> propertiesSearched)

从类复制的说明: CmsSearchFieldConfiguration

Extends the given document by the configured field mappings.

覆盖:

appendFieldMappings 在类中 CmsSearchFieldConfiguration

参数:

document - the document to extend

cms - the OpenCms context used for building the search index

resource - the resource that is indexed

extractionResult - the plain text extraction result from the resource

properties - the list of all properties directly attached to the resource (not searched)

propertiesSearched - the list of all searched properties of the resource

返回:

the document extended by the configured field mappings

另请参阅:

CmsSearchFieldConfiguration.appendFieldMappings(org.opencms.search.I_CmsSearchDocument, org.opencms.file.CmsObject, org.opencms.file.CmsResource, org.opencms.search.extractors.I_CmsExtractionResult, java.util.List, java.util.List)

appendLocales

protected I_CmsSearchDocument appendLocales(I_CmsSearchDocument document,
                                CmsObject cms,
                                CmsResource resource,
                                I_CmsExtractionResult extraction,
                                java.util.List<CmsProperty> properties,
                                java.util.List<CmsProperty> propertiesSearched)

从类复制的说明: CmsSearchFieldConfiguration

Extends the given document by the "res_locales" field.

覆盖:

appendLocales 在类中 CmsSearchFieldConfiguration

参数:

document - the document to extend

cms - the OpenCms context used for building the search index

resource - the resource that is indexed

extraction - the plain text extraction result from the resource

properties - the list of all properties directly attached to the resource (not searched)

propertiesSearched - the list of all searched properties of the resource

返回:

the document extended by the resource locales

另请参阅:

CmsSearchFieldConfiguration.appendLocales(org.opencms.search.I_CmsSearchDocument, org.opencms.file.CmsObject, org.opencms.file.CmsResource, org.opencms.search.extractors.I_CmsExtractionResult, java.util.List, java.util.List)

appendProperties

protected I_CmsSearchDocument appendProperties(I_CmsSearchDocument document,
                                   CmsObject cms,
                                   CmsResource resource,
                                   I_CmsExtractionResult extraction,
                                   java.util.List<CmsProperty> properties,
                                   java.util.List<CmsProperty> propertiesSearched)

从类复制的说明: CmsSearchFieldConfiguration

Appends all direct properties, that are not empty or white space only to the document.

覆盖:

appendProperties 在类中 CmsSearchFieldConfiguration

参数:

document - the document to extend

cms - the OpenCms context used for building the search index

resource - the resource that is indexed

extraction - the plain text extraction result from the resource

properties - the list of all properties directly attached to the resource (not searched)

propertiesSearched - the list of all searched properties of the resource

返回:

the document extended by resource category information

另请参阅:

CmsSearchFieldConfiguration.appendProperties(org.opencms.search.I_CmsSearchDocument, org.opencms.file.CmsObject, org.opencms.file.CmsResource, org.opencms.search.extractors.I_CmsExtractionResult, java.util.List, java.util.List)

getContentLocales

protected java.util.List<java.util.Locale> getContentLocales(CmsObject cms,
                                                 CmsResource resource,
                                                 I_CmsExtractionResult extraction)

Retrieves the locales for an content, that is whether an XML content nor an XML page.

Uses following strategy:

• first by file name
• then by detection and
• otherwise take the first configured default locale for this resource

参数:

cms - the current CmsObject

resource - the resource to get the content locales for

extraction - the extraction result

返回:

the determined locales for the given resource

getXSDMappings

protected java.util.Set<CmsSearchField> getXSDMappings(CmsObject cms,
                                           CmsResource resource)

Returns the search field mappings declared within the XSD.

参数:

cms - the CmsObject

resource - the resource

返回:

the fields to map