io.scif

Interface Groupable

All Known Subinterfaces:

Parser, Reader, TypedParser<M>, TypedReader<M,P>

All Known Implementing Classes:

AbstractGroupable, AbstractParser, AbstractReader, AbstractReaderFilter, APNGFormat.Parser, APNGFormat.Reader, AVIFormat.Parser, AVIFormat.Reader, BMPFormat.Parser, BMPFormat.Reader, BufferedImageReader, ByteArrayReader, ChannelFiller, DefaultParser, DefaultReader, DICOMFormat.Parser, DICOMFormat.Reader, DimensionSwapper, EPSFormat.Parser, EPSFormat.Reader, FileStitcher, FITSFormat.Parser, FITSFormat.Reader, GIFFormat.Parser, GIFFormat.Reader, ICSFormat.Parser, ICSFormat.Reader, ImageIOFormat.Parser, ImageIOFormat.Reader, JPEG2000Format.Parser, JPEG2000Format.Reader, JPEGFormat.Parser, JPEGFormat.Reader, JPEGTileFormat.Parser, JPEGTileFormat.Reader, KontronFormat.Parser, KontronFormat.Reader, LegacyQTFormat.Parser, LegacyQTFormat.Reader, MicromanagerFormat.Parser, MicromanagerFormat.Reader, MinimalTIFFFormat.Parser, MinimalTIFFFormat.Reader, MinMaxFilter, MNGFormat.Parser, MNGFormat.Reader, NativeQTFormat.Parser, NativeQTFormat.Reader, NRRDFormat.Parser, NRRDFormat.Reader, PCXFormat.Parser, PCXFormat.Reader, PGMFormat.Parser, PGMFormat.Reader, PICTFormat.Parser, PICTFormat.Reader, PlaneSeparator, ReaderFilter, ScancoISQFormat.Parser, ScancoISQFormat.Reader, StratecPQCTFormat.Parser, StratecPQCTFormat.Reader, TestImgFormat.Parser, TestImgFormat.Reader, TIFFFormat.BaseTIFFParser, TIFFFormat.Parser, TIFFFormat.Reader, TIFFJAIFormat.Parser, TIFFJAIFormat.Reader

public interface Groupable

Interface for components that can group multiple files together (e.g. for Parsing metadata or reading pixels)

Author:

Mark Hiner

Method Summary

Modifier and Type	Method and 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.

Method Detail

fileGroupOption

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

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

Throws:

FormatException

IOException

isSingleFile

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

Returns true if this is a single-file format.

Throws:

FormatException

IOException

hasCompanionFiles

boolean hasCompanionFiles()

Returns true if this format supports multi-file datasets.