com.nt.udc.io

Class CDataSink

java.lang.Object

com.nt.udc.io.CDataSink

All Implemented Interfaces:

IDataSink

public class CDataSink
extends java.lang.Object
implements IDataSink

This class is used to write data into files in a specified output directory.

Since:

JDK1.1.7

Field Summary

Fields

Modifier and Type	Field and Description
protected FilenameGenerator	m_filenameGen This member is used to generate filenames
protected java.lang.String	m_filePrefix This member is the output file prefix.
protected java.lang.String	m_fileSuffix This member is the output file suffix.
protected ILogger	m_iLogger This member is used for reporting errors and warnings.
protected java.lang.String	m_outputDir This member is the directory files are written to.
protected java.io.DataOutputStream	m_outputStream This member is the stream we output data to.

Constructor Summary

Constructors

Constructor and Description
CDataSink(java.lang.String outputDir, ILogger iLogger)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getFilePrefix()
java.lang.String	getFileSuffix()
protected java.lang.String	getNewFilename() This function is used to return a new filename unique to the current output directory.
java.lang.String	getOutputDir()
void	setFilenameGenerator(FilenameGenerator filenameGen)
void	setFilePrefix(java.lang.String filePrefix)
void	setFileSuffix(java.lang.String fileSuffix)
boolean	start() This function is called to start writing.
boolean	stop() This function is called to stop writing.
boolean	writeData(java.lang.Object data) This function is called to write a string to the output medium.

Methods inherited from class java.lang.Object

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

Field Detail

m_iLogger

protected ILogger m_iLogger

This member is used for reporting errors and warnings.

m_outputDir

protected java.lang.String m_outputDir

This member is the directory files are written to.

m_outputStream

protected java.io.DataOutputStream m_outputStream

This member is the stream we output data to.

m_filePrefix

protected java.lang.String m_filePrefix

This member is the output file prefix.

m_fileSuffix

protected java.lang.String m_fileSuffix

This member is the output file suffix.

m_filenameGen

protected FilenameGenerator m_filenameGen

This member is used to generate filenames

Constructor Detail

CDataSink

public CDataSink(java.lang.String outputDir,
         ILogger iLogger)

Method Detail

getOutputDir

public java.lang.String getOutputDir()

getFilePrefix

public java.lang.String getFilePrefix()

getFileSuffix

public java.lang.String getFileSuffix()

setFilePrefix

public void setFilePrefix(java.lang.String filePrefix)

setFileSuffix

public void setFileSuffix(java.lang.String fileSuffix)

setFilenameGenerator

public final void setFilenameGenerator(FilenameGenerator filenameGen)

writeData

public boolean writeData(java.lang.Object data)

This function is called to write a string to the output medium.

Specified by:

writeData in interface IDataSink

Returns:

true if successful, false otherwise

start

public boolean start()

This function is called to start writing.

Specified by:

start in interface IDataSink

Returns:

true if successful, false otherwise

stop

public boolean stop()

This function is called to stop writing.

Specified by:

stop in interface IDataSink

Returns:

true if successful, false otherwise

getNewFilename

protected java.lang.String getNewFilename()

This function is used to return a new filename unique to the current output directory.

Returns:

true if successful, false otherwise