IDAREReaderSetupTask (IDARE 2.0 API)

java.lang.Object
- idare.imagenode.Interfaces.DataSetReaders.IDAREReaderSetupTask

All Implemented Interfaces:

org.cytoscape.work.Task
```
public abstract class IDAREReaderSetupTask
extends Object
implements org.cytoscape.work.Task
```
An Abstract Basis Class that defines a Task that is necessary to set up a reader for dataset parsing. The reader can use this Task to obtain a set of Tunables that can be defined in this Task if the corresponding TunableHandler is defined. This Task should NOT add additional Tasks

Author:

Thomas Pfau

Constructor Summary

Constructors
Constructor Description

IDAREReaderSetupTask(IDAREDatasetReader reader)
Default constructor using the reader this Task is supposed to set up.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`cancel()`
`abstract void`	`execute(org.cytoscape.work.TaskMonitor taskMonitor)`	Execute the Task.
`void`	`run(org.cytoscape.work.TaskMonitor taskMonitor)`	Runs the Task specified by the execute method and catches any exception, converting the exception into a status message.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - IDAREReaderSetupTask
```
public IDAREReaderSetupTask(IDAREDatasetReader reader)
```
    Default constructor using the reader this Task is supposed to set up.
    
    Parameters:
    
    reader - the DataSetReader to use
- Method Detail
  - execute
```
public abstract void execute(org.cytoscape.work.TaskMonitor taskMonitor)
                      throws Exception
```
    Execute the Task.
    
    Parameters:
    
    taskMonitor - the TaskMonitor this Task can use.
    
    Throws:
    
    Exception - Multiple Exceptions passed on from Cytoscape
  - run
```
public final void run(org.cytoscape.work.TaskMonitor taskMonitor)
               throws Exception
```
    Runs the Task specified by the execute method and catches any exception, converting the exception into a status message. Also updates the statusMessage to indicate the reader is ready if the Task completes without errors.
    
    Specified by:
    
    run in interface org.cytoscape.work.Task
    
    Throws:
    
    Exception
  - cancel
```
public void cancel()
```
    Specified by:
    
    cancel in interface org.cytoscape.work.Task