Package overit.geocallapp.wfm.ai.bl.processing.task

Class BTBasicAIProcess

java.lang.Object

overit.geocall.bl.BusinessTask<Void>

overit.geocallapp.wfm.ai.bl.processing.task.BTBasicAIProcess

All Implemented Interfaces:

Serializable, Tool

Direct Known Subclasses:

BTBasicClusterMapping, BTBasicPrediction, BTBasicTraining, BTPredictionAgendaAffinity, BTUpdateS3Orders

public abstract class BTBasicAIProcess
extends BusinessTask<Void>

Basic AI Task with history and log functions

Since:

9.2

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	algorithmName
protected boolean	asyncQueueMode
protected BOConfParamsHistory	configurationParamsHistory
protected BOElaborationHistory	elaborationHistory
protected S3WebResourceFactory	factory
protected List<String>	filesToDelete
protected AWSRequestHeaders	headers
protected String	instanceType
protected String	modelName
protected String	resourcesFolder

Constructor Summary

Constructors

Constructor	Description
BTBasicAIProcess()

Method Summary

Modifier and Type	Method	Description
protected void	body(Void v, PoolKit pk)	Implements this method to write the specific task logic to handle the input parameter.
protected void	buildHeaders()	Method that builds all the headers for AI Api calls.
protected void	checkConfiguration()
protected void	clearOldLogs(PoolKit pk)	Delete the old history record for the elaboration of this configuration
protected void	deleteFileS3(String key)
protected void	deleteTemporaryFiles()
protected abstract void	elaborateTask(PoolKit pk)
BOConfigurationParams	getAiConfiguration()
protected String	getAwsUploadPath(String algorithm, String model)
protected BOConfParamsHistory	getConfigurationParamsHistory(PoolKit pk)
protected BOElaborationHistory	getElaborationHistory(PoolKit pk)
String	getError()
protected String	getJobName()
protected abstract int	getLogValidityDays()
String	getResourcesFolder()
Long	getTrainingType()
boolean	isAsyncQueueMode()
protected void	prepareDataForApi()	This method must be called before calling AI Api.It composes the basic info for AI calls.
void	setAiConfiguration(BOConfigurationParams aiConfiguration)
void	setAsyncQueueMode(boolean asyncQueueMode)
protected void	setJobName()
void	setResourcesFolder(String resourcesFolder)
void	setTrainingType(Long trainingType)
protected String	uploadFileS3(String inputFilePath, boolean toZip, String inputFileName)	Method that uploads a file to S3.
protected void	writeLogTable(String taskStatus, String log, byte[] xlsReport, byte[] xlsReport2, String htmlReport, String htmlReport2, PoolKit pk)

Methods inherited from class overit.geocall.bl.BusinessTask

start, start, startAlone, startInBackground

Methods inherited from class java.lang.Object

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

Field Details

configurationParamsHistory

protected BOConfParamsHistory configurationParamsHistory

elaborationHistory

protected BOElaborationHistory elaborationHistory

filesToDelete

protected List<String> filesToDelete

resourcesFolder

protected String resourcesFolder

factory

protected S3WebResourceFactory factory

algorithmName

protected String algorithmName

modelName

protected String modelName

instanceType

protected String instanceType

headers

protected AWSRequestHeaders headers

asyncQueueMode

protected boolean asyncQueueMode

Constructor Details

BTBasicAIProcess

public BTBasicAIProcess()

Method Details

isAsyncQueueMode

public boolean isAsyncQueueMode()

setAsyncQueueMode

public void setAsyncQueueMode(boolean asyncQueueMode)

prepareDataForApi

protected void prepareDataForApi()

This method must be called before calling AI Api.It composes the basic info for AI calls.

buildHeaders

protected void buildHeaders()

Method that builds all the headers for AI Api calls.

getError

public String getError()

getTrainingType

public Long getTrainingType()

setTrainingType

public void setTrainingType(Long trainingType)

getAiConfiguration

public BOConfigurationParams getAiConfiguration()

setAiConfiguration

public void setAiConfiguration(BOConfigurationParams aiConfiguration)

getResourcesFolder

public String getResourcesFolder()

setResourcesFolder

public void setResourcesFolder(String resourcesFolder)

body

protected void body(Void v,
 PoolKit pk)
             throws DAException,
DAValidateException

Description copied from class: BusinessTask

Implements this method to write the specific task logic to handle the input parameter.

Specified by:

body in class BusinessTask<Void>

Parameters:

v - the object upon which the task will works on

pk - the poolkit containing the reference to the database connection that can be used

Throws:

DAException - in case of database error

DAValidateException - in case of database validation error

checkConfiguration

protected void checkConfiguration()
                           throws DAValidateException,
DAException

Throws:

DAValidateException

DAException

getElaborationHistory

protected BOElaborationHistory getElaborationHistory(PoolKit pk)
                                              throws DAValidateException,
DAException

Throws:

DAValidateException

DAException

getConfigurationParamsHistory

protected BOConfParamsHistory getConfigurationParamsHistory(PoolKit pk)
                                                     throws DAValidateException,
DAException

Throws:

DAValidateException

DAException

elaborateTask

protected abstract void elaborateTask(PoolKit pk)
                               throws DAException,
DAValidateException

Throws:

DAException

DAValidateException

writeLogTable

protected void writeLogTable(String taskStatus,
 String log,
 byte[] xlsReport,
 byte[] xlsReport2,
 String htmlReport,
 String htmlReport2,
 PoolKit pk)
                      throws DAException,
DAValidateException

Throws:

DAException

DAValidateException

deleteTemporaryFiles

protected void deleteTemporaryFiles()

clearOldLogs

protected void clearOldLogs(PoolKit pk)
                     throws DAException,
DAValidateException

Delete the old history record for the elaboration of this configuration

Parameters:

pk - the Poolkit

Throws:

DAException

DAValidateException

getLogValidityDays

protected abstract int getLogValidityDays()

getAwsUploadPath

protected String getAwsUploadPath(String algorithm,
 String model)

Parameters:

algorithm -

model -

Returns:

uploadFileS3

protected String uploadFileS3(String inputFilePath,
 boolean toZip,
 String inputFileName)
                       throws IOException

Method that uploads a file to S3.

Parameters:

inputFilePath -

toZip -

inputFileName -

Returns:

Throws:

IOException

deleteFileS3

protected void deleteFileS3(String key)

getJobName

protected String getJobName()

setJobName

protected void setJobName()