com.nt.udc.io

Class CFileMgr

java.lang.Object

com.nt.udc.io.CFileMgr

public class CFileMgr
extends java.lang.Object

This class manages files stored in an input directory. It is used to return files to process.

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	m_debugLevel
protected java.lang.String	m_doneFilePrefix This is the "done" marker-file prefix.
protected java.lang.String	m_doneFileSuffix This is the "done" marker-file suffix.
protected java.io.FilenameFilter	m_filenameFilter This is the filter used to select files to process.
protected ILogger	m_iLogger This member is used to report errors and warnings
protected java.io.File	m_inputDir This is the input directory
protected java.io.File[]	m_inputFileCache This is the cache of input files.
protected int	m_inputFileIndex This is the position of the next file to process in m_inputFileCache.
protected java.io.File	m_scratchDir This is the scratch directory.

Constructor Summary

Constructors

Constructor and Description
CFileMgr(ILogger iLogger)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	debug(java.lang.String fName, java.lang.String msg)
protected void	error(java.lang.String fName, java.lang.String msg)
boolean	finishedProcessing(CManagedFile file) This function is called after a file has been processed.
static int	getDebugLevel()
java.lang.String	getDoneFilePrefix()
java.lang.String	getDoneFileSuffix()
java.io.FilenameFilter	getFilenameFilter()
CManagedFile	getFileToProcess() This function is used to select a file to process.
java.lang.String	getInputDir()
java.lang.String	getScratchDir()
boolean	hasMoreFilesToProcess() This function is used to check if more files are available for processing.
protected boolean	selectFileForProcessing(java.io.File inputFile) This function is used to check whether an inputFile may be selected for processing.
static void	setDebugLevel(int debugLevel)
void	setDoneFilePrefix(java.lang.String doneFilePrefix)
void	setDoneFileSuffix(java.lang.String doneFileSuffix)
void	setFilenameFilter(java.io.FilenameFilter filenameFilter)
void	setInputDir(java.lang.String inputDirName)
void	setScratchDir(java.lang.String scratchDirName)

Methods inherited from class java.lang.Object

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

Field Detail

m_debugLevel

protected static int m_debugLevel

m_iLogger

protected ILogger m_iLogger

This member is used to report errors and warnings

m_inputDir

protected java.io.File m_inputDir

This is the input directory

m_inputFileCache

protected java.io.File[] m_inputFileCache

This is the cache of input files. It is used to retrieve the files to process.

m_inputFileIndex

protected int m_inputFileIndex

This is the position of the next file to process in m_inputFileCache.

m_scratchDir

protected java.io.File m_scratchDir

This is the scratch directory. Work-files are stored here.

m_filenameFilter

protected java.io.FilenameFilter m_filenameFilter

This is the filter used to select files to process.

m_doneFilePrefix

protected java.lang.String m_doneFilePrefix

This is the "done" marker-file prefix.

m_doneFileSuffix

protected java.lang.String m_doneFileSuffix

This is the "done" marker-file suffix.

Constructor Detail

CFileMgr

public CFileMgr(ILogger iLogger)

Method Detail

getDebugLevel

public static int getDebugLevel()

getInputDir

public java.lang.String getInputDir()

getScratchDir

public java.lang.String getScratchDir()

getFilenameFilter

public java.io.FilenameFilter getFilenameFilter()

getDoneFilePrefix

public java.lang.String getDoneFilePrefix()

getDoneFileSuffix

public java.lang.String getDoneFileSuffix()

setDebugLevel

public static void setDebugLevel(int debugLevel)

setInputDir

public void setInputDir(java.lang.String inputDirName)

setScratchDir

public void setScratchDir(java.lang.String scratchDirName)

setFilenameFilter

public void setFilenameFilter(java.io.FilenameFilter filenameFilter)

setDoneFilePrefix

public void setDoneFilePrefix(java.lang.String doneFilePrefix)

setDoneFileSuffix

public void setDoneFileSuffix(java.lang.String doneFileSuffix)

hasMoreFilesToProcess

public boolean hasMoreFilesToProcess()

This function is used to check if more files are available for processing.

We search the input file cache first. If no file is found, we try to update the cache and do the search again. If a file is found, it is guaranteed that the input file index remains positioned on a valid candidate.

getFileToProcess

public CManagedFile getFileToProcess()

This function is used to select a file to process.

We search the input directory for files to be processed. The oldest successful candidate is returned. A cache of input files, sorted by last-modification time is used to avoid frequent disk-accesses.

finishedProcessing

public boolean finishedProcessing(CManagedFile file)

This function is called after a file has been processed.

A marker file is created in the input directory.

selectFileForProcessing

protected boolean selectFileForProcessing(java.io.File inputFile)

This function is used to check whether an inputFile may be selected for processing.

error

protected void error(java.lang.String fName,
         java.lang.String msg)

debug

protected void debug(java.lang.String fName,
         java.lang.String msg)