com.aspc.Util.Export

Class Exporter

java.lang.Object

com.aspc.Util.Export.Exporter

Direct Known Subclasses:

ExporterWithUpdate, FileExporter

public abstract class Exporter
extends java.lang.Object

Exporter is a generic process for exporting result sets. The exporter will do default processing and pass the results onto sub classes to do specific processing such as write the results to a file. Further control is provided by various plugins.
THREAD MODE: SINGLE-THREADED export

Since:

February 7, 2003, 4:00 PM

Author:

Jason McGrath

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Object	plugin

Constructor Summary

Constructors

Constructor and Description
Exporter(DBResult results)

Method Summary

Modifier and Type	Method and Description
void	addAttribute(java.lang.String key, java.lang.String value)
void	addFieldDef(ExportFieldDef def)
void	addFieldDef(ExportFieldDef[] defs)
void	appendField(java.lang.StringBuilder buffer, java.lang.String inValue, boolean isText)
java.lang.String	buildDetailLine(DBObject o)
protected java.lang.String	createHeader(DBObject o)
protected java.lang.String	doDetailLine(DBObject o)
void	export()
protected java.lang.String	extGetDisplayName(java.lang.String name)
java.lang.String	getAttribute(java.lang.String key)
java.lang.String	getDisplayName()
DataSource	getDS()
char	getFieldDelimiter()
java.lang.String	getMimeType()
DBResult	getResults()
protected java.lang.String	getStatusMsg(int lineNum, int estRows)
int	getTotalProcessed()
protected void	handleError(java.lang.Throwable t)
protected void	iSetStatus(java.lang.String msg)
protected abstract void	postProcess(boolean successfull)
protected abstract void	preProcess()
protected void	processBatch(DBObject[] batch)
protected abstract void	processDetailLine(java.lang.String ln, DBObject o)
protected abstract void	processHeading(java.lang.String ln, DBObject o)
void	setAttributes(java.lang.String attributes)
void	setDS(DataSource ds)
void	setFieldDelimiter(char delim)
void	setFirstLineIsHeadings(boolean showHeadings)
void	setMaxToExport(int max) max records to export.
void	setMimeType(java.lang.String mimeType)
void	setPlugin(java.lang.Object plugin)
void	setResults(DBResult results)
void	setStringDelimiter(char delim)

Methods inherited from class java.lang.Object

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

Field Detail

plugin

protected java.lang.Object plugin

Constructor Detail

Exporter

public Exporter(DBResult results)

Parameters:

results -

Method Detail

preProcess

protected abstract void preProcess()
                            throws java.lang.Exception

Throws:

java.lang.Exception - a serious problem

processHeading

protected abstract void processHeading(java.lang.String ln,
                                       DBObject o)
                                throws java.lang.Exception

Parameters:

ln -

o -

Throws:

java.lang.Exception - a serious problem

processDetailLine

protected abstract void processDetailLine(java.lang.String ln,
                                          DBObject o)
                                   throws java.lang.Exception

Parameters:

ln -

o -

Throws:

java.lang.Exception - a serious problem

postProcess

protected abstract void postProcess(boolean successfull)

Parameters:

successfull -

setAttributes

public void setAttributes(java.lang.String attributes)

Parameters:

attributes -

addAttribute

public void addAttribute(java.lang.String key,
                         java.lang.String value)

Parameters:

key - The key

value - the value

getAttribute

public java.lang.String getAttribute(java.lang.String key)

Parameters:

key - The key

Returns:

the value

addFieldDef

public void addFieldDef(ExportFieldDef def)

Parameters:

def - the class

addFieldDef

public void addFieldDef(ExportFieldDef[] defs)

Parameters:

defs -

setFirstLineIsHeadings

public void setFirstLineIsHeadings(boolean showHeadings)

Parameters:

showHeadings -

setFieldDelimiter

public void setFieldDelimiter(char delim)

Parameters:

delim -

getFieldDelimiter

public char getFieldDelimiter()

Returns:

the value

setStringDelimiter

public void setStringDelimiter(char delim)

Parameters:

delim -

setDS

public void setDS(DataSource ds)

Parameters:

ds - the data source

getDS

public DataSource getDS()

Returns:

the value

getResults

public DBResult getResults()

Returns:

the value

setResults

public final void setResults(DBResult results)

Parameters:

results -

setMimeType

public final void setMimeType(java.lang.String mimeType)

Parameters:

mimeType -

getMimeType

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

Returns:

the value

Throws:

java.lang.Exception - a serious problem

appendField

public void appendField(java.lang.StringBuilder buffer,
                        java.lang.String inValue,
                        boolean isText)

Parameters:

buffer -

inValue - the value

isText -

setPlugin

public void setPlugin(java.lang.Object plugin)
               throws java.lang.Exception

Parameters:

plugin -

Throws:

java.lang.Exception - a serious problem

setMaxToExport

public void setMaxToExport(int max)
                    throws java.lang.Exception

max records to export.

Parameters:

max -

Throws:

java.lang.Exception - Exception A serious problem

export

public void export()
            throws java.lang.Exception

Throws:

java.lang.Exception - a serious problem

getStatusMsg

protected java.lang.String getStatusMsg(int lineNum,
                                        int estRows)

Parameters:

lineNum -

estRows -

Returns:

the value

iSetStatus

protected void iSetStatus(java.lang.String msg)

Parameters:

msg - the message

getDisplayName

public java.lang.String getDisplayName()

Returns:

the value

getTotalProcessed

public int getTotalProcessed()

Returns:

the value

extGetDisplayName

protected java.lang.String extGetDisplayName(java.lang.String name)

Parameters:

name -

Returns:

the value

processBatch

protected void processBatch(DBObject[] batch)
                     throws java.lang.Exception

Parameters:

batch -

Throws:

java.lang.Exception - a serious problem

handleError

protected void handleError(java.lang.Throwable t)

Parameters:

t -

doDetailLine

protected java.lang.String doDetailLine(DBObject o)
                                 throws java.lang.Exception

Parameters:

o -

Returns:

the value

Throws:

java.lang.Exception - a serious problem

createHeader

protected java.lang.String createHeader(DBObject o)
                                 throws java.lang.Exception

Parameters:

o -

Returns:

the value

Throws:

java.lang.Exception - a serious problem

buildDetailLine

public java.lang.String buildDetailLine(DBObject o)
                                 throws java.lang.Exception

Parameters:

o -

Returns:

the value

Throws:

java.lang.Exception - a serious problem