io.scif

Class AbstractFormat

java.lang.Object

org.scijava.AbstractContextual

org.scijava.plugin.AbstractRichPlugin

io.scif.AbstractSCIFIOPlugin

io.scif.AbstractFormat

All Implemented Interfaces:

Format, SCIFIOPlugin, Comparable<org.scijava.Prioritized>, org.scijava.Contextual, org.scijava.Identifiable, org.scijava.Locatable, org.scijava.log.Logged, org.scijava.plugin.HasPluginInfo, org.scijava.plugin.RichPlugin, org.scijava.plugin.SciJavaPlugin, org.scijava.Prioritized, org.scijava.Versioned

Direct Known Subclasses:

APNGFormat, AVIFormat, BMPFormat, DICOMFormat, EPSFormat, FITSFormat, GIFFormat, ICSFormat, ImageIOFormat, JPEG2000Format, JPEGTileFormat, KontronFormat, LegacyQTFormat, MicromanagerFormat, MinimalTIFFFormat, MNGFormat, NativeQTFormat, NRRDFormat, PCXFormat, PGMFormat, PICTFormat, ScancoISQFormat, StratecPQCTFormat, TestImgFormat, TIFFFormat, TIFFJAIFormat

public abstract class AbstractFormat
extends AbstractSCIFIOPlugin
implements Format

Abstract superclass of all SCIFIO Format implementations.

Author:

Mark Hiner

See Also:

Format, Metadata, Parser, Reader, Writer, Checker, FormatService

Constructor Summary

Constructors

Constructor and Description
AbstractFormat()

Method Summary

Modifier and Type	Method and Description
Checker	createChecker() Create an instance of the Checker associated with this format.
Metadata	createMetadata() Create an instance of the Metadata associated with this format.
Parser	createParser() Create an instance of the Parser associated with this format.
Reader	createReader() Creates an instance of the Reader associated with this format.
Writer	createWriter() Creates an instance of the Writer associated with this format.
Class<? extends Checker>	getCheckerClass()
String	getFormatName() Gets the name of this file format.
Class<? extends Metadata>	getMetadataClass()
Class<? extends Parser>	getParserClass()
Class<? extends Reader>	getReaderClass()
String[]	getSuffixes() Gets the default file suffixes for this file format.
Class<? extends Writer>	getWriterClass()
boolean	isEnabled()
protected abstract String[]	makeSuffixArray() Helper method to cache the suffix array for a format.
void	setEnabled(boolean enabled) Toggle whether this Format should be used when checking image compatibility.

Methods inherited from class io.scif.AbstractSCIFIOPlugin

getVersion, log

Methods inherited from class org.scijava.plugin.AbstractRichPlugin

getInfo, getPriority, setInfo, setPriority, toString

Methods inherited from class org.scijava.AbstractContextual

context, getContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.scif.Format

ownsLocationType

Methods inherited from interface io.scif.SCIFIOPlugin

getVersion, log

Methods inherited from interface org.scijava.plugin.RichPlugin

getIdentifier

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

Constructor Detail

AbstractFormat

public AbstractFormat()

Method Detail

makeSuffixArray

protected abstract String[] makeSuffixArray()

Helper method to cache the suffix array for a format. Concrete format classes should implement this method, returning an array of supported suffixes.

Returns:

Valid suffixes for this file format.

getSuffixes

public String[] getSuffixes()

Description copied from interface: Format

Gets the default file suffixes for this file format.

Sample valid suffixes:

• png
• avi
• bmp

Specified by:

getSuffixes in interface Format

Returns:

an array of extensions associated with this Format

setEnabled

public void setEnabled(boolean enabled)

Description copied from interface: Format

Toggle whether this Format should be used when checking image compatibility.

Specified by:

setEnabled in interface Format

Parameters:

enabled - - if true, this Format will be used in image/IO. Default: true

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface Format

Returns:

True if this Format is active when checking image compatibility.

getFormatName

public String getFormatName()

Description copied from interface: Format

Gets the name of this file format.

Specified by:

getFormatName in interface Format

Returns:

a String representation of this Format's name

createMetadata

public Metadata createMetadata()
                        throws FormatException

Description copied from interface: Format

Create an instance of the Metadata associated with this format.

Specified by:

createMetadata in interface Format

Returns:

A new Metadata instance compatible with this Format's components

Throws:

FormatException

createChecker

public Checker createChecker()
                      throws FormatException

Description copied from interface: Format

Create an instance of the Checker associated with this format.

Specified by:

createChecker in interface Format

Returns:

A new Checker instance which can determine if sources are compatible with this Format.

Throws:

FormatException

createParser

public Parser createParser()
                    throws FormatException

Description copied from interface: Format

Create an instance of the Parser associated with this format.

Specified by:

createParser in interface Format

Returns:

A new Parser instance capable of populating Metadata compatible with this Format.

Throws:

FormatException

createReader

public Reader createReader()
                    throws FormatException

Description copied from interface: Format

Creates an instance of the Reader associated with this format.

Specified by:

createReader in interface Format

Returns:

A new Reader instance capable of reading datasets of this Format.

Throws:

FormatException

createWriter

public Writer createWriter()
                    throws FormatException

Description copied from interface: Format

Creates an instance of the Writer associated with this format.

Specified by:

createWriter in interface Format

Returns:

A new Writer instance capable of writing datasets of this Format.

Throws:

FormatException

getMetadataClass

public Class<? extends Metadata> getMetadataClass()

Specified by:

getMetadataClass in interface Format

Returns:

The class of the Metadata associated with this format

getCheckerClass

public Class<? extends Checker> getCheckerClass()

Specified by:

getCheckerClass in interface Format

Returns:

The class of the Checker associated with this format

getParserClass

public Class<? extends Parser> getParserClass()

Specified by:

getParserClass in interface Format

Returns:

The class of the Parser associated with this format

getReaderClass

public Class<? extends Reader> getReaderClass()

Specified by:

getReaderClass in interface Format

Returns:

The class of the Reader associated with this format

getWriterClass

public Class<? extends Writer> getWriterClass()

Specified by:

getWriterClass in interface Format

Returns:

The class of the Writer associated with this format