com.nt.udc.nar

Class NARFileManager

java.lang.Object

com.nt.udc.nar.NARStreamHandler

com.nt.udc.nar.NARFileManager

All Implemented Interfaces:

DataProviderIfc, DataReceiverIfc, DCStreamHandler, FileDataProviderIfc, FileDataReceiverIfc

Direct Known Subclasses:

NARFileManagerMT

public class NARFileManager
extends NARStreamHandler
implements DataReceiverIfc, DataProviderIfc

Manages a node's NAR input files and NAR output files. This class is also responsible for routing to specific NAR output files, if desired.

Field Summary

Fields

Modifier and Type	Field and Description
protected DataProviderIfc	dataProvider Reference to the object providing data to this NAR router.
protected DataReceiverIfc	dataReceiver Reference to the object receiving data from this NAR router.
protected FileDataProviderIfc	fileDataProvider Reference to the object providing file data to this NAR router.
protected FileDataReceiverIfc	fileDataReceiver Reference to the object receiving file data from this NAR router.

Fields inherited from class com.nt.udc.nar.NARStreamHandler

inputShutdown, narsIn, narsOut, np, outputShutdown

Constructor Summary

Constructors

Constructor and Description
NARFileManager(DCNode dcNode) Constructs a NARFileManager with the given node.
NARFileManager(DCNode dcNode, boolean createWriter)
NARFileManager(DCNode dcNode, boolean createWriter, boolean isMultiThreaded, int threadCount, int currThread, boolean isOrdered)
NARFileManager(DCNode dcNode, boolean isMultiThreaded, int threadCount, int currThread)
NARFileManager(DCNode dcNode, boolean isMultiThreaded, int threadCount, int currThread, boolean isOrdered)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	checkInput() This method invokes a NarReader method which will check for an empty input directory.
boolean	cleanup() Deletes NARs files that have been processed
void	createNewCacheFile()
void	dataIsAvailable() When this method is called by the DataProvider, a return call is made to the provider's getData() method.
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.
DCFieldContainer	getData() Allows a DataReceiver to obtain the available data in a known format.
DataProviderIfc	getDataProvider() Returns the object from which this DataReceiver is receiving data.
DataReceiverIfc	getDataReceiver() Returns the object to which this DataProvider is sending data.
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
FilenameGenerator	getFilenameGenerator() Returns the current filename generator
java.lang.String	getNodeID() This method returns the node ID.
long	getRealNarsIn() This must return a count of how many records this node has read in, since it started.
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()
java.lang.String	openInputFile()
void	processData(DCFieldContainer data) Manipulates the data provided by its DataProvider.
void	processData(DCFieldContainer[] data) Manipulates the data provided by its DataProvider.
boolean	processEndOfFileData(java.lang.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(java.lang.String fileName) Allows FileDataProvider to indicate start of file
DCFieldContainer[]	readBulkData() Returns a set of DCFieldContainer objects from the data stream.
DCFieldContainer	readData() Return a DCFieldContainer object from the data stream.
NAR	readNAR() Return a NAR from the data stream.
NAR[]	readNARs() Return an array of NARs from the data stream.
NAR[]	readNARsFromFile() Return an array of NARs from the data stream.
boolean	rejectFile() Indicates data provider to stop reading from the input file and reject it
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	setFilenameGenerator(FilenameGenerator filenameGen) Sets a new FilenameGenerator
void	setTransactionID(java.lang.String tID)
void	shutdown() This method invokes the shutdown method of each NarWriter object.
void	shutdownInput() For this implementation of the StreamHandler, simply set the flag that will prevent the input methods from allowing any more data into the node.
void	shutdownOutput() For this implementation of the StreamHandler, there is no reason to stop the output stream without first stopping the input stream.
boolean	storeNAR(NAR record) Writes a single NAR to the appropriate cache file.
boolean	storeNARs(NAR[] records) Writes multiple NARs to the appropriate cache file

Methods inherited from class com.nt.udc.nar.NARStreamHandler

getPerformanceMetrics, writeData, writeData

Methods inherited from class java.lang.Object

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

Field Detail

dataProvider

protected DataProviderIfc dataProvider

Reference to the object providing data to this NAR router.

dataReceiver

protected DataReceiverIfc dataReceiver

Reference to the object receiving data from this NAR router.

fileDataProvider

protected FileDataProviderIfc fileDataProvider

Reference to the object providing file data to this NAR router.

fileDataReceiver

protected FileDataReceiverIfc fileDataReceiver

Reference to the object receiving file data from this NAR router.

Constructor Detail

NARFileManager

public NARFileManager(DCNode dcNode)

Constructs a NARFileManager with the given node. This NARFileManager will monitor the node's input/output directories (where appropriate), provide NAR input objects, and provide the mechanisms to send a processed NAR to the next node in the chain, possibly through routing.

Parameters:

dcNode - Node to manage

NARFileManager

public NARFileManager(DCNode dcNode,
              boolean isMultiThreaded,
              int threadCount,
              int currThread)

NARFileManager

public NARFileManager(DCNode dcNode,
              boolean isMultiThreaded,
              int threadCount,
              int currThread,
              boolean isOrdered)

NARFileManager

public NARFileManager(DCNode dcNode,
              boolean createWriter)

NARFileManager

public NARFileManager(DCNode dcNode,
              boolean createWriter,
              boolean isMultiThreaded,
              int threadCount,
              int currThread,
              boolean isOrdered)

Method Detail

shutdown

public void shutdown()

This method invokes the shutdown method of each NarWriter object.

Specified by:

shutdown in interface DCStreamHandler

Overrides:

shutdown in class NARStreamHandler

storeNARs

public boolean storeNARs(NAR[] records)

Writes multiple NARs to the appropriate cache file

Specified by:

storeNARs in class NARStreamHandler

Returns:

true, if the write was successful.

storeNAR

public boolean storeNAR(NAR record)

Writes a single NAR to the appropriate cache file.

Specified by:

storeNAR in class NARStreamHandler

Returns:

true, if the write was successful.

readNAR

public NAR readNAR()

Return a NAR from the data stream.

Specified by:

readNAR in class NARStreamHandler

Returns:

Returns a single NAR.

readNARs

public NAR[] readNARs()

Return an array of NARs from the data stream.

Specified by:

readNARs in class NARStreamHandler

Returns:

Returns an array of NARs.

readNARsFromFile

public NAR[] readNARsFromFile()
                       throws java.lang.Exception

Return an array of NARs from the data stream.

Returns:

Returns an array of NARs.

Throws:

java.lang.Exception

checkInput

public boolean checkInput()

This method invokes a NarReader method which will check for an empty input directory.

Returns:

true, if input directory contains files

getNodeID

public java.lang.String getNodeID()

This method returns the node ID.

Returns:

node ID

getFilenameGenerator

public final FilenameGenerator getFilenameGenerator()

Returns the current filename generator

Returns:

current FilenameGenerator

setFilenameGenerator

public final void setFilenameGenerator(FilenameGenerator filenameGen)

Sets a new FilenameGenerator

readData

public DCFieldContainer readData()

Return a DCFieldContainer object from the data stream.

Specified by:

readData in interface DCStreamHandler

Overrides:

readData in class NARStreamHandler

Returns:

Returns a single DCFieldContainer.

readBulkData

public DCFieldContainer[] readBulkData()

Returns a set of DCFieldContainer objects from the data stream.

Specified by:

readBulkData in interface DCStreamHandler

Returns:

Returns an array of DCFieldContainer objects.

shutdownInput

public void shutdownInput()

For this implementation of the StreamHandler, simply set the flag that will prevent the input methods from allowing any more data into the node. The NARFileManager will still be capable of processing any data that has already been queued and writing data to the 'output stream', as necessary.

Specified by:

shutdownInput in interface DCStreamHandler

Overrides:

shutdownInput in class NARStreamHandler

cleanup

public boolean cleanup()

Description copied from class: NARStreamHandler

Deletes NARs files that have been processed

Specified by:

cleanup in interface DCStreamHandler

Specified by:

cleanup in class NARStreamHandler

shutdownOutput

public void shutdownOutput()

For this implementation of the StreamHandler, there is no reason to stop the output stream without first stopping the input stream. Stop both the input and output capabilities of the NARFileManager.

Specified by:

shutdownOutput in interface DCStreamHandler

Overrides:

shutdownOutput in class NARStreamHandler

isDataAvailable

public boolean isDataAvailable()

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()

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()

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

Specified by:

getBulkData in interface DataProviderIfc

Returns:

DCFieldContainer[] object containing the data that is available for processing

setDataReceiver

public void setDataReceiver(DataReceiverIfc receiver)

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

Specified by:

setDataReceiver in interface DataProviderIfc

Parameters:

receiver - Object which will receive data from this provider

getDataReceiver

public DataReceiverIfc getDataReceiver()

Returns the object to which this DataProvider is sending data.

Specified by:

getDataReceiver in interface DataProviderIfc

Returns:

Returns the DataReceiver of this provider.

dataIsAvailable

public void dataIsAvailable()

When this method is called by the DataProvider, a return call is made to the provider's getData() method. The resulting DCFieldContainer is then passed to this receiver's processData() method.

Specified by:

dataIsAvailable in interface DataReceiverIfc

processData

public void processData(DCFieldContainer data)
                 throws NodeProcessingException

Manipulates the data provided by its DataProvider. In this case, the 'processing' is to simply write the NAR to the cache file.

Specified by:

processData in interface DataReceiverIfc

Parameters:

data - The DCFieldContainer (actually a NAR) received from the DataProvider

Throws:

NodeProcessingException

processData

public void processData(DCFieldContainer[] data)
                 throws NodeProcessingException

Manipulates the data provided by its DataProvider. In this case, the 'processing' is to simply write the NAR to the cache file.

Specified by:

processData in interface DataReceiverIfc

Parameters:

data - The DCFieldContainer array (actually a set of NARs) received from the DataProvider

Throws:

NodeProcessingException

setDataProvider

public void setDataProvider(DataProviderIfc provider)

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

Specified by:

setDataProvider in interface DataReceiverIfc

Parameters:

provider - DataProvider of this receiver

getDataProvider

public DataProviderIfc getDataProvider()

Returns the object from which this DataReceiver is receiving data.

Specified by:

getDataProvider in interface DataReceiverIfc

Returns:

Returns the DataProvider of this receiver.

getRealNarsIn

public long getRealNarsIn()

Description copied from class: NARStreamHandler

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

Specified by:

getRealNarsIn in class NARStreamHandler

Returns:

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()
                            throws java.lang.Exception

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

Throws:

java.lang.Exception

isEndOfFile

public boolean isEndOfFile()
                    throws java.lang.Exception

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

Throws:

java.lang.Exception

isStartOfFile

public boolean isStartOfFile()
                      throws java.lang.Exception

Description copied from interface: FileDataProviderIfc

Determines if the record received is start of file indication

Specified by:

isStartOfFile in interface FileDataProviderIfc

Returns:

Throws:

java.lang.Exception

getFileData

public DCFieldContainer getFileData()
                             throws java.lang.Exception,
                                    FileRejectException,
                                    EndOfFileException

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

Throws:

java.lang.Exception

FileRejectException

EndOfFileException

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(java.lang.String fileName)
                               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(java.lang.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

rejectFile

public boolean rejectFile()
                   throws java.lang.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:

java.lang.Exception

openInputFile

public java.lang.String openInputFile()
                               throws java.lang.Exception

Specified by:

openInputFile in interface FileDataProviderIfc

Returns:

Throws:

java.lang.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(java.lang.String tID)

Specified by:

setTransactionID in interface FileDataReceiverIfc