DataManager (LOCI Javadocs 0-SNAPSHOT API)

java.lang.Object
- loci.visbio.LogicManager
- - loci.visbio.data.DataManager

All Implemented Interfaces:

Saveable
```
public class DataManager
extends LogicManager
```
DataManager is the manager encapsulating VisBio's data transform logic.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`AUTO_THUMBS` String for thumbnail auto-generation option.
`protected DataControls`	`dataControls` Datasets control panel.
`protected static int`	`DEFAULT_THUMBNAIL_RESOLUTION` Default resolution for low-resolution thumbnails.
`protected static String`	`SAMPLE_PREFIX` URL prefix for sample datasets.
`static String`	`THUMB_RES` String for thumbnail resolution option.
`protected Vector<String>`	`transformLabels` List of registered data transform type labels.
`protected Vector<Class<?>>`	`transformTypes` List of registered data transform type classes.

Fields inherited from class loci.visbio.LogicManager
bio

Constructor Summary

Constructors
Constructor and Description

DataManager(VisBioFrame bio)
Constructs a dataset manager.

Constructors
Constructor and Description
`DataManager(VisBioFrame bio)` Constructs a dataset manager.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addData(DataTransform data)` Adds a data object to the list.
`void`	`createDataset(String name, String pattern, BioTask bioTask)` Creates a dataset, updating the given task object as things progress.
`void`	`doEvent(VisBioEvent evt)` Called to notify the logic manager of a VisBio event.
`void`	`exportData()` Exports the selected data object to disk.
`void`	`exportData(ImageTransform data)` Exports the given data object to disk.
`boolean`	`getAutoThumbGen()` Gets whether low-resolution thumbnails should be automatically generated from VisBio options.
`DataControls`	`getControls()` Gets associated control panel.
`DataTransform`	`getDataById(int id)` Gets the data transform with the associated ID.
`Vector<DataTransform>`	`getDataList()` Gets a list of data transforms present in the tree.
`DefaultMutableTreeNode`	`getDataRoot()` Gets the root node of the data object tree.
`String[]`	`getRegisteredDataLabels()` Gets list of regitered data transform labels.
`Class<?>[]`	`getRegisteredDataTypes()` Gets list of registered data transform types.
`DataTransform`	`getSelectedData()` Gets the currently selected data object.
`int`	`getTasks()` Gets the number of tasks required to initialize this logic manager.
`int[]`	`getThumbnailResolution()` Gets resolution of low-resolution thumbnails from VisBio options.
`void`	`importData()` Imports a dataset.
`void`	`importData(Component parent)` Imports a dataset, using the given parent component for user dialogs.
`void`	`openSampleData(String name)` Loads the given sample dataset.
`void`	`registerDataType(Class<?> c, String label)` Registers the given subclass of DataTransform with the data manager, using the given label as a description.
`void`	`removeData(DataTransform data)` Removes a data object from the list.
`void`	`removeData(DataTransform data, boolean confirm)` Removes a data object from the list.
`void`	`restoreState(Element el)` Restores the current state from the given DOM element ("VisBio").
`void`	`saveState(Element el)` Writes the current state to the given DOM element ("VisBio").
`void`	`sendDataToImageJ()` Sends the selected data object to an instance of ImageJ.
`void`	`sendDataToImageJ(ImageTransform data)` Sends the given data object to an instance of ImageJ.
`void`	`showControls(DataTransform data)` Shows dialog containing controls for the given data object.

Methods inherited from class loci.visbio.LogicManager
getVisBio

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

- Field Detail
  - SAMPLE_PREFIX
```
protected static final String SAMPLE_PREFIX
```
    URL prefix for sample datasets.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_THUMBNAIL_RESOLUTION
```
protected static final int DEFAULT_THUMBNAIL_RESOLUTION
```
    Default resolution for low-resolution thumbnails.
    
    See Also:
    
    Constant Field Values
  - AUTO_THUMBS
```
public static final String AUTO_THUMBS
```
    String for thumbnail auto-generation option.
    
    See Also:
    
    Constant Field Values
  - THUMB_RES
```
public static final String THUMB_RES
```
    String for thumbnail resolution option.
    
    See Also:
    
    Constant Field Values
  - dataControls
```
protected DataControls dataControls
```
    Datasets control panel.
  - transformTypes
```
protected Vector<Class<?>> transformTypes
```
    List of registered data transform type classes.
  - transformLabels
```
protected Vector<String> transformLabels
```
    List of registered data transform type labels.
- Constructor Detail
  - DataManager
```
public DataManager(VisBioFrame bio)
```
    Constructs a dataset manager.
- Method Detail
  - addData
```
public void addData(DataTransform data)
```
    Adds a data object to the list.
  - removeData
```
public void removeData(DataTransform data)
```
    Removes a data object from the list.
  - removeData
```
public void removeData(DataTransform data,
                       boolean confirm)
```
    Removes a data object from the list.
  - getDataRoot
```
public DefaultMutableTreeNode getDataRoot()
```
    Gets the root node of the data object tree.
  - getSelectedData
```
public DataTransform getSelectedData()
```
    Gets the currently selected data object.
  - showControls
```
public void showControls(DataTransform data)
```
    Shows dialog containing controls for the given data object.
  - registerDataType
```
public void registerDataType(Class<?> c,
                             String label)
```
    Registers the given subclass of DataTransform with the data manager, using the given label as a description.
  - getRegisteredDataTypes
```
public Class<?>[] getRegisteredDataTypes()
```
    Gets list of registered data transform types.
  - getRegisteredDataLabels
```
public String[] getRegisteredDataLabels()
```
    Gets list of regitered data transform labels.
  - getDataList
```
public Vector<DataTransform> getDataList()
```
    Gets a list of data transforms present in the tree.
  - getDataById
```
public DataTransform getDataById(int id)
```
    Gets the data transform with the associated ID.
  - importData
```
public void importData()
```
    Imports a dataset.
  - importData
```
public void importData(Component parent)
```
    Imports a dataset, using the given parent component for user dialogs.
  - exportData
```
public void exportData()
```
    Exports the selected data object to disk.
  - exportData
```
public void exportData(ImageTransform data)
```
    Exports the given data object to disk.
  - sendDataToImageJ
```
public void sendDataToImageJ()
```
    Sends the selected data object to an instance of ImageJ.
  - sendDataToImageJ
```
public void sendDataToImageJ(ImageTransform data)
```
    Sends the given data object to an instance of ImageJ.
  - openSampleData
```
public void openSampleData(String name)
```
    Loads the given sample dataset. If one with the given name already exists in the samples cache, it is used. Otherwise, it is downloaded from the VisBio site and stored in the cache first.
  - createDataset
```
public void createDataset(String name,
                          String pattern,
                          BioTask bioTask)
```
    Creates a dataset, updating the given task object as things progress. If no task object is given, a new one is created to use.
  - getAutoThumbGen
```
public boolean getAutoThumbGen()
```
    Gets whether low-resolution thumbnails should be automatically generated from VisBio options.
  - getThumbnailResolution
```
public int[] getThumbnailResolution()
```
    Gets resolution of low-resolution thumbnails from VisBio options.
  - getControls
```
public DataControls getControls()
```
    Gets associated control panel.
  - doEvent
```
public void doEvent(VisBioEvent evt)
```
    Called to notify the logic manager of a VisBio event.
    
    Overrides:
    
    doEvent in class LogicManager
  - getTasks
```
public int getTasks()
```
    Gets the number of tasks required to initialize this logic manager.
    
    Overrides:
    
    getTasks in class LogicManager
  - saveState
```
public void saveState(Element el)
               throws SaveException
```
    Writes the current state to the given DOM element ("VisBio").
    
    Specified by:
    
    saveState in interface Saveable
    
    Overrides:
    
    saveState in class LogicManager
    
    Throws:
    
    SaveException
  - restoreState
```
public void restoreState(Element el)
                  throws SaveException
```
    Restores the current state from the given DOM element ("VisBio").
    
    Specified by:
    
    restoreState in interface Saveable
    
    Overrides:
    
    restoreState in class LogicManager
    
    Throws:
    
    SaveException

Class DataManager

Field Summary

Fields inherited from class loci.visbio.LogicManager

Constructor Summary

Method Summary

Methods inherited from class loci.visbio.LogicManager

Methods inherited from class java.lang.Object

Field Detail

SAMPLE_PREFIX

DEFAULT_THUMBNAIL_RESOLUTION

AUTO_THUMBS

THUMB_RES

dataControls

transformTypes

transformLabels

Constructor Detail

DataManager

Method Detail

addData

removeData

removeData

getDataRoot

getSelectedData

showControls

registerDataType

getRegisteredDataTypes

getRegisteredDataLabels

getDataList

getDataById

importData

importData

exportData

exportData

sendDataToImageJ

sendDataToImageJ

openSampleData

createDataset

getAutoThumbGen

getThumbnailResolution

getControls

doEvent

getTasks

saveState

restoreState