com.nt.udc.io

Class CManagedFile

java.lang.Object

com.nt.udc.io.CManagedFile

public class CManagedFile
extends java.lang.Object

This class is used to manage files with bookmarks.

Every file has an associated bookmark file residing in the same directory. Classes using CManagedFile have control over the placement of bookmarks with respect to the content of the managed file.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.io.File	m_bookmarkFile This member represents the bookmark-file associated to the managed file.
protected java.io.RandomAccessFile	m_bookmarkStream This member represents the input/output stream opened on the bookmark file.
protected static int	m_debugLevel
protected java.io.File	m_file This member represents the file to be managed
protected ILogger	m_iLogger This member is used for reporting errors and warnings.
protected java.io.FileInputStream	m_inputStream This member represents the input stream opened on the managed file.
protected java.io.BufferedReader	m_reader This member represents the buffered reader to read characters from.
protected java.io.File	m_scratchDir This member is used for storing the scratch directory, where bookmark files are kept.

Constructor Summary

Constructors

Constructor and Description
CManagedFile(java.io.File file, java.io.File scratchDir, ILogger iLogger) This constructor opens the specified file, checks if there is an associated bookmark (checkpoint) file and if there is one, retrieves the position to start reading from.

Method Summary

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)
static int	getDebugLevel()
java.io.File	getFile()
java.lang.String	getFilename()
char	read()
int	read(char[] buf, int len)
java.lang.String	readLine()
boolean	setBookmark(int lineNo) This function is called to set a bookmark in the bookmark-file associated to the managed file.
static void	setDebugLevel(int debugLevel)

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_scratchDir

protected java.io.File m_scratchDir

This member is used for storing the scratch directory, where bookmark files are kept.

m_iLogger

protected ILogger m_iLogger

This member is used for reporting errors and warnings.

m_file

protected java.io.File m_file

This member represents the file to be managed

m_bookmarkFile

protected java.io.File m_bookmarkFile

This member represents the bookmark-file associated to the managed file.

m_inputStream

protected java.io.FileInputStream m_inputStream

This member represents the input stream opened on the managed file.

m_reader

protected java.io.BufferedReader m_reader

This member represents the buffered reader to read characters from.

m_bookmarkStream

protected java.io.RandomAccessFile m_bookmarkStream

This member represents the input/output stream opened on the bookmark file.

Constructor Detail

CManagedFile

public CManagedFile(java.io.File file,
                    java.io.File scratchDir,
                    ILogger iLogger)
             throws java.lang.Exception

This constructor opens the specified file, checks if there is an associated bookmark (checkpoint) file and if there is one, retrieves the position to start reading from.

Throws:

java.lang.Exception

Method Detail

getDebugLevel

public static int getDebugLevel()

getFile

public java.io.File getFile()

getFilename

public java.lang.String getFilename()

Returns:

The name of the current file

read

public char read()
          throws java.lang.Exception

Returns:

A character read from the stream If EOF is reached, the file is closed, as well as the associated bookmark, if there is one.

Throws:

java.lang.Exception

readLine

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

Throws:

java.lang.Exception

read

public int read(char[] buf,
                int len)
         throws java.lang.Exception

Throws:

java.lang.Exception

setBookmark

public boolean setBookmark(int lineNo)

This function is called to set a bookmark in the bookmark-file associated to the managed file. If the bookmark-file doesn't exist, then it's created. The bookmarks consists of the current position in the input stream opened on the managed file.

setDebugLevel

public static void setDebugLevel(int debugLevel)

error

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

debug

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