com.konakartadmin.bl

Class AdminSolrMgr

java.lang.Object

com.konakartadmin.bl.AdminBaseMgr

com.konakartadmin.bl.AdminSolrMgr

All Implemented Interfaces:

AdminSolrMgrIf

public class AdminSolrMgr
extends AdminBaseMgr
implements AdminSolrMgrIf

The AdminSolrMgr - for Managing the interface to the SOLR search server

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AdminSolrMgr.StaticData Used to store the static data of this manager

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	END Static variable for constructing string when adding a product
protected static org.apache.commons.logging.Log	log the log
protected static java.lang.String	MIDDLE Static variable for constructing string when adding a product
protected static java.lang.String	mutex mutex
protected static boolean	PDFReaderPresent this is set to true if the PDF reader classes are found
private java.util.Random	rnd For random number generation
protected static java.lang.String	START Static variable for constructing string when adding a product
protected static java.util.Map<java.lang.String,AdminSolrMgr.StaticData>	staticDataHM Hash Map that contains the static data
protected java.util.HashMap<java.lang.Integer,java.lang.Integer>	topLevelCatMap Map to temporarily store top level category id for a category
static int	TT_CAT static variable for term type
static int	TT_CAT_MANU static variable for term type
static int	TT_MANU static variable for term type
static int	TT_MANU_CAT static variable for term type
static int	TT_MODEL static variable for term type
static int	TT_NAME static variable for term type
protected static java.lang.String	TYPE_PDF static variable for file type
protected static java.lang.String	TYPE_TEXT static variable for file type

Fields inherited from class com.konakartadmin.bl.AdminBaseMgr

adminEng, baseMgrMutex, baseStaticDataHM, cDataEnd, cDataStart, debugStackTraceExclusions, kkAdminPropsFilePath, kkConf, kkInstanceId, mgrFactory, STORE_ID, templateBaseDir

Constructor Summary

Constructors

Constructor and Description
AdminSolrMgr(KKAdminIf eng) Constructor

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	addAllProductsToSearchEngineMultiThreadedSync() Uses a configurable number of threads to populate Solr with KonaKart products
protected void	addAllProductsToSearchEnginePrivate(AdminDataDescriptor dd, AdminProductSearch ps) 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.
protected void	addSpelling(java.lang.StringBuffer sb, AdminProduct prod, AdminManufacturer manu, java.util.HashMap<java.lang.Integer,AdminLanguage> langMap, java.lang.String storeId, AdminSolrMgr.StaticData sd, java.lang.String catalogId) Method to populate a field with text that provides spelling suggestions.
protected void	addSpellings(java.lang.StringBuffer sb, AdminProduct prod, AdminManufacturer manu, java.util.HashMap<java.lang.Integer,AdminLanguage> langMap, java.lang.String storeId, AdminSolrMgr.StaticData sd, java.util.ArrayList<java.lang.String> catalogIdList) Method calls the addSpelling method once for every catalog id
protected void	addTerm(int type, java.lang.StringBuffer sb, java.lang.String langCode, java.lang.String term, int prodId, int catId, int manuId, java.lang.String storeId, java.lang.String catalogId, int parentCatId) Common code to add a term for dynamic suggested searching
protected void	addTerms(int type, java.lang.StringBuffer sb, java.lang.String langCode, java.lang.String term, int prodId, int catId, int manuId, java.lang.String storeId, java.util.ArrayList<java.lang.String> catalogIdList, int parentCatId) Method calls the addTerm method once for every catalog id
protected void	beforeAddProduct(java.lang.StringBuffer addProdData, AdminProduct prod, java.lang.String storeId, java.util.HashMap<java.lang.Integer,AdminLanguage> langMap) This method offers an opportunity to modify the data sent to Solr when adding a product.
private void	checkPDFReaderPresent()
boolean	commitInCode() Returns true if we should commit to Solr in code, otherwise it returns false
protected AdminDataDescriptor	getAdminDataDescriptorForMultiThreadedAdd() Returns an AdminDataDescriptor object used in the product search of the multi-threaded add to fetch products to be added.
protected AdminProductSearch	getAdminProductSearchForMultiThreadedAdd() Returns an AdminProductSearch object used in the product search of the multi-threaded add to fetch products to be added.
protected java.lang.String	getAttachmentText(AdminProduct product) Returns the text from the attachment so that it can be indexed in SOLR
protected java.util.ArrayList<java.lang.String>	getCatalogIdsForProduct(AdminSolrMgr.StaticData sd, int prodId) Returns an array of catalog ids for which the product is defined
protected java.lang.String	getCustomSearchData(AdminProduct prod, AdminLanguage lang) A method that can be overidden to supply data from a product object that is not normally indexed in Solr.
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
protected java.lang.String	getFileType(java.lang.String filePath) Returns the file extension
java.util.HashMap<java.lang.Integer,AdminLanguage>	getLangMap() Returns a HashMap mapping language id to language
protected int	getMaxWaitSecsForMultiThreadedAddGracefulShutdown()
protected int	getNumberOfThreadsForMultiThreadedAdd()
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.
protected int	getTopLevelCatId(int catId) Find the top level category for a category
protected void	isEnabled() Throws an exception if Solr isn't enabled.
protected static boolean	isPDFReaderPresent()
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.
protected void	sendProductsToSearchEngineMultiThreaded(AdminProducts prods, java.util.HashMap<java.lang.Integer,AdminLanguage> langMap, java.net.URL solrUrl) Called by the Solr sender in a separate thread
protected static void	setPDFReaderPresent(boolean readerPresent)
boolean	useSolr() Returns true if Solr can be used, otherwise it returns false

Methods inherited from class com.konakartadmin.bl.AdminBaseMgr

addInsertAttr, addInsertAttr, addStringRuleConstraint, addStringRuleConstraint, checkAPICallEnabled, checkIntInRange, checkIntIsSet, checkRequired, executeQuery, executeQuery, getAdminAddressMgr, getAdminAuditMgr, getAdminBillingMgr, getAdminBookableProductMgr, getAdminCatMgr, getAdminConfigMgr, getAdminContentMgr, getAdminCurrMgr, getAdminCustMgr, getAdminCustPwdHistMgr, getAdminCustTagMgr, getAdminEmailMgr, getAdminEng, getAdminEngineCacheMgr, getAdminEventMgr, getAdminExecuteMgr, getAdminFileMgr, getAdminFilterMgr, getAdminHtmlMgr, getAdminImportMgr, getAdminLanguageMgr, getAdminManuMgr, getAdminMessageMgr, getAdminMiscItemMgr, getAdminMiscPriceMgr, getAdminModulesMgr, getAdminMultiStoreMgr, getAdminOrderMgr, getAdminPdfMgr, getAdminProdAttrMgr, getAdminProdMgr, getAdminPromMgr, getAdminReviewMgr, getAdminSearchRuleMgr, getAdminSecMgr, getAdminServletMgr, getAdminShipmentMgr, getAdminSolrMgr, getAdminStoreMgr, getAdminSuggestionMgr, getAdminTagMgr, getAdminTaxMgr, getAdminValidationMgr, getAdminVelocityContextMgr, getAdminWishListMgr, getBooleanFromString, getDebugStackTraceExclusions, getEmailThreadGracefulShutdownTimeout, getExportMgr, getExportMgr, getExportXMLData, getIntFromString, getKkAdminPropsFilePath, getKkConfig, getKkInstanceId, getMode, getModeString, getMqMgr, getNewCriteria, getNewCriteria, getNewCriteria, getNewCriteria, getOtherModuleByName, getPostSearchText, getPreSearchText, getProductsToCategoresCriteria, getPropertyValue, getPropertyValue, getPropertyValueAsBool, getPropertyValueAsInt, getPropertyValueAsLong, getRecordCount, getRecordCount, getRewardPointMgr, getSingleIntResult, getStoreId, getTemplate, getTemplateBase, getXml_io, init, insertKKEvent, insertKKEvent, isBusiness, isBusinessOrEnterprise, isCommunity, isConfigSet, isEnterprise, isMultiStoreLanguagesShared, isMultiStoreMode, isMultiStoreShareCategories, isMultiStoreShareCustomers, isMultiStoreShareCustomersOrProducts, isMultiStoreShareProducts, isMultiStoreSingleDBCSMode, isMultiStoreSingleDBMode, isMultiStoreSingleDBNonCSMode, isUnix, isWindows, manageException, manageThrowable, removeCData, sendMQMessages, setAdminEng, setDebugStackTraceExclusions, setKkAdminPropsFilePath, setupWildCardRules, setWildCardAfter, setWildCardBefore, shutdownGracefully, shutdownGracefully, timestampStr, 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

mutex

protected static java.lang.String mutex

mutex

rnd

private java.util.Random rnd

For random number generation

staticDataHM

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

Hash Map that contains the static data

START

protected static final java.lang.String START

Static variable for constructing string when adding a product

See Also:

Constant Field Values

MIDDLE

protected static final java.lang.String MIDDLE

Static variable for constructing string when adding a product

See Also:

Constant Field Values

END

protected static final java.lang.String END

Static variable for constructing string when adding a product

See Also:

Constant Field Values

TYPE_TEXT

protected static final java.lang.String TYPE_TEXT

static variable for file type

See Also:

Constant Field Values

TYPE_PDF

protected static final java.lang.String TYPE_PDF

static variable for file type

See Also:

Constant Field Values

TT_CAT

public static final int TT_CAT

static variable for term type

See Also:

Constant Field Values

TT_MANU

public static final int TT_MANU

static variable for term type

See Also:

Constant Field Values

TT_CAT_MANU

public static final int TT_CAT_MANU

static variable for term type

See Also:

Constant Field Values

TT_MANU_CAT

public static final int TT_MANU_CAT

static variable for term type

See Also:

Constant Field Values

TT_NAME

public static final int TT_NAME

static variable for term type

See Also:

Constant Field Values

TT_MODEL

public static final int TT_MODEL

static variable for term type

See Also:

Constant Field Values

PDFReaderPresent

protected static boolean PDFReaderPresent

this is set to true if the PDF reader classes are found

topLevelCatMap

protected java.util.HashMap<java.lang.Integer,java.lang.Integer> topLevelCatMap

Map to temporarily store top level category id for a category

Constructor Detail

AdminSolrMgr

public AdminSolrMgr(KKAdminIf eng)
             throws java.lang.Exception

Constructor

Parameters:

eng - the Admin Engine

Throws:

java.lang.Exception - an unexpected exception

Method Detail

addAllProductsToSearchEngine

public 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. It uses a separate thread since the operation may take a while.

Specified by:

addAllProductsToSearchEngine in interface AdminSolrMgrIf

Parameters:

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

Throws:

java.lang.Exception - an unexpected exception

addAllProductsToSearchEngineSync

public void addAllProductsToSearchEngineSync()
                                      throws java.lang.Exception

Loop through all of the products in the KonaKart database and add them to the Solr search engine. The AdminDataDescriptor and AdminProductSearch objects are defined here and then passed to another method which does the actual work. The reason for this is to be able to easily override this method in a custom manager in order to introduce any special constraints to filter the products that are added.

Specified by:

addAllProductsToSearchEngineSync in interface AdminSolrMgrIf

Throws:

java.lang.Exception - an unexpected exception

addAllProductsToSearchEnginePrivate

protected void addAllProductsToSearchEnginePrivate(AdminDataDescriptor dd,
                                                   AdminProductSearch ps)
                                            throws java.lang.Exception

Loop through all of the products in the KonaKart database and add them to the Solr search engine. The AdminDataDescriptor and AdminProductSearch objects used for the product search are passed in as parameters.

Parameters:

dd - AdminDataDescriptor used for the product search

ps - AdminProductSearch used for the product search

Throws:

java.lang.Exception - an unexpected exception

getSolrCommitFrequency

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

Specified by:

getSolrCommitFrequency in interface AdminSolrMgrIf

Returns:

Returns an integer

addAllProductsToSearchEngineMultiThreadedSync

public void addAllProductsToSearchEngineMultiThreadedSync()
                                                   throws java.lang.Exception

Uses a configurable number of threads to populate Solr with KonaKart products

Throws:

java.lang.Exception - an unexpected exception

sendProductsToSearchEngineMultiThreaded

protected void sendProductsToSearchEngineMultiThreaded(AdminProducts prods,
                                                       java.util.HashMap<java.lang.Integer,AdminLanguage> langMap,
                                                       java.net.URL solrUrl)
                                                throws java.lang.Exception

Called by the Solr sender in a separate thread

Parameters:

prods - An array of products to be sent to Solr

langMap - Map of languages

solrUrl - The Solr URL

Throws:

java.lang.Exception - an unexpected exception

getAdminDataDescriptorForMultiThreadedAdd

protected AdminDataDescriptor getAdminDataDescriptorForMultiThreadedAdd()
                                                                 throws KKAdminException

Returns an AdminDataDescriptor object used in the product search of the multi-threaded add to fetch products to be added. Method maybe overridden for example to fetch invisible products.

Returns:

Returns an AdminDataDescriptor object

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin Engine

getAdminProductSearchForMultiThreadedAdd

protected AdminProductSearch getAdminProductSearchForMultiThreadedAdd()

Returns an AdminProductSearch object used in the product search of the multi-threaded add to fetch products to be added.

Returns:

Returns an AdminProductSearch object

getNumberOfThreadsForMultiThreadedAdd

protected int getNumberOfThreadsForMultiThreadedAdd()
                                             throws KKAdminException

Returns:

Returns the number of threads used to add products to Solr

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin Engine

getMaxWaitSecsForMultiThreadedAddGracefulShutdown

protected int getMaxWaitSecsForMultiThreadedAddGracefulShutdown()
                                                         throws KKAdminException

Returns:

Returns the number of seconds to wait for gracefull shutdown of all threads

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin Engine

removeAllProductsFromSearchEngine

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

Specified by:

removeAllProductsFromSearchEngine in interface AdminSolrMgrIf

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

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

Remove all products from the Solr search engine

Specified by:

removeAllProductsFromSearchEngineSync in interface AdminSolrMgrIf

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

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 AdminSolrMgrIf

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

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

Specified by:

removeProductFromSearchEngine in interface AdminSolrMgrIf

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

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

Specified by:

addProductToSearchEngine in interface AdminSolrMgrIf

Parameters:

productId - the productId

storeId - the storeId

Throws:

java.lang.Exception - an unexpected exception

addProductToSearchEngine

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

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

Specified by:

addProductToSearchEngine in interface AdminSolrMgrIf

Parameters:

productId - the productId

Throws:

java.lang.Exception - an unexpected exception

getLangMap

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

Returns a HashMap mapping language id to language

Specified by:

getLangMap in interface AdminSolrMgrIf

Returns:

Returns a HashMap mapping language id to language

Throws:

java.lang.Exception - an unexpected exception

getDocFromProduct

public 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

Specified by:

getDocFromProduct in interface AdminSolrMgrIf

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

getCatalogIdsForProduct

protected java.util.ArrayList<java.lang.String> getCatalogIdsForProduct(AdminSolrMgr.StaticData sd,
                                                                        int prodId)
                                                                 throws java.lang.Exception

Returns an array of catalog ids for which the product is defined

Parameters:

sd - the sd

prodId - the prodId

Returns:

Returns an array of catalog ids for which the product is defined

Throws:

java.lang.Exception - an unexpected exception

beforeAddProduct

protected void beforeAddProduct(java.lang.StringBuffer addProdData,
                                AdminProduct prod,
                                java.lang.String storeId,
                                java.util.HashMap<java.lang.Integer,AdminLanguage> langMap)

This method offers an opportunity to modify the data sent to Solr when adding a product.

Parameters:

addProdData - A string buffer containing data that will be sent to Solr. Extra data may be appended to the string buffer and / or the data it currently contains may be modified.

prod - The product being added to Solr

storeId - The store id

langMap - A hash map containing the current languages

addTerms

protected void addTerms(int type,
                        java.lang.StringBuffer sb,
                        java.lang.String langCode,
                        java.lang.String term,
                        int prodId,
                        int catId,
                        int manuId,
                        java.lang.String storeId,
                        java.util.ArrayList<java.lang.String> catalogIdList,
                        int parentCatId)
                 throws java.lang.Exception

Method calls the addTerm method once for every catalog id

Parameters:

type - the type

sb - the sb

langCode - the langCode

term - the term

prodId - the prodId

catId - the catId

manuId - the manuId

storeId - the storeId

catalogIdList - the catalogIdList

parentCatId - the parentCatId

Throws:

java.lang.Exception - an unexpected exception

addTerm

protected void addTerm(int type,
                       java.lang.StringBuffer sb,
                       java.lang.String langCode,
                       java.lang.String term,
                       int prodId,
                       int catId,
                       int manuId,
                       java.lang.String storeId,
                       java.lang.String catalogId,
                       int parentCatId)
                throws java.lang.Exception

Common code to add a term for dynamic suggested searching

Parameters:

type - Used when specializing this method to decide whether to not include certain terms in the search.

sb - the sb

langCode - the langCode

term - the term

prodId - the prodId

catId - the catId

manuId - the manuId

storeId - the storeId

catalogId - the catalogId

parentCatId - the parentCatId

Throws:

java.lang.Exception - an unexpected exception

addSpellings

protected void addSpellings(java.lang.StringBuffer sb,
                            AdminProduct prod,
                            AdminManufacturer manu,
                            java.util.HashMap<java.lang.Integer,AdminLanguage> langMap,
                            java.lang.String storeId,
                            AdminSolrMgr.StaticData sd,
                            java.util.ArrayList<java.lang.String> catalogIdList)
                     throws KKAdminException

Method calls the addSpelling method once for every catalog id

Parameters:

sb - the sb

prod - the prod

manu - the manu

langMap - the langMap

storeId - the storeId

sd - the sd

catalogIdList - the catalogIdList

Throws:

KKAdminException - unexpected exception in the KonaKart Admin Engine

addSpelling

protected void addSpelling(java.lang.StringBuffer sb,
                           AdminProduct prod,
                           AdminManufacturer manu,
                           java.util.HashMap<java.lang.Integer,AdminLanguage> langMap,
                           java.lang.String storeId,
                           AdminSolrMgr.StaticData sd,
                           java.lang.String catalogId)
                    throws KKAdminException

Method to populate a field with text that provides spelling suggestions.

Parameters:

sb - the sb

prod - the prod

manu - the manu

langMap - the langMap

storeId - the storeId

sd - the sd

catalogId - the catalogId

Throws:

KKAdminException - unexpected exception in the KonaKart Admin Engine

getAttachmentText

protected java.lang.String getAttachmentText(AdminProduct product)
                                      throws java.lang.Exception

Returns the text from the attachment so that it can be indexed in SOLR

Parameters:

product - the product

Returns:

Returns the text

Throws:

java.lang.Exception - an unexpected exception

checkPDFReaderPresent

private void checkPDFReaderPresent()
                            throws KKAdminException

Throws:

KKAdminException

getFileType

protected java.lang.String getFileType(java.lang.String filePath)

Returns the file extension

Parameters:

filePath - the filePath

Returns:

The file extension

getSolrUrl

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

Derive a Solr Url from configuration variables.

Specified by:

getSolrUrl in interface AdminSolrMgrIf

Returns:

Returns a Solr Url

Throws:

java.lang.Exception - an unexpected exception

refreshConfigs

public void refreshConfigs()
                    throws java.lang.Exception

Refresh the configuration of the Admin Solr Manager

Specified by:

refreshConfigs in interface AdminSolrMgrIf

Overrides:

refreshConfigs in class AdminBaseMgr

Throws:

java.lang.Exception - an unexpected exception

useSolr

public boolean useSolr()
                throws java.lang.Exception

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

Specified by:

useSolr in interface AdminSolrMgrIf

Returns:

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

Throws:

java.lang.Exception - an unexpected exception

commitInCode

public boolean commitInCode()
                     throws java.lang.Exception

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

Specified by:

commitInCode in interface AdminSolrMgrIf

Returns:

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

Throws:

java.lang.Exception - an unexpected exception

isEnabled

protected void isEnabled()
                  throws java.lang.Exception

Throws an exception if Solr isn't enabled.

Throws:

java.lang.Exception - an unexpected Exception exception

isPDFReaderPresent

protected static boolean isPDFReaderPresent()

Returns:

the pDFReaderPresent

setPDFReaderPresent

protected static void setPDFReaderPresent(boolean readerPresent)

Parameters:

readerPresent - the pDFReaderPresent to set

getCustomSearchData

protected java.lang.String getCustomSearchData(AdminProduct prod,
                                               AdminLanguage lang)

A method that can be overidden to supply data from a product object that is not normally indexed in Solr. Typically the data could come from any custom field or even the SKU. Data that is already included in the Solr index (and should not be included twice) is the following.

• name
• model
• manufacturer
• description including comparison data and description custom fields

If you have more than one language defined, the method will be called more times for the same product. In this case you may use the language information to filter the return data. If the return data is language independent (e.g. an SKU) then you can ignore the language information.

This indexed data will only be used by the storefront APIs when you set whereToSearch in the ProductSearch object to ProductSearch.SEARCH_IN_PRODUCT_DESCRIPTION

Parameters:

prod - A full AdminProduct object

lang - The language currently being indexed

Returns:

Return a string containing data that will be indexed in Solr

getTopLevelCatId

protected int getTopLevelCatId(int catId)
                        throws java.lang.Exception

Find the top level category for a category

Parameters:

catId - the catId

Returns:

Returns the id of the top level parent

Throws:

java.lang.Exception - an unexpected exception