com.konakartadmin.blif

Interface AdminSolrMgrIf

All Known Implementing Classes:

AdminSolrMgr

public interface AdminSolrMgrIf

AdminSolrMgrIf

Method Summary

Modifier and Type	Method and Description
void	addAllProductsToSearchEngine(boolean async) Loop through all of the products in the KonaKart database and add them to the Solr search engine.
void	addAllProductsToSearchEngineSync() Loop through all of the products in the KonaKart database and add them to the Solr search engine
void	addProductToSearchEngine(int productId) Add a single product referenced by productId to the Solr search engine
void	addProductToSearchEngine(int productId, java.lang.String storeId) Add a single product referenced by productId to the Solr search engine.
boolean	commitInCode() Returns true if we should commit to Solr in code, otherwise it returns false
java.lang.StringBuffer	getDocFromProduct(int productId, java.lang.String storeId, java.util.HashMap<java.lang.Integer,AdminLanguage> languageMap) Create an XML string from the product object that can be passed to Solr
java.util.HashMap<java.lang.Integer,AdminLanguage>	getLangMap() Returns a HashMap mapping language id to language
int	getSolrCommitFrequency() The chunk size of records read from the database and written to SOLR after which a SOLR commit command is sent.
java.net.URL	getSolrUrl() Derive a Solr Url from configuration variables.
void	refreshConfigs() Refresh the configuration of the Admin Solr Manager
void	removeAllProductsFromSearchEngine(boolean async) Remove all products from the Solr search engine.
void	removeAllProductsFromSearchEngineSync() Remove all products from the Solr search engine
void	removeProductFromSearchEngine(int productId) Remove a single product referenced by productId from the Solr search engine
void	removeProductFromSearchEngine(int productId, java.lang.String storeId) Remove a single product referenced by productId from the Solr search engine.
boolean	useSolr() Returns true if Solr can be used, otherwise it returns false

Method Detail

addAllProductsToSearchEngine

void addAllProductsToSearchEngine(boolean async)
                           throws java.lang.Exception

Loop through all of the products in the KonaKart database and add them to the Solr search engine.

Parameters:

async - If true, the API call runs asynchronously and control is returned immediately

Throws:

java.lang.Exception - an unexpected exception

addAllProductsToSearchEngineSync

void addAllProductsToSearchEngineSync()
                               throws java.lang.Exception

Loop through all of the products in the KonaKart database and add them to the Solr search engine

Throws:

java.lang.Exception - an unexpected exception

removeAllProductsFromSearchEngine

void removeAllProductsFromSearchEngine(boolean async)
                                throws org.apache.torque.TorqueException,
                                       com.workingdogs.village.DataSetException,
                                       java.lang.Exception

Remove all products from the Solr search engine. It uses a separate thread since the operation may take a while.

Parameters:

async - If true we do it asynchronously

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

java.lang.Exception - an unexpected exception

removeAllProductsFromSearchEngineSync

void removeAllProductsFromSearchEngineSync()
                                    throws org.apache.torque.TorqueException,
                                           com.workingdogs.village.DataSetException,
                                           java.lang.Exception

Remove all products from the Solr search engine

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

java.lang.Exception - an unexpected exception

removeProductFromSearchEngine

void removeProductFromSearchEngine(int productId)
                            throws org.apache.torque.TorqueException,
                                   com.workingdogs.village.DataSetException,
                                   java.lang.Exception

Remove a single product referenced by productId from the Solr search engine

Parameters:

productId - the productId

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

java.lang.Exception - an unexpected exception

removeProductFromSearchEngine

void removeProductFromSearchEngine(int productId,
                                   java.lang.String storeId)
                            throws org.apache.torque.TorqueException,
                                   com.workingdogs.village.DataSetException,
                                   java.lang.Exception

Remove a single product referenced by productId from the Solr search engine. The store is selected by the storeId parameter.

Parameters:

productId - the productId

storeId - the storeId

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

java.lang.Exception - an unexpected exception

addProductToSearchEngine

void addProductToSearchEngine(int productId)
                       throws java.lang.Exception

Add a single product referenced by productId to the Solr search engine

Parameters:

productId - the productId

Throws:

java.lang.Exception - an unexpected exception

addProductToSearchEngine

void addProductToSearchEngine(int productId,
                              java.lang.String storeId)
                       throws java.lang.Exception

Add a single product referenced by productId to the Solr search engine. The store is selected by the storeId parameter.

Parameters:

productId - the productId

storeId - the storeId

Throws:

java.lang.Exception - an unexpected exception

refreshConfigs

void refreshConfigs()
             throws java.lang.Exception

Refresh the configuration of the Admin Solr Manager

Throws:

java.lang.Exception - an unexpected exception

useSolr

boolean useSolr()
         throws java.lang.Exception

Returns true if Solr can be used, otherwise it returns false

Returns:

Returns true if Solr can be used, otherwise it returns false

Throws:

java.lang.Exception - an unexpected exception

com.konakart.app.KKException - an unexpected KKException exception

commitInCode

boolean commitInCode()
              throws java.lang.Exception

Returns true if we should commit to Solr in code, otherwise it returns false

Returns:

Returns true if we should commit to Solr in code, otherwise it returns false

Throws:

java.lang.Exception - an unexpected exception

getSolrCommitFrequency

int getSolrCommitFrequency()

The chunk size of records read from the database and written to SOLR after which a SOLR commit command is sent. The default value is 100.

Returns:

Returns an integer

getLangMap

java.util.HashMap<java.lang.Integer,AdminLanguage> getLangMap()
                                                       throws java.lang.Exception

Returns a HashMap mapping language id to language

Returns:

Returns a HashMap mapping language id to language

Throws:

java.lang.Exception - an unexpected exception

getDocFromProduct

java.lang.StringBuffer getDocFromProduct(int productId,
                                         java.lang.String storeId,
                                         java.util.HashMap<java.lang.Integer,AdminLanguage> languageMap)
                                  throws java.lang.Exception

Create an XML string from the product object that can be passed to Solr

Parameters:

productId - the productId

storeId - the storeId

languageMap - the languageMap

Returns:

Returns the XML representation of the product required by Solr

Throws:

java.lang.Exception - an unexpected exception

getSolrUrl

java.net.URL getSolrUrl()
                 throws java.lang.Exception

Derive a Solr Url from configuration variables.

Returns:

Returns the Solr Url

Throws:

java.lang.Exception - an unexpected exception