org.opencms.search.galleries
Class CmsGallerySearchFieldConfiguration

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

All Implemented Interfaces:

java.lang.Comparable<CmsSearchFieldConfiguration>

public class CmsGallerySearchFieldConfiguration
extends CmsSearchFieldConfiguration

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.CmsSearchFieldConfiguration

DEFAULT_STANDARD, SEARCH_PRIORITY_HIGH_VALUE, SEARCH_PRIORITY_LOW_VALUE, SEARCH_PRIORITY_MAX_VALUE, SEARCH_PRIORITY_NORMAL_VALUE, STR_STANDARD, STR_STANDARD_DESCRIPTION, VFS_DOCUMENT_KEY_PREFIX

Constructor Summary

CmsGallerySearchFieldConfiguration()
Default constructor.

Method Summary

protected org.apache.lucene.document.Document	appendFieldMappings(org.apache.lucene.document.Document 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 org.apache.lucene.document.Document	appendMultipleFieldMapping(org.apache.lucene.document.Document document, CmsSearchField fieldConfig, 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.
static java.lang.String	getLocaleExtendedName(java.lang.String lookup, java.util.Locale locale) Returns the locale extended name for the given lookup String.
static java.lang.String	getLocaleExtendedName(java.lang.String lookup, java.lang.String locale) Returns the locale extended name for the given lookup String.

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

addField, appendCategories, appendContentBlob, appendDates, appendFieldMapping, appendPath, appendType, compareTo, createDocument, equals, getAnalyzer, getDateTerms, getDescription, getExcerptFieldNames, getField, getFieldNames, getFields, getName, getParentFolderTokens, hashCode, setBoost, setDescription, 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

getLocaleExtendedName

public static final java.lang.String getLocaleExtendedName(java.lang.String lookup,
                                                           java.util.Locale locale)

Returns the locale extended name for the given lookup String.

Parameters:

lookup - the lookup String

locale - the locale

Returns:

the locale extended name for the given lookup String

getLocaleExtendedName

public static final java.lang.String getLocaleExtendedName(java.lang.String lookup,
                                                           java.lang.String locale)

Returns the locale extended name for the given lookup String.

Parameters:

lookup - the lookup String

locale - the locale

Returns:

the locale extended name for the given lookup String

appendFieldMappings

protected org.apache.lucene.document.Document appendFieldMappings(org.apache.lucene.document.Document 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 org.apache.lucene.document.Document appendMultipleFieldMapping(org.apache.lucene.document.Document document,
                                                                         CmsSearchField fieldConfig,
                                                                         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

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