Package com.nt.udc.ndk.node

Class DeclNPLFieldProcessor

java.lang.Object

com.nt.udc.ndk.node.DCFieldProcessor

com.nt.udc.ndk.node.DeclNPLFieldProcessor

All Implemented Interfaces:

DataProviderIfc, DataReceiverIfc, FileDataProviderIfc, FileDataReceiverIfc, Runnable

Direct Known Subclasses:

AggregatorFieldProcessor, DiscProcFieldProcessor, DupRemoverFieldProcessor, SeqProcFieldProcessor

public abstract class DeclNPLFieldProcessor
extends DCFieldProcessor

This field processor is intended for those nodes that can not use procedural NPL, but still required the declarative configuration elements of NPL. A derived field processor will have access to those configuration elements through the "getNPLConfig()" method. Please refer to the Java documentation for the class "NPLDeclarations" for more information on how to obtain the desired configuration element from the NPL file.

Constructor Summary

Constructors

Constructor	Description
DeclNPLFieldProcessor(LoggerIfc inLogger, String fileName)	Calls parent's constructor.

Method Summary

Modifier and Type	Method	Description
abstract void	dataIsAvailable()	Allows a DataProvider 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.
protected LoggerIfc	getLogger()	Returns the LoggerIfc object used by this class to record log messages
protected ConfigIfc	getNPLConfig()	Returns the a ConfigIfc that represents the NPL configuration.
String	getNPLFileName()
protected NPLProgramIfc	getNPLProgram()	Returns the NPLProgramIfc object used by this field processor
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
abstract void	processData(DCFieldContainer inputData)	Manipulates the data provided by its DataProvider
abstract void	processData(DCFieldContainer[] inputData)	Manipulates the set of data provided by its DataProvider
abstract void	run()
void	setNPLFileName(String fileName)
abstract void	shutdown()	Performs all steps necessary to gracefully stop this FieldProcessor.

Methods inherited from class com.nt.udc.ndk.node.DCFieldProcessor

fileDataIsAvailable, getCurrArchFile, getData, getDataProvider, getDataReceiver, getDiscardedCounter, getFileBulkData, getFileData, getFileDataProvider, getFileDataReceiver, getOutputType, getPollForData, getProcessedArchFile, isEndOfFile, isFileDataAvailable, isStartOfFile, openInputFile, processEndOfFileData, processFileData, processFileData, processRejectFile, processStartOfFileData, rejectFile, removeProcessedFile, setbulkIOConfig, setBulkProcessing, setDataProvider, setDataReceiver, setDiscardedCounter, setFileDataProvider, setFileDataReceiver, setMultiThreadConfig, setOutputType, setPollForData, setProcessedArchFile, setTransactionID, signalBatchCompletion, validOIMinorType

Methods inherited from class java.lang.Object

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

Constructor Details

DeclNPLFieldProcessor

public DeclNPLFieldProcessor(LoggerIfc inLogger,
 String fileName)
                      throws NodeProcessingException

Calls parent's constructor.

Parameters:

inLogger - Object that will be used for logging messages from this DeclNPLFieldProcessor.

fileName - Either the name of the NPL text file or the precompiled NPLProgram class file to us errors

Throws:

NodeProcessingException

Method Details

getNPLProgram

protected NPLProgramIfc getNPLProgram()

Returns the NPLProgramIfc object used by this field processor

Returns:

The NPLProgramIfc object used by this field processor

getNPLFileName

public String getNPLFileName()

setNPLFileName

public void setNPLFileName(String fileName)
                    throws NodeProcessingException

Throws:

NodeProcessingException

getLogger

protected LoggerIfc getLogger()

Returns the LoggerIfc object used by this class to record log messages

Returns:

The LoggerIfc object used by this field processor

run

public abstract void run()

Specified by:

run in interface Runnable

Specified by:

run in class DCFieldProcessor

shutdown

public abstract void shutdown()

Performs all steps necessary to gracefully stop this FieldProcessor.

Specified by:

shutdown in class DCFieldProcessor

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

Specified by:

isDataAvailable in class DCFieldProcessor

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

Specified by:

getData in class DCFieldProcessor

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.

Returns:

DCFieldContainer object array, containing the data that is for processing

dataIsAvailable

public abstract 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

Specified by:

dataIsAvailable in class DCFieldProcessor

processData

public abstract void processData(DCFieldContainer inputData)
                          throws NodeProcessingException

Description copied from interface: DataReceiverIfc

Manipulates the data provided by its DataProvider

Specified by:

processData in interface DataReceiverIfc

Specified by:

processData in class DCFieldProcessor

Throws:

NodeProcessingException

processData

public abstract void processData(DCFieldContainer[] inputData)
                          throws NodeProcessingException

Description copied from interface: DataReceiverIfc

Manipulates the set of data provided by its DataProvider

Throws:

NodeProcessingException

getNPLConfig

protected ConfigIfc getNPLConfig()

Returns the a ConfigIfc that represents the NPL configuration.

Returns:

ConfigIfc, containing the NPL configuration

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

Overrides:

handleRejectOfFile in class DCFieldProcessor