Package com.metasolv.nm.processor.MXAggregator

Class MXNarOutReceiverWrapper

java.lang.Object

com.metasolv.nm.processor.MXAggregator.MXNarOutReceiverWrapper

All Implemented Interfaces:

DataProviderIfc, DataReceiverIfc, DCStreamHandler, FileDataProviderIfc, FileDataReceiverIfc

public class MXNarOutReceiverWrapper
extends Object
implements DCStreamHandler

Make a DCStreamHandler-derived class for use by FlexibleTableFlush, which only uses the writeData() methods.

Constructor Summary

Constructors

Constructor	Description
MXNarOutReceiverWrapper(DataReceiverIfc narOut)

Method Summary

Modifier and Type	Method	Description
boolean	cleanup()	Performs any necessary cleanup desired, such as deleting files that have been processed.
void	createNewCacheFile()
void	dataIsAvailable()	Allows a DataProvider to indicate that some data is available for processing
void	fileDataIsAvailable()	Allows a FileDataProvider to indicate that some data is available for processing
DCFieldContainer[]	getBulkData()	Allows a DataReceiver to obtain the available data in a known format.
File	getCurrArchFile()	Allows a DataReceiver to obtain the currently processing .arch file
DCFieldContainer	getData()	Allows a DataReceiver to obtain the available data in a known format.
DCFieldContainer	getData(String batch)	Allows a DataReceiver to obtain the available data in a known format.
DataProviderIfc	getDataProvider()	Gets the object that is holding data for this DataReceiver
DataReceiverIfc	getDataReceiver()	Gets the object that is retrieving data from this DataProvider
DCFieldContainer[]	getFileBulkData()	Allows a FileDataReceiver to obtain the available data in a known format.
DCFieldContainer	getFileData()	Allows a FileDataReceiver to obtain the available data in a known format.
FileDataProviderIfc	getFileDataProvider()	Gets the object that is holding data for this FileDataReceiver
FileDataReceiverIfc	getFileDataReceiver()	Gets the object that is retrieving data from this FileDataProvider
DCNodePerformance	getPerformanceMetrics()	Returns a DCNodePerformance object containing node performance data.
String	getProcessedArchFile()	Allows a DataReceiver to obtain the last processed .arch file
void	handleRejectOfFile()	To handle the remaining input files when there is reject of a file
boolean	isDataAvailable()	Allows a DataReceiver to determine whether some data is available for processing
boolean	isEndOfFile()	Determines if record received is an End of file indication
boolean	isFileDataAvailable()	Allows a FileDataReceiver to determine whether some file is available for processing
boolean	isStartOfFile()	Determines if the record received is start of file indication
void	moveToReadyToOut(boolean initNew)	Make cache file as ready to moveToOutput()
String	openInputFile()
void	processData(DCFieldContainer data)	Manipulates the data provided by its DataProvider
void	processData(DCFieldContainer[] data)	Manipulates the set of data provided by its DataProvider
boolean	processEndOfFileData(String transactionID)	Allows FileDataProvider to indicate end of file record
boolean	processFileData(DCFieldContainer data)	Manipulates the data provided by its DataProvider
boolean	processFileData(DCFieldContainer[] data)	Manipulates the set of data provided by its DataProvider
boolean	processRejectFile()	Allows FileDataProvider to indicate rejection of the file
boolean	processStartOfFileData(String originalFileName)	Allows FileDataProvider to indicate start of file
DCFieldContainer[]	readBulkData()	Reads a set of DCFieldContainer objects from this DataProvider.
DCFieldContainer	readData()	Reads a DCFieldContainer object from this DataProvider
boolean	rejectFile()	Indicates data provider to stop reading from the input file and reject it
void	removeProcessedFile(File currArchFile)	Allows a DataReceiver to remove .arch file once processed currArchFile - processed .arch file
void	setDataProvider(DataProviderIfc provider)	Sets the object from which this DataReceiver will obtain its data.
void	setDataReceiver(DataReceiverIfc receiver)	Sets the object to which this DataProvider will send its data.
void	setFileDataProvider(FileDataProviderIfc provider)	Sets the object from which this FileDataReceiver will obtain its data.
void	setFileDataReceiver(FileDataReceiverIfc receiver)	Sets the object to which this FileDataProvider will send its data.
void	setProcessedArchFile(String file)	Sets the processed .arch file absolute path
void	setTransactionID(String tID)
void	shutdown()	Performs any tasks necessary to cleanly shutdown the input and output streams of the stream handler, as appropriate
void	shutdownInput()	Performs any tasks necessary to cleanly shutdown the input stream of the stream handler
void	shutdownOutput()	Performs any tasks necessary to cleanly shutdown the output stream of the stream handler
void	signalBatchCompletion(String batch)	Allows a DataReceiver to know that the nars under the specified batch are completed and handed over to the Data receiver
boolean	validOIMinorType()	Allows a DataReceiver to check if Minor Type supported for disaster recovery
boolean	writeData(DCFieldContainer datum)	Stores information into a DCFieldContainer object
boolean	writeData(DCFieldContainer[] data)	Stores information into multiple DCFieldContainer objects

Methods inherited from class java.lang.Object

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

Constructor Details

MXNarOutReceiverWrapper

public MXNarOutReceiverWrapper(DataReceiverIfc narOut)

Method Details

writeData

public boolean writeData(DCFieldContainer datum)

Description copied from interface: DCStreamHandler

Stores information into a DCFieldContainer object

Specified by:

writeData in interface DCStreamHandler

Parameters:

datum - Object to put the information into

Returns:

true, if the data was successfully written to the object

writeData

public boolean writeData(DCFieldContainer[] data)

Description copied from interface: DCStreamHandler

Stores information into multiple DCFieldContainer objects

Specified by:

writeData in interface DCStreamHandler

Returns:

true, if the data was successfully written to the object

readData

public DCFieldContainer readData()

Description copied from interface: DCStreamHandler

Reads a DCFieldContainer object from this DataProvider

Specified by:

readData in interface DCStreamHandler

readBulkData

public DCFieldContainer[] readBulkData()

Description copied from interface: DCStreamHandler

Reads a set of DCFieldContainer objects from this DataProvider.

Specified by:

readBulkData in interface DCStreamHandler

Returns:

DCFieldContainer objects, if available; null otherwise

getPerformanceMetrics

public DCNodePerformance getPerformanceMetrics()

Description copied from interface: DCStreamHandler

Returns a DCNodePerformance object containing node performance data.

Specified by:

getPerformanceMetrics in interface DCStreamHandler

Returns:

DCNodePerformance object,

cleanup

public boolean cleanup()

Description copied from interface: DCStreamHandler

Performs any necessary cleanup desired, such as deleting files that have been processed.

Specified by:

cleanup in interface DCStreamHandler

shutdown

public void shutdown()

Description copied from interface: DCStreamHandler

Performs any tasks necessary to cleanly shutdown the input and output streams of the stream handler, as appropriate

Specified by:

shutdown in interface DCStreamHandler

shutdownInput

public void shutdownInput()

Description copied from interface: DCStreamHandler

Performs any tasks necessary to cleanly shutdown the input stream of the stream handler

Specified by:

shutdownInput in interface DCStreamHandler

shutdownOutput

public void shutdownOutput()

Description copied from interface: DCStreamHandler

Performs any tasks necessary to cleanly shutdown the output stream of the stream handler

Specified by:

shutdownOutput in interface DCStreamHandler

dataIsAvailable

public void dataIsAvailable()

Description copied from interface: DataReceiverIfc

Allows a DataProvider to indicate that some data is available for processing

Specified by:

dataIsAvailable in interface DataReceiverIfc

processData

public void processData(DCFieldContainer data)
                 throws NodeProcessingException

Description copied from interface: DataReceiverIfc

Manipulates the data provided by its DataProvider

Specified by:

processData in interface DataReceiverIfc

Throws:

NodeProcessingException

processData

public void processData(DCFieldContainer[] data)
                 throws NodeProcessingException

Description copied from interface: DataReceiverIfc

Manipulates the set of data provided by its DataProvider

Specified by:

processData in interface DataReceiverIfc

Throws:

NodeProcessingException

setDataProvider

public void setDataProvider(DataProviderIfc provider)

Description copied from interface: DataReceiverIfc

Sets the object from which this DataReceiver will obtain its data.

Specified by:

setDataProvider in interface DataReceiverIfc

Parameters:

provider - Object which has data that needs to be retrieved by this DataReceiver

getDataProvider

public DataProviderIfc getDataProvider()

Description copied from interface: DataReceiverIfc

Gets the object that is holding data for this DataReceiver

Specified by:

getDataProvider in interface DataReceiverIfc

Returns:

Object from which this DataReceiver is retrieving data

isDataAvailable

public boolean isDataAvailable()

Description copied from interface: DataProviderIfc

Allows a DataReceiver to determine whether some data is available for processing

Specified by:

isDataAvailable in interface DataProviderIfc

Returns:

true, if data is available

getData

public DCFieldContainer getData()

Description copied from interface: DataProviderIfc

Allows a DataReceiver to obtain the available data in a known format.

Specified by:

getData in interface DataProviderIfc

Returns:

DCFieldContainer object containing the data that is available for processing

getBulkData

public DCFieldContainer[] getBulkData()

Description copied from interface: DataProviderIfc

Allows a DataReceiver to obtain the available data in a known format.

Specified by:

getBulkData in interface DataProviderIfc

Returns:

DCFieldContainer object array, containing the data that is for processing

setDataReceiver

public void setDataReceiver(DataReceiverIfc receiver)

Description copied from interface: DataProviderIfc

Sets the object to which this DataProvider will send its data.

Specified by:

setDataReceiver in interface DataProviderIfc

Parameters:

receiver - Object which will obtain data from this DataProvider

getDataReceiver

public DataReceiverIfc getDataReceiver()

Description copied from interface: DataProviderIfc

Gets the object that is retrieving data from this DataProvider

Specified by:

getDataReceiver in interface DataProviderIfc

Returns:

Object to which this DataProvider is sending data

moveToReadyToOut

public void moveToReadyToOut(boolean initNew)

Description copied from interface: DCStreamHandler

Make cache file as ready to moveToOutput()

Specified by:

moveToReadyToOut in interface DCStreamHandler

createNewCacheFile

public void createNewCacheFile()

Specified by:

createNewCacheFile in interface DCStreamHandler

isFileDataAvailable

public boolean isFileDataAvailable()

Description copied from interface: FileDataProviderIfc

Allows a FileDataReceiver to determine whether some file is available for processing

Specified by:

isFileDataAvailable in interface FileDataProviderIfc

Returns:

true, if data is available

isEndOfFile

public boolean isEndOfFile()

Description copied from interface: FileDataProviderIfc

Determines if record received is an End of file indication

Specified by:

isEndOfFile in interface FileDataProviderIfc

Returns:

true, if data is available

isStartOfFile

public boolean isStartOfFile()

Description copied from interface: FileDataProviderIfc

Determines if the record received is start of file indication

Specified by:

isStartOfFile in interface FileDataProviderIfc

Returns:

getFileData

public DCFieldContainer getFileData()

Description copied from interface: FileDataProviderIfc

Allows a FileDataReceiver to obtain the available data in a known format.

Specified by:

getFileData in interface FileDataProviderIfc

Returns:

DCFieldContainer object containing the data that is available for processing

getFileBulkData

public DCFieldContainer[] getFileBulkData()

Description copied from interface: FileDataProviderIfc

Allows a FileDataReceiver to obtain the available data in a known format.

Specified by:

getFileBulkData in interface FileDataProviderIfc

Returns:

DCFieldContainer object array, containing the data that is for processing

setFileDataReceiver

public void setFileDataReceiver(FileDataReceiverIfc receiver)

Description copied from interface: FileDataProviderIfc

Sets the object to which this FileDataProvider will send its data.

Specified by:

setFileDataReceiver in interface FileDataProviderIfc

Parameters:

receiver - Object which will obtain data from this FileDataProvider

getFileDataReceiver

public FileDataReceiverIfc getFileDataReceiver()

Description copied from interface: FileDataProviderIfc

Gets the object that is retrieving data from this FileDataProvider

Specified by:

getFileDataReceiver in interface FileDataProviderIfc

Returns:

Object to which this FileDataProvider is sending data

fileDataIsAvailable

public void fileDataIsAvailable()

Description copied from interface: FileDataReceiverIfc

Allows a FileDataProvider to indicate that some data is available for processing

Specified by:

fileDataIsAvailable in interface FileDataReceiverIfc

processStartOfFileData

public boolean processStartOfFileData(String originalFileName)
                               throws NodeProcessingException

Description copied from interface: FileDataReceiverIfc

Allows FileDataProvider to indicate start of file

Specified by:

processStartOfFileData in interface FileDataReceiverIfc

Returns:

true, if data is available

Throws:

NodeProcessingException

processFileData

public boolean processFileData(DCFieldContainer data)
                        throws NodeProcessingException

Description copied from interface: FileDataReceiverIfc

Manipulates the data provided by its DataProvider

Specified by:

processFileData in interface FileDataReceiverIfc

Returns:

true, if data is processed successfully

Throws:

NodeProcessingException

processFileData

public boolean processFileData(DCFieldContainer[] data)
                        throws NodeProcessingException

Description copied from interface: FileDataReceiverIfc

Manipulates the set of data provided by its DataProvider

Specified by:

processFileData in interface FileDataReceiverIfc

Returns:

true, if data is processed successfully

Throws:

NodeProcessingException

processEndOfFileData

public boolean processEndOfFileData(String transactionID)
                             throws NodeProcessingException

Description copied from interface: FileDataReceiverIfc

Allows FileDataProvider to indicate end of file record

Specified by:

processEndOfFileData in interface FileDataReceiverIfc

Returns:

true , if processed successfully

Throws:

NodeProcessingException

processRejectFile

public boolean processRejectFile()
                          throws NodeProcessingException

Description copied from interface: FileDataReceiverIfc

Allows FileDataProvider to indicate rejection of the file

Specified by:

processRejectFile in interface FileDataReceiverIfc

Returns:

true , if processed successfully

Throws:

NodeProcessingException

setFileDataProvider

public void setFileDataProvider(FileDataProviderIfc provider)

Description copied from interface: FileDataReceiverIfc

Sets the object from which this FileDataReceiver will obtain its data.

Specified by:

setFileDataProvider in interface FileDataReceiverIfc

Parameters:

provider - Object which has data that needs to be retrieved by this DataReceiver

getFileDataProvider

public FileDataProviderIfc getFileDataProvider()

Description copied from interface: FileDataReceiverIfc

Gets the object that is holding data for this FileDataReceiver

Specified by:

getFileDataProvider in interface FileDataReceiverIfc

Returns:

Object from which this DataReceiver is retrieving data

openInputFile

public String openInputFile()
                     throws Exception

Specified by:

openInputFile in interface FileDataProviderIfc

Returns:

Throws:

Exception

rejectFile

public boolean rejectFile()
                   throws Exception

Description copied from interface: FileDataProviderIfc

Indicates data provider to stop reading from the input file and reject it

Specified by:

rejectFile in interface FileDataProviderIfc

Returns:

true for successful rejection of input file

Throws:

Exception

handleRejectOfFile

public void handleRejectOfFile()

Description copied from interface: FileDataProviderIfc

To handle the remaining input files when there is reject of a file

Specified by:

handleRejectOfFile in interface FileDataProviderIfc

setTransactionID

public void setTransactionID(String tID)

Specified by:

setTransactionID in interface FileDataReceiverIfc

getData

public DCFieldContainer getData(String batch)

Description copied from interface: DataProviderIfc

Allows a DataReceiver to obtain the available data in a known format. batch - The nars read will be grouped under the specified batch

Specified by:

getData in interface DataProviderIfc

Returns:

DCFieldContainer object containing the data that is available for processing

signalBatchCompletion

public void signalBatchCompletion(String batch)

Description copied from interface: DataProviderIfc

Allows a DataReceiver to know that the nars under the specified batch are completed and handed over to the Data receiver

Specified by:

signalBatchCompletion in interface DataProviderIfc

removeProcessedFile

public void removeProcessedFile(File currArchFile)

Description copied from interface: DataProviderIfc

Allows a DataReceiver to remove .arch file once processed currArchFile - processed .arch file

Specified by:

removeProcessedFile in interface DataProviderIfc

getCurrArchFile

public File getCurrArchFile()

Description copied from interface: DataProviderIfc

Allows a DataReceiver to obtain the currently processing .arch file

Specified by:

getCurrArchFile in interface DataProviderIfc

Returns:

currently processing .arch file

getProcessedArchFile

public String getProcessedArchFile()

Description copied from interface: DataProviderIfc

Allows a DataReceiver to obtain the last processed .arch file

Specified by:

getProcessedArchFile in interface DataProviderIfc

Returns:

currently processing .arch file absolute path

setProcessedArchFile

public void setProcessedArchFile(String file)

Description copied from interface: DataProviderIfc

Sets the processed .arch file absolute path

Specified by:

setProcessedArchFile in interface DataProviderIfc

Parameters:

file - absolute path of processed .arch file

validOIMinorType

public boolean validOIMinorType()

Description copied from interface: DataProviderIfc

Allows a DataReceiver to check if Minor Type supported for disaster recovery

Specified by:

validOIMinorType in interface DataProviderIfc

Returns:

true if valid