Uses of Interface
org.broadleafcommerce.core.catalog.domain.Indexable

Packages that use Indexable

Package	Description
org.broadleafcommerce.core.catalog.domain
org.broadleafcommerce.core.search.service.solr
org.broadleafcommerce.core.search.service.solr.index
org.broadleafcommerce.core.search.service.solr.indexer

Uses of Indexable in org.broadleafcommerce.core.catalog.domain

Subinterfaces of Indexable in org.broadleafcommerce.core.catalog.domain

Modifier and Type	Interface	Description
interface	Product	Implementations of this interface are used to hold data for a Product.
interface	ProductBundle	Deprecated. instead, use the ProductType Module's Product Add-Ons to build and configure bundles
interface	Sku	Implementations of this interface are used to hold data about a SKU.

Classes in org.broadleafcommerce.core.catalog.domain that implement Indexable

Modifier and Type	Class	Description
class	ProductBundleImpl	Deprecated. instead, use the ProductType Module's Product Add-Ons to build and configure bundles
class	ProductImpl	The Class ProductImpl is the default implementation of Product.
class	SkuImpl	The Class SkuImpl is the default implementation of Sku.

Uses of Indexable in org.broadleafcommerce.core.search.service.solr

Methods in org.broadleafcommerce.core.search.service.solr with parameters of type Indexable

Modifier and Type	Method	Description
Long	SolrHelperService.getCurrentProductId(Indexable indexable)
Long	SolrHelperServiceImpl.getCurrentProductId(Indexable indexable)
String	SolrHelperService.getDocumentType(Indexable indexable)	Returns the type for the given Indexable.
String	SolrHelperServiceImpl.getDocumentType(Indexable indexable)
Long	SolrHelperService.getIndexableId(Indexable indexable)	In certain cases, the sku id used for Solr indexing is different than the direct id on the sku.
Long	SolrHelperServiceImpl.getIndexableId(Indexable indexable)
Product	SolrHelperService.getProductForIndexable(Indexable indexable)
Product	SolrHelperServiceImpl.getProductForIndexable(Indexable indexable)
String	SolrHelperService.getSolrDocumentId(org.apache.solr.common.SolrInputDocument document, Indexable indexable)
String	SolrHelperServiceImpl.getSolrDocumentId(org.apache.solr.common.SolrInputDocument document, Indexable indexable)

Uses of Indexable in org.broadleafcommerce.core.search.service.solr.index

Methods in org.broadleafcommerce.core.search.service.solr.index that return types with arguments of type Indexable

Modifier and Type	Method	Description
protected List<? extends Indexable>	SolrIndexServiceImpl.readAllActiveIndexables(int pageSize, Long lastId)
List<? extends Indexable>	SolrIndexOperation.readIndexables(int pageSize, Long lastId)	Perform the a read of the Indexable items for a particular page and pageSize

Methods in org.broadleafcommerce.core.search.service.solr.index with parameters of type Indexable

Modifier and Type	Method	Description
org.broadleafcommerce.common.extension.ExtensionResultStatusType	AbstractSolrIndexServiceExtensionHandler.addPropertyValues(Indexable indexable, Field field, FieldType fieldType, Map<String,Object> values, String propertyName, List<org.broadleafcommerce.common.locale.domain.Locale> locales)
org.broadleafcommerce.common.extension.ExtensionResultStatusType	I18nSolrIndexServiceExtensionHandler.addPropertyValues(Indexable indexable, Field field, FieldType fieldType, Map<String,Object> values, String propertyName, List<org.broadleafcommerce.common.locale.domain.Locale> locales)
org.broadleafcommerce.common.extension.ExtensionResultStatusType	SolrIndexServiceExtensionHandler.addPropertyValues(Indexable indexable, Field field, FieldType fieldType, Map<String,Object> values, String propertyName, List<org.broadleafcommerce.common.locale.domain.Locale> locales)	Given the input field, populates the values array with the fields needed for the passed in field.
org.broadleafcommerce.common.extension.ExtensionResultStatusType	AbstractSolrIndexServiceExtensionHandler.attachAdditionalBasicFields(Indexable indexable, org.apache.solr.common.SolrInputDocument document, SolrHelperService shs)
org.broadleafcommerce.common.extension.ExtensionResultStatusType	SolrIndexServiceExtensionHandler.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.
org.broadleafcommerce.common.extension.ExtensionResultStatusType	AbstractSolrIndexServiceExtensionHandler.attachAdditionalDocumentFields(Indexable indexable, org.apache.solr.common.SolrInputDocument document)
org.broadleafcommerce.common.extension.ExtensionResultStatusType	SolrIndexServiceExtensionHandler.attachAdditionalDocumentFields(Indexable indexable, org.apache.solr.common.SolrInputDocument document)
protected void	SolrIndexServiceImpl.attachAdditionalDocumentFields(Indexable indexable, org.apache.solr.common.SolrInputDocument document)	Implementors can extend this and override this method to add additional fields to the Solr document.
protected void	SolrIndexServiceImpl.attachBasicDocumentFields(Indexable indexable, org.apache.solr.common.SolrInputDocument document)
org.broadleafcommerce.common.extension.ExtensionResultStatusType	AbstractSolrIndexServiceExtensionHandler.attachChildDocuments(Indexable indexable, org.apache.solr.common.SolrInputDocument document, List<IndexField> fields, List<org.broadleafcommerce.common.locale.domain.Locale> locales)
org.broadleafcommerce.common.extension.ExtensionResultStatusType	SolrIndexServiceExtensionHandler.attachChildDocuments(Indexable indexable, org.apache.solr.common.SolrInputDocument document, List<IndexField> fields, List<org.broadleafcommerce.common.locale.domain.Locale> locales)	This extension point allows other modules to contribute child documents to this document.
void	SolrIndexService.attachIndexableDocumentFields(org.apache.solr.common.SolrInputDocument document, Indexable indexable, List<IndexField> fields, List<org.broadleafcommerce.common.locale.domain.Locale> locales)	Iterates through the fields for this Indexable and indexes any IndexFields
void	SolrIndexServiceImpl.attachIndexableDocumentFields(org.apache.solr.common.SolrInputDocument document, Indexable indexable, List<IndexField> fields, List<org.broadleafcommerce.common.locale.domain.Locale> locales)
org.apache.solr.common.SolrInputDocument	SolrIndexService.buildDocument(Indexable indexable, List<IndexField> fields, List<org.broadleafcommerce.common.locale.domain.Locale> locales)	Given a product, fields that relate to that product, and a list of locales and pricelists, builds a SolrInputDocument to be added to the Solr index.
org.apache.solr.common.SolrInputDocument	SolrIndexServiceImpl.buildDocument(Indexable indexable, List<IndexField> fields, List<org.broadleafcommerce.common.locale.domain.Locale> locales)
org.broadleafcommerce.common.extension.ExtensionResultStatusType	AbstractSolrIndexServiceExtensionHandler.getIndexableId(Indexable indexable, Long[] returnContainer)
org.broadleafcommerce.common.extension.ExtensionResultStatusType	SolrIndexServiceExtensionHandler.getIndexableId(Indexable indexable, Long[] returnContainer)	In certain scenarios, the requested product id might not be the one that should be used in Solr.
protected Map<String,Object>	SolrIndexServiceImpl.getPropertyValues(Indexable indexedItem, Field field, FieldType fieldType, List<org.broadleafcommerce.common.locale.domain.Locale> locales)	Returns a map of prefix to value for the requested attributes.

Method parameters in org.broadleafcommerce.core.search.service.solr.index with type arguments of type Indexable

Modifier and Type	Method	Description
Collection<org.apache.solr.common.SolrInputDocument>	SolrIndexService.buildIncrementalIndex(String collection, List<? extends Indexable> indexables, org.apache.solr.client.solrj.SolrClient solrServer)	Builds a set of Indexables against the given SolrServer
Collection<org.apache.solr.common.SolrInputDocument>	SolrIndexService.buildIncrementalIndex(List<? extends Indexable> indexables, org.apache.solr.client.solrj.SolrClient solrServer)	Deprecated. Use SolrIndexService.buildIncrementalIndex(String, List, SolrClient) instead so that the collection that's being used can be customized otherwise the default collection will always be used.
Collection<org.apache.solr.common.SolrInputDocument>	SolrIndexServiceImpl.buildIncrementalIndex(String collection, List<? extends Indexable> indexables, org.apache.solr.client.solrj.SolrClient solrServer)
Collection<org.apache.solr.common.SolrInputDocument>	SolrIndexServiceImpl.buildIncrementalIndex(List<? extends Indexable> indexables, org.apache.solr.client.solrj.SolrClient solrServer)
void	SolrIndexOperation.buildPage(List<? extends Indexable> indexables)	Build a page from SolrIndexOperation.readIndexables(int, Long) on the SolrIndexOperation.getSolrServerForIndexing().
org.broadleafcommerce.common.extension.ExtensionResultStatusType	AbstractSolrIndexServiceExtensionHandler.endBatchEvent(List<? extends Indexable> products)
org.broadleafcommerce.common.extension.ExtensionResultStatusType	I18nSolrIndexServiceExtensionHandler.endBatchEvent(List<? extends Indexable> indexables)
org.broadleafcommerce.common.extension.ExtensionResultStatusType	SolrIndexServiceExtensionHandler.endBatchEvent(List<? extends Indexable> indexables)	Perform actions to end a batch event, such as closing any Contexts that have been previously created.
org.broadleafcommerce.common.extension.ExtensionResultStatusType	AbstractSolrIndexServiceExtensionHandler.modifyBuiltDocuments(Collection<org.apache.solr.common.SolrInputDocument> documents, List<? extends Indexable> products, List<IndexField> fields, List<org.broadleafcommerce.common.locale.domain.Locale> locales)
org.broadleafcommerce.common.extension.ExtensionResultStatusType	SolrIndexServiceExtensionHandler.modifyBuiltDocuments(Collection<org.apache.solr.common.SolrInputDocument> documents, List<? extends Indexable> items, List<IndexField> fields, List<org.broadleafcommerce.common.locale.domain.Locale> locales)
org.broadleafcommerce.common.extension.ExtensionResultStatusType	AbstractSolrIndexServiceExtensionHandler.startBatchEvent(List<? extends Indexable> products)
org.broadleafcommerce.common.extension.ExtensionResultStatusType	I18nSolrIndexServiceExtensionHandler.startBatchEvent(List<? extends Indexable> indexables)
org.broadleafcommerce.common.extension.ExtensionResultStatusType	SolrIndexServiceExtensionHandler.startBatchEvent(List<? extends Indexable> indexables)	Perform actions at the start of a batch to improve performance of Solr search for the list of batch products.

Uses of Indexable in org.broadleafcommerce.core.search.service.solr.indexer

Methods in org.broadleafcommerce.core.search.service.solr.indexer with parameters of type Indexable

Modifier and Type	Method	Description
protected void	CatalogDocumentBuilderImpl.attachAdditionalDocumentFields(Indexable indexable, org.apache.solr.common.SolrInputDocument document)
protected void	CatalogDocumentBuilderImpl.attachBasicDocumentFields(Indexable indexable, org.apache.solr.common.SolrInputDocument document)
protected void	CatalogDocumentBuilderImpl.attachIndexableDocumentFields(org.apache.solr.common.SolrInputDocument document, Indexable indexable, List<IndexField> fields, List<org.broadleafcommerce.common.locale.domain.Locale> locales)
org.apache.solr.common.SolrInputDocument	AbstractSolrIndexUpdateServiceImpl.buildDocument(Indexable indexable)
org.apache.solr.common.SolrInputDocument	AbstractSolrIndexUpdateServiceImpl.buildDocument(Indexable indexable, List<IndexField> fields, List<org.broadleafcommerce.common.locale.domain.Locale> locales)
org.apache.solr.common.SolrInputDocument	CatalogDocumentBuilderImpl.buildDocument(Indexable indexable, List<IndexField> fields, List<org.broadleafcommerce.common.locale.domain.Locale> locales)
org.apache.solr.common.SolrInputDocument	CatalogSolrIndexUpdateCommandHandlerImpl.buildDocument(Indexable indexable)
org.apache.solr.common.SolrInputDocument	CatalogSolrIndexUpdateCommandHandlerImpl.buildDocument(Indexable indexable, List<IndexField> fields, List<org.broadleafcommerce.common.locale.domain.Locale> locales)
org.apache.solr.common.SolrInputDocument	DocumentBuilder.buildDocument(Indexable indexable, List<IndexField> fields, List<org.broadleafcommerce.common.locale.domain.Locale> locales)
org.apache.solr.common.SolrInputDocument	SolrIndexUpdateCommandHandler.buildDocument(Indexable indexable)	Provides an interface for a caller to convert an Indexable into a SolrInputDocument.
org.apache.solr.common.SolrInputDocument	SolrIndexUpdateCommandHandler.buildDocument(Indexable indexable, List<IndexField> fields, List<org.broadleafcommerce.common.locale.domain.Locale> locales)	Provides an interface for a caller to convert an Indexable into a SolrInputDocument.
org.apache.solr.common.SolrInputDocument	SolrIndexUpdateService.buildDocument(Indexable indexable)	Provides an interface for a caller to convert an Indexable into a SolrInputDocument.
org.apache.solr.common.SolrInputDocument	SolrIndexUpdateService.buildDocument(Indexable indexable, List<IndexField> fields, List<org.broadleafcommerce.common.locale.domain.Locale> locales)	Provides an interface for a caller to convert an Indexable into a SolrInputDocument.
protected Map<String,Object>	CatalogDocumentBuilderImpl.getPropertyValues(Indexable indexedItem, Field field, FieldType fieldType, List<org.broadleafcommerce.common.locale.domain.Locale> locales)
protected void	CatalogDocumentBuilderImpl.modifyDocument(Indexable indexable, List<IndexField> fields, List<org.broadleafcommerce.common.locale.domain.Locale> locales)	This is a simple hook point to allow implementors to override and modify the documents after the default functionality has created them.