Module io.scif

Package io.scif

Class AbstractGroupable

java.lang.Object

org.scijava.AbstractContextual

org.scijava.plugin.AbstractRichPlugin

io.scif.AbstractSCIFIOPlugin

io.scif.AbstractHasFormat

io.scif.AbstractHasSource

io.scif.AbstractGroupable

All Implemented Interfaces:

Groupable, HasFormat, HasSource, 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:

AbstractParser, AbstractReader

public abstract class AbstractGroupable
extends AbstractHasSource
implements Groupable

Abstract super-class for all Groupable components.

Author:

Mark Hiner

See Also:

Groupable

Constructor Summary

Constructors

Constructor	Description
AbstractGroupable()

Method Summary

Modifier and Type	Method	Description
int	fileGroupOption(org.scijava.io.location.Location id)	Returns an int indicating that we cannot, must, or might group the files in a given dataset.
boolean	hasCompanionFiles()	Returns true if this format supports multi-file datasets.
boolean	isSingleFile(org.scijava.io.location.Location id)	Returns true if this is a single-file format.

Methods inherited from class io.scif.AbstractHasSource

close

Methods inherited from class io.scif.AbstractHasFormat

asBrowsableLocation, asBrowsableLocation, getFormat, getFormatName

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 org.scijava.Contextual

context, getContext, setContext

Methods inherited from interface org.scijava.plugin.HasPluginInfo

getInfo, setInfo

Methods inherited from interface io.scif.HasSource

close

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

Methods inherited from interface io.scif.SCIFIOPlugin

getVersion, log

Constructor Detail

AbstractGroupable

public AbstractGroupable()

Method Detail

fileGroupOption

public int fileGroupOption(org.scijava.io.location.Location id)
                    throws FormatException,
                           IOException

Description copied from interface: Groupable

Returns an int indicating that we cannot, must, or might group the files in a given dataset.

Specified by:

fileGroupOption in interface Groupable

Throws:

FormatException

IOException

isSingleFile

public boolean isSingleFile(org.scijava.io.location.Location id)
                     throws FormatException,
                            IOException

Description copied from interface: Groupable

Returns true if this is a single-file format.

Specified by:

isSingleFile in interface Groupable

Throws:

FormatException

IOException

hasCompanionFiles

public boolean hasCompanionFiles()

Description copied from interface: Groupable

Returns true if this format supports multi-file datasets.

Specified by:

hasCompanionFiles in interface Groupable