Package com.nt.udc.nar

Class NARStreamHandler

java.lang.Object

com.nt.udc.nar.NARStreamHandler

All Implemented Interfaces:

DataProviderIfc, DataReceiverIfc, DCStreamHandler, FileDataProviderIfc, FileDataReceiverIfc

Direct Known Subclasses:

MXNARFileManager, NARFileManager

public abstract class NARStreamHandler
extends Object
implements DCStreamHandler

Provides file (or more generically stream) management for the node, such as reading and writing NARs to and from the .cache files

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	inputShutdown	Indicates whether the input stream of the StreamHandler is available
protected Long	narsIn	Total number of NARs read
protected Long	narsOut	Total number of NARs written
protected DCNodePerformance	np	Node Performance object
protected boolean	outputShutdown	Indicates whether the output stream of the StreamHandler is available

Constructor Summary

Constructors

Constructor	Description
NARStreamHandler()

Method Summary

Modifier and Type	Method	Description
abstract boolean	cleanup()	Deletes NARs files that have been processed
DCNodePerformance	getPerformanceMetrics()	Returns a node performance object
abstract long	getRealNarsIn()	This must return a count of how many records this node has read in, since it started.
DCFieldContainer	readData()	Calls readNAR()
abstract NAR	readNAR()	Retrieves a single NAR file
abstract NAR[]	readNARs()	Retrieves multiple NARs
void	shutdown()	Performs tasks necessary to cleanly shutdown the stream handler
void	shutdownInput()	Performs tasks necessary to cleanly shutdown the input stream of the stream handler
void	shutdownOutput()	Performs tasks necessary to cleanly shutdown the output stream of the stream handler
abstract boolean	storeNAR(NAR record)	Writes a single NAR to the cache file
abstract boolean	storeNARs(NAR[] records)	Writes a multiple NARs to the cache file
boolean	writeData(DCFieldContainer field)	Calls storeNAR()
boolean	writeData(DCFieldContainer[] fields)	Calls storeNAR()

Methods inherited from class java.lang.Object

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

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.DataReceiverIfc

dataIsAvailable, getDataProvider, processData, processData, setDataProvider

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

createNewCacheFile, moveToReadyToOut, readBulkData

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

Field Details

inputShutdown

protected boolean inputShutdown

Indicates whether the input stream of the StreamHandler is available

outputShutdown

protected boolean outputShutdown

Indicates whether the output stream of the StreamHandler is available

narsIn

protected Long narsIn

Total number of NARs read

narsOut

protected Long narsOut

Total number of NARs written

np

protected DCNodePerformance np

Node Performance object

Constructor Details

NARStreamHandler

public NARStreamHandler()

Method Details

readData

public DCFieldContainer readData()

Calls readNAR()

Specified by:

readData in interface DCStreamHandler

readNAR

public abstract NAR readNAR()

Retrieves a single NAR file

readNARs

public abstract NAR[] readNARs()

Retrieves multiple NARs

writeData

public boolean writeData(DCFieldContainer field)

Calls storeNAR()

Specified by:

writeData in interface DCStreamHandler

Parameters:

field - Object to put the information into

Returns:

true, if the data was successfully written to the object

writeData

public boolean writeData(DCFieldContainer[] fields)

Calls storeNAR()

Specified by:

writeData in interface DCStreamHandler

Returns:

true, if the data was successfully written to the object

getPerformanceMetrics

public DCNodePerformance getPerformanceMetrics()

Returns a node performance object

Specified by:

getPerformanceMetrics in interface DCStreamHandler

Returns:

DCNodePerformance object,

storeNAR

public abstract boolean storeNAR(NAR record)

Writes a single NAR to the cache file

storeNARs

public abstract boolean storeNARs(NAR[] records)

Writes a multiple NARs to the cache file

cleanup

public abstract boolean cleanup()

Deletes NARs files that have been processed

Specified by:

cleanup in interface DCStreamHandler

shutdown

public void shutdown()

Performs tasks necessary to cleanly shutdown the stream handler

Specified by:

shutdown in interface DCStreamHandler

shutdownInput

public void shutdownInput()

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

Specified by:

shutdownInput in interface DCStreamHandler

shutdownOutput

public void shutdownOutput()

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

Specified by:

shutdownOutput in interface DCStreamHandler

getRealNarsIn

public abstract long getRealNarsIn()

This must return a count of how many records this node has read in, since it started. The counts should be accurate, even if this node is an EI/CC. (as opposed to the narsIN counter, which won't count any input records if the node is an EI.)

Returns: