com.partnersoft.v3x.apps.Staker.interfaces.CSV
Class CSVInterfaceModule

java.lang.Object
  com.partnersoft.v3x.apps.Staker.interfaces.ExternalInterfaceModule
      com.partnersoft.v3x.apps.Staker.interfaces.CSV.CSVInterfaceModule

All Implemented Interfaces:

java.io.Serializable

public class CSVInterfaceModule
extends ExternalInterfaceModule

An generic external interface that exchanges job file information via CSV (comma separated value) text files.

See Also:

Serialized Form

Field Summary

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

verbose

Constructor Summary

CSVInterfaceModule()

Method Summary

java.lang.Object	createExternalJob(Job job) Create the specialized "Job" for this interface.
void	export(Job job) Writes a job update to the export file.
java.lang.String	generateReportFor(Job job) Generates a job report.
java.util.ArrayList	getCSVFieldNames() Returns the ordered list of names of the fields in the CSV exchange format.
java.lang.String	getExportPath()
RecordTranslator	getExportTranslator()
java.lang.String	getForeignExportProgram()
int	getForeignRunInterval()
int	getForeignRunLag()
java.lang.String	getImportPath()
RecordTranslator	getImportTranslator()
TextReportEngine	getReportEngine()
boolean	isRunningForeignExport()
void	launchInterface(JobLibrarian librarian) Launches the foreign export command runner, if turned on.
void	runForeignExportProgram() Runs the external interfaces' export program, if any.
void	runImport(JobLibrarian librarian) Slurps in the import file and updates jobs from it.
void	setCSVFieldNames(java.util.ArrayList newNames)
void	setExportPath(java.lang.String newPath)
void	setExportTranslator(RecordTranslator newTranslator)
void	setForeignExportProgram(java.lang.String newProg)
void	setForeignRunInterval(int newInterval)
void	setForeignRunLag(int newLag)
void	setImportPath(java.lang.String newPath)
void	setImportTranslator(RecordTranslator newTranslator)
void	setReportEngine(TextReportEngine newEngine)
void	setRunningForeignExport(boolean tizit)

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, 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

CSVInterfaceModule

public CSVInterfaceModule()

Method Detail

launchInterface

public void launchInterface(JobLibrarian librarian)

Launches the foreign export command runner, if turned on. Then calls super.launchInterface() to do usual stuff.

Overrides:

launchInterface in class ExternalInterfaceModule

runImport

public void runImport(JobLibrarian librarian)

Slurps in the import file and updates jobs from it.

Specified by:

runImport in class ExternalInterfaceModule

export

public void export(Job job)

Writes a job update to the export file.

Specified by:

export in class ExternalInterfaceModule

generateReportFor

public java.lang.String generateReportFor(Job job)

Description copied from class: ExternalInterfaceModule

Generates a job report. Not always applicable; if so use return "".

Specified by:

generateReportFor in class ExternalInterfaceModule

createExternalJob

public java.lang.Object createExternalJob(Job job)

Description copied from class: ExternalInterfaceModule

Create the specialized "Job" for this interface. Often this has some sort of subset or superset or disjoint set of the data actually stored by the staking system.

Specified by:

createExternalJob in class ExternalInterfaceModule

runForeignExportProgram

public void runForeignExportProgram()

Runs the external interfaces' export program, if any. For example, if a download program needs to be run to fetch the import file.

getImportPath

public java.lang.String getImportPath()

setImportPath

public void setImportPath(java.lang.String newPath)

getExportPath

public java.lang.String getExportPath()

setExportPath

public void setExportPath(java.lang.String newPath)

getImportTranslator

public RecordTranslator getImportTranslator()

setImportTranslator

public void setImportTranslator(RecordTranslator newTranslator)

getExportTranslator

public RecordTranslator getExportTranslator()

setExportTranslator

public void setExportTranslator(RecordTranslator newTranslator)

getCSVFieldNames

public java.util.ArrayList getCSVFieldNames()

Returns the ordered list of names of the fields in the CSV exchange format.

setCSVFieldNames

public void setCSVFieldNames(java.util.ArrayList newNames)

getReportEngine

public TextReportEngine getReportEngine()

setReportEngine

public void setReportEngine(TextReportEngine newEngine)

getForeignExportProgram

public java.lang.String getForeignExportProgram()

setForeignExportProgram

public void setForeignExportProgram(java.lang.String newProg)

isRunningForeignExport

public boolean isRunningForeignExport()

setRunningForeignExport

public void setRunningForeignExport(boolean tizit)

getForeignRunInterval

public int getForeignRunInterval()

setForeignRunInterval

public void setForeignRunInterval(int newInterval)

getForeignRunLag

public int getForeignRunLag()

setForeignRunLag

public void setForeignRunLag(int newLag)