org.opencms.search.galleries
Class CmsGallerySearchFieldConfiguration

java.lang.Object
  org.opencms.search.fields.CmsSearchFieldConfiguration
      org.opencms.search.fields.CmsLuceneFieldConfiguration
          org.opencms.search.galleries.CmsGallerySearchFieldConfiguration

All Implemented Interfaces:

java.lang.Comparable<CmsSearchFieldConfiguration>

public class CmsGallerySearchFieldConfiguration
extends CmsLuceneFieldConfiguration

Describes the search field configuration that is used by the gallery index.

Since:

8.0.0

Field Summary

Fields inherited from class org.opencms.search.fields.CmsLuceneFieldConfiguration

DEFAULT_STANDARD, STR_STANDARD_DESCRIPTION

Fields inherited from class org.opencms.search.fields.CmsSearchFieldConfiguration

STR_STANDARD

Constructor Summary

CmsGallerySearchFieldConfiguration()
Default constructor.

Method Summary

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.
protected I_CmsSearchDocument	appendMultipleFieldMapping(I_CmsSearchDocument document, CmsSearchField field, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched) Extends the given document by the gallery index special multiple language filed mappings for the given field.

Methods inherited from class org.opencms.search.fields.CmsLuceneFieldConfiguration

getAnalyzer, getExcerptFieldNames, getLuceneFields

Methods inherited from class org.opencms.search.fields.CmsSearchFieldConfiguration

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

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsGallerySearchFieldConfiguration

public CmsGallerySearchFieldConfiguration()

Default constructor.

Method Detail

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)

Extends the given document by the configured field mappings.

Overrides:

appendFieldMappings in class CmsSearchFieldConfiguration

Parameters:

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

Returns:

the document extended by the configured field mappings

appendMultipleFieldMapping

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

Extends the given document by the gallery index special multiple language filed mappings for the given field.

Parameters:

document - the document to extend

field - 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

Returns:

the document extended by the gallery index special multiple language filed mappings for the given field