loci.formats
Interface IFormatHandler

All Superinterfaces:
StatusReporter
All Known Subinterfaces:
IFormatReader, IFormatWriter
All Known Implementing Classes:
AliconaReader, AVIReader, AVIWriter, BaseTiffReader, BioRadReader, BMPReader, ChannelFiller, ChannelMerger, ChannelSeparator, DeltavisionReader, DicomReader, DimensionSwapper, EPSReader, EPSWriter, FileStitcher, FitsReader, FlexReader, FluoviewReader, FormatHandler, FormatReader, FormatWriter, GatanReader, GelReader, GIFReader, ICSReader, ImageIOReader, ImageIOWriter, ImageReader, ImageWriter, ImarisReader, ImarisTiffReader, ImprovisionTiffReader, IPLabReader, IPWReader, JPEGReader, JPEGWriter, KhorosReader, LegacyPictReader, LegacyQTReader, LegacyQTWriter, LegacyZVIReader, LeicaReader, LIFReader, LIMReader, MetamorphReader, MicromanagerReader, MinMaxCalculator, MNGReader, MRCReader, ND2Reader, NikonReader, NRRDReader, OIBReader, OIFReader, OMETiffReader, OMETiffWriter, OMEXMLReader, OpenlabRawReader, OpenlabReader, PCIReader, PerkinElmerReader, PGMReader, PictReader, PNGReader, PNGWriter, PrairieReader, PSDReader, QTReader, QTWriter, ReaderWrapper, SDTReader, SEQReader, SlidebookReader, TCSReader, TiffReader, TiffWriter, VisitechReader, ZeissLSMReader, ZeissZVIReader

public interface IFormatHandler
extends StatusReporter

Interface for all biological file format readers and writers.

Source code:
Trac, SVN


Method Summary
 void close()
          Closes currently open file(s) and frees allocated memory.
 String getFormat()
          Gets the name of this file format.
 String[] getSuffixes()
          Gets the default file suffixes for this file format.
 boolean isThisType(String name)
          Checks if the given string is a valid filename for this file format.
 boolean isThisType(String name, boolean open)
          Checks if the given string is a valid filename for this file format.
 void setId(String id)
          Sets the current file name.
 void setId(String id, boolean force)
          Sets the current file name.
 
Methods inherited from interface loci.formats.StatusReporter
addStatusListener, getStatusListeners, removeStatusListener
 

Method Detail

isThisType

boolean isThisType(String name)
Checks if the given string is a valid filename for this file format.


isThisType

boolean isThisType(String name,
                   boolean open)
Checks if the given string is a valid filename for this file format.

Parameters:
open - If true, and the file extension is insufficient to determine the file type, the (existing) file is opened for further analysis.

getFormat

String getFormat()
Gets the name of this file format.


getSuffixes

String[] getSuffixes()
Gets the default file suffixes for this file format.


setId

void setId(String id)
           throws FormatException,
                  IOException
Sets the current file name.

Throws:
FormatException
IOException

setId

void setId(String id,
           boolean force)
           throws FormatException,
                  IOException
Sets the current file name.

Parameters:
force - If set, the handler will be re-initialized no matter what.
Throws:
FormatException
IOException

close

void close()
           throws IOException
Closes currently open file(s) and frees allocated memory.

Throws:
IOException