com.konakartadmin.bl

Class AdminProductBatchMgr

java.lang.Object

com.konakartadmin.bl.AdminBaseMgr

com.konakartadmin.bl.AdminBatchBaseMgr

com.konakartadmin.bl.AdminProductBatchMgr

public class AdminProductBatchMgr
extends AdminBatchBaseMgr

The ProductBatchMgr

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	AdminProductBatchMgr.SolrProductSender Purpose of object is to send a product to Solr.

Nested classes/interfaces inherited from class com.konakartadmin.bl.AdminBatchBaseMgr

AdminBatchBaseMgr.CustTagCounter

Nested classes/interfaces inherited from class com.konakartadmin.bl.AdminBaseMgr

AdminBaseMgr.StaticData

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	CHANGEFREQ
private static java.lang.String	CHANGEFREQ_END
private static java.lang.String	HEADER
private static java.lang.String	IMAGE
private static java.lang.String	IMAGE_END
private static java.lang.String	IMAGE_LOC
private static java.lang.String	IMAGE_LOC_END
private static java.lang.String	IMAGE_TITLE
private static java.lang.String	IMAGE_TITLE_END
private static java.lang.String	LASTMOD
private static java.lang.String	LASTMOD_END
private static java.lang.String	LOC
private static java.lang.String	LOC_END
private static java.lang.String	PRIORITY
private static java.lang.String	PRIORITY_END
private static java.lang.String	SITEMAP
private static java.lang.String	SITEMAP_END
private static java.lang.String	SITEMAPINDEX
private static java.lang.String	SITEMAPINDEX_END
private static java.lang.String	URL
private static java.lang.String	URL_END
private static java.lang.String	URLSET
private static java.lang.String	URLSET_END
private static java.lang.String	URLSET_PROD

Fields inherited from class com.konakartadmin.bl.AdminBatchBaseMgr

log

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
AdminProductBatchMgr(KKAdminIf eng)

Method Summary

Modifier and Type	Method and Description
java.lang.String	addAllProductsToSearchEngineBatch(java.lang.String logName, java.lang.String appendLogStr, java.lang.String numThreadsStr, java.lang.String recordFetchSizeStr, java.lang.String debugStr, java.lang.String sessId) This batch adds all products to the Solr search engine using multiple threads.
void	createSitemapBatch(java.lang.String logName, java.lang.String appendLogStr, java.lang.String recordFetchSizeStr) This method creates 4 or more files as described below: sitemap.xml - the sitemap index file that includes the other sitemap files sitemap-products_n.xml - includes links to all of the product detail pages.
java.lang.String	removeExpiredStockReservationsBatch(java.lang.String logName, java.lang.String appendLogStr) This batch removes all expired stock reservation records.
void	setProductAverageRatingsBatch(java.lang.String logName, java.lang.String appendLogStr, java.lang.String recordFetchSizeStr) Whenever a product review is submitted, a rating is given to the product.
void	setSpecialPriceStateBatch(java.lang.String logName, java.lang.String appendLogStr, java.lang.String recordFetchSizeStr) Whenever a product special price is set and active, it is used in sort / filter by price queries regardless of whether it has expired or has yet to start.
private void	setSpecialState(com.konakart.db.KKCriteria updateC, com.konakart.db.KKCriteria selectC, int id, boolean enable) Private method to enable or disable the special
void	synchronizeStoresBatch(java.lang.String logName, java.lang.String appendLogStr, java.lang.String recordFetchSizeStr, java.lang.String storeIdFrom, java.lang.String storeIdTo) This batch synchronizes the products in storeIdFrom with the ones in storeIdTo.
private void	writeSitemapPageEntry(java.io.BufferedWriter sm, java.lang.String url, java.lang.String changeFreq, java.lang.String priority) Utility method to write a sitemap entry for a page

Methods inherited from class com.konakartadmin.bl.AdminBatchBaseMgr

ensureCustomerTagIsPresent, getAdEngConf, getAdminJsonEngine, getBatchLogName, getBoolean, getCustomerTagsHash, getInt, getIntArray, getIntArray, getLiteCustomerCriteria, getLiteCustomers, getLogName, getOrders, getSkuForProduct, insertOrUpdateCustomerTag, trimMultiTag, validateTemplate

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, refreshConfigs, 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

HEADER

private static final java.lang.String HEADER

See Also:

Constant Field Values

SITEMAPINDEX

private static final java.lang.String SITEMAPINDEX

See Also:

Constant Field Values

SITEMAPINDEX_END

private static final java.lang.String SITEMAPINDEX_END

See Also:

Constant Field Values

SITEMAP

private static final java.lang.String SITEMAP

See Also:

Constant Field Values

SITEMAP_END

private static final java.lang.String SITEMAP_END

See Also:

Constant Field Values

LOC

private static final java.lang.String LOC

See Also:

Constant Field Values

LOC_END

private static final java.lang.String LOC_END

See Also:

Constant Field Values

URLSET_PROD

private static final java.lang.String URLSET_PROD

See Also:

Constant Field Values

URLSET

private static final java.lang.String URLSET

See Also:

Constant Field Values

URLSET_END

private static final java.lang.String URLSET_END

See Also:

Constant Field Values

URL

private static final java.lang.String URL

See Also:

Constant Field Values

URL_END

private static final java.lang.String URL_END

See Also:

Constant Field Values

LASTMOD

private static final java.lang.String LASTMOD

See Also:

Constant Field Values

LASTMOD_END

private static final java.lang.String LASTMOD_END

See Also:

Constant Field Values

CHANGEFREQ

private static final java.lang.String CHANGEFREQ

See Also:

Constant Field Values

CHANGEFREQ_END

private static final java.lang.String CHANGEFREQ_END

See Also:

Constant Field Values

PRIORITY

private static final java.lang.String PRIORITY

See Also:

Constant Field Values

PRIORITY_END

private static final java.lang.String PRIORITY_END

See Also:

Constant Field Values

IMAGE

private static final java.lang.String IMAGE

See Also:

Constant Field Values

IMAGE_END

private static final java.lang.String IMAGE_END

See Also:

Constant Field Values

IMAGE_LOC

private static final java.lang.String IMAGE_LOC

See Also:

Constant Field Values

IMAGE_LOC_END

private static final java.lang.String IMAGE_LOC_END

See Also:

Constant Field Values

IMAGE_TITLE

private static final java.lang.String IMAGE_TITLE

See Also:

Constant Field Values

IMAGE_TITLE_END

private static final java.lang.String IMAGE_TITLE_END

See Also:

Constant Field Values

Constructor Detail

AdminProductBatchMgr

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

Parameters:

eng - the eng

Throws:

java.lang.Exception - an unexpected exception

Method Detail

setProductAverageRatingsBatch

public void setProductAverageRatingsBatch(java.lang.String logName,
                                          java.lang.String appendLogStr,
                                          java.lang.String recordFetchSizeStr)
                                   throws java.lang.Exception

Whenever a product review is submitted, a rating is given to the product. This method calculates the average rating and number of reviews for each product and updates the product rating attribute and numberReviews attribute with these values. Only visible reviews are processed.

The product rating may be used by the application to filter and order products.

Parameters:

logName - The name of the log which shouldn't include the path or extension. i.e. It should be myLog rather than /logs/myLog.txt.

appendLogStr - If set to false, a new log will be created every time the batch job is run. Otherwise new data will be appended to the existing log. It defaults to false.

recordFetchSizeStr - It the batch involves reading many records in a loop, this determines the maximum number read in any one loop. It defaults to 100.

Throws:

java.lang.Exception - an unexpected exception

setSpecialPriceStateBatch

public void setSpecialPriceStateBatch(java.lang.String logName,
                                      java.lang.String appendLogStr,
                                      java.lang.String recordFetchSizeStr)
                               throws java.lang.Exception

Whenever a product special price is set and active, it is used in sort / filter by price queries regardless of whether it has expired or has yet to start. The price shown on the product is always the correct price but when for example sorting by price, it may appear in the wrong position because the special price is used to do the sorting whereas the full price is displayed. The reason for this functionality is that only the special status (for performance reasons) is looked at to decide which price to use when sorting / filtering.

If your policy is to set special prices on a daily basis, then this batch should be run on a daily basis. It looks at the start and expiry dates of the special and disables it if the current date doesn't lie in between these two dates. Otherwise the special is enabled if there is a start date and the special price should have started.

Parameters:

logName - The name of the log which shouldn't include the path or extension. i.e. It should be myLog rather than /logs/myLog.txt.

appendLogStr - If set to false, a new log will be created every time the batch job is run. Otherwise new data will be appended to the existing log. It defaults to false.

recordFetchSizeStr - It the batch involves reading many records in a loop, this determines the maximum number read in any one loop. It defaults to 100.

Throws:

java.lang.Exception - an unexpected exception

setSpecialState

private void setSpecialState(com.konakart.db.KKCriteria updateC,
                             com.konakart.db.KKCriteria selectC,
                             int id,
                             boolean enable)
                      throws org.apache.torque.TorqueException

Private method to enable or disable the special

Parameters:

updateC - the updateC

selectC - the selectC

id - the id

enable - the enable

Throws:

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

synchronizeStoresBatch

public void synchronizeStoresBatch(java.lang.String logName,
                                   java.lang.String appendLogStr,
                                   java.lang.String recordFetchSizeStr,
                                   java.lang.String storeIdFrom,
                                   java.lang.String storeIdTo)
                            throws java.lang.Exception

This batch synchronizes the products in storeIdFrom with the ones in storeIdTo. It can only be used if the KonaKart engine is running in shared category / shared product mode. It performs the following three copy operations from the source store to the destination store:

• Copy all products that have uuid equal to null. If uuid is equal to null, this means that the products have never been copied.
• Copy all products that have a valid uuid but the uuid doesn't exist in the destination store. This situation can arise if the products have been copied before to another store which isn't the destination store. They may also have been copied and then deleted from the destination store.
• Copy all products that have matching uuids but the dates in the masterProdDate attribute do not match. This situation can arise if a product has previously been copied but then modified.

A product object has two attributes to manage synchronization. One is the uuid which identifies identical products in different stores. i.e. When a product is copied from one store to another, the product id of the copied product is different but a uuid is generated and saved in both products in order to match them. The other attribute is the masterProdDate which is the last modified date of the source product. This date is maintained during the copy so that it can be used to determine when the products are no longer in sync. If after the copy, the source product is edited, the masterProdDate of the source product is automatically modified to the new edit date and so can be used to determine that the copied product in another store is now out of date.

Parameters:

logName - The name of the log which shouldn't include the path or extension. i.e. It should be myLog rather than /logs/myLog.txt.

appendLogStr - If set to false, a new log will be created every time the batch job is run. Otherwise new data will be appended to the existing log. It defaults to false.

recordFetchSizeStr - It the batch involves reading many records in a loop, this determines the maximum number read in any one loop. It defaults to 100.

storeIdFrom - The id of the source store

storeIdTo - The id of the destination store

Throws:

java.lang.Exception - an unexpected exception

createSitemapBatch

public void createSitemapBatch(java.lang.String logName,
                               java.lang.String appendLogStr,
                               java.lang.String recordFetchSizeStr)
                        throws java.lang.Exception

This method creates 4 or more files as described below:

• sitemap.xml - the sitemap index file that includes the other sitemap files
• sitemap-products_n.xml - includes links to all of the product detail pages. Depending on the number of products in the database, multiple files may be produced named sitemap-products_1.xml, sitemap-products_2.xml etc.
• sitemap-categories.xml - includes links to all of the top level category landing pages
• sitemap-pages.xml - includes the home page and various static pages

The directory into which the files are written is defined by a configuration variable and can be set in the Admin App under "Configuration >> Sitemap Configuration".

More information on sitemaps can be found at http://www.sitemaps.org/.

Parameters:

logName - The name of the log which shouldn't include the path or extension. i.e. It should be myLog rather than /logs/myLog.txt.

appendLogStr - If set to false, a new log will be created every time the batch job is run. Otherwise new data will be appended to the existing log. It defaults to false.

recordFetchSizeStr - It the batch involves reading many records in a loop, this determines the maximum number read in any one loop. It defaults to 100.

Throws:

java.lang.Exception - an unexpected exception

writeSitemapPageEntry

private void writeSitemapPageEntry(java.io.BufferedWriter sm,
                                   java.lang.String url,
                                   java.lang.String changeFreq,
                                   java.lang.String priority)
                            throws java.io.IOException

Utility method to write a sitemap entry for a page

Parameters:

sm - the sm

url - the url

changeFreq - the changeFreq

priority - the priority

Throws:

java.io.IOException - an unexpected IOException exception

removeExpiredStockReservationsBatch

public java.lang.String removeExpiredStockReservationsBatch(java.lang.String logName,
                                                            java.lang.String appendLogStr)
                                                     throws java.lang.Exception

This batch removes all expired stock reservation records.

Parameters:

logName - The name of the log which shouldn't include the path or extension. i.e. It should be myLog rather than /logs/myLog.txt.

appendLogStr - If set to false, a new log will be created every time the batch job is run. Otherwise new data will be appended to the existing log. It defaults to false.

Returns:

Returns the number of stock reservation records removed

Throws:

java.lang.Exception - an unexpected exception

addAllProductsToSearchEngineBatch

public java.lang.String addAllProductsToSearchEngineBatch(java.lang.String logName,
                                                          java.lang.String appendLogStr,
                                                          java.lang.String numThreadsStr,
                                                          java.lang.String recordFetchSizeStr,
                                                          java.lang.String debugStr,
                                                          java.lang.String sessId)
                                                   throws java.lang.Exception

This batch adds all products to the Solr search engine using multiple threads. This code may be used as a starting point to write your own Solr importer that only imports a subset of products based on constraints.

Parameters:

logName - The name of the log which shouldn't include the path or extension. i.e. It should be myLog rather than /logs/myLog.txt.

appendLogStr - If set to false, a new log will be created every time the batch job is run. Otherwise new data will be appended to the existing log. It defaults to false.

numThreadsStr - Defines the number of worker threads to use for sending the product data to Solr

recordFetchSizeStr - Defines number of products to read from the DB in a single query. They are then sent to Solr by the worker threads and committed.

debugStr - When set to true, more detailed information is written to the log

sessId - The sessionId. The sessionId is a special parameter defined in the konakart_jobs.xml file. If a parameter is defined with value "SESSION_ID", KonaKart will replace this value with the sessionId of the logged in session.

Returns:

Returns the number of products added to Solr

Throws:

java.lang.Exception - an unexpected exception