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 TypeMethodDescriptionvoidinit(I_CmsSearchIndex index) (Re-)Initializes the transformer.transform(I_CmsSearchDocument doc, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, List<CmsProperty> properties, List<CmsProperty> propertiesSearched) Performs the transformation.
-
Method Details
-
init
(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 transformcms- the CMS objectresource- the resource for the found documentextractionResult- the extraction resultproperties- the properties set directly at the resourcepropertiesSearched- the properties read recursively from the resource- Returns:
- the manipulated Solr document
-