com.nt.udc.ndk.node

Interface DCStreamHandler

All Superinterfaces:

DataProviderIfc, DataReceiverIfc, FileDataProviderIfc, FileDataReceiverIfc

All Known Implementing Classes:

MXNARFileManager, MXNarOutReceiverWrapper, NARFileManager, NARFileManagerMT, NARStreamHandler

public interface DCStreamHandler
extends DataReceiverIfc, DataProviderIfc, FileDataProviderIfc, FileDataReceiverIfc

Method Summary

Modifier and Type	Method and Description
boolean	cleanup() Performs any necessary cleanup desired, such as deleting files that have been processed.
void	createNewCacheFile()
DCNodePerformance	getPerformanceMetrics() Returns a DCNodePerformance object containing node performance data.
void	moveToReadyToOut(boolean initNew) Make cache file as ready to moveToOutput()
DCFieldContainer[]	readBulkData() Reads a set of DCFieldContainer objects from this DataProvider.
DCFieldContainer	readData() Reads a DCFieldContainer object from this DataProvider
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
boolean	writeData(DCFieldContainer datum) Stores information into a DCFieldContainer object
boolean	writeData(DCFieldContainer[] data) Stores information into multiple DCFieldContainer objects

Methods inherited from interface com.nt.udc.ndk.node.DataReceiverIfc

dataIsAvailable, getDataProvider, processData, processData, setDataProvider

Methods inherited from interface com.nt.udc.ndk.node.DataProviderIfc

getBulkData, getCurrArchFile, getData, getData, getDataReceiver, getProcessedArchFile, isDataAvailable, removeProcessedFile, setDataReceiver, setProcessedArchFile, signalBatchCompletion, validOIMinorType

Methods inherited from interface com.nt.udc.ndk.node.FileDataProviderIfc

getFileBulkData, getFileData, getFileDataReceiver, handleRejectOfFile, isEndOfFile, isFileDataAvailable, isStartOfFile, openInputFile, rejectFile, setFileDataReceiver

Methods inherited from interface com.nt.udc.ndk.node.FileDataReceiverIfc

fileDataIsAvailable, getFileDataProvider, processEndOfFileData, processFileData, processFileData, processRejectFile, processStartOfFileData, setFileDataProvider, setTransactionID

Method Detail

readData

DCFieldContainer readData()

Reads a DCFieldContainer object from this DataProvider

readBulkData

DCFieldContainer[] readBulkData()

Reads a set of DCFieldContainer objects from this DataProvider.

Returns:

DCFieldContainer objects, if available; null otherwise

writeData

boolean writeData(DCFieldContainer datum)

Stores information into a DCFieldContainer object

Parameters:

datum - Object to put the information into

Returns:

true, if the data was successfully written to the object

writeData

boolean writeData(DCFieldContainer[] data)

Stores information into multiple DCFieldContainer objects

Returns:

true, if the data was successfully written to the object

getPerformanceMetrics

DCNodePerformance getPerformanceMetrics()

Returns a DCNodePerformance object containing node performance data.

Returns:

DCNodePerformance object,

cleanup

boolean cleanup()

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

shutdown

void shutdown()

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

shutdownInput

void shutdownInput()

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

shutdownOutput

void shutdownOutput()

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

moveToReadyToOut

void moveToReadyToOut(boolean initNew)

Make cache file as ready to moveToOutput()

createNewCacheFile

void createNewCacheFile()