io.scif.services

Class DefaultFormatService

java.lang.Object

org.scijava.AbstractContextual

org.scijava.plugin.AbstractRichPlugin

org.scijava.service.AbstractService

io.scif.services.DefaultFormatService

All Implemented Interfaces:

SCIFIOService, FormatService, 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 DefaultFormatService
extends org.scijava.service.AbstractService
implements FormatService

Default FormatService implementation

Author:

Mark Hiner

See Also:

FormatService

Field Summary

Fields inherited from interface io.scif.services.FormatService

PRIORITY

Constructor Summary

Constructors

Constructor and Description
DefaultFormatService()

Method Summary

Modifier and Type	Method and Description
void	addComponents(Format format) Creates mappings between this Format and its components.
boolean	addFormat(Format format) Makes the provided Format available for image IO operations in this context.
Set<Format>	getAllFormats() Returns a list of all Formats within this context.
Format	getFormat(org.scijava.io.handle.DataHandle<org.scijava.io.location.Location> source) As FormatService.getFormat(Location) but takes an initialized DataHandle.
Format	getFormat(org.scijava.io.handle.DataHandle<org.scijava.io.location.Location> source, SCIFIOConfig config) As FormatService.getFormat(Location, SCIFIOConfig) but takes an initialized DataHandle.
Format	getFormat(org.scijava.io.location.Location id) Returns the first Format known to be compatible with the source provided.
Format	getFormat(org.scijava.io.location.Location id, SCIFIOConfig config) Returns the first Format known to be compatible with the source provided.
<C extends Checker> Format	getFormatFromChecker(Class<C> checkerClass) Format lookup method using the Checker component.
<F extends Format> F	getFormatFromClass(Class<F> formatClass) Lookup method for the Format map.
Format	getFormatFromComponent(Class<?> componentClass) Returns the Format compatible with this component class, or null if no matching Format can be found.
<M extends Metadata> Format	getFormatFromMetadata(Class<M> metadataClass) Format lookup method using the Metadata component.
<P extends Parser> Format	getFormatFromParser(Class<P> parserClass) Format lookup method using the Parser component.
<R extends Reader> Format	getFormatFromReader(Class<R> readerClass) Format lookup method using the Reader component
<W extends Writer> Format	getFormatFromWriter(Class<W> writerClass) Format lookup method using the Writer component.
List<Format>	getFormatList(org.scijava.io.handle.DataHandle<org.scijava.io.location.Location> source) As FormatService.getFormatList(Location) but takes an initialized DataHandle.
List<Format>	getFormatList(org.scijava.io.handle.DataHandle<org.scijava.io.location.Location> source, SCIFIOConfig config, boolean greedy) As FormatService.getFormatList(Location, SCIFIOConfig, boolean) but takes an initialized DataHandle.
List<Format>	getFormatList(org.scijava.io.location.Location id) Returns a list of all formats that are compatible with the source provided, ordered by their priority.
List<Format>	getFormatList(org.scijava.io.location.Location id, SCIFIOConfig config, boolean greedy) Returns a list of all formats that are compatible with the source provided, ordered by their priority.
Collection<Format>	getOutputFormats()
String[]	getSuffixes() Returns a complete list of all suffixes supported within this context.
String	getVersion()
Writer	getWriterForLocation(org.scijava.io.location.Location fileId) Writer lookup method using the suffix or other methods to locate a fitting writer.
void	initialize()
void	removeComponents(Format format) Removes any mappings involving this Format's components.
boolean	removeFormat(Format format) Removes the provided Format from this context, if it was previously available.

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.service.Service

registerEventHandlers

Methods inherited from interface org.scijava.plugin.RichPlugin

getIdentifier, log

Methods inherited from interface org.scijava.Contextual

context, getContext, setContext

Methods inherited from interface org.scijava.Prioritized

compareTo, getPriority, setPriority

Methods inherited from interface org.scijava.plugin.HasPluginInfo

getInfo, setInfo

Methods inherited from interface org.scijava.Locatable

getLocation

Methods inherited from interface org.scijava.Disposable

dispose

Constructor Detail

DefaultFormatService

public DefaultFormatService()

Method Detail

getSuffixes

public String[] getSuffixes()

Description copied from interface: FormatService

Returns a complete list of all suffixes supported within this context.

Specified by:

getSuffixes in interface FormatService

addFormat

public boolean addFormat(Format format)

Description copied from interface: FormatService

Makes the provided Format available for image IO operations in this context.

No effect if the format is already known.

Specified by:

addFormat in interface FormatService

Parameters:

format - a new Format to support in this context.

Returns:

True if the Format was added successfully.

removeFormat

public boolean removeFormat(Format format)

Description copied from interface: FormatService

Removes the provided Format from this context, if it was previously available.

Specified by:

removeFormat in interface FormatService

Parameters:

format - the Format to stop supporting in this context.

Returns:

True if a format was successfully removed.

addComponents

public void addComponents(Format format)

Description copied from interface: FormatService

Creates mappings between this Format and its components.

Specified by:

addComponents in interface FormatService

removeComponents

public void removeComponents(Format format)

Description copied from interface: FormatService

Removes any mappings involving this Format's components.

Specified by:

removeComponents in interface FormatService

getFormatFromClass

public <F extends Format> F getFormatFromClass(Class<F> formatClass)

Description copied from interface: FormatService

Lookup method for the Format map. Use this method when you want a concrete type reference instead of trying to construct a new Format.

NB: because SezPoz is used for automatic detection of Formats in SCIFIO, all concrete Format implementations have a zero-parameter constructor. If you manually invoke that constructor and then try to link your Format to an existing context, e.g. via the FormatService.addFormat(Format) method, it will fail if the Format was already discovered. The same principle is true if the context-based constructor is invoked.

Specified by:

getFormatFromClass in interface FormatService

Parameters:

formatClass - the class of the desired Format

Returns:

A reference to concrete class of the queried Format, or null if the Format was not found.

getFormatFromComponent

public Format getFormatFromComponent(Class<?> componentClass)

Description copied from interface: FormatService

Returns the Format compatible with this component class, or null if no matching Format can be found.

Specified by:

getFormatFromComponent in interface FormatService

getFormatFromReader

public <R extends Reader> Format getFormatFromReader(Class<R> readerClass)

Description copied from interface: FormatService

Format lookup method using the Reader component

Specified by:

getFormatFromReader in interface FormatService

Parameters:

readerClass - the class of the Reader component for the desired Format

Returns:

A reference to the queried Format, or null if the Format was not found.

getFormatFromWriter

public <W extends Writer> Format getFormatFromWriter(Class<W> writerClass)

Description copied from interface: FormatService

Format lookup method using the Writer component.

Specified by:

getFormatFromWriter in interface FormatService

Parameters:

writerClass - the class of the Writer component for the desired Format

Returns:

A reference to the queried Format, or null if the Format was not found.

getWriterForLocation

public Writer getWriterForLocation(org.scijava.io.location.Location fileId)
                            throws FormatException

Description copied from interface: FormatService

Writer lookup method using the suffix or other methods to locate a fitting writer. This bypasses the Checker logic, and thus does not guarantee the associated Format can read image sources of the provided type.

Specified by:

getWriterForLocation in interface FormatService

Throws:

FormatException - if now writer could be found

getFormatFromChecker

public <C extends Checker> Format getFormatFromChecker(Class<C> checkerClass)

Description copied from interface: FormatService

Format lookup method using the Checker component.

Specified by:

getFormatFromChecker in interface FormatService

Parameters:

checkerClass - the class of the Checker component for the desired Format

Returns:

A reference to the queried Format, or null if the Format was not found.

getFormatFromParser

public <P extends Parser> Format getFormatFromParser(Class<P> parserClass)

Description copied from interface: FormatService

Format lookup method using the Parser component.

Specified by:

getFormatFromParser in interface FormatService

Parameters:

parserClass - the class of the Parser component for the desired Format

Returns:

A reference to the queried Format, or null if the Format was not found.

getFormatFromMetadata

public <M extends Metadata> Format getFormatFromMetadata(Class<M> metadataClass)

Description copied from interface: FormatService

Format lookup method using the Metadata component.

Specified by:

getFormatFromMetadata in interface FormatService

Parameters:

metadataClass - the class of the Metadata component for the desired Format

Returns:

A reference to the queried Format, or null if the Format was not found.

getFormat

public Format getFormat(org.scijava.io.location.Location id)
                 throws FormatException

Description copied from interface: FormatService

Returns the first Format known to be compatible with the source provided. Formats are checked in ascending order of their priority. The source is read if necessary to determine compatibility.

Specified by:

getFormat in interface FormatService

Parameters:

id - the source

Returns:

A Format compatible with the provided source

Throws:

FormatException - if no compatible format was found, or if something goes wrong checking the source

getFormat

public Format getFormat(org.scijava.io.location.Location id,
                        SCIFIOConfig config)
                 throws FormatException

Description copied from interface: FormatService

Returns the first Format known to be compatible with the source provided. Formats are checked in ascending order of their priority.

Specified by:

getFormat in interface FormatService

Parameters:

id - the source

config - Configuration for this method execution.

Returns:

A Format compatible with the provided source

Throws:

FormatException - if no compatible format was found, or if something goes wrong checking the source

getFormatList

public List<Format> getFormatList(org.scijava.io.location.Location id)
                           throws FormatException

Description copied from interface: FormatService

Returns a list of all formats that are compatible with the source provided, ordered by their priority. The source is read if necessary to determine compatibility.

Specified by:

getFormatList in interface FormatService

Parameters:

id - the source

Returns:

A list of Formats compatible with the provided source, which will be an empty list if no compatible formats are found.

Throws:

FormatException - if something goes wrong checking the source.

getFormatList

public List<Format> getFormatList(org.scijava.io.location.Location id,
                                  SCIFIOConfig config,
                                  boolean greedy)
                           throws FormatException

Description copied from interface: FormatService

Returns a list of all formats that are compatible with the source provided, ordered by their priority.

Specified by:

getFormatList in interface FormatService

Parameters:

id - the source

config - Configuration for this method execution.

greedy - if true, the search will terminate after finding the first compatible format

Returns:

A list of Formats compatible with the provided source, which will be an empty list if no compatible formats are found.

Throws:

FormatException - if something goes wrong checking the source.

getFormat

public Format getFormat(org.scijava.io.handle.DataHandle<org.scijava.io.location.Location> source)
                 throws FormatException

Description copied from interface: FormatService

As FormatService.getFormat(Location) but takes an initialized DataHandle.

Specified by:

getFormat in interface FormatService

Parameters:

source - the source

Returns:

A Format compatible with the provided source

Throws:

FormatException - if no compatible format was found, or if something goes wrong checking the source

getFormat

public Format getFormat(org.scijava.io.handle.DataHandle<org.scijava.io.location.Location> source,
                        SCIFIOConfig config)
                 throws FormatException

Description copied from interface: FormatService

As FormatService.getFormat(Location, SCIFIOConfig) but takes an initialized DataHandle.

Specified by:

getFormat in interface FormatService

Parameters:

source - the source

config - Configuration for this method execution.

Returns:

A Format compatible with the provided source

Throws:

FormatException - if no compatible format was found, or if something goes wrong checking the source

getFormatList

public List<Format> getFormatList(org.scijava.io.handle.DataHandle<org.scijava.io.location.Location> source)
                           throws FormatException

Description copied from interface: FormatService

As FormatService.getFormatList(Location) but takes an initialized DataHandle.

Specified by:

getFormatList in interface FormatService

Parameters:

source - the source

Returns:

A list of Formats compatible with the provided source, which will be an empty list if no compatible formats are found.

Throws:

FormatException - if something goes wrong checking the source.

getFormatList

public List<Format> getFormatList(org.scijava.io.handle.DataHandle<org.scijava.io.location.Location> source,
                                  SCIFIOConfig config,
                                  boolean greedy)
                           throws FormatException

Description copied from interface: FormatService

As FormatService.getFormatList(Location, SCIFIOConfig, boolean) but takes an initialized DataHandle.

Specified by:

getFormatList in interface FormatService

Parameters:

source - the source

config - Configuration for this method execution.

greedy - if true, the search will terminate after finding the first compatible format

Returns:

A list of Formats compatible with the provided source, which will be an empty list if no compatible formats are found.

Throws:

FormatException - if something goes wrong checking the source.

getAllFormats

public Set<Format> getAllFormats()

Description copied from interface: FormatService

Returns a list of all Formats within this context.

Specified by:

getAllFormats in interface FormatService

getOutputFormats

public Collection<Format> getOutputFormats()

Specified by:

getOutputFormats in interface FormatService

Returns:

A list of all Formats that have Writer implementations.

getVersion

public String getVersion()

Specified by:

getVersion in interface org.scijava.Versioned

initialize

public void initialize()

Specified by:

initialize in interface org.scijava.Initializable

Specified by:

initialize in interface org.scijava.service.Service