org.broadleafcommerce.core.search.service.solr

Interface SolrIndexService

All Known Implementing Classes:

SolrIndexServiceImpl

public interface SolrIndexService

Service exposing several methods for creating a Solr index based on catalog product data.

Author:

Andre Azzolini (apazzolini), Jeff Fischer

See Also:

SolrIndexCachedOperation

Method Summary

Modifier and Type	Method and Description
org.apache.solr.common.SolrInputDocument	buildDocument(Product product, List<Field> fields, List<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	buildDocument(Sku sku, List<Field> fields, List<Locale> locales) Given a sku, fields that relate to that sku, and a list of locales and pricelists, builds a SolrInputDocument to be added to the Solr index.
void	buildIncrementalIndex(int page, int pageSize, boolean useReindexServer) The internal method for building indexes.
void	buildIncrementalProductIndex(List<Product> products, boolean useReindexServer) This can be used in lieu of passing in page sizes, The reason is that one might want to apply filters or only index certain products.
void	buildIncrementalSkuIndex(List<Sku> skus, boolean useReindexServer) This can be used in lieu of passing in page sizes, The reason is that one might want to apply filters or only index certain skus.
void	commit(org.apache.solr.client.solrj.SolrServer server) Allows a commit to be called.
void	commit(org.apache.solr.client.solrj.SolrServer server, boolean softCommit, boolean waitSearcher, boolean waitFlush) This allows an external caller to force a commit to the SolrServer.
List<Locale>	getAllLocales()
boolean	isReindexInProcess() Allows a query to determine if a full reindex is currently being performed.
void	logDocuments(Collection<org.apache.solr.common.SolrInputDocument> documents) Prints out the docs to the trace logger
void	optimizeIndex(org.apache.solr.client.solrj.SolrServer server) Triggers the Solr optimize index function on the given server.
void	performCachedOperation(SolrIndexCachedOperation.CacheOperation cacheOperation) SolrIndexService exposes buildIncrementalIndex(int, int, boolean).
void	rebuildIndex() Rebuilds the current index.
void	restoreState(Object[] pack) Restores state that was saved prior to indexing that might have been altered.
Object[]	saveState() Saves some global context that might be altered during indexing.

Method Detail

rebuildIndex

void rebuildIndex()
           throws ServiceException,
                  IOException

Rebuilds the current index.

Throws:

IOException

ServiceException

isReindexInProcess

boolean isReindexInProcess()

Allows a query to determine if a full reindex is currently being performed. NOTE: There is no guarantee that reindexing is not happening in another process or another server. This method simply indicates whether this instance, within a single JVM is currently performing a reindex.

Returns:

buildIncrementalIndex

void buildIncrementalIndex(int page,
                           int pageSize,
                           boolean useReindexServer)
                    throws ServiceException

The internal method for building indexes. This is exposed via this interface in case someone would like to more granularly control the indexing strategy.

Parameters:

page -

pageSize -

useReindexServer - - if set to false will index directly on the primary server

Throws:

ServiceException

See Also:

restoreState(Object[])

buildIncrementalSkuIndex

void buildIncrementalSkuIndex(List<Sku> skus,
                              boolean useReindexServer)
                       throws ServiceException

This can be used in lieu of passing in page sizes, The reason is that one might want to apply filters or only index certain skus.

Parameters:

skus -

useReindexServer -

Throws:

ServiceException

buildIncrementalProductIndex

void buildIncrementalProductIndex(List<Product> products,
                                  boolean useReindexServer)
                           throws ServiceException

This can be used in lieu of passing in page sizes, The reason is that one might want to apply filters or only index certain products.

Parameters:

products -

useReindexServer -

Throws:

ServiceException

saveState

Object[] saveState()

Saves some global context that might be altered during indexing.

Returns:

restoreState

void restoreState(Object[] pack)

Restores state that was saved prior to indexing that might have been altered.

Parameters:

pack -

See Also:

saveState()

optimizeIndex

void optimizeIndex(org.apache.solr.client.solrj.SolrServer server)
            throws ServiceException,
                   IOException

Triggers the Solr optimize index function on the given server. NOTE: This should rarely be called.

Parameters:

server -

Throws:

ServiceException

IOException

commit

void commit(org.apache.solr.client.solrj.SolrServer server)
     throws ServiceException,
            IOException

Allows a commit to be called. By default, the details of the commit will depend on system properties, including: solr.index.commit - if false, then no commit will be performed. autoCommit (and autoSoftCommit) should be configured in Solr. solr.index.softCommit - indicates if a soft commit should be performed solr.index.waitSearcher - indicates if the process should wait for a searcher to be configured solr.index.waitFlush - indicates if the process should wait for a flush to disk

Parameters:

server -

Throws:

ServiceException

IOException

commit

void commit(org.apache.solr.client.solrj.SolrServer server,
            boolean softCommit,
            boolean waitSearcher,
            boolean waitFlush)
     throws ServiceException,
            IOException

This allows an external caller to force a commit to the SolrServer. See Solr Documentation for additional details. If using softCommit, you should ensure that a hardCommit is performed, either using autoCommit, or at the end of the commit process to flush the changes to the disk. Note that this method will force a commit even if solr.index.commit=false

Parameters:

server - - the SolrServer to update

softCommit - - soft commit is an efficient commit that does not write the data to the file system

waitSearcher - - whether or not to wait for a new searcher to be created

waitFlush - - whether or not to wait for a flush to disk.

Throws:

ServiceException

IOException

logDocuments

void logDocuments(Collection<org.apache.solr.common.SolrInputDocument> documents)

Prints out the docs to the trace logger

Parameters:

documents -

getAllLocales

List<Locale> getAllLocales()

Returns:

a list of all possible locale prefixes to consider

buildDocument

org.apache.solr.common.SolrInputDocument buildDocument(Product product,
                                                       List<Field> fields,
                                                       List<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.

Parameters:

product -

fields -

locales -

Returns:

the document

buildDocument

org.apache.solr.common.SolrInputDocument buildDocument(Sku sku,
                                                       List<Field> fields,
                                                       List<Locale> locales)

Given a sku, fields that relate to that sku, and a list of locales and pricelists, builds a SolrInputDocument to be added to the Solr index.

Parameters:

sku -

fields -

locales -

Returns:

the document

performCachedOperation

void performCachedOperation(SolrIndexCachedOperation.CacheOperation cacheOperation)
                     throws ServiceException

SolrIndexService exposes buildIncrementalIndex(int, int, boolean). By wrapping the call to this method inside of a SolrIndexCachedOperation.CacheOperation, a single cache will be used for all the contained calls to buildIncrementalIndex. Here's an example: {@code performCachedOperation(new SolrIndexCachedOperation.CacheOperation() {

Parameters:

cacheOperation - the block of code to perform using a single cache for best performance

Throws:

ServiceException