com.partnersoft.v3x.apps.Staker.interfaces.report
Class ReportModule

java.lang.Object
  com.partnersoft.v3x.apps.Staker.interfaces.ExternalInterfaceModule
      com.partnersoft.v3x.apps.Staker.interfaces.report.ReportModule

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

InterfaceReportModule

public class ReportModule
extends ExternalInterfaceModule

An external interface module that creates and saves textual reports .

See Also:

Serialized Form

Field Summary

Fields inherited from class com.partnersoft.v3x.apps.Staker.interfaces.ExternalInterfaceModule

verbose

Constructor Summary

ReportModule()

Method Summary

java.lang.Object	createExternalJob(Job job) A ReportJob is a job with lots of collated aggregate fields and stuff.
void	export(Job job) Exports a single job, generating the report to the desired spot.
java.lang.String	generateReportFor(Job job) Subclasses must override this to provide report functionality.
java.lang.String	getFileSuffix()
java.io.File	getReportDir()
java.lang.String	getReportDirName()
TextReportEngine	getReportEngine()
boolean	getUseShortNames()
void	initialize() Initializes the module.
boolean	isInitialized()
void	runImport(JobLibrarian librarian) This module does not import, so this method does not do anything.
void	setFileSuffix(java.lang.String newSuffix)
void	setReportDirName(java.lang.String newName)
void	setReportEngine(TextReportEngine newEngine)
void	setUseShortNames(boolean izit)

Methods inherited from class com.partnersoft.v3x.apps.Staker.interfaces.ExternalInterfaceModule

getDoNotExportField, getExportOnce, getExportOnceProperty, getHub, getLibrarian, getLog, getName, getRunInterval, getRunLag, getSynchronousExport, haltInterface, isExporting, isImporting, isInterfaceRunning, isVerbose, launchInterface, setDoNotExportField, setExporting, setExportOnce, setExportOnceProperty, setHub, setImporting, setLibrarian, setName, setRunInterval, setRunLag, setSynchronousExport, setVerbose, updateJob

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportModule

public ReportModule()

Method Detail

runImport

public void runImport(JobLibrarian librarian)

This module does not import, so this method does not do anything.

Specified by:

runImport in class ExternalInterfaceModule

export

public void export(Job job)

Exports a single job, generating the report to the desired spot.

Specified by:

export in class ExternalInterfaceModule

generateReportFor

public java.lang.String generateReportFor(Job job)

Subclasses must override this to provide report functionality.

Specified by:

generateReportFor in class ExternalInterfaceModule

createExternalJob

public java.lang.Object createExternalJob(Job job)

A ReportJob is a job with lots of collated aggregate fields and stuff. This method horks one up. (Well, maybe later, broke for now).

Specified by:

createExternalJob in class ExternalInterfaceModule

initialize

public void initialize()

Initializes the module. Subclasses should call this if they override.

getReportDir

public java.io.File getReportDir()

isInitialized

public boolean isInitialized()

getReportDirName

public java.lang.String getReportDirName()

setReportDirName

public void setReportDirName(java.lang.String newName)

getFileSuffix

public java.lang.String getFileSuffix()

setFileSuffix

public void setFileSuffix(java.lang.String newSuffix)

getUseShortNames

public boolean getUseShortNames()

setUseShortNames

public void setUseShortNames(boolean izit)

getReportEngine

public TextReportEngine getReportEngine()

setReportEngine

public void setReportEngine(TextReportEngine newEngine)