Package org.opencms.search.solr

Interface I_CmsSolrDocumentTransformer

public interface I_CmsSolrDocumentTransformer

The processor can be used in order to manipulate search documents before they are indexed.

Since:

21.0

Method Summary

Modifier and Type	Method	Description
void	init(I_CmsSearchIndex index)	(Re-)Initializes the transformer.
I_CmsSearchDocument	transform(I_CmsSearchDocument doc, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, List<CmsProperty> properties, List<CmsProperty> propertiesSearched)	Performs the transformation.

Method Details

init

void init(I_CmsSearchIndex index)

(Re-)Initializes the transformer.

transform

I_CmsSearchDocument transform(I_CmsSearchDocument doc,
 CmsObject cms,
 CmsResource resource,
 I_CmsExtractionResult extractionResult,
 List<CmsProperty> properties,
 List<CmsProperty> propertiesSearched)

Performs the transformation.

Parameters:

doc - the document to transform

cms - the CMS object

resource - the resource for the found document

extractionResult - the extraction result

properties - the properties set directly at the resource

propertiesSearched - the properties read recursively from the resource

Returns:

the manipulated Solr document