Package de.businesscode.bcdui.wrs.load

Class AbstractDataWriter

java.lang.Object

de.businesscode.bcdui.wrs.load.AbstractDataWriter

All Implemented Interfaces:

IDataWriter

Direct Known Subclasses:

CsvDataWriter, SylkDataWriter, VFSDataWriter, WrsDataWriter

public abstract class AbstractDataWriter
extends Object
implements IDataWriter

An abstract writer-implementation - contains helper getters for all writer parameters

Field Summary

Fields

Modifier and Type	Field	Description
protected int	rowCounter

Constructor Summary

Constructors

Constructor	Description
AbstractDataWriter()	AbstractDataWriter

Method Summary

Modifier and Type	Method	Description
final int	getColumnsCount()
protected final long	getDuration()
protected final ISqlGenerator	getGenerator()
protected final IRequestOptions	getOptions()
protected final Element	getRequestDocRoot()	getRequestDocRoot
protected final ResultSet	getResultSet()
protected final ResultSetMetaData	getResultSetMetaData()
int	getRowCount()	Number of rows written
protected boolean	isEscapeXMLType(int colNo)	isXMLType
protected void	setEscapeXMLType(int colNo, boolean isXMLType)	setXMLType
protected abstract void	write()	replace the write method from interface
final void	write(IRequestOptions options, ISqlGenerator generator, ResultSet resultSet, long duration)	Write the result-set and (possible) input option

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.businesscode.bcdui.wrs.load.IDataWriter

close

Field Details

rowCounter

protected int rowCounter

Constructor Details

AbstractDataWriter

public AbstractDataWriter()

AbstractDataWriter

Method Details

write

protected abstract void write()
                       throws Exception

replace the write method from interface

Throws:

Exception

write

public final void write(IRequestOptions options,
 ISqlGenerator generator,
 ResultSet resultSet,
 long duration)
                 throws Exception

Description copied from interface: IDataWriter

Write the result-set and (possible) input option

Specified by:

write in interface IDataWriter

Parameters:

options - - the options used for ths request

generator - - the generator used for the request

resultSet - - data to write out. Can be null if generator was empty

duration - - the database execution duration in MS

Throws:

Exception

See Also:

• IDataWriter.write(de.businesscode.bcdui.wrs.IRequestOptions, de.businesscode.bcdui.wrs.load.ISqlGenerator, java.sql.ResultSet, long)

getOptions

protected final IRequestOptions getOptions()

Returns:

the options

getGenerator

protected final ISqlGenerator getGenerator()

Returns:

the generator

getResultSet

protected final ResultSet getResultSet()

Returns:

the resultSet

getDuration

protected final long getDuration()

Returns:

the execution duration

getRowCount

public int getRowCount()

Number of rows written

Specified by:

getRowCount in interface IDataWriter

Returns:

The number of rows written with last write

getColumnsCount

public final int getColumnsCount()

Specified by:

getColumnsCount in interface IDataWriter

Returns:

The number of columns written with last write.

See Also:

• IDataWriter.getColumnsCount()

getResultSetMetaData

protected final ResultSetMetaData getResultSetMetaData()

Returns:

the resultSetMetaData

isEscapeXMLType

protected boolean isEscapeXMLType(int colNo)

isXMLType

Parameters:

colNo -

Returns:

true if colNo should be XML escaped

setEscapeXMLType

protected void setEscapeXMLType(int colNo,
 boolean isXMLType)

setXMLType

Parameters:

colNo -

isXMLType -

getRequestDocRoot

protected final Element getRequestDocRoot()

getRequestDocRoot

Returns:

the request-doc root