com.aspc.Util.Export.plugins

Interface ExportBuildLinePlugin

All Known Implementing Classes:

RenewalNoticeRunPlugin, UpdateTestExportPlugin

public interface ExportBuildLinePlugin

This plugin allows changes to be made to the output lines where the default processing is not sufficient. Output lines can also be skipped by returning empty StringBuilders
THREAD MODE: SINGLE-THREADED

Since:

13 May 2005, 09:13

Author:

Jason McGrath

Method Summary

Modifier and Type	Method and Description
java.lang.StringBuilder	buildDetailLine(Exporter exporter, java.lang.StringBuilder buffer, DBObject dbObj) Requests a StringBuilder to be used as the details line for the supplied DBObject Note: If no changes are required then the buffer should be returned
java.lang.StringBuilder	buildHeader(Exporter exporter, java.lang.StringBuilder buffer, DBObject dbObj) Requests a StringBuilder to be used as the header line Note: If no changes are required then the buffer should be returned

Method Detail

buildDetailLine

java.lang.StringBuilder buildDetailLine(Exporter exporter,
                                        java.lang.StringBuilder buffer,
                                        DBObject dbObj)
                                 throws java.lang.Exception

Requests a StringBuilder to be used as the details line for the supplied DBObject Note: If no changes are required then the buffer should be returned

Parameters:

exporter - - current exporter that called this method

buffer - - A StringBuilder containing the default output line generated by the exporter

dbObj - - The current DBObject used to generate output line

Returns:

A StringBuilder.

Throws:

java.lang.Exception - - Exception

buildHeader

java.lang.StringBuilder buildHeader(Exporter exporter,
                                    java.lang.StringBuilder buffer,
                                    DBObject dbObj)
                             throws java.lang.Exception

Requests a StringBuilder to be used as the header line Note: If no changes are required then the buffer should be returned

Parameters:

exporter - - current exporter that called this method

buffer - - A StringBuilder containing the default header line generated by the exporter

dbObj - - The first DBObject read from the results

Returns:

A StringBuilder.

Throws:

java.lang.Exception - - Exception