com.konakart.blif

Interface SolrMgrIf

All Known Implementing Classes:

SolrMgr

public interface SolrMgrIf

SolrMgrIf Interface which an implementation of this manager must adhere to.

Method Summary

Modifier and Type	Method and Description
java.lang.String	escapeSearchString(java.lang.String searchString) The Lucene search engine requires the following characters to be escaped: + - ! ( ) { } [ ] ^ " ~ * ? : \
java.lang.String	getSolrUrl() Get the Solr URL.
SuggestedSearchItem[]	getSuggestedSearchItems(java.lang.String sessionId, SuggestedSearchOptionsIf options) Method that uses SOLR Terms in order to get suggested search data based on a search string.
SuggestedSpellingItem[]	getSuggestedSpellingItems(java.lang.String sessionId, SuggestedSpellingOptionsIf options) Method that uses SOLR in order to get suggested spelling data based on a search string.
SolrProducts	parseReply(java.lang.String xmlReply, ProductSearchIf prodSearch, int langId) A DOM structure is created from the XML reply.
void	refreshConfigs() Get the config variables needed to setup the Solr mgr
void	removeProductFromSearchEngine(int productId) Remove a single product referenced by productId from the Solr search engine
SolrProducts	searchForProducts(java.lang.String sessionId, DataDescriptorIf dataDesc, ProductSearchIf prodSearch, int priceId, int languageId, FetchProductOptionsIf options) This method only gets called if the Solr search engine is activated
java.lang.String	sendQueryToSolr(java.lang.String query, int type, java.lang.String action) Sends the query to Solr.
java.lang.String	sendQueryToSolr(java.lang.String query, int type, java.lang.String action, int attempt) Sends the query to Solr
boolean	useSolr() Returns true if Solr can be used, otherwise it returns false

Method Detail

searchForProducts

SolrProducts searchForProducts(java.lang.String sessionId,
                               DataDescriptorIf dataDesc,
                               ProductSearchIf prodSearch,
                               int priceId,
                               int languageId,
                               FetchProductOptionsIf options)
                        throws java.lang.Exception

This method only gets called if the Solr search engine is activated

Parameters:

sessionId - the sessionId

dataDesc - the dataDesc

prodSearch - the prodSearch

priceId - the priceId

languageId - the languageId

options - the options

Returns:

Returns an array of integers for the products that have been found

Throws:

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

getSuggestedSearchItems

SuggestedSearchItem[] getSuggestedSearchItems(java.lang.String sessionId,
                                              SuggestedSearchOptionsIf options)
                                       throws java.lang.Exception

Method that uses SOLR Terms in order to get suggested search data based on a search string.

Parameters:

sessionId - May be left null

options - the options

Returns:

Returns an array of SuggestedSearchItems

Throws:

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

java.lang.Exception - an unexpected exception

getSuggestedSpellingItems

SuggestedSpellingItem[] getSuggestedSpellingItems(java.lang.String sessionId,
                                                  SuggestedSpellingOptionsIf options)
                                           throws java.lang.Exception

Method that uses SOLR in order to get suggested spelling data based on a search string.

Parameters:

sessionId - May be left null

options - the options

Returns:

Returns an array of SuggestedSpellingItems

Throws:

java.lang.Exception - an unexpected exception

refreshConfigs

void refreshConfigs()
             throws java.lang.Exception

Get the config variables needed to setup the Solr mgr

Throws:

java.lang.Exception - an unexpected exception

useSolr

boolean useSolr()
         throws com.konakart.app.KKException

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

Returns:

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

Throws:

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

escapeSearchString

java.lang.String escapeSearchString(java.lang.String searchString)

The Lucene search engine requires the following characters to be escaped: + - ! ( ) { } [ ] ^ " ~ * ? : \

Parameters:

searchString - the searchString

Returns:

Returns the escaped string

sendQueryToSolr

java.lang.String sendQueryToSolr(java.lang.String query,
                                 int type,
                                 java.lang.String action)
                          throws org.apache.torque.TorqueException,
                                 com.workingdogs.village.DataSetException,
                                 java.lang.Exception

Sends the query to Solr. It actually tries a maximum of two times to send the query to Solr. If there's a connection exception on the first call it calls refreshConfigs before trying a second time. If it fails the second time this will return an Exception indicating what the problem was.

Parameters:

query - The parameters for the HTTP GET

type - The type of query

action - The action for the query. Type is ignored if action is not null.

Returns:

Returns the SOLR response

Throws:

java.lang.Exception - an unexpected exception

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

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

sendQueryToSolr

java.lang.String sendQueryToSolr(java.lang.String query,
                                 int type,
                                 java.lang.String action,
                                 int attempt)
                          throws org.apache.torque.TorqueException,
                                 com.workingdogs.village.DataSetException,
                                 java.lang.Exception

Sends the query to Solr

Parameters:

query - The parameters for the HTTP GET

type - The type of query

action - The action for the query. Type is ignored if action is not null.

attempt - indicates the attempt number when Solr calls are retried

Returns:

Returns the SOLR response

Throws:

java.lang.Exception - an unexpected exception

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

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

parseReply

SolrProducts parseReply(java.lang.String xmlReply,
                        ProductSearchIf prodSearch,
                        int langId)
                 throws java.lang.Exception

A DOM structure is created from the XML reply. We traverse the structure to capture the information we are interested in.

Parameters:

xmlReply - the xmlReply

prodSearch - the prodSearch

langId - the langId

Returns:

Returns a SolrProducts object

Throws:

java.lang.Exception - an unexpected exception

getSolrUrl

java.lang.String getSolrUrl()
                     throws java.lang.Exception

Get the Solr URL. It will return a URL in for form: http://node:8983/ Note that it does not include the "/solr/konakart" that is often appended by another method.

Returns:

Returns a URL which will be used to access Solr.

Throws:

java.lang.Exception - an unexpected exception