com.konakartadmin.bl

Class AdminBatchBaseMgr

java.lang.Object

com.konakartadmin.bl.AdminBaseMgr

com.konakartadmin.bl.AdminBatchBaseMgr

Direct Known Subclasses:

AdminAbandonedCartBatchMgr, AdminAIBatchMgr, AdminCatalogBatchMgr, AdminCurrencyBatchMgr, AdminCustomerBatchMgr, AdminFileBatchMgr, AdminLogFileBatchMgr, AdminOrderBatchMgr, AdminOrderStatsBatchMgr, AdminProductBatchMgr, AdminProductExportBatchMgr, AdminReviewBatchMgr, AdminSendProductSuggestionBatchMgr

public class AdminBatchBaseMgr
extends AdminBaseMgr

The BatchBaseMgr

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AdminBatchBaseMgr.CustTagCounter A return object containing CustomerTag counters for inserted and updated records

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

AdminBaseMgr.StaticData

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.commons.logging.Log	log the 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
AdminBatchBaseMgr()

Method Summary

Modifier and Type	Method and Description
protected void	ensureCustomerTagIsPresent(AdminCustomerTag tag, java.io.BufferedWriter bw)
protected AdminEngineConfig	getAdEngConf()
protected KKAdminIf	getAdminJsonEngine(java.lang.String adminJSONUrlStr)
protected java.lang.String	getBatchLogName(java.lang.String logNameIn, boolean appendLog) Creates the name of the log depending on whether it has to be unique or not and appends it to the log file directory.
protected boolean	getBoolean(java.lang.String in, boolean defValue, boolean useDefault) Convert a String to a boolean, passing in a default value.
protected java.util.HashMap<java.lang.String,AdminCustomerTag>	getCustomerTagsHash(int customerId, java.util.Set<java.lang.String> tagsToUpdate) Get the customer tags for the specified customerId.
protected int	getInt(java.lang.String in, int defValue, boolean useDefault) Convert a String to an int, passing in a default value.
protected int[]	getIntArray(java.lang.String in) Convert a String to an int[]
protected int[]	getIntArray(java.lang.String in, java.lang.String sep) Convert a String to an int[]
protected com.konakart.db.KKCriteria	getLiteCustomerCriteria(int size) Get the criteria object to retrieve lite customers
protected java.util.List<AdminCustomer>	getLiteCustomers(com.konakart.db.KKCriteria c, int custId) The method returns a null list within the return object when all of the customers have been read.
protected java.lang.String	getLogName(java.lang.String logNameIn, boolean appendLog) Creates the name of the log depending on whether it has to be unique or not and appends it to the log file directory.
protected AdminOrder[]	getOrders(com.konakart.db.KKCriteria c, int orderId) The method returns an array of orders which will be empty when all of the orders have been read.
protected java.lang.String	getSkuForProduct(int productId, AdminOrder[] orders) Get the SKU for the specified product.
protected void	insertOrUpdateCustomerTag(java.lang.String tagName, java.util.HashMap<java.lang.String,AdminCustomerTag> currentTags, int custId, java.lang.String value, java.util.HashMap<java.lang.String,AdminBatchBaseMgr.CustTagCounter> tagCounter) Insert or Update the specified tag with the specified value.
protected java.lang.String	trimMultiTag(java.lang.String tagValue, java.lang.String delim, int maxTagValueSize) Trim the multi-value customer tag value to the specified size by chopping off items from the end of the String.
protected void	validateTemplate(java.lang.String templateName) Check that the Velocity template is valid

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

log

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

the log

Constructor Detail

AdminBatchBaseMgr

public AdminBatchBaseMgr()

Method Detail

getLogName

protected java.lang.String getLogName(java.lang.String logNameIn,
                                      boolean appendLog)
                               throws org.apache.torque.TorqueException,
                                      com.workingdogs.village.DataSetException,
                                      KKAdminException,
                                      java.lang.Exception

Creates the name of the log depending on whether it has to be unique or not and appends it to the log file directory.

Parameters:

logNameIn - the logNameIn

appendLog - the appendLog

Returns:

The name of the log

Throws:

java.lang.Exception - an unexpected exception

KKAdminException - an unexpected exception in the KonaKart Admin engine

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)

getBatchLogName

protected java.lang.String getBatchLogName(java.lang.String logNameIn,
                                           boolean appendLog)
                                    throws org.apache.torque.TorqueException,
                                           com.workingdogs.village.DataSetException,
                                           KKAdminException,
                                           java.lang.Exception

Creates the name of the log depending on whether it has to be unique or not and appends it to the log file directory. This is similar to the above getLogName but it does not append a timestamp or ".log" and it uses the configuration variable BATCH_LOG_DIRECTORY to prefix the name.

Parameters:

logNameIn - the logNameIn

appendLog - the appendLog

Returns:

The name of the log

Throws:

java.lang.Exception - an unexpected exception

KKAdminException - an unexpected exception in the KonaKart Admin engine

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)

validateTemplate

protected void validateTemplate(java.lang.String templateName)
                         throws java.lang.Exception

Check that the Velocity template is valid

Parameters:

templateName - Velocity template name to validate

Throws:

java.lang.Exception - an unexpected exception

getInt

protected int getInt(java.lang.String in,
                     int defValue,
                     boolean useDefault)
              throws KKAdminException

Convert a String to an int, passing in a default value.

Parameters:

in - the in

defValue - the defValue

useDefault - the useDefault

Returns:

Returns an int

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

getBoolean

protected boolean getBoolean(java.lang.String in,
                             boolean defValue,
                             boolean useDefault)
                      throws KKAdminException

Convert a String to a boolean, passing in a default value.

Parameters:

in - the in

defValue - the defValue

useDefault - the useDefault

Returns:

Returns a boolean

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

getIntArray

protected int[] getIntArray(java.lang.String in)
                     throws KKAdminException

Convert a String to an int[]

Parameters:

in - the in

Returns:

Returns an int[]

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

getIntArray

protected int[] getIntArray(java.lang.String in,
                            java.lang.String sep)
                     throws KKAdminException

Convert a String to an int[]

Parameters:

in - the in

sep - Separator string to split on

Returns:

Returns an int[]

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

getOrders

protected AdminOrder[] getOrders(com.konakart.db.KKCriteria c,
                                 int orderId)
                          throws java.lang.Exception

The method returns an array of orders which will be empty when all of the orders have been read.

Parameters:

c - the c

orderId - the orderId - select orders with Orders_id greater than this value

Returns:

Returns a list of AdminOrderProducts and last order processed

Throws:

java.lang.Exception - an unexpected exception

ensureCustomerTagIsPresent

protected void ensureCustomerTagIsPresent(AdminCustomerTag tag,
                                          java.io.BufferedWriter bw)
                                   throws KKAdminException

Throws:

KKAdminException

trimMultiTag

protected java.lang.String trimMultiTag(java.lang.String tagValue,
                                        java.lang.String delim,
                                        int maxTagValueSize)
                                 throws KKAdminException

Trim the multi-value customer tag value to the specified size by chopping off items from the end of the String.

Parameters:

tagValue - the tag value

delim - the delimiter

maxTagValueSize - tag value size

Returns:

the trimmed String

Throws:

KKAdminException - if something unexpected happened in the KKAdmin engine

getSkuForProduct

protected java.lang.String getSkuForProduct(int productId,
                                            AdminOrder[] orders)
                                     throws org.apache.torque.TorqueException,
                                            com.workingdogs.village.DataSetException,
                                            KKAdminException,
                                            java.lang.Exception

Get the SKU for the specified product. The review only has a productId so we look for a match of that in the past orders. If we find a match we look up the SKU for the OrderProduct. If there are no matching OrderProducts we return the SKU on the product.

Parameters:

productId - the productId

orders - array of orders

Returns:

the SKU or null if it's not found

Throws:

java.lang.Exception - if something unexpected happened

KKAdminException - if something unexpected happened in the KKAdmin engine

com.workingdogs.village.DataSetException - if something unexpected happened in the database layer

org.apache.torque.TorqueException - if something unexpected happened in the database layer

getLiteCustomers

protected java.util.List<AdminCustomer> getLiteCustomers(com.konakart.db.KKCriteria c,
                                                         int custId)
                                                  throws java.lang.Exception

The method returns a null list within the return object when all of the customers have been read. The caller can stop looping when he receives null.

Parameters:

c - the lite customer criteria

custId - the customerId (only customers with customerId greater than this will be returned)

Returns:

Returns a list of AdminCustomers and the last customer Id

Throws:

java.lang.Exception - an unexpected exception

getLiteCustomerCriteria

protected com.konakart.db.KKCriteria getLiteCustomerCriteria(int size)
                                                      throws KKAdminException

Get the criteria object to retrieve lite customers

Parameters:

size - the number of records to retrieve at a time

Returns:

Returns a criteria object

Throws:

KKAdminException - if something unexpected happened in the KKAdmin engine

getCustomerTagsHash

protected java.util.HashMap<java.lang.String,AdminCustomerTag> getCustomerTagsHash(int customerId,
                                                                                   java.util.Set<java.lang.String> tagsToUpdate)
                                                                            throws java.lang.Exception

Get the customer tags for the specified customerId.

Parameters:

customerId - the customerId

tagsToUpdate - a set of tag names that we wish to update

Returns:

a HashMap containing the customers tags that are in the set of customer tags we wish to update.

Throws:

java.lang.Exception - if something unexpected happened

insertOrUpdateCustomerTag

protected void insertOrUpdateCustomerTag(java.lang.String tagName,
                                         java.util.HashMap<java.lang.String,AdminCustomerTag> currentTags,
                                         int custId,
                                         java.lang.String value,
                                         java.util.HashMap<java.lang.String,AdminBatchBaseMgr.CustTagCounter> tagCounter)
                                  throws KKAdminException,
                                         org.apache.torque.TorqueException,
                                         java.text.ParseException,
                                         com.workingdogs.village.DataSetException,
                                         java.lang.Exception

Insert or Update the specified tag with the specified value.

Parameters:

tagName - the new tag's name

currentTags - a HashMap of current customer tags

custId - the customer's Id

value - the tag's new value to set

tagCounter - the tag counter used for reporting results

Throws:

KKAdminException - if something unexpected happened in the KKAdmin engine

org.apache.torque.TorqueException - if something unexpected happened in the database layer

java.text.ParseException - if something unexpected happened parsing in the KKAdmin engine

com.workingdogs.village.DataSetException - if something unexpected happened in the database layer

java.lang.Exception - if something unexpected happened

getAdEngConf

protected AdminEngineConfig getAdEngConf()
                                  throws KKAdminException

Throws:

KKAdminException

getAdminJsonEngine

protected KKAdminIf getAdminJsonEngine(java.lang.String adminJSONUrlStr)
                                throws KKAdminException

Throws:

KKAdminException