com.nt.udc.io

Class CDataSourceSingleFile

java.lang.Object

com.nt.udc.io.CDataSourceSingleFile

All Implemented Interfaces:

IDataSource

public class CDataSourceSingleFile
extends java.lang.Object
implements IDataSource

This class represents data sources consisting of individual files.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	m_filename This member represents the input filename
protected java.io.FileInputStream	m_inputStream This member represents the input stream to read from.
protected java.io.BufferedReader	m_reader This member is actually used for reading data.
protected COSARReporter	m_reporter This member is used for reporting.

Fields inherited from interface com.nt.udc.io.IDataSource

EOF

Constructor Summary

Constructors

Constructor and Description
CDataSourceSingleFile(java.lang.String filename)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	end() This function is called to end reading.
protected void	error(java.lang.String fName, java.lang.String msg)
COSARReporter	getReporter()
java.lang.String	getSourceName()
boolean	hasMoreData()
boolean	initialize() This function is called to initialize the data source.
boolean	isHealthy()
char	nextChar()
int	read(char[] buf, int len) This function reads a given number of characters from the source.
boolean	setBookmark(int lineNo) This function is called to mark a certain position in the input stream.
void	setReporter(COSARReporter reporter)
boolean	start() This function is called to start reading.
boolean	terminate() This function is called to terminate the data source.

Methods inherited from class java.lang.Object

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

Field Detail

m_filename

protected java.lang.String m_filename

This member represents the input filename

m_inputStream

protected java.io.FileInputStream m_inputStream

This member represents the input stream to read from.

m_reader

protected java.io.BufferedReader m_reader

This member is actually used for reading data.

m_reporter

protected COSARReporter m_reporter

This member is used for reporting.

Constructor Detail

CDataSourceSingleFile

public CDataSourceSingleFile(java.lang.String filename)
                      throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

getReporter

public COSARReporter getReporter()

setReporter

public void setReporter(COSARReporter reporter)

getSourceName

public java.lang.String getSourceName()

Specified by:

getSourceName in interface IDataSource

Returns:

The name of the source.

hasMoreData

public boolean hasMoreData()

Specified by:

hasMoreData in interface IDataSource

Returns:

true if more input is available.

nextChar

public char nextChar()
              throws java.lang.Exception

Specified by:

nextChar in interface IDataSource

Returns:

The next character from the input. If no more characters are available, IDataSource.EOF is returned instead.

Throws:

java.lang.Exception

read

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

Description copied from interface: IDataSource

This function reads a given number of characters from the source.

Specified by:

read in interface IDataSource

Returns:

The number of characters actually read.

Throws:

java.lang.Exception

initialize

public boolean initialize()

Description copied from interface: IDataSource

This function is called to initialize the data source.

Specified by:

initialize in interface IDataSource

terminate

public boolean terminate()

Description copied from interface: IDataSource

This function is called to terminate the data source.

Specified by:

terminate in interface IDataSource

start

public boolean start()

Description copied from interface: IDataSource

This function is called to start reading. Classes implementing IDataSource may use it for initialization.

Specified by:

start in interface IDataSource

Returns:

true if successful, false otherwise

end

public boolean end()

Description copied from interface: IDataSource

This function is called to end reading. Classes implementing IDataSource may use it for clean-up operations.

Specified by:

end in interface IDataSource

Returns:

true if successful, false otherwise

setBookmark

public boolean setBookmark(int lineNo)

Description copied from interface: IDataSource

This function is called to mark a certain position in the input stream. This mark may be stored on a persistent medium in order to avoid re-reading the same data during the next reading session.

Specified by:

setBookmark in interface IDataSource

isHealthy

public boolean isHealthy()

Specified by:

isHealthy in interface IDataSource

Returns:

true if the data source is OK, false otherwise.

error

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