com.inductiveautomation.ignition.designer.sqltags.scanclass

Class ScanclassCSV.Exporter

java.lang.Object

com.inductiveautomation.ignition.client.script.ClientFileUtilities.CharFileWritingTask

com.inductiveautomation.ignition.designer.sqltags.scanclass.ScanclassCSV.Exporter

All Implemented Interfaces:

ClientFileUtilities.FileWritingTask, AsyncClientTask

Enclosing class:

ScanclassCSV

protected static class ScanclassCSV.Exporter
extends ClientFileUtilities.CharFileWritingTask
implements AsyncClientTask

Constructor Summary

Constructors

Constructor and Description
Exporter(java.io.File targetFile, java.util.List<ScanClass> values)
Exporter(java.util.List<ScanClass> values)

Method Summary

Modifier and Type	Method and Description
boolean	canCancel() Whether or not the user is allowed to cancel the operation.
java.lang.String	getTaskTitle() A helpful title describing the operation for the user.
void	run(TaskProgressListener progressListener) The "work" function.
void	writeToFile(java.io.File file)
void	writeToFile(java.io.Writer out)

Methods inherited from class java.lang.Object

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

Constructor Detail

Exporter

public Exporter(java.util.List<ScanClass> values)

Exporter

public Exporter(java.io.File targetFile,
                java.util.List<ScanClass> values)

Method Detail

writeToFile

public void writeToFile(java.io.File file)
                 throws java.io.IOException

Specified by:

writeToFile in interface ClientFileUtilities.FileWritingTask

Overrides:

writeToFile in class ClientFileUtilities.CharFileWritingTask

Throws:

java.io.IOException

getTaskTitle

public java.lang.String getTaskTitle()

Description copied from interface: AsyncClientTask

A helpful title describing the operation for the user.

Specified by:

getTaskTitle in interface AsyncClientTask

canCancel

public boolean canCancel()

Description copied from interface: AsyncClientTask

Whether or not the user is allowed to cancel the operation.

Specified by:

canCancel in interface AsyncClientTask

run

public void run(TaskProgressListener progressListener)
         throws java.lang.Exception

Description copied from interface: AsyncClientTask

The "work" function. Should update the progressListener of status, and check whether the operation has been canceled, if applicable. Should throw an exception on failure.

Specified by:

run in interface AsyncClientTask

Throws:

java.lang.Exception

writeToFile

public void writeToFile(java.io.Writer out)
                 throws java.io.IOException

Specified by:

writeToFile in class ClientFileUtilities.CharFileWritingTask

Throws:

java.io.IOException