Module io.scif

Package io.scif.services

Class DefaultDatasetIOService

java.lang.Object

org.scijava.AbstractContextual

org.scijava.plugin.AbstractRichPlugin

org.scijava.service.AbstractService

io.scif.services.DefaultDatasetIOService

All Implemented Interfaces:

SCIFIOService, DatasetIOService, Comparable<org.scijava.Prioritized>, org.scijava.Contextual, org.scijava.Disposable, org.scijava.Identifiable, org.scijava.Initializable, org.scijava.Locatable, org.scijava.log.Logged, org.scijava.plugin.HasPluginInfo, org.scijava.plugin.RichPlugin, org.scijava.plugin.SciJavaPlugin, org.scijava.Prioritized, org.scijava.service.Service, org.scijava.Versioned

public class DefaultDatasetIOService
extends org.scijava.service.AbstractService
implements DatasetIOService

Default DatasetIOService implementation.

Author:

Mark Hiner

Constructor Summary

Constructors

Constructor	Description
DefaultDatasetIOService()

Method Summary

Modifier and Type	Method	Description
boolean	canOpen(String source)	Determines whether the given source can be opened as a Dataset using the DatasetIOService.open(Location) method.
boolean	canOpen(org.scijava.io.location.Location source)	Determines whether the given source can be opened as a Dataset using the DatasetIOService.open(Location) method.
boolean	canSave(org.scijava.io.location.Location destination)	Determines whether the given destination can be used to save a Dataset using the DatasetIOService.save(Dataset, Location) method.
net.imagej.Dataset	open(String source)
net.imagej.Dataset	open(String source, SCIFIOConfig config)	Loads a dataset from a source (such as a file on disk).
net.imagej.Dataset	open(org.scijava.io.location.Location source)	Loads a dataset from a source (such as a file on disk).
net.imagej.Dataset	open(org.scijava.io.location.Location source, SCIFIOConfig config)	As DatasetIOService.open(Location), with the given io.scif.config.SCIFIOConfig.
List<net.imagej.Dataset>	openAll(String source)
List<net.imagej.Dataset>	openAll(String source, SCIFIOConfig config)
List<net.imagej.Dataset>	openAll(org.scijava.io.location.Location source)	Load all the datasets from a given source.
List<net.imagej.Dataset>	openAll(org.scijava.io.location.Location source, SCIFIOConfig config)	As DatasetIOService.openAll(Location), with a given io.scif.config.SCIFIOConfig.
Metadata	save(net.imagej.Dataset dataset, String destination)	Saves a dataset to a destination (such as a file on disk).
Metadata	save(net.imagej.Dataset dataset, String destination, SCIFIOConfig config)	Saves a dataset to a destination (such as a file on disk).
Metadata	save(net.imagej.Dataset dataset, org.scijava.io.location.Location destination)	Saves a dataset to a destination (such as a file on disk).
Metadata	save(net.imagej.Dataset dataset, org.scijava.io.location.Location destination, SCIFIOConfig config)	Saves a dataset to a destination (such as a file on disk).

Methods inherited from class org.scijava.service.AbstractService

getContext, setContext, toString

Methods inherited from class org.scijava.plugin.AbstractRichPlugin

getInfo, getPriority, setInfo, setPriority

Methods inherited from class org.scijava.AbstractContextual

context

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.scijava.Contextual

context, getContext, setContext

Methods inherited from interface org.scijava.Disposable

dispose

Methods inherited from interface org.scijava.plugin.HasPluginInfo

getInfo, setInfo

Methods inherited from interface org.scijava.Locatable

getLocation

Methods inherited from interface org.scijava.Prioritized

compareTo, getPriority, setPriority

Methods inherited from interface org.scijava.plugin.RichPlugin

getIdentifier, log

Methods inherited from interface org.scijava.service.Service

initialize, registerEventHandlers

Methods inherited from interface org.scijava.Versioned

getVersion

Constructor Detail

DefaultDatasetIOService

public DefaultDatasetIOService()

Method Detail

canOpen

public boolean canOpen(org.scijava.io.location.Location source)

Description copied from interface: DatasetIOService

Determines whether the given source can be opened as a Dataset using the DatasetIOService.open(Location) method.

Specified by:

canOpen in interface DatasetIOService

canOpen

public boolean canOpen(String source)

Description copied from interface: DatasetIOService

Determines whether the given source can be opened as a Dataset using the DatasetIOService.open(Location) method.

Specified by:

canOpen in interface DatasetIOService

canSave

public boolean canSave(org.scijava.io.location.Location destination)

Description copied from interface: DatasetIOService

Determines whether the given destination can be used to save a Dataset using the DatasetIOService.save(Dataset, Location) method.

Specified by:

canSave in interface DatasetIOService

open

public net.imagej.Dataset open(org.scijava.io.location.Location source)
                        throws IOException

Description copied from interface: DatasetIOService

Loads a dataset from a source (such as a file on disk).

Specified by:

open in interface DatasetIOService

Throws:

IOException

open

public net.imagej.Dataset open(String source)
                        throws IOException

Specified by:

open in interface DatasetIOService

Throws:

IOException

See Also:

DatasetIOService.open(Location)

open

public net.imagej.Dataset open(org.scijava.io.location.Location source,
                               SCIFIOConfig config)
                        throws IOException

Description copied from interface: DatasetIOService

As DatasetIOService.open(Location), with the given io.scif.config.SCIFIOConfig.

Specified by:

open in interface DatasetIOService

Throws:

IOException

open

public net.imagej.Dataset open(String source,
                               SCIFIOConfig config)
                        throws IOException

Description copied from interface: DatasetIOService

Loads a dataset from a source (such as a file on disk).

Specified by:

open in interface DatasetIOService

Throws:

IOException

openAll

public List<net.imagej.Dataset> openAll(org.scijava.io.location.Location source)
                                 throws IOException

Description copied from interface: DatasetIOService

Load all the datasets from a given source. (Useful for files containing image series)

Specified by:

openAll in interface DatasetIOService

Parameters:

source - the source location of the images

Returns:

a list of all datasets contained by the image file.

Throws:

IOException

openAll

public List<net.imagej.Dataset> openAll(String source)
                                 throws IOException

Specified by:

openAll in interface DatasetIOService

Throws:

IOException

See Also:

DatasetIOService.openAll(Location)

openAll

public List<net.imagej.Dataset> openAll(String source,
                                        SCIFIOConfig config)
                                 throws IOException

Specified by:

openAll in interface DatasetIOService

Throws:

IOException

See Also:

DatasetIOService.openAll(Location)

openAll

public List<net.imagej.Dataset> openAll(org.scijava.io.location.Location source,
                                        SCIFIOConfig config)
                                 throws IOException

Description copied from interface: DatasetIOService

As DatasetIOService.openAll(Location), with a given io.scif.config.SCIFIOConfig.

Specified by:

openAll in interface DatasetIOService

Parameters:

source - path on the disk

config - SCIFIOConfig file

Returns:

a list of all datasets contained by the image file.

Throws:

IOException

save

public Metadata save(net.imagej.Dataset dataset,
                     String destination)
              throws IOException

Description copied from interface: DatasetIOService

Saves a dataset to a destination (such as a file on disk).

Specified by:

save in interface DatasetIOService

Parameters:

dataset - The dataset to save.

destination - Where the dataset should be saved (e.g., a file path on disk).

Throws:

IOException

save

public Metadata save(net.imagej.Dataset dataset,
                     org.scijava.io.location.Location destination)
              throws IOException

Description copied from interface: DatasetIOService

Saves a dataset to a destination (such as a file on disk).

Specified by:

save in interface DatasetIOService

Parameters:

dataset - The dataset to save.

destination - Where the dataset should be saved (e.g., a file path on disk).

Throws:

IOException

save

public Metadata save(net.imagej.Dataset dataset,
                     String destination,
                     SCIFIOConfig config)
              throws IOException

Description copied from interface: DatasetIOService

Saves a dataset to a destination (such as a file on disk).

Specified by:

save in interface DatasetIOService

Parameters:

dataset - The dataset to save.

destination - Where the dataset should be saved (e.g., a file path on disk).

config - The io.scif.config.SCIFIOConfig describing how the data should be saved.

Throws:

IOException

save

public Metadata save(net.imagej.Dataset dataset,
                     org.scijava.io.location.Location destination,
                     SCIFIOConfig config)
              throws IOException

Description copied from interface: DatasetIOService

Saves a dataset to a destination (such as a file on disk).

Specified by:

save in interface DatasetIOService

Parameters:

dataset - The dataset to save.

destination - Where the dataset should be saved (e.g., a file path on disk).

config - The io.scif.config.SCIFIOConfig describing how the data should be saved.

Throws:

IOException