ome.formats.importer

Class ImportCandidates.SCANNING

java.lang.Object

ome.formats.importer.ImportEvent

ome.formats.importer.ImportCandidates.SCANNING

Enclosing class:

ImportCandidates

public static class ImportCandidates.SCANNING
extends ImportEvent

Event raised during a pass through the directory structure given to ImportCandidates. A Scanning event will not necessarily be raised for every file or directory, but the values will be valid for each event. If totalFiles is less than 0, then the directory is currently be scanned and the count is unknown. Once totalFiles is positive, it will remain constant. If cancel() is called, then directory searching will cease. The ImportCandidates instance will be left with no ImportContainers.

Nested Class Summary

Nested classes/interfaces inherited from class ome.formats.importer.ImportEvent

ImportEvent.ADD, ImportEvent.BEGIN_POST_PROCESS, ImportEvent.BEGIN_SAVE_TO_DB, ImportEvent.COUNT_EVENT, ImportEvent.DATA_STORED, ImportEvent.DATASET_STORED, ImportEvent.DEBUG_SEND, ImportEvent.END_POST_PROCESS, ImportEvent.END_SAVE_TO_DB, ImportEvent.ERRORS_COMPLETE, ImportEvent.ERRORS_FAILED, ImportEvent.ERRORS_PENDING, ImportEvent.FILE_UPLOAD_BYTES, ImportEvent.FILE_UPLOAD_CANCELLED, ImportEvent.FILE_UPLOAD_COMPLETE, ImportEvent.FILE_UPLOAD_ERROR, ImportEvent.FILE_UPLOAD_EVENT, ImportEvent.FILE_UPLOAD_FAILED, ImportEvent.FILE_UPLOAD_FINISHED, ImportEvent.FILE_UPLOAD_STARTED, ImportEvent.FILESET_EXCLUSION, ImportEvent.FILESET_UPLOAD_END, ImportEvent.FILESET_UPLOAD_PREPARATION, ImportEvent.FILESET_UPLOAD_START, ImportEvent.IMPORT_ARCHIVING, ImportEvent.IMPORT_DONE, ImportEvent.IMPORT_OVERLAYS, ImportEvent.IMPORT_PROCESSING, ImportEvent.IMPORT_STARTED, ImportEvent.IMPORT_STEP, ImportEvent.IMPORT_SUMMARY, ImportEvent.LOADED_IMAGE, ImportEvent.LOADING_IMAGE, ImportEvent.LOGGED_IN, ImportEvent.LOGGED_OUT, ImportEvent.METADATA_IMPORTED, ImportEvent.METADATA_PROCESSED, ImportEvent.OBJECTS_RETURNED, ImportEvent.PIXELDATA_PROCESSED, ImportEvent.POST_UPLOAD_EVENT, ImportEvent.PROGRESS_EVENT, ImportEvent.REIMPORT, ImportEvent.THUMBNAILS_GENERATED

Field Summary

Fields

Modifier and Type	Field and Description
int	depth
File	file
int	numFiles
int	totalFiles

Fields inherited from class ome.formats.importer.ImportEvent

GROUP_COLLAB_READ, GROUP_COLLAB_READ_LINK, GROUP_PRIVATE, GROUP_PUBLIC, GROUP_SYSTEM

Constructor Summary

Constructors

Constructor and Description
ImportCandidates.SCANNING(File file, int depth, int numFiles, int totalFiles)

Method Summary

Methods

Modifier and Type	Method and Description
void	cancel() Can be called to cancel the current action.
String	toLog()

Methods inherited from class java.lang.Object

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

Field Detail

file

public final File file

depth

public final int depth

numFiles

public final int numFiles

totalFiles

public final int totalFiles

Constructor Detail

ImportCandidates.SCANNING

public ImportCandidates.SCANNING(File file,
                         int depth,
                         int numFiles,
                         int totalFiles)

Method Detail

cancel

public void cancel()

Can be called to cancel the current action.

toLog

public String toLog()

Overrides:

toLog in class ImportEvent