org.kuali.ole.batch.impl

Class AbstractBatchProcess

java.lang.Object

org.kuali.ole.batch.impl.AbstractBatchProcess

All Implemented Interfaces:

OLEBatchProcess

Direct Known Subclasses:

BatchProcessBibImport, BatchProcessDeleteData, BatchProcessExportData, BatchProcessInvoiceIngest, BatchProcessLocationIngest, BatchProcessOrderIngest, BatchProcessPatronIngest, OLEBatchProcessClaimReport, OLEBatchProcessSerialRecordImport

public abstract class AbstractBatchProcess
extends Object
implements OLEBatchProcess

Created with IntelliJ IDEA. User: meenrajd Date: 7/8/13 Time: 3:55 PM To change this template use File | Settings | File Templates.

Field Summary

Fields

Modifier and Type	Field and Description
protected OLEBatchProcessJobDetailsBo	job
protected OLEBatchProcessDefinitionDocument	processDef

Fields inherited from interface org.kuali.ole.batch.impl.OLEBatchProcess

EXPORT_BIB_AND_INSTANCE, EXPORT_BIB_INSTANCE_AND_EINSTANCE, EXPORT_BIB_ONLY, EXPORT_EX_STAFF, EXPORT_FILTER, EXPORT_FULL, EXPORT_INC, EXT_ERR_TXT, EXT_MARC, EXT_MARCXML, FILTER_DT_FORMAT, INCREMENTAL_EXPORT_EX_STAFF, JOB_DT_FORMAT, MARC, MARCXML, PERCENT, SOLR_DT_FORMAT, XML_DEC

Constructor Summary

Constructors

Constructor and Description
AbstractBatchProcess()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	checkJobPauseStatus() checks if the job is in the Pause state
protected void	createBatchDeleteFailureReportFile(String failureReportData) Create the failure report record file in the batch process type directory for batch delete
protected void	createBatchErrorAttachmentFile(String failureRecordData)
protected void	createBatchFailureFile(String failureRecordData) Create the failure record file in the batch process type directory
protected void	createBatchFailureFile(String failureRecordData, String fileName) Create the failure record file in the batch process type directory
protected void	createBatchSuccessFile(String successRecordData) Create the success record file in the batch process type directory for batch delete
protected void	createFile(String[] content)
protected void	deleteBatchFile() Delete the upload file in the batch process type dirctory
protected void	deleteBatchFile(String fileName) Delete the upload file in the batch process type dirctory
protected String	getBatchProcessFileContent() Get the upload file content from the batch process type dirctory by using job id an upload file name
protected String	getBatchProcessFileContent(String fileName)
protected String	getBatchProcessFilePath(String batchProceesType) create and return the dirctory based on batch process type in the server file system
protected org.kuali.rice.krad.service.BusinessObjectService	getBusinessObjectService()
protected abstract void	getNextBatch() method to be implemented to retreive the next batch of data to be processed
protected boolean	isJobRunning() checks if the job is in the RUNNING state
protected void	loadProfile(OLEBatchProcessDefinitionDocument processDef) First method to be called in the batch process will load the profile for the process id in the process defn document
protected abstract void	prepareForRead() method to be implemented to read initial data for the various processes; will be called before prepareForWrite() method
protected abstract void	prepareForWrite() method to be implemented to prepare for writing the data; will be called before writeData()
void	process(OLEBatchProcessDefinitionDocument processDef, OLEBatchProcessJobDetailsBo jobBo) This method will be invoked for various processes implementing the OLEBatchProcess The method will perform following operation in sequence 1.
protected abstract void	processBatch() method to be implemented for various write operation
void	updateJobProgress() method to update the batch job progress will be called after every other method completes operation

Methods inherited from class java.lang.Object

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

Field Detail

job

protected OLEBatchProcessJobDetailsBo job

processDef

protected OLEBatchProcessDefinitionDocument processDef

Constructor Detail

AbstractBatchProcess

public AbstractBatchProcess()

Method Detail

process

public final void process(OLEBatchProcessDefinitionDocument processDef,
           OLEBatchProcessJobDetailsBo jobBo)
                   throws Exception

This method will be invoked for various processes implementing the OLEBatchProcess The method will perform following operation in sequence 1. loadProfile() - loads the profile of the process that has been invoked 2. prepareForRead() - performs the initial read or read support operation as implemented by the invoked process 3. prepareForWrite() - performs the initial write or write support operation as implemented by the invoked process 4. writeData() - performs the actual write operation intended and implemented by the process invoked 5. getNextBatch() - performs the read operation if there is more data to be read

The writeData() and getNextBatch() will be executed till the job status is RUNNING. The implemented process will have to set the job status to STOPPED / COMPLETED etc. as per its discretion

updateBatchProgress() - performs the job update after each of the above method complete operation.

Specified by:

process in interface OLEBatchProcess

Parameters:

processDef -

jobBo -

Throws:

Exception

getBusinessObjectService

protected org.kuali.rice.krad.service.BusinessObjectService getBusinessObjectService()

loadProfile

protected void loadProfile(OLEBatchProcessDefinitionDocument processDef)
                    throws Exception

First method to be called in the batch process will load the profile for the process id in the process defn document

Parameters:

processDef -

Throws:

Exception

updateJobProgress

public void updateJobProgress()
                       throws Exception

method to update the batch job progress will be called after every other method completes operation

Throws:

Exception

prepareForRead

protected abstract void prepareForRead()
                                throws Exception

method to be implemented to read initial data for the various processes; will be called before prepareForWrite() method

Throws:

Exception

prepareForWrite

protected abstract void prepareForWrite()
                                 throws Exception

method to be implemented to prepare for writing the data; will be called before writeData()

Throws:

Exception

getNextBatch

protected abstract void getNextBatch()
                              throws Exception

method to be implemented to retreive the next batch of data to be processed

Throws:

Exception

processBatch

protected abstract void processBatch()
                              throws Exception

method to be implemented for various write operation

Throws:

Exception

isJobRunning

protected boolean isJobRunning()

checks if the job is in the RUNNING state

Returns:

checkJobPauseStatus

protected void checkJobPauseStatus()
                            throws Exception

checks if the job is in the Pause state

Throws:

Exception

getBatchProcessFilePath

protected String getBatchProcessFilePath(String batchProceesType)

create and return the dirctory based on batch process type in the server file system

createBatchSuccessFile

protected void createBatchSuccessFile(String successRecordData)
                               throws Exception

Create the success record file in the batch process type directory for batch delete

Parameters:

successRecordData -

Throws:

Exception

createBatchDeleteFailureReportFile

protected void createBatchDeleteFailureReportFile(String failureReportData)
                                           throws Exception

Create the failure report record file in the batch process type directory for batch delete

Parameters:

failureReportData -

Throws:

Exception

createBatchFailureFile

protected void createBatchFailureFile(String failureRecordData)
                               throws Exception

Create the failure record file in the batch process type directory

Parameters:

failureRecordData -

Throws:

Exception

createBatchErrorAttachmentFile

protected void createBatchErrorAttachmentFile(String failureRecordData)
                                       throws Exception

Throws:

Exception

createFile

protected void createFile(String[] content)
                   throws Exception

Throws:

Exception

deleteBatchFile

protected void deleteBatchFile()
                        throws Exception

Delete the upload file in the batch process type dirctory

Throws:

Exception

getBatchProcessFileContent

protected String getBatchProcessFileContent()
                                     throws Exception

Get the upload file content from the batch process type dirctory by using job id an upload file name

Throws:

Exception

getBatchProcessFileContent

protected String getBatchProcessFileContent(String fileName)
                                     throws Exception

Throws:

Exception

deleteBatchFile

protected void deleteBatchFile(String fileName)
                        throws Exception

Delete the upload file in the batch process type dirctory

Throws:

Exception

createBatchFailureFile

protected void createBatchFailureFile(String failureRecordData,
                          String fileName)
                               throws Exception

Create the failure record file in the batch process type directory

Parameters:

failureRecordData -

Throws:

Exception