com.konakart.bl

Class SolrMgr

java.lang.Object

com.konakart.bl.BaseMgr

com.konakart.bl.SolrMgr

All Implemented Interfaces:

SolrMgrIf

public class SolrMgr
extends BaseMgr
implements SolrMgrIf

Manager for code to interface with Solr

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	SolrMgr.MultiValuedTagGroup Used to store a list of multi valued tag groups
protected class	SolrMgr.StaticData Used to store the static data of this manager

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	AND Value used in Query
protected static java.util.regex.Pattern	AND_PATTERN Lucene constant
protected static java.lang.String	CLOSE_BRACKETS Value used in Query
protected static java.lang.String	COLON Value used in Query
protected static org.apache.commons.logging.Log	log the log
protected static java.lang.String	LUCENE_ESCAPE_CHARS Lucene constant
protected static java.util.regex.Pattern	LUCENE_PATTERN Lucene constant
protected static java.lang.String	mutex Mutex
protected static java.util.regex.Pattern	NOT_PATTERN Lucene constant
protected static java.lang.String	OPEN_BRACKETS Value used in Query
protected static java.lang.String	OR Value used in Query
protected static java.util.regex.Pattern	OR_PATTERN Lucene constant
protected static java.lang.String	POST_ENCODING Value used in Query
protected static int	QUERY_SELECT Type of Query
protected static int	QUERY_TERM Type of Query
protected static java.lang.String	REPLACEMENT_STRING Lucene constant
protected static java.lang.String	START Value used in Query
protected static java.util.Map<java.lang.String,SolrMgr.StaticData>	staticDataHM Hash Map that contains the static data
protected static java.lang.String	TO Value used in Query
protected static java.util.regex.Pattern	TOKENIZER_PATTERN Lucene constant

Fields inherited from class com.konakart.bl.BaseMgr

templateBaseDir

Constructor Summary

Constructors

Constructor and Description
SolrMgr(KKEngIf eng) Constructor

Method Summary

Modifier and Type	Method and Description
protected void	appendAND(java.lang.StringBuffer sb) Utility method to only append an AND if it isn't the first constraint being added to the query
protected java.lang.String	beforeSendQuery(java.lang.String sessionId, java.lang.String queryString, DataDescriptorIf dataDesc, ProductSearchIf prodSearch, int languageId, FetchProductOptionsIf options) Method that can be used to customize the query string.
java.lang.String	escapeSearchString(java.lang.String searchString) The Lucene search engine requires the following characters to be escaped: + - ! ( ) { } [ ] ^ " ~ * ? : \
protected java.lang.String	getAttr(org.w3c.dom.Node node, java.lang.String name) Utility method for retrieving the value of an attribute from a node
protected NameNumber[]	getChildIntData(org.w3c.dom.Node parent, java.util.HashMap<java.lang.Integer,java.math.BigDecimal> scoreMap) Utility method to process XML similar to example below:
protected java.lang.String	getCustomSearchString(java.math.BigDecimal searchDec, int rule, int customFieldNum) Creates a search string based on the rule.
protected java.lang.String	getCustomSearchString(java.lang.Integer searchInt, int rule, int customFieldNum) Creates a search string based on the rule.
protected java.lang.String	getCustomSearchString(java.lang.String searchString, int rule, int customFieldNum) Creates a search string based on the rule.
protected java.math.BigDecimal	getDec(java.math.BigDecimal in, int scale) Utility method to make code more readable
protected java.math.BigDecimal	getDec(java.lang.String in, int scale) Utility method to make code more readable
protected java.net.URL	getSolrSelectUrl(java.lang.String cmd, int type, java.lang.String action) Get the Solr Url For selecting data
protected java.net.URL	getSolrUpdateUrl() Get the Solr Url For updating data
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.
protected java.lang.String	getTextSearchString(java.lang.String searchString, int rule) Creates a search string based on the rule.
protected void	getTokenizedSearchString(java.lang.StringBuffer querySb, java.lang.String attr, java.lang.String[] tokenArray) Utility method to avoid duplicating code
protected boolean	isAttr(org.w3c.dom.Node node, java.lang.String name, java.lang.String value) Utility method for determining whether an attribute exists
SolrProducts	parseReply(java.lang.String xmlReply, ProductSearchIf prodSearch, int langId) A DOM structure is created from the XML reply.
protected void	processChildren(org.w3c.dom.NodeList nList, SolrProducts sProds, ProductSearchIf prodSearch, int langId) Process the child nodes of the node passed in as a parameter
protected void	processFacets(org.w3c.dom.Node cNode, SolrProducts sProds, ProductSearchIf prodSearch, int langId) Process XML similar to example below:
protected void	processNode(org.w3c.dom.Node cNode, SolrProducts sProds, ProductSearchIf prodSearch, int langId) We identify the node and process it to retrieve information.
protected void	processPriceFacets(org.w3c.dom.Node cNode, SolrProducts sProds, ProductSearchIf prodSearch) Process XML similar to sample below:
protected void	processProducts(org.w3c.dom.Node cNode, SolrProducts sProds) Process XML similar to example below.
protected void	processSnippets(org.w3c.dom.Node cNode, SolrProducts sProds) Process XML similar to sample below:
protected void	processStats(org.w3c.dom.Node cNode, SolrProducts sProds) Process XML similar to sample below:
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 and if the prodSearch contains some text.
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
protected void	traverse(org.w3c.dom.Node cNode, SolrProducts sProds, ProductSearchIf prodSearch, int langId) The start method for processing the DOM structure
boolean	useSolr() Returns true if Solr can be used, otherwise it returns false

Methods inherited from class com.konakart.bl.BaseMgr

acquireLock, addInsertAttr, addInsertAttr, addStringRuleConstraint, addStringRuleConstraint, checkRequired, escapeHTML, executeQuery, executeQuery, executeQuery, executeQuery, executeQuery, getAdminEngMgr, getBasketMgr, getBillingMgr, getBookableProductMgr, getCacheMgr, getCatMgr, getConfigMgr, getCookieMgr, getCurrMgr, getCustMgr, getCustomerIdFromSession, getCustomerStatsMgr, getCustomerTagMgr, getEmailMgr, getEng, getEventMgr, getExportMgr, getHTMLEscaper, getKonaKartConfig, getKonaKartConfig, getKonaKartConfig, getLangMgr, getManuMgr, getMiscItemMgr, getMiscPriceMgr, getMode, getModeString, getMqMgr, getMultiStoreMgr, getNewCriteria, getNewCriteria, getOrderIntegrationMgr, getOrderMgr, getOrderTotalMgr, getPaymentMgr, getProdMgr, getProductsToCategoresCriteria, getPromMgr, getPunchOutMgr, getRewardPointMgr, getSecMgr, getShippingMgr, getSolrMgr, getStoreId, getStoreMgr, getStoreTime, getSuggestionMgr, getTaxMgr, getTemplate, getTemplateRoot, getVelocityContextMgr, getWishListMgr, init, insertKKEvent, insertKKEvent, isBusiness, isBusinessOrEnterprise, isClassPresent, isCommunity, isDeadlockException, isEnterprise, isMultiStoreShareCategories, isMultiStoreShareCustomers, isMultiStoreShareCustomersOrProducts, isMultiStoreSharedDb, isMultiStoreShareProducts, isMultiVendor, isUnix, manageThrowable, releaseLock, updateStaticVariablesNow

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

protected static org.apache.commons.logging.Log log

the log

staticDataHM

protected static java.util.Map<java.lang.String,SolrMgr.StaticData> staticDataHM

Hash Map that contains the static data

QUERY_SELECT

protected static final int QUERY_SELECT

Type of Query

See Also:

Constant Field Values

QUERY_TERM

protected static final int QUERY_TERM

Type of Query

See Also:

Constant Field Values

START

protected static final java.lang.String START

Value used in Query

See Also:

Constant Field Values

AND

protected static final java.lang.String AND

Value used in Query

See Also:

Constant Field Values

OR

protected static final java.lang.String OR

Value used in Query

See Also:

Constant Field Values

TO

protected static final java.lang.String TO

Value used in Query

See Also:

Constant Field Values

COLON

protected static final java.lang.String COLON

Value used in Query

See Also:

Constant Field Values

OPEN_BRACKETS

protected static final java.lang.String OPEN_BRACKETS

Value used in Query

See Also:

Constant Field Values

CLOSE_BRACKETS

protected static final java.lang.String CLOSE_BRACKETS

Value used in Query

See Also:

Constant Field Values

POST_ENCODING

protected static final java.lang.String POST_ENCODING

Value used in Query

See Also:

Constant Field Values

LUCENE_ESCAPE_CHARS

protected static final java.lang.String LUCENE_ESCAPE_CHARS

Lucene constant

See Also:

Constant Field Values

LUCENE_PATTERN

protected static final java.util.regex.Pattern LUCENE_PATTERN

Lucene constant

AND_PATTERN

protected static final java.util.regex.Pattern AND_PATTERN

Lucene constant

OR_PATTERN

protected static final java.util.regex.Pattern OR_PATTERN

Lucene constant

NOT_PATTERN

protected static final java.util.regex.Pattern NOT_PATTERN

Lucene constant

REPLACEMENT_STRING

protected static final java.lang.String REPLACEMENT_STRING

Lucene constant

See Also:

Constant Field Values

TOKENIZER_PATTERN

protected static final java.util.regex.Pattern TOKENIZER_PATTERN

Lucene constant

mutex

protected static java.lang.String mutex

Mutex

Constructor Detail

SolrMgr

public SolrMgr(KKEngIf eng)
        throws java.lang.Exception

Constructor

Parameters:

eng - the eng

Throws:

java.lang.Exception - an unexpected exception

Method Detail

getSuggestedSearchItems

public 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.

Specified by:

getSuggestedSearchItems in interface SolrMgrIf

Parameters:

sessionId - the sessionId

options - the options

Returns:

Returns an array of SuggestedSearchItems

Throws:

java.lang.Exception - an unexpected exception

getSuggestedSpellingItems

public 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.

Specified by:

getSuggestedSpellingItems in interface SolrMgrIf

Parameters:

sessionId - the sessionId

options - the options

Returns:

Returns an array of SuggestedSpellingItems

Throws:

java.lang.Exception - an unexpected exception

searchForProducts

public 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 and if the prodSearch contains some text.

Specified by:

searchForProducts in interface SolrMgrIf

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

getTokenizedSearchString

protected void getTokenizedSearchString(java.lang.StringBuffer querySb,
                                        java.lang.String attr,
                                        java.lang.String[] tokenArray)

Utility method to avoid duplicating code

Parameters:

querySb - the querySb

attr - the attr

tokenArray - the tokenArray

parseReply

public 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.

Specified by:

parseReply in interface SolrMgrIf

Parameters:

xmlReply - the xmlReply

prodSearch - the prodSearch

langId - the langId

Returns:

Returns a SolrProducts object

Throws:

java.lang.Exception - an unexpected exception

traverse

protected void traverse(org.w3c.dom.Node cNode,
                        SolrProducts sProds,
                        ProductSearchIf prodSearch,
                        int langId)
                 throws java.lang.Exception

The start method for processing the DOM structure

Parameters:

cNode - the cNode

sProds - the sProds

prodSearch - the prodSearch

langId - the langId

Throws:

java.lang.Exception - an unexpected exception

processChildren

protected void processChildren(org.w3c.dom.NodeList nList,
                               SolrProducts sProds,
                               ProductSearchIf prodSearch,
                               int langId)
                        throws java.lang.Exception

Process the child nodes of the node passed in as a parameter

Parameters:

nList - the nList

sProds - the sProds

prodSearch - the prodSearch

langId - the langId

Throws:

java.lang.Exception - an unexpected exception

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

processNode

protected void processNode(org.w3c.dom.Node cNode,
                           SolrProducts sProds,
                           ProductSearchIf prodSearch,
                           int langId)
                    throws java.lang.Exception

We identify the node and process it to retrieve information.

Parameters:

cNode - the cNode

sProds - the sProds

prodSearch - the prodSearch

langId - the langId

Throws:

java.lang.Exception - an unexpected exception

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

processProducts

protected void processProducts(org.w3c.dom.Node cNode,
                               SolrProducts sProds)

Process XML similar to example below.

 
 <result name="response" numFound="5" start="0" maxScore="3.334529" >
 <doc>
 <int name="id">23</int>
 </doc>
 <doc>
 <int name="id">20</int>
 </doc>
 <doc>
 <int name="id">6</int>
 </doc>
 <doc>
 <int name="id">11</int>
 </doc>
 <doc>
 <int name="id">4</int>
 </doc>
 </result>
 
 

Parameters:

cNode - the cNode

sProds - the sProds

processSnippets

protected void processSnippets(org.w3c.dom.Node cNode,
                               SolrProducts sProds)

Process XML similar to sample below:

 
 <lst name="highlighting">
 <lst name="10">
 <arr name="desc_en">
 <str> 11.8% of total employment in &lt;b&gt;Aberdeen&lt;/b&gt; City, 11</str><
 <str> 11.8% of total employment in &lt;b&gt;Aberdeen&lt;/b&gt; City, 11</str>
 </arr>
 <lst name="34">
 <arr name="desc_en">
 <str> 11.8% of total employment in &lt;b&gt;Aberdeen&lt;/b&gt; City, 11</str>
 </arr>
 </lst>
 </lst>
 
 

Parameters:

cNode - the cNode

sProds - the sProds

processFacets

protected void processFacets(org.w3c.dom.Node cNode,
                             SolrProducts sProds,
                             ProductSearchIf prodSearch,
                             int langId)
                      throws java.lang.Exception

Process XML similar to example below:

 
 <lst name="facet_fields">
 <lst name="manu_id">
 <int name="3">3</int>
 <int name="8">1</int>
 <int name="11">1</int>
 </lst>
 <lst name="cat_id">
 <int name="10">3</int>
 <int name="15">1</int>
 <int name="20">1</int>
 </lst>
 <lst name="facet_1">
 <int name="aaa">3</int>
 </lst>
 <lst name="facet_2">
 <int name="bbb">2</int>
 <int name="eee">1</int>
 </lst>
 <lst name="facet_30">
 <int name="ccc">1</int>
 <int name="ddd">1</int>
 <int name="fff">1</int>
 </lst>
 </lst>
 
 

Parameters:

cNode - the cNode

sProds - the sProds

prodSearch - the prodSearch

langId - the langId

Throws:

java.lang.Exception - an unexpected exception

processPriceFacets

protected void processPriceFacets(org.w3c.dom.Node cNode,
                                  SolrProducts sProds,
                                  ProductSearchIf prodSearch)
                           throws java.lang.Exception

Process XML similar to sample below:

 
 <lst name="facet_ranges">
 <lst name="price0">
 <lst name="counts">
 <int name="20.0">2</int>
 <int name="30.0">1</int>
 <int name="50.0">1</int>
 <int name="90.0">1</int>
 </lst>
 <float name="gap">10.0</float>
 <float name="start">0.0</float>
 <float name="end">50000.0</float>
 </lst>
 </lst>
 
 

Parameters:

cNode - the cNode

sProds - the sProds

prodSearch - the prodSearch

Throws:

java.lang.Exception - an unexpected exception

getDec

protected java.math.BigDecimal getDec(java.lang.String in,
                                      int scale)

Utility method to make code more readable

Parameters:

in - the in

scale - the scale

Returns:

a scaled BigDecimal

getDec

protected java.math.BigDecimal getDec(java.math.BigDecimal in,
                                      int scale)

Utility method to make code more readable

Parameters:

in - the in

scale - the scale

Returns:

a scaled BigDecimal

processStats

protected void processStats(org.w3c.dom.Node cNode,
                            SolrProducts sProds)

Process XML similar to sample below:

 
 <lst name="stats_fields">
 <lst name="price0">
 <double name="min">29.989999771118164</double>
 <double name="max">54.9900016784668</double>
 <long name="count">3</long>
 <long name="missing">0</long>
 <double name="sum">116.98000144958496</double>
 <double name="sumOfSquares">4947.300370869449</double>
 <double name="mean">38.99333381652832</double>
 <double name="stddev">13.889926646455255</double>
 <lst name="facets"/>
 </lst>
 </lst>
 
 

Parameters:

cNode - the cNode

sProds - the sProds

getChildIntData

protected NameNumber[] getChildIntData(org.w3c.dom.Node parent,
                                       java.util.HashMap<java.lang.Integer,java.math.BigDecimal> scoreMap)

Utility method to process XML similar to example below:

 
 <int name="ccc">1</int>
 <int name="ddd">1</int>
 <int name="fff">1</int>
 
 

Parameters:

parent - the parent

scoreMap - the scoreMap

Returns:

Returns a NameNumber array

getAttr

protected java.lang.String getAttr(org.w3c.dom.Node node,
                                   java.lang.String name)

Utility method for retrieving the value of an attribute from a node

Parameters:

node - the node

name - the name

Returns:

Returns the attribute value

isAttr

protected boolean isAttr(org.w3c.dom.Node node,
                         java.lang.String name,
                         java.lang.String value)

Utility method for determining whether an attribute exists

Parameters:

node - the node

name - the name

value - the value

Returns:

Returns true if the attribute exists

appendAND

protected void appendAND(java.lang.StringBuffer sb)

Utility method to only append an AND if it isn't the first constraint being added to the query

Parameters:

sb - the sb

beforeSendQuery

protected java.lang.String beforeSendQuery(java.lang.String sessionId,
                                           java.lang.String queryString,
                                           DataDescriptorIf dataDesc,
                                           ProductSearchIf prodSearch,
                                           int languageId,
                                           FetchProductOptionsIf options)
                                    throws java.lang.Exception

Method that can be used to customize the query string. The query string does not include the SOLR URL.

Parameters:

sessionId - The sessionId of the logged in user

queryString - Query string that will be sent to SOLR

dataDesc - DataDescriptor object

prodSearch - ProductSearch object which may be null

languageId - Language id

options - a FetchProductOptions object which may be null

Returns:

Returns the customized query string

Throws:

java.lang.Exception - an unexpected exception

sendQueryToSolr

public 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.

Specified by:

sendQueryToSolr in interface SolrMgrIf

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

public 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

Specified by:

sendQueryToSolr in interface SolrMgrIf

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)

removeProductFromSearchEngine

public 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

Specified by:

removeProductFromSearchEngine in interface SolrMgrIf

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

getSolrSelectUrl

protected java.net.URL getSolrSelectUrl(java.lang.String cmd,
                                        int type,
                                        java.lang.String action)
                                 throws org.apache.torque.TorqueException,
                                        com.workingdogs.village.DataSetException,
                                        java.lang.Exception

Get the Solr Url For selecting data

Parameters:

cmd - the cmd

type - The type of query

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

Returns:

Returns the Solr Url

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

getSolrUpdateUrl

protected java.net.URL getSolrUpdateUrl()
                                 throws org.apache.torque.TorqueException,
                                        com.workingdogs.village.DataSetException,
                                        java.lang.Exception

Get the Solr Url For updating data

Returns:

Returns the Solr Url

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

refreshConfigs

public void refreshConfigs()
                    throws java.lang.Exception

Get the config variables needed to setup the Solr mgr

Specified by:

refreshConfigs in interface SolrMgrIf

Throws:

java.lang.Exception - an unexpected exception

useSolr

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

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

Specified by:

useSolr in interface SolrMgrIf

Returns:

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

Throws:

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

getTextSearchString

protected java.lang.String getTextSearchString(java.lang.String searchString,
                                               int rule)

Creates a search string based on the rule. Adds wild cards if necessary.

Parameters:

searchString - the searchString

rule - the rule

Returns:

Returns a search string with wild cards if appropriate

getCustomSearchString

protected java.lang.String getCustomSearchString(java.lang.String searchString,
                                                 int rule,
                                                 int customFieldNum)

Creates a search string based on the rule. Adds wild cards if necessary.

Parameters:

searchString - The search string

rule - The rule for determining whether to introduce a wild card

customFieldNum - Used to detect which custom field is being used

Returns:

Returns a search string with wild cards if appropriate

getCustomSearchString

protected java.lang.String getCustomSearchString(java.lang.Integer searchInt,
                                                 int rule,
                                                 int customFieldNum)

Creates a search string based on the rule.

Parameters:

searchInt - The search integer

rule - The rule for determining whether to introduce less than, greater than etc.

customFieldNum - Used to detect which custom field is being used

Returns:

Returns a search string for solr

getCustomSearchString

protected java.lang.String getCustomSearchString(java.math.BigDecimal searchDec,
                                                 int rule,
                                                 int customFieldNum)

Creates a search string based on the rule.

Parameters:

searchDec - The search Big Decimal

rule - The rule for determining whether to introduce less than, greater than etc.

customFieldNum - Used to detect which custom field is being used

Returns:

Returns a search string for solr

escapeSearchString

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

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

Specified by:

escapeSearchString in interface SolrMgrIf

Parameters:

searchString - the searchString

Returns:

Returns the escaped string

getSolrUrl

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

Description copied from interface: SolrMgrIf

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.

Specified by:

getSolrUrl in interface SolrMgrIf

Returns:

Returns a URL which will be used to access Solr.

Throws:

java.lang.Exception - an unexpected exception