Package org.broadleafcommerce.core.search.service.solr.index

Class AbstractSolrIndexServiceExtensionHandler

java.lang.Object

org.broadleafcommerce.common.extension.AbstractExtensionHandler

org.broadleafcommerce.core.search.service.solr.index.AbstractSolrIndexServiceExtensionHandler

All Implemented Interfaces:

ExtensionHandler, SolrIndexServiceExtensionHandler

Direct Known Subclasses:

I18nSolrIndexServiceExtensionHandler

public abstract class AbstractSolrIndexServiceExtensionHandler
extends AbstractExtensionHandler
implements SolrIndexServiceExtensionHandler

Implementors of the SolrIndexServiceExtensionHandler interface should extend this class so that if additional extension points are added which they don't care about, their code will not need to be modified.

Author:

bpolster, Phillip Verheyden (phillipuniverse)

Field Summary

Fields inherited from class org.broadleafcommerce.common.extension.AbstractExtensionHandler

enabled, priority

Constructor Summary

Constructors

Constructor	Description
AbstractSolrIndexServiceExtensionHandler()

Method Summary

Modifier and Type	Method	Description
ExtensionResultStatusType	addPropertyValues(Indexable indexable, Field field, FieldType fieldType, Map<String,Object> values, String propertyName, List<Locale> locales)	Given the input field, populates the values array with the fields needed for the passed in field.
ExtensionResultStatusType	attachAdditionalBasicFields(Indexable indexable, org.apache.solr.common.SolrInputDocument document, SolrHelperService shs)	Allows the extension additional fields to the document that are not configured via the DB.
ExtensionResultStatusType	attachAdditionalDocumentFields(Indexable indexable, org.apache.solr.common.SolrInputDocument document)
ExtensionResultStatusType	attachChildDocuments(Indexable indexable, org.apache.solr.common.SolrInputDocument document, List<IndexField> fields, List<Locale> locales)	This extension point allows other modules to contribute child documents to this document.
ExtensionResultStatusType	endBatchEvent(List<? extends Indexable> products)	Perform actions to end a batch event, such as closing any Contexts that have been previously created.
ExtensionResultStatusType	getCategoryId(Long category, Long[] returnContainer)	In certain scenarios, the requested category id might not be the one that should be used in Solr.
ExtensionResultStatusType	getIndexableId(Indexable indexable, Long[] returnContainer)	In certain scenarios, the requested product id might not be the one that should be used in Solr.
ExtensionResultStatusType	modifyBuiltDocuments(Collection<org.apache.solr.common.SolrInputDocument> documents, List<? extends Indexable> products, List<IndexField> fields, List<Locale> locales)
ExtensionResultStatusType	populateDocumentForIndexField(org.apache.solr.common.SolrInputDocument document, IndexField field, FieldType fieldType, Map<String,Object> propertyValues)	This is used to populate any fields for the given parameters as well as adding any property names to the added properties list.
ExtensionResultStatusType	startBatchEvent(List<? extends Indexable> products)	Perform actions at the start of a batch to improve performance of Solr search for the list of batch products.

Methods inherited from class org.broadleafcommerce.common.extension.AbstractExtensionHandler

getPriority, isEnabled, setEnabled, setPriority

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.broadleafcommerce.common.extension.ExtensionHandler

getPriority, isEnabled

Constructor Details

AbstractSolrIndexServiceExtensionHandler

public AbstractSolrIndexServiceExtensionHandler()

Method Details

addPropertyValues

public ExtensionResultStatusType addPropertyValues(Indexable indexable,
 Field field,
 FieldType fieldType,
 Map<String,Object> values,
 String propertyName,
 List<Locale> locales)
                                            throws IllegalAccessException,
InvocationTargetException,
NoSuchMethodException

Description copied from interface: SolrIndexServiceExtensionHandler

Given the input field, populates the values array with the fields needed for the passed in field.

For example, a handler might create multiple fields for the given passed in field.

Specified by:

addPropertyValues in interface SolrIndexServiceExtensionHandler

Returns:

Throws:

IllegalAccessException

InvocationTargetException

NoSuchMethodException

attachAdditionalBasicFields

public ExtensionResultStatusType attachAdditionalBasicFields(Indexable indexable,
 org.apache.solr.common.SolrInputDocument document,
 SolrHelperService shs)

Description copied from interface: SolrIndexServiceExtensionHandler

Allows the extension additional fields to the document that are not configured via the DB.

Specified by:

attachAdditionalBasicFields in interface SolrIndexServiceExtensionHandler

populateDocumentForIndexField

public ExtensionResultStatusType populateDocumentForIndexField(org.apache.solr.common.SolrInputDocument document,
 IndexField field,
 FieldType fieldType,
 Map<String,Object> propertyValues)

Description copied from interface: SolrIndexServiceExtensionHandler

This is used to populate any fields for the given parameters as well as adding any property names to the added properties list.

Specified by:

populateDocumentForIndexField in interface SolrIndexServiceExtensionHandler

Parameters:

document - the document we are populating

field - the field we are populating the document with

fieldType - the field type of the field

propertyValues - the property values for the given Field

Returns:

the result of this handler, if NOT_HANDLED, no fields were populated

attachAdditionalDocumentFields

public ExtensionResultStatusType attachAdditionalDocumentFields(Indexable indexable,
 org.apache.solr.common.SolrInputDocument document)

Specified by:

attachAdditionalDocumentFields in interface SolrIndexServiceExtensionHandler

attachChildDocuments

public ExtensionResultStatusType attachChildDocuments(Indexable indexable,
 org.apache.solr.common.SolrInputDocument document,
 List<IndexField> fields,
 List<Locale> locales)

Description copied from interface: SolrIndexServiceExtensionHandler

This extension point allows other modules to contribute child documents to this document.

Specified by:

attachChildDocuments in interface SolrIndexServiceExtensionHandler

Returns:

either ExtensionResultStatusType.NOT_HANDLED or ExtensionResultStatusType.HANDLED_CONTINUE.

modifyBuiltDocuments

public ExtensionResultStatusType modifyBuiltDocuments(Collection<org.apache.solr.common.SolrInputDocument> documents,
 List<? extends Indexable> products,
 List<IndexField> fields,
 List<Locale> locales)

Specified by:

modifyBuiltDocuments in interface SolrIndexServiceExtensionHandler

startBatchEvent

public ExtensionResultStatusType startBatchEvent(List<? extends Indexable> products)

Description copied from interface: SolrIndexServiceExtensionHandler

Perform actions at the start of a batch to improve performance of Solr search for the list of batch products. For example we want to get, in bulk, the SkuPriceData for each product and save these in memory by default.

Specified by:

startBatchEvent in interface SolrIndexServiceExtensionHandler

Returns:

endBatchEvent

public ExtensionResultStatusType endBatchEvent(List<? extends Indexable> products)

Description copied from interface: SolrIndexServiceExtensionHandler

Perform actions to end a batch event, such as closing any Contexts that have been previously created.

Specified by:

endBatchEvent in interface SolrIndexServiceExtensionHandler

Returns:

getIndexableId

public ExtensionResultStatusType getIndexableId(Indexable indexable,
 Long[] returnContainer)

Description copied from interface: SolrIndexServiceExtensionHandler

In certain scenarios, the requested product id might not be the one that should be used in Solr. If this method returns ExtensionResultStatusType.HANDLED, the value placed in the 0th element in the returnContainer should be used.

Specified by:

getIndexableId in interface SolrIndexServiceExtensionHandler

Returns:

the extension result status type

getCategoryId

public ExtensionResultStatusType getCategoryId(Long category,
 Long[] returnContainer)

Description copied from interface: SolrIndexServiceExtensionHandler

In certain scenarios, the requested category id might not be the one that should be used in Solr. If this method returns ExtensionResultStatusType.HANDLED, the value placed in the 0th element in the returnContainer should be used.

Specified by:

getCategoryId in interface SolrIndexServiceExtensionHandler

Returns:

the extension result status type