ImportProcess (Bio-Formats API)

java.lang.Object
- loci.plugins.in.ImportProcess

All Implemented Interfaces:

StatusReporter
```
public class ImportProcess
extends java.lang.Object
implements StatusReporter
```
Manages the import preparation process. After calling execute(), the process will be ready to feed to an ImagePlusReader to read in the actual ImagePlus objects.
Source code:

Trac, Gitweb

Field Summary

Fields
Modifier and Type Field and Description

protected Location idLoc

protected java.lang.String idName

protected IMetadata meta

Fields
Modifier and Type	Field and Description
`protected Location`	`idLoc`
`protected java.lang.String`	`idName`
`protected IMetadata`	`meta`

Constructor Summary

Constructors
Constructor and Description

ImportProcess()

ImportProcess(ImporterOptions options)

Constructors
Constructor and Description
`ImportProcess()`
`ImportProcess(ImporterOptions options)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addStatusListener(StatusListener l)`
`void`	`cancel()` Cancels the import process.
`boolean`	`execute()` Performs the import preparation process, notifying status listeners at each step.
`IFormatReader`	`getBaseReader()` Valid only after `ImportStep.READER`.
`int`	`getCBegin(int s)`
`int`	`getCCount(int s)` Valid only after `ImportStep.SERIES`.
`int`	`getCEnd(int s)` Valid only after `ImportStep.STACK`.
`ChannelFiller`	`getChannelFiller()` Valid only after `ImportStep.STACK`.
`ChannelSeparator`	`getChannelSeparator()` Valid only after `ImportStep.STACK`.
`Region`	`getCropRegion(int s)` Valid only after `ImportStep.STACK`.
`int`	`getCStep(int s)`
`java.lang.String`	`getCurrentFile()` Valid only after `ImportStep.STACK`.
`DimensionSwapper`	`getDimensionSwapper()` Valid only after `ImportStep.STACK`.
`FileStitcher`	`getFileStitcher()` Valid only after `ImportStep.STACK`.
`Location`	`getIdLocation()` Valid only after `ImportStep.READER`.
`java.lang.String`	`getIdName()` Valid only after `ImportStep.READER`.
`ImageReader`	`getImageReader()` Valid only after `ImportStep.READER`.
`long`	`getMemoryUsage()` Gets a projection of required memory in bytes.
`MinMaxCalculator`	`getMinMaxCalculator()` Valid only after `ImportStep.STACK`.
`IMetadata`	`getOMEMetadata()` Valid only after `ImportStep.READER`.
`java.lang.String`	`getOMEXML()` Valid only after `ImportStep.READER`.
`ImporterOptions`	`getOptions()`
`ImporterMetadata`	`getOriginalMetadata()` Valid only after `ImportStep.METADATA`.
`ImageProcessorReader`	`getReader()` Valid only after `ImportStep.STACK`.
`int`	`getSeriesCount()` Valid only after `ImportStep.STACK`.
`java.lang.String`	`getSeriesLabel(int s)` Valid only after `ImportStep.STACK`.
`java.lang.String`	`getStackOrder()` Valid only after `ImportStep.STACK`.
`int`	`getTBegin(int s)`
`int`	`getTCount(int s)` Valid only after `ImportStep.SERIES`.
`int`	`getTEnd(int s)` Valid only after `ImportStep.STACK`.
`int`	`getTStep(int s)`
`VirtualReader`	`getVirtualReader()` Valid only after `ImportStep.STACK`.
`int`	`getZBegin(int s)`
`int`	`getZCount(int s)` Valid only after `ImportStep.SERIES`.
`int`	`getZEnd(int s)` Valid only after `ImportStep.STACK`.
`int`	`getZStep(int s)`
`boolean`	`isWindowless()`
`void`	`notifyListeners(StatusEvent e)`
`void`	`removeStatusListener(StatusListener l)`
`void`	`setSeriesList(java.lang.String seriesList)`
`boolean`	`wasCanceled()` Gets whether the import process was canceled.

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

- Field Detail
  - idName
```
protected java.lang.String idName
```
  - idLoc
```
protected Location idLoc
```
  - meta
```
protected IMetadata meta
```
- Constructor Detail
  - ImportProcess
```
public ImportProcess()
              throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - ImportProcess
```
public ImportProcess(ImporterOptions options)
```
- Method Detail
  - execute
```
public boolean execute()
                throws FormatException,
                       java.io.IOException
```
    Performs the import preparation process, notifying status listeners at each step.
    
    Returns:
    true if the preparation process completed successfully.
    
    Throws:
    
    FormatException
    
    java.io.IOException
  - cancel
```
public void cancel()
```
    Cancels the import process.
  - wasCanceled
```
public boolean wasCanceled()
```
    Gets whether the import process was canceled.
  - getOptions
```
public ImporterOptions getOptions()
```
  - isWindowless
```
public boolean isWindowless()
```
  - setSeriesList
```
public void setSeriesList(java.lang.String seriesList)
```
  - getBaseReader
```
public IFormatReader getBaseReader()
```
    Valid only after ImportStep.READER.
  - getImageReader
```
public ImageReader getImageReader()
```
    Valid only after ImportStep.READER.
  - getIdName
```
public java.lang.String getIdName()
```
    Valid only after ImportStep.READER.
  - getIdLocation
```
public Location getIdLocation()
```
    Valid only after ImportStep.READER.
  - getOMEMetadata
```
public IMetadata getOMEMetadata()
```
    Valid only after ImportStep.READER.
  - getOMEXML
```
public java.lang.String getOMEXML()
```
    Valid only after ImportStep.READER.
  - getFileStitcher
```
public FileStitcher getFileStitcher()
```
    Valid only after ImportStep.STACK.
  - getChannelFiller
```
public ChannelFiller getChannelFiller()
```
    Valid only after ImportStep.STACK.
  - getChannelSeparator
```
public ChannelSeparator getChannelSeparator()
```
    Valid only after ImportStep.STACK.
  - getDimensionSwapper
```
public DimensionSwapper getDimensionSwapper()
```
    Valid only after ImportStep.STACK.
  - getMinMaxCalculator
```
public MinMaxCalculator getMinMaxCalculator()
```
    Valid only after ImportStep.STACK.
  - getVirtualReader
```
public VirtualReader getVirtualReader()
```
    Valid only after ImportStep.STACK.
  - getReader
```
public ImageProcessorReader getReader()
```
    Valid only after ImportStep.STACK.
  - getCurrentFile
```
public java.lang.String getCurrentFile()
```
    Valid only after ImportStep.STACK.
  - getSeriesCount
```
public int getSeriesCount()
```
    Valid only after ImportStep.STACK.
  - getSeriesLabel
```
public java.lang.String getSeriesLabel(int s)
```
    Valid only after ImportStep.STACK.
  - getStackOrder
```
public java.lang.String getStackOrder()
```
    Valid only after ImportStep.STACK.
  - getCBegin
```
public int getCBegin(int s)
```
  - getCEnd
```
public int getCEnd(int s)
```
    Valid only after ImportStep.STACK.
  - getCStep
```
public int getCStep(int s)
```
  - getZBegin
```
public int getZBegin(int s)
```
  - getZEnd
```
public int getZEnd(int s)
```
    Valid only after ImportStep.STACK.
  - getZStep
```
public int getZStep(int s)
```
  - getTBegin
```
public int getTBegin(int s)
```
  - getTEnd
```
public int getTEnd(int s)
```
    Valid only after ImportStep.STACK.
  - getTStep
```
public int getTStep(int s)
```
  - getCropRegion
```
public Region getCropRegion(int s)
```
    Valid only after ImportStep.STACK.
  - getCCount
```
public int getCCount(int s)
```
    Valid only after ImportStep.SERIES.
  - getZCount
```
public int getZCount(int s)
```
    Valid only after ImportStep.SERIES.
  - getTCount
```
public int getTCount(int s)
```
    Valid only after ImportStep.SERIES.
  - getMemoryUsage
```
public long getMemoryUsage()
```
    Gets a projection of required memory in bytes. Valid only after ImportStep.SERIES.
  - getOriginalMetadata
```
public ImporterMetadata getOriginalMetadata()
```
    Valid only after ImportStep.METADATA.
  - addStatusListener
```
public void addStatusListener(StatusListener l)
```
    Specified by:
    
    addStatusListener in interface StatusReporter
  - removeStatusListener
```
public void removeStatusListener(StatusListener l)
```
    Specified by:
    
    removeStatusListener in interface StatusReporter
  - notifyListeners
```
public void notifyListeners(StatusEvent e)
```
    Specified by:
    
    notifyListeners in interface StatusReporter

Class ImportProcess

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

idName

idLoc

meta

Constructor Detail

ImportProcess

ImportProcess

Method Detail

execute

cancel

wasCanceled

getOptions

isWindowless

setSeriesList

getBaseReader

getImageReader

getIdName

getIdLocation

getOMEMetadata

getOMEXML

getFileStitcher

getChannelFiller

getChannelSeparator

getDimensionSwapper

getMinMaxCalculator

getVirtualReader

getReader

getCurrentFile

getSeriesCount

getSeriesLabel

getStackOrder

getCBegin

getCEnd

getCStep

getZBegin

getZEnd

getZStep

getTBegin

getTEnd

getTStep

getCropRegion

getCCount

getZCount

getTCount

getMemoryUsage

getOriginalMetadata

addStatusListener

removeStatusListener

notifyListeners