io.scif

Interface TypedParser<M extends TypedMetadata>

Type Parameters:

M - The Metadata type that will be returned by this Parser.

All Superinterfaces:

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

All Known Implementing Classes:

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

public interface TypedParser<M extends TypedMetadata>
extends Parser

Interface for all Parser implementations that use generic parameters.

Generics allow each concrete Parser implementation to type narrow the return the type of Metadata from its parse(org.scijava.io.location.Location) methods, as well as the argument Metadata types for the same methods.

Author:

Mark Hiner

Method Summary

Modifier and Type	Method and Description
M	parse(org.scijava.io.handle.DataHandle<org.scijava.io.location.Location> handle) Creates a Metadata object from the provided image source.
M	parse(org.scijava.io.handle.DataHandle<org.scijava.io.location.Location> stream, M meta) Generic-parameterized parse method, using TypedMetadata to avoid type erasure conflicts with Parser.parse(DataHandle, Metadata).
M	parse(org.scijava.io.handle.DataHandle<org.scijava.io.location.Location> stream, M meta, SCIFIOConfig config) Generic-parameterized parse method, using TypedMetadata to avoid type erasure conflicts with Parser.parse(DataHandle, Metadata).
M	parse(org.scijava.io.handle.DataHandle<org.scijava.io.location.Location> handle, SCIFIOConfig config) As Parser.parse(DataHandle) with configuration options.
M	parse(org.scijava.io.location.Location loc) Creates a Metadata object using the provided location of an image source.
M	parse(org.scijava.io.location.Location fileName, M meta, SCIFIOConfig config) Generic-parameterized parse method, using TypedMetadata to avoid type erasure conflicts with Parser.parse(Location, Metadata).
M	parse(org.scijava.io.location.Location loc, SCIFIOConfig config) As Parser.parse(Location) with configuration options.

Methods inherited from interface io.scif.Parser

getAdvancedImageUsedLocations, getAdvancedUsedLocations, getImageUsedFiles, getImageUsedFiles, getMetadata, getSource, getSourceLocation, getSupportedMetadataLevels, getUsedFiles, getUsedLocations, parse, parse, parse, parse, updateSource

Methods inherited from interface io.scif.HasFormat

getFormat, getFormatName

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

Methods inherited from interface io.scif.HasSource

close, close

Methods inherited from interface io.scif.Groupable

fileGroupOption, hasCompanionFiles, isSingleFile

Method Detail

parse

M parse(org.scijava.io.location.Location loc)
 throws IOException,
        FormatException

Description copied from interface: Parser

Creates a Metadata object using the provided location of an image source.

Specified by:

parse in interface Parser

Parameters:

loc - the Location of the image source to parse.

Returns:

A new Metadata object of the appropriate type.

Throws:

IOException

FormatException

parse

M parse(org.scijava.io.handle.DataHandle<org.scijava.io.location.Location> handle)
 throws IOException,
        FormatException

Description copied from interface: Parser

Creates a Metadata object from the provided image source.

Specified by:

parse in interface Parser

Parameters:

handle - a random access handle to the image source to parse.

Returns:

A new Metadata object of the appropriate type.

Throws:

IOException

FormatException

parse

M parse(org.scijava.io.location.Location loc,
        SCIFIOConfig config)
 throws IOException,
        FormatException

Description copied from interface: Parser

As Parser.parse(Location) with configuration options.

Specified by:

parse in interface Parser

Parameters:

loc - Name of the image source to parse.

config - Configuration information to use for this parse.

Returns:

A new Metadata object of the appropriate type.

Throws:

IOException

FormatException

parse

M parse(org.scijava.io.handle.DataHandle<org.scijava.io.location.Location> handle,
        SCIFIOConfig config)
 throws IOException,
        FormatException

Description copied from interface: Parser

As Parser.parse(DataHandle) with configuration options.

Specified by:

parse in interface Parser

Parameters:

handle - a DataHandle to the image source to parse.

config - Configuration information to use for this parse.

Returns:

A new Metadata object of the appropriate type.

Throws:

IOException

FormatException

parse

M parse(org.scijava.io.handle.DataHandle<org.scijava.io.location.Location> stream,
        M meta)
 throws IOException,
        FormatException

Generic-parameterized parse method, using TypedMetadata to avoid type erasure conflicts with Parser.parse(DataHandle, Metadata).

Throws:

IOException

FormatException

See Also:

Parser.parse(DataHandle, Metadata)

parse

M parse(org.scijava.io.location.Location fileName,
        M meta,
        SCIFIOConfig config)
 throws IOException,
        FormatException

Generic-parameterized parse method, using TypedMetadata to avoid type erasure conflicts with Parser.parse(Location, Metadata).

Throws:

IOException

FormatException

See Also:

Parser.parse(Location, Metadata, SCIFIOConfig)

parse

M parse(org.scijava.io.handle.DataHandle<org.scijava.io.location.Location> stream,
        M meta,
        SCIFIOConfig config)
 throws IOException,
        FormatException

Generic-parameterized parse method, using TypedMetadata to avoid type erasure conflicts with Parser.parse(DataHandle, Metadata).

Throws:

IOException

FormatException

See Also:

Parser.parse(DataHandle, Metadata, SCIFIOConfig)