ImageListener (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- fsalign.ImageListener

All Implemented Interfaces:

FileListener, Runnable, EventListener

Direct Known Subclasses:

FSAlignListener
```
public abstract class ImageListener
extends Object
implements FileListener, Runnable
```
Author:

Larry Lindsey

Constructor Summary

Constructors
Constructor and Description

ImageListener()

Constructors
Constructor and Description
`ImageListener()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`dropImage(File file)`
`void`	`dropImage(String path)` Remove the ImagePlus at the given path from the HashTable mapping them together.
`protected boolean`	`fileIsReady(File imageFile)` Checks whether an image file is ready, in the sense that it has been completely written to disk.
`ij.ImagePlus`	`getImageFromPath(File file)`
`ij.ImagePlus`	`getImageFromPath(String path)` Returns an ImagePlus given a path String.
`void`	`handle(FolderWatcher fw)` Handles a new file event passed by a FolderWatcher.
`static FolderWatcher`	`imageFolderWatcher(String folderName, int interval, ImageListener imageListener, String regexp)` Create a FolderWatcher to watch the given folder
`boolean`	`isEnabled()`
`protected abstract void`	`processImage(File imageFile)` An inheriting class should implement a method that processes each image file as it is popped from the queue.
`void`	`run()`
`void`	`setEnabled(boolean go)`
`void`	`stop()` Causes this ImageListener to quit

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

- Constructor Detail
  - ImageListener
```
public ImageListener()
```
- Method Detail
  - imageFolderWatcher
```
public static FolderWatcher imageFolderWatcher(String folderName,
                                               int interval,
                                               ImageListener imageListener,
                                               String regexp)
```
    Create a FolderWatcher to watch the given folder
    
    Parameters:
    
    folderName - the folder to watch
    
    interval - the poll interval
    
    imageListener - the ImageListener to use
    
    regexp - the regular expression used to match image files.
    
    Returns:
    
    a new FolderWatcher to watch the given folder
  - handle
```
public void handle(FolderWatcher fw)
```
    Handles a new file event passed by a FolderWatcher. The FolderWatcher passes itself as a parameter.
    
    Specified by:
    
    handle in interface FileListener
    
    Parameters:
    
    fw - the FolderWatcher calling this method
  - setEnabled
```
public void setEnabled(boolean go)
```
  - isEnabled
```
public boolean isEnabled()
```
  - run
```
public void run()
```
    Specified by:
    
    run in interface Runnable
  - stop
```
public void stop()
```
    Causes this ImageListener to quit
    
    Specified by:
    
    stop in interface FileListener
  - getImageFromPath
```
public ij.ImagePlus getImageFromPath(File file)
```
  - dropImage
```
public void dropImage(File file)
```
  - dropImage
```
public void dropImage(String path)
```
    Remove the ImagePlus at the given path from the HashTable mapping them together. The purpose of this function is to help with garbage collection.
    
    Parameters:
    
    path - the path keying the given ImagePlus
  - getImageFromPath
```
public ij.ImagePlus getImageFromPath(String path)
```
    Returns an ImagePlus given a path String. To check whether an image file is ready, an ImageListener attempts to open it as an ImagePlus. If a non-null ImagePlus is returned by IJ.open, the image is determined to be ready. In that case, in order to avoid duplication of effort, the ImagePlus is stored in a HashTable (which is synchronized), and keyed to its path. This function returns that already-opened ImagePlus for user further down the line.
    
    Parameters:
    
    path - the path of the given ImagePlus
    
    Returns:
    
    the ImagePlus that was previously opened from the given path by this ImageListener.
  - fileIsReady
```
protected boolean fileIsReady(File imageFile)
```
    Checks whether an image file is ready, in the sense that it has been completely written to disk. This is determined by whether it can be opened as a non-null ImagePlus.
    
    Parameters:
    
    imageFile - the File representing the image file to test.
    
    Returns:
    
    true if the image is ready, false otherwise.
  - processImage
```
protected abstract void processImage(File imageFile)
```
    An inheriting class should implement a method that processes each image file as it is popped from the queue. Images are popped in order of modification time.
    
    Parameters:
    
    imageFile - the image File to process

Class ImageListener

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ImageListener

Method Detail

imageFolderWatcher

handle

setEnabled

isEnabled

run

stop

getImageFromPath

dropImage

dropImage

getImageFromPath

fileIsReady

processImage