com.konakartadmin.bl

Class AdminAIBatchMgr

java.lang.Object

com.konakartadmin.bl.AdminBaseMgr

com.konakartadmin.bl.AdminBatchBaseMgr

com.konakartadmin.bl.AdminAIBatchMgr

public class AdminAIBatchMgr
extends AdminBatchBaseMgr

The AdminAIBatchMgr - Artificial Intelligence Mgr

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AdminAIBatchMgr.CustRetList A return object containing a list of Customers and the last customer Id processed

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
(package private) static int	CONNECT_TIMEOUT
private com.google.gson.Gson	gson
protected static org.apache.commons.logging.Log	log the log
(package private) static int	READ_TIMEOUT

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

Method Summary

Modifier and Type	Method and Description
protected boolean	attrExists(com.google.gson.JsonObject jsonObj, java.lang.String attr)
private int	calcConfidence(int score, int maxScore)
private boolean	exportCustomers(java.lang.String sessId, java.io.BufferedWriter bw, ExporterOptions exporterOptions)
private void	exportProducts(java.lang.String sessId, java.io.BufferedWriter bw, ExporterOptions exporterOptions)
private void	generateTag(java.lang.String sessId, java.io.BufferedWriter bw, ExporterOptions exporterOptions)
protected float	getAsFloat(com.google.gson.JsonObject jsonObj, java.lang.String attr)
protected int	getAsInt(com.google.gson.JsonObject jsonObj, java.lang.String attr)
protected com.google.gson.JsonArray	getAsJsonArray(com.google.gson.JsonObject jsonObj, java.lang.String attr)
protected com.google.gson.JsonObject	getAsJsonObject(java.lang.String response, boolean returnNullIfMissing)
protected java.lang.String	getAsString(com.google.gson.JsonObject jsonObj, java.lang.String attr)
protected java.lang.String	getAsString(com.google.gson.JsonObject jsonObj, java.lang.String attr, boolean returnNullIfMissing)
protected AdminAIBatchMgr.CustRetList	getCustomers(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.
com.google.gson.Gson	getGson()
private java.util.List<java.lang.Integer>	getIdsInTag(AdminCustomerTag custTag, AdminCustomerTag tagDetail)
protected com.konakart.db.KKCriteria	getLiteCustomerCriteria(int size) Get the criteria object to retrieve lite customers
private int	getMaxPairCount(java.io.BufferedWriter bw, java.util.HashMap<java.lang.Integer,java.util.HashMap<java.lang.Integer,java.lang.Integer>> orderedProductsByProduct)
private java.util.HashMap<java.lang.Integer,java.util.Set<java.lang.Integer>>	getOrderedProductIds(java.io.BufferedWriter bw)
private java.util.HashMap<java.lang.Integer,java.util.HashMap<java.lang.Integer,java.lang.Integer>>	getOrderedProductIdsByProduct(java.io.BufferedWriter bw, java.util.HashMap<java.lang.Integer,java.util.Set<java.lang.Integer>> orderedProductsByCustomer)
private java.util.Set<java.lang.Integer>	getOrderedProductIdsForCustomer(int custId)
void	getProductRecommendationSuggestions(java.lang.String logName, java.lang.String appendLogStr, java.lang.String dataDirectory, java.lang.String aiServiceUrl, java.lang.String loadDBStr, java.lang.String genTagPROPERTIES_TIME_VIEWEDStr, java.lang.String genRandomDataStr, java.lang.String maxAnalysisTimeMinsStr, java.lang.String loadVersion, java.lang.String minConfidenceStr, java.lang.String custFieldMap, java.lang.String sessId) Get Product Recommendation Suggestions data from the AI Service
private java.util.HashMap<java.lang.Integer,AdminCustomerTag>	populateCustTagsHash(java.io.BufferedWriter bw)
private java.lang.String	postFile(java.lang.String url, java.lang.String request, java.lang.String params, java.lang.String filename, java.lang.String storeId, java.lang.String verb)
java.lang.String	postRequest(java.lang.String aiUrl, java.lang.String request, java.lang.String params, java.lang.String filename, int maxAttempts, java.lang.String storeId, java.lang.String verb)
java.lang.String	postRequest(java.lang.String url, java.lang.String request, java.lang.String params, java.lang.String filename, java.lang.String storeId, java.lang.String verb)
java.lang.String	prettyJson(java.lang.String jsonString) Convert a JSON string to pretty print version
java.lang.String	prettyJsonArray(java.lang.String jsonString) Convert a JSON Array string to pretty print version
private void	processCustomersKonaKartService(java.io.BufferedWriter bw, java.util.HashMap<java.lang.Integer,java.util.Set<java.lang.Integer>> orderedProductsByCustomer, java.util.HashMap<java.lang.Integer,AdminCustomerTag> custTagHash, boolean loadDB, java.lang.String loadVersion, int minConfidence)
private void	processInKonaKartService(java.io.BufferedWriter bw, java.lang.String dataDir, boolean loadDB, java.lang.String loadVersion, int minConfidence)
private void	processInZucchettiService(java.io.BufferedWriter bw, java.lang.String aiServiceUrl, java.lang.String uploadFile, java.lang.String maxAnalysisTimeMinsStr, java.lang.String dataDir, boolean loadDB, int chunkSize, java.lang.String loadVersion, int minConfidence)
private void	processProductsKonaKartService(java.io.BufferedWriter bw, java.util.HashMap<java.lang.Integer,java.util.HashMap<java.lang.Integer,java.lang.Integer>> orderedProductsByProduct, int maxPairCount, boolean loadDB, java.lang.String loadVersion, int minConfidence)
protected int	updateCustomerSuggestionsInDBKonaKartService(int custId, java.util.HashMap<java.lang.Integer,java.lang.Integer> productScoresHash, java.lang.String loadVersion, int productScoreMax, int minConfidence)

Methods inherited from class com.konakartadmin.bl.AdminBatchBaseMgr

ensureCustomerTagIsPresent, getAdEngConf, getAdminJsonEngine, getBatchLogName, getBoolean, getCustomerTagsHash, getInt, getIntArray, getIntArray, 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

log

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

the log

gson

private com.google.gson.Gson gson

CONNECT_TIMEOUT

static int CONNECT_TIMEOUT

READ_TIMEOUT

static int READ_TIMEOUT

Constructor Detail

AdminAIBatchMgr

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

Parameters:

eng - the KKAdminIf engine

Throws:

java.lang.Exception - an unexpected exception

Method Detail

getProductRecommendationSuggestions

public void getProductRecommendationSuggestions(java.lang.String logName,
                                                java.lang.String appendLogStr,
                                                java.lang.String dataDirectory,
                                                java.lang.String aiServiceUrl,
                                                java.lang.String loadDBStr,
                                                java.lang.String genTagPROPERTIES_TIME_VIEWEDStr,
                                                java.lang.String genRandomDataStr,
                                                java.lang.String maxAnalysisTimeMinsStr,
                                                java.lang.String loadVersion,
                                                java.lang.String minConfidenceStr,
                                                java.lang.String custFieldMap,
                                                java.lang.String sessId)
                                         throws java.lang.Exception

Get Product Recommendation Suggestions data from the AI Service

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.

dataDirectory - data directory for storing intermediate files. If not specified the directory KonaKartAIData data is created under INSTALLATION_HOME

aiServiceUrl - AI service URL (use an empty String if you don't want to use an external AI Service)

loadDBStr - if "true" the results are loaded into the database

genTagPROPERTIES_TIME_VIEWEDStr - if "true" the PROPERTIES_TIME_VIEWED tag is generated

genRandomDataStr - if "true" generate random data

maxAnalysisTimeMinsStr - maximum time (in minutes) that we'll wait for the analysis to complete before giving up

loadVersion - Suggestions will be loaded wit this version number

minConfidenceStr - Only add suggestions where the confidence level (0 to 999) is greater than this value

custFieldMap - Custom field mapping (e.g. #1,#2,FAVOURITE_COLOUR,#4,#5)

sessId - sessionId

Throws:

java.lang.Exception - an unexpected exception

exportProducts

private void exportProducts(java.lang.String sessId,
                            java.io.BufferedWriter bw,
                            ExporterOptions exporterOptions)
                     throws java.lang.Exception

Throws:

java.lang.Exception

processInKonaKartService

private void processInKonaKartService(java.io.BufferedWriter bw,
                                      java.lang.String dataDir,
                                      boolean loadDB,
                                      java.lang.String loadVersion,
                                      int minConfidence)
                               throws KKAdminException,
                                      java.lang.Exception

Throws:

KKAdminException

java.lang.Exception

populateCustTagsHash

private java.util.HashMap<java.lang.Integer,AdminCustomerTag> populateCustTagsHash(java.io.BufferedWriter bw)
                                                                            throws org.apache.torque.TorqueException,
                                                                                   com.workingdogs.village.DataSetException,
                                                                                   KKAdminException,
                                                                                   java.lang.Exception

Throws:

org.apache.torque.TorqueException

com.workingdogs.village.DataSetException

KKAdminException

java.lang.Exception

processCustomersKonaKartService

private void processCustomersKonaKartService(java.io.BufferedWriter bw,
                                             java.util.HashMap<java.lang.Integer,java.util.Set<java.lang.Integer>> orderedProductsByCustomer,
                                             java.util.HashMap<java.lang.Integer,AdminCustomerTag> custTagHash,
                                             boolean loadDB,
                                             java.lang.String loadVersion,
                                             int minConfidence)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

processProductsKonaKartService

private void processProductsKonaKartService(java.io.BufferedWriter bw,
                                            java.util.HashMap<java.lang.Integer,java.util.HashMap<java.lang.Integer,java.lang.Integer>> orderedProductsByProduct,
                                            int maxPairCount,
                                            boolean loadDB,
                                            java.lang.String loadVersion,
                                            int minConfidence)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

calcConfidence

private int calcConfidence(int score,
                           int maxScore)

getOrderedProductIdsForCustomer

private java.util.Set<java.lang.Integer> getOrderedProductIdsForCustomer(int custId)
                                                                  throws com.workingdogs.village.DataSetException,
                                                                         org.apache.torque.TorqueException,
                                                                         KKAdminException

Throws:

com.workingdogs.village.DataSetException

org.apache.torque.TorqueException

KKAdminException

getOrderedProductIds

private java.util.HashMap<java.lang.Integer,java.util.Set<java.lang.Integer>> getOrderedProductIds(java.io.BufferedWriter bw)
                                                                                            throws java.lang.Exception

Throws:

java.lang.Exception

getOrderedProductIdsByProduct

private java.util.HashMap<java.lang.Integer,java.util.HashMap<java.lang.Integer,java.lang.Integer>> getOrderedProductIdsByProduct(java.io.BufferedWriter bw,
                                                                                                                                  java.util.HashMap<java.lang.Integer,java.util.Set<java.lang.Integer>> orderedProductsByCustomer)
                                                                                                                           throws java.io.IOException

Throws:

java.io.IOException

getMaxPairCount

private int getMaxPairCount(java.io.BufferedWriter bw,
                            java.util.HashMap<java.lang.Integer,java.util.HashMap<java.lang.Integer,java.lang.Integer>> orderedProductsByProduct)
                     throws java.io.IOException

Throws:

java.io.IOException

updateCustomerSuggestionsInDBKonaKartService

protected int updateCustomerSuggestionsInDBKonaKartService(int custId,
                                                           java.util.HashMap<java.lang.Integer,java.lang.Integer> productScoresHash,
                                                           java.lang.String loadVersion,
                                                           int productScoreMax,
                                                           int minConfidence)
                                                    throws KKAdminException,
                                                           java.lang.Exception

Throws:

KKAdminException

java.lang.Exception

getIdsInTag

private java.util.List<java.lang.Integer> getIdsInTag(AdminCustomerTag custTag,
                                                      AdminCustomerTag tagDetail)
                                               throws KKAdminException

Throws:

KKAdminException

processInZucchettiService

private void processInZucchettiService(java.io.BufferedWriter bw,
                                       java.lang.String aiServiceUrl,
                                       java.lang.String uploadFile,
                                       java.lang.String maxAnalysisTimeMinsStr,
                                       java.lang.String dataDir,
                                       boolean loadDB,
                                       int chunkSize,
                                       java.lang.String loadVersion,
                                       int minConfidence)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getCustomers

protected AdminAIBatchMgr.CustRetList getCustomers(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 c

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

Overrides:

getLiteCustomerCriteria in class AdminBatchBaseMgr

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

postRequest

public java.lang.String postRequest(java.lang.String url,
                                    java.lang.String request,
                                    java.lang.String params,
                                    java.lang.String filename,
                                    java.lang.String storeId,
                                    java.lang.String verb)
                             throws java.lang.Exception

Parameters:

url - URL

request - request string

params - parameters as a string

filename - file name

storeId - storeId

verb - verb (GET/PUT)

Returns:

the response

Throws:

java.lang.Exception - an unexpected exception

postRequest

public java.lang.String postRequest(java.lang.String aiUrl,
                                    java.lang.String request,
                                    java.lang.String params,
                                    java.lang.String filename,
                                    int maxAttempts,
                                    java.lang.String storeId,
                                    java.lang.String verb)
                             throws java.lang.Exception

Parameters:

aiUrl - URL

request - request string

params - parameters as a string

filename - file name

maxAttempts - maximum number of attempts

storeId - storeId

verb - verb (GET/PUT)

Returns:

the response

Throws:

java.lang.Exception - an unexpected exception

postFile

private java.lang.String postFile(java.lang.String url,
                                  java.lang.String request,
                                  java.lang.String params,
                                  java.lang.String filename,
                                  java.lang.String storeId,
                                  java.lang.String verb)
                           throws java.lang.Exception

Throws:

java.lang.Exception

generateTag

private void generateTag(java.lang.String sessId,
                         java.io.BufferedWriter bw,
                         ExporterOptions exporterOptions)
                  throws java.lang.Exception

Throws:

java.lang.Exception

exportCustomers

private boolean exportCustomers(java.lang.String sessId,
                                java.io.BufferedWriter bw,
                                ExporterOptions exporterOptions)
                         throws java.lang.Exception

Throws:

java.lang.Exception

getGson

public com.google.gson.Gson getGson()

Returns:

the gson

prettyJsonArray

public java.lang.String prettyJsonArray(java.lang.String jsonString)

Convert a JSON Array string to pretty print version

Parameters:

jsonString - a JSON string

Returns:

Returns a formatted JSON string

prettyJson

public java.lang.String prettyJson(java.lang.String jsonString)

Convert a JSON string to pretty print version

Parameters:

jsonString - a JSON string

Returns:

Returns a formatted JSON string

attrExists

protected boolean attrExists(com.google.gson.JsonObject jsonObj,
                             java.lang.String attr)
                      throws KKAdminException

Throws:

KKAdminException

getAsInt

protected int getAsInt(com.google.gson.JsonObject jsonObj,
                       java.lang.String attr)
                throws KKAdminException

Throws:

KKAdminException

getAsFloat

protected float getAsFloat(com.google.gson.JsonObject jsonObj,
                           java.lang.String attr)
                    throws KKAdminException

Throws:

KKAdminException

getAsJsonArray

protected com.google.gson.JsonArray getAsJsonArray(com.google.gson.JsonObject jsonObj,
                                                   java.lang.String attr)
                                            throws KKAdminException

Throws:

KKAdminException

getAsJsonObject

protected com.google.gson.JsonObject getAsJsonObject(java.lang.String response,
                                                     boolean returnNullIfMissing)
                                              throws KKAdminException

Throws:

KKAdminException

getAsString

protected java.lang.String getAsString(com.google.gson.JsonObject jsonObj,
                                       java.lang.String attr)
                                throws KKAdminException

Throws:

KKAdminException

getAsString

protected java.lang.String getAsString(com.google.gson.JsonObject jsonObj,
                                       java.lang.String attr,
                                       boolean returnNullIfMissing)
                                throws KKAdminException

Throws:

KKAdminException