com.nt.udc.ndk.node

Class GenericFlatFileProcessor

java.lang.Object

com.nt.udc.ndk.node.EITransport

com.nt.udc.ei.transport.FileEITransport

com.nt.udc.ndk.node.GenericFlatFileProcessor

All Implemented Interfaces:

DataProviderIfc, DCTransport, FileDataProviderIfc, java.lang.Runnable

Direct Known Subclasses:

FlatFileEIProcessor, KnownFieldLengthFileProcessor

public abstract class GenericFlatFileProcessor
extends FileEITransport

This is an abstract class that should be extended when a new type of flat file processing node is requrired

Since:

JDK1.3.1

Field Summary

Fields

Modifier and Type	Field and Description
protected java.io.File	actfile
protected PosLineReader	br
protected boolean	debug
protected java.lang.String	fileName
protected static java.lang.String	FILENAME_NAR_ID
protected static java.lang.String	INPUT_BACKUP_DIR
protected java.io.FileInputStream	inputStream
protected java.lang.String	lineOfText
protected boolean	m_bCRLFTerminatorEnabled This flag specifies if CRLF is active as a line delimiter.
protected boolean	m_bCRTerminatorEnabled This flag specifies if CR is active as a line delimiter.
protected boolean	m_bLFTerminatorEnabled This flag specifies if LF is active as a line delimiter.
protected long	numBytes
static java.lang.String	PROCESSED_FILE_PREFIX
static java.lang.String	PROCESSED_FILE_SUFFIX
protected java.lang.String	rawHeader
protected DCEIRecord	record Use one DCEIRecord for all data processing.
protected java.io.RandomAccessFile	recoveryFile
protected java.io.File	scratchFile
protected static java.lang.String	UNICODE_TRANSFORMATION_FORMAT

Fields inherited from class com.nt.udc.ei.transport.FileEITransport

DEFAULT_POLLING_INTERVAL, DELETE_LOCAL_FILES, deleteLocalFiles, fileLevelTransaction, fileSeqCheck, fsChecked, ioLock, isOrdered, itsFileSuffix, localDir, logger, mtChecked, MULTI_THREADED, ORDER_REQUIRED, POLLING_INTERVAL, scratchDir, useSynchronizedDirectory

Fields inherited from class com.nt.udc.ndk.node.EITransport

dataReceiver, fdChecked, filedataReceiver, fileduplicateCheck, fileToProcess, inputCount, lockFile, movedFile, node, pollingInterval, processing, processingData, running

Constructor Summary

Constructors

Constructor and Description
GenericFlatFileProcessor(DCNode node, java.io.File localdir, java.lang.String suffix, SMGLock lock) Use this constructor when the accounting files are pushed to a local directory by an outside source.
GenericFlatFileProcessor(DCNode node, SynchronizedDirectory sd, java.lang.String suffix, SMGLock lock) Use this constructor when using FTP to retrieve the accounting files that need to be processed.

Method Summary

Modifier and Type	Method and Description
protected void	getHeader(java.lang.String text) Parses a line of text (the file header) for the field names.
protected void	initLineTerminators() This method is used to initialize the line delimiters, which consist of combinations of CR, LF and CRLF.
protected void	processFiles(java.util.Vector filesToProcess) Here's where we actually parse the files and extract the data of interest.
protected void	processFilesOrdered(java.io.File currFile)
protected boolean	processScratchFile() Processes scratch files in case of a abnormal shutdown.
protected abstract void	processTheRecord(java.lang.String rawRecord) This call process the record.
protected void	setRecordType(DCEIRecord rec) This call is used to set the specific object type used to process the individual records that have been read in from a flat file.
protected void	skipAhead() This skips ahead in the last file being processed before termination.
protected void	skipHeader() This code should be overridden by nodes which are processing data which does not have a header record.

Methods inherited from class com.nt.udc.ei.transport.FileEITransport

deleteLocalFiles, getActFilter, getBulkData, getData, getInputBackupDir, getLength, isDataAvailable, isHealthy, isLessThan, moveCurrentFileToBackUp, readLength, run, setActFilter, setDubCheckObj, setDupCheckFlag, setSeqCheckFlag, setSeqCheckObj, shutdown, sortFiles, writeLength, writeLength

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

getCurrArchFile, getData, getDataReceiver, getDubCheckObj, getDupCheckFlag, getFileBulkData, getFileData, getFileDataReceiver, getFileList, getMovedFileStatus, getNode, getPollingInterval, getProcessedArchFile, handleRejectOfFile, incrementIn, incrementIn, isEndOfFile, isFileDataAvailable, isProcessing, isProcessingData, isStartOfFile, openInputFile, rejectFile, removeProcessedFile, setCountsSuspect, setDataReceiver, setFileDataReceiver, setFileToProcess, setMovedFileStatus, setNode, setPollingInterval, setProcessedArchFile, setProcessing, signalBatchCompletion, validOIMinorType

Methods inherited from class java.lang.Object

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

Field Detail

debug

protected boolean debug

PROCESSED_FILE_PREFIX

public static final java.lang.String PROCESSED_FILE_PREFIX

See Also:

Constant Field Values

PROCESSED_FILE_SUFFIX

public static final java.lang.String PROCESSED_FILE_SUFFIX

See Also:

Constant Field Values

INPUT_BACKUP_DIR

protected static final java.lang.String INPUT_BACKUP_DIR

See Also:

Constant Field Values

record

protected DCEIRecord record

Use one DCEIRecord for all data processing. This field should be set using the setRecordType call by the concrete class that is extending this class.

m_bCRTerminatorEnabled

protected boolean m_bCRTerminatorEnabled

This flag specifies if CR is active as a line delimiter.

m_bLFTerminatorEnabled

protected boolean m_bLFTerminatorEnabled

This flag specifies if LF is active as a line delimiter.

m_bCRLFTerminatorEnabled

protected boolean m_bCRLFTerminatorEnabled

This flag specifies if CRLF is active as a line delimiter.

actfile

protected java.io.File actfile

inputStream

protected java.io.FileInputStream inputStream

br

protected PosLineReader br

lineOfText

protected java.lang.String lineOfText

fileName

protected java.lang.String fileName

rawHeader

protected java.lang.String rawHeader

numBytes

protected long numBytes

scratchFile

protected java.io.File scratchFile

recoveryFile

protected java.io.RandomAccessFile recoveryFile

FILENAME_NAR_ID

protected static final java.lang.String FILENAME_NAR_ID

See Also:

Constant Field Values

UNICODE_TRANSFORMATION_FORMAT

protected static final java.lang.String UNICODE_TRANSFORMATION_FORMAT

See Also:

Constant Field Values

Constructor Detail

GenericFlatFileProcessor

public GenericFlatFileProcessor(DCNode node,
                                java.io.File localdir,
                                java.lang.String suffix,
                                SMGLock lock)
                         throws NodeStartException

Use this constructor when the accounting files are pushed to a local directory by an outside source.

Parameters:

node - The EI node which is using this class.

localdir - The local directory where the target files can be found

suffix - The file suffix used to identify the files that need to be processed (can be null if you want to process all files in the directory)

Throws:

NodeStartException - Used to signal the EI Node that there was a problem getting things going

GenericFlatFileProcessor

public GenericFlatFileProcessor(DCNode node,
                                SynchronizedDirectory sd,
                                java.lang.String suffix,
                                SMGLock lock)
                         throws NodeStartException

Use this constructor when using FTP to retrieve the accounting files that need to be processed.

Parameters:

node - The EI node which is using this class.

sd - The representation of the local directory where the target files can be found

suffix - The file suffix used to identify the files that need to be processed (can be null if you want to process all files in the directory)

lock -

Throws:

NodeStartException - Used to signal the EI Node that there was a problem getting things going

Method Detail

processFiles

protected void processFiles(java.util.Vector filesToProcess)

Here's where we actually parse the files and extract the data of interest.

Specified by:

processFiles in class FileEITransport

Parameters:

filesToProcess - list of filenames that need to be processed

processFilesOrdered

protected void processFilesOrdered(java.io.File currFile)

processTheRecord

protected abstract void processTheRecord(java.lang.String rawRecord)

This call process the record. Classes derived from this type should override this method to use there own record processing class.

Parameters:

String - rawRecord The raw unprocessed data record.

setRecordType

protected void setRecordType(DCEIRecord rec)

This call is used to set the specific object type used to process the individual records that have been read in from a flat file.

processScratchFile

protected boolean processScratchFile()

Processes scratch files in case of a abnormal shutdown.

skipAhead

protected void skipAhead()

This skips ahead in the last file being processed before termination. This should be overridden for record types the don't have a header record.

skipHeader

protected void skipHeader()

This code should be overridden by nodes which are processing data which does not have a header record. Just declare a member that does nothing.

getHeader

protected void getHeader(java.lang.String text)

Parses a line of text (the file header) for the field names.

initLineTerminators

protected void initLineTerminators()

This method is used to initialize the line delimiters, which consist of combinations of CR, LF and CRLF. By default, all are active.