org.kuali.ole.batch.export

Class BatchProcessExportData

java.lang.Object

org.kuali.ole.batch.impl.AbstractBatchProcess

org.kuali.ole.batch.export.BatchProcessExportData

All Implemented Interfaces:

OLEBatchProcess

public class BatchProcessExportData
extends AbstractBatchProcess

Created with IntelliJ IDEA. User: meenrajd Date: 7/5/13 Time: 5:34 PM

OLE Batch export process performs the export process for the given profile. Writes the exported data to marcxml or mrc file based on file type in the process definition

Field Summary

Fields inherited from class org.kuali.ole.batch.impl.AbstractBatchProcess

job, 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
BatchProcessExportData()

Method Summary

Methods

Modifier and Type	Method and Description
Object[]	batchExport(OLEBatchProcessProfileBo profileBo) The method receives the profile information and performs the solr query to retrieve the solr document list and calls the ExportService to get the export data and writes the formatted data to the file system
void	batchProcessExportFetch()
int	generateMarcFromXml() Writes the content read into a mrc file
List<String>	getBibDocList()
SearchResponse	getDeleteSolrQuery()
DocstoreClientLocator	getDocstoreClientLocator()
StringBuilder	getErrBuilder()
String	getErrCnt()
String	getFileName()
File	getFilePath()
SearchResponse	getIncrementalSolrQuery()
protected void	getNextBatch() gets the next batch of records for export
int	getProcessedRec()
SearchResponse	getResponse()
void	getSolrQuery() Gets the filter criteria which is used to create the solr query
int	getTotalRecordsExported()
protected void	loadProfile(OLEBatchProcessDefinitionDocument processDef) loads the profile and checks for incremental export
void	performSolrQuery() gets the solr query based on the filter criteria and executed to retrieve the results
protected void	prepareForRead() method to be implemented to read initial data for the various processes; will be called before prepareForWrite() method
protected void	prepareForWrite() methods creates the directories to write file to if they do not exist if the user provided folder is not valid (cannot be created) then the default location is chosen
void	prepareForWrite(String fileName)
protected void	processBatch() Performs the batch write operation Writes the data to marcxml or mrc format based on the output format specified in the process
void	setErrCnt(String errCnt)
void	setFileName(String fileName)
void	setResponse(SearchResponse response)
void	setTotalRecordsExported(int totalRecordsExported)
void	writeErrorFile() Writes the error records to the path
void	writeFileToLocation() Write the content read to mrcxml file
void	writeFileToLocation(String fileName)

Methods inherited from class org.kuali.ole.batch.impl.AbstractBatchProcess

checkJobPauseStatus, createBatchDeleteFailureReportFile, createBatchErrorAttachmentFile, createBatchFailureFile, createBatchFailureFile, createBatchSuccessFile, createFile, deleteBatchFile, deleteBatchFile, getBatchProcessFileContent, getBatchProcessFileContent, getBatchProcessFilePath, getBusinessObjectService, isJobRunning, process, updateJobProgress

Methods inherited from class java.lang.Object

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

Constructor Detail

BatchProcessExportData

public BatchProcessExportData()

Method Detail

getDocstoreClientLocator

public DocstoreClientLocator getDocstoreClientLocator()

batchExport

public Object[] batchExport(OLEBatchProcessProfileBo profileBo)
                     throws Exception

The method receives the profile information and performs the solr query to retrieve the solr document list and calls the ExportService to get the export data and writes the formatted data to the file system

Returns:

List docList

Throws:

Exception

getSolrQuery

public void getSolrQuery()
                  throws Exception

Gets the filter criteria which is used to create the solr query

Throws:

Exception

getDeleteSolrQuery

public SearchResponse getDeleteSolrQuery()
                                  throws Exception

Throws:

Exception

getIncrementalSolrQuery

public SearchResponse getIncrementalSolrQuery()
                                       throws Exception

Throws:

Exception

prepareForRead

protected void prepareForRead()
                       throws Exception

Description copied from class: AbstractBatchProcess

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

Specified by:

prepareForRead in class AbstractBatchProcess

Throws:

Exception

getNextBatch

protected void getNextBatch()
                     throws Exception

gets the next batch of records for export

Specified by:

getNextBatch in class AbstractBatchProcess

Throws:

Exception

prepareForWrite

protected void prepareForWrite()
                        throws Exception

methods creates the directories to write file to if they do not exist if the user provided folder is not valid (cannot be created) then the default location is chosen

Specified by:

prepareForWrite in class AbstractBatchProcess

Throws:

Exception

prepareForWrite

public void prepareForWrite(String fileName)
                     throws Exception

Throws:

Exception

processBatch

protected void processBatch()
                     throws Exception

Performs the batch write operation Writes the data to marcxml or mrc format based on the output format specified in the process

Specified by:

processBatch in class AbstractBatchProcess

Throws:

Exception

writeFileToLocation

public void writeFileToLocation()
                         throws Exception

Write the content read to mrcxml file

Throws:

Exception

writeFileToLocation

public void writeFileToLocation(String fileName)
                         throws Exception

Throws:

Exception

generateMarcFromXml

public int generateMarcFromXml()
                        throws Exception

Writes the content read into a mrc file

Throws:

Exception

loadProfile

protected void loadProfile(OLEBatchProcessDefinitionDocument processDef)
                    throws Exception

loads the profile and checks for incremental export

Overrides:

loadProfile in class AbstractBatchProcess

Parameters:

processDef -

Throws:

Exception

performSolrQuery

public void performSolrQuery()
                      throws Exception

gets the solr query based on the filter criteria and executed to retrieve the results

Throws:

Exception

writeErrorFile

public void writeErrorFile()
                    throws Exception

Writes the error records to the path

Throws:

Exception

batchProcessExportFetch

public void batchProcessExportFetch()
                             throws Exception

Throws:

Exception

getErrBuilder

public StringBuilder getErrBuilder()

getErrCnt

public String getErrCnt()

setErrCnt

public void setErrCnt(String errCnt)

getBibDocList

public List<String> getBibDocList()

getProcessedRec

public int getProcessedRec()

getFileName

public String getFileName()

setFileName

public void setFileName(String fileName)

getTotalRecordsExported

public int getTotalRecordsExported()

setTotalRecordsExported

public void setTotalRecordsExported(int totalRecordsExported)

getResponse

public SearchResponse getResponse()

setResponse

public void setResponse(SearchResponse response)

getFilePath

public File getFilePath()