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

Interface SolrIndexOperation

All Known Implementing Classes:

GlobalSolrFullReIndexOperation

public interface SolrIndexOperation

Defines the lifecylce of an indexing operation used in SolrIndexService. Each of the methods in this interface are executed in order during different phases of SolrIndexService.executeSolrIndexOperation(SolrIndexOperation).

Author:

Phillip Verheyden (phillipuniverse)

Method Summary

Modifier and Type	Method and Description
void	afterBuildPage() Executes after building each page, this is where any filters or cleanup for building can be taken care of
void	afterCountIndexables() Executes after the count, this is where any filters or cleanup for counting can be taken care of
void	afterReadIndexables() Executes after the read, this is where any filters or cleanup for reading can be taken care of
void	beforeBuildPage() Executes before building each page, this is where any filters or setup for building can be taken care of
void	beforeCountIndexables() Executes before the count, this is where any filters or setup for counting can be taken care of
void	beforeReadIndexables() Executes before the read, this is where any filters or setup for reading can be taken care of
void	buildPage(List<? extends Indexable> indexables) Build a page from readIndexables(int, Long) on the getSolrServerForIndexing().
Long	countIndexables() The count of all of the Indexable items about to be indexed.
org.apache.solr.client.solrj.SolrClient	getSolrServerForIndexing() Which SolrClient the index should be built on
boolean	obtainLock() Grab some sort of lock so that nothing else can index items at the same time
List<? extends Indexable>	readIndexables(int pageSize, Long lastId) Perform the a read of the Indexable items for a particular page and pageSize
void	releaseLock() If a lock was obtained in obtainLock() this releases it

Method Detail

obtainLock

boolean obtainLock()

Grab some sort of lock so that nothing else can index items at the same time

getSolrServerForIndexing

org.apache.solr.client.solrj.SolrClient getSolrServerForIndexing()

Which SolrClient the index should be built on

beforeCountIndexables

void beforeCountIndexables()

Executes before the count, this is where any filters or setup for counting can be taken care of

countIndexables

Long countIndexables()
              throws ServiceException

The count of all of the Indexable items about to be indexed. Used to determine paging used by #readIndexables(int, int)

Throws:

ServiceException

afterCountIndexables

void afterCountIndexables()

Executes after the count, this is where any filters or cleanup for counting can be taken care of

beforeReadIndexables

void beforeReadIndexables()

Executes before the read, this is where any filters or setup for reading can be taken care of

readIndexables

List<? extends Indexable> readIndexables(int pageSize,
                                         Long lastId)
                                  throws ServiceException

Perform the a read of the Indexable items for a particular page and pageSize

Throws:

ServiceException

afterReadIndexables

void afterReadIndexables()

Executes after the read, this is where any filters or cleanup for reading can be taken care of

beforeBuildPage

void beforeBuildPage()

Executes before building each page, this is where any filters or setup for building can be taken care of

buildPage

void buildPage(List<? extends Indexable> indexables)
        throws ServiceException

Build a page from readIndexables(int, Long) on the getSolrServerForIndexing(). This is used as a wrapper extension around SolrIndexService.buildIncrementalIndex(List, SolrClient).

Throws:

ServiceException

afterBuildPage

void afterBuildPage()

Executes after building each page, this is where any filters or cleanup for building can be taken care of

releaseLock

void releaseLock()

If a lock was obtained in obtainLock() this releases it