org.opencms.search.galleries
Class CmsGallerySearchInfoProvider

java.lang.Object
  org.opencms.search.galleries.CmsGallerySearchInfoProvider

public final class CmsGallerySearchInfoProvider
extends Object

Provides additional information to be stored in the gallery search index.

Since:

8.0.0

Method Summary

static String	getAdditionalInfo(CmsObject cms, CmsResource res, I_CmsExtractionResult extractionResult, List<CmsProperty> properties, List<CmsProperty> propertiesSearched) Provides additional information to be stored in the gallery search index.
static String	getContainerTypes(CmsObject cms, CmsResource res, I_CmsExtractionResult extractionResult, List<CmsProperty> properties, List<CmsProperty> propertiesSearched) Provides the container types to be stored in the gallery search index.

Methods inherited from class java.lang.Object

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

Method Detail

getAdditionalInfo

public static String getAdditionalInfo(CmsObject cms,
                                       CmsResource res,
                                       I_CmsExtractionResult extractionResult,
                                       List<CmsProperty> properties,
                                       List<CmsProperty> propertiesSearched)

Provides additional information to be stored in the gallery search index.

Parameters:

cms - the OpenCms context used for building the search index

res - 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 String value extracted form the provided data according to the rules of this mapping type

getContainerTypes

public static String getContainerTypes(CmsObject cms,
                                       CmsResource res,
                                       I_CmsExtractionResult extractionResult,
                                       List<CmsProperty> properties,
                                       List<CmsProperty> propertiesSearched)

Provides the container types to be stored in the gallery search index.

The return value is one string that contains all supported container names separated by a white space.

Parameters:

cms - the OpenCms context used for building the search index

res - 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 String value extracted form the provided data according to the rules of this mapping type