Module io.scif

Package io.scif

Interface Checker

All Superinterfaces:

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

All Known Implementing Classes:

AbstractChecker, APNGFormat.Checker, AVIFormat.Checker, BMPFormat.Checker, DefaultChecker, DICOMFormat.Checker, GIFFormat.Checker, JPEG2000Format.Checker, JPEGFormat.Checker, KontronFormat.Checker, MicromanagerFormat.Checker, MinimalTIFFFormat.Checker, MNGFormat.Checker, NativeQTFormat.Checker, NRRDFormat.Checker, PCXFormat.Checker, PGMFormat.Checker, ScancoISQFormat.Checker, StratecPQCTFormat.Checker, TestImgFormat.Checker

public interface Checker
extends HasFormat

Interface for all SCIFIO Checker components.

Checker components are used to determine if the Format they are associated with is compatibile with a given image. This is accomplished via the isFormat(org.scijava.io.location.Location) methods.

Author:

Mark Hiner

See Also:

Format, HasFormat

Method Summary

Modifier and Type	Method	Description
boolean	checkHeader(byte[] block)	Checks if the given bytes are a valid header for this Format.
boolean	isFormat(org.scijava.io.handle.DataHandle<org.scijava.io.location.Location> stream)	Checks if the given stream is a valid stream for this Format.
boolean	isFormat(org.scijava.io.location.Location loc)	Checks if the provided image source is compatible with this Format.
boolean	isFormat(org.scijava.io.location.Location loc, SCIFIOConfig config)	Checks if the provided image source is compatible with this Format.
boolean	suffixNecessary()	Whether the file extension matching one of the format's suffixes is necessary to identify the file as a source compatible with this format.
boolean	suffixSufficient()	Whether the file extension matching one of the format's suffixes is sufficient to identify the file as a source compatible with this format.

Methods inherited from interface org.scijava.Contextual

context, getContext, setContext

Methods inherited from interface io.scif.HasFormat

getFormat, getFormatName

Methods inherited from interface org.scijava.plugin.HasPluginInfo

getInfo, setInfo

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

Method Detail

suffixNecessary

boolean suffixNecessary()

Whether the file extension matching one of the format's suffixes is necessary to identify the file as a source compatible with this format.

suffixSufficient

boolean suffixSufficient()

Whether the file extension matching one of the format's suffixes is sufficient to identify the file as a source compatible with this format.

If false, the source will have to be read to determine compatibility.

isFormat

boolean isFormat(org.scijava.io.location.Location loc)

Checks if the provided image source is compatible with this Format. Will not open the source during this process.

Parameters:

loc - path to the image source to check.

Returns:

True if the image source is compatible with this Format.

isFormat

boolean isFormat(org.scijava.io.location.Location loc,
                 SCIFIOConfig config)

Checks if the provided image source is compatible with this Format.

If open is true and the source name is insufficient to determine the image type, the source may be opened for further analysis, or other relatively expensive file system operations (such as file existence tests and directory listings) may be performed.

Parameters:

loc - path to the image source to check.

config - SCIFIOConfig for this isFormat call.

Returns:

True if the image source is compatible with this Format.

isFormat

boolean isFormat(org.scijava.io.handle.DataHandle<org.scijava.io.location.Location> stream)
          throws IOException

Checks if the given stream is a valid stream for this Format.

Parameters:

stream - the image source to check.

Returns:

True if stream is compatible with this Format.

Throws:

IOException

checkHeader

boolean checkHeader(byte[] block)

Checks if the given bytes are a valid header for this Format.

Parameters:

block - the byte array to check.

Returns:

True if block is compatible with this Format.