io.scif.formats

Class NRRDFormat.Parser

java.lang.Object

org.scijava.AbstractContextual

org.scijava.plugin.AbstractRichPlugin

io.scif.AbstractSCIFIOPlugin

io.scif.AbstractHasFormat

io.scif.AbstractHasSource

io.scif.AbstractGroupable

io.scif.AbstractParser<NRRDFormat.Metadata>

io.scif.formats.NRRDFormat.Parser

All Implemented Interfaces:

Groupable, HasFormat, HasSource, Parser, SCIFIOPlugin, TypedParser<NRRDFormat.Metadata>, 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

Enclosing class:

NRRDFormat

public static class NRRDFormat.Parser
extends AbstractParser<NRRDFormat.Metadata>

Constructor Summary

Constructors

Constructor and Description
Parser()

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.
org.scijava.io.location.Location[]	getImageUsedFiles(int imageIndex, boolean noPixels) Returns an array of filenames needed to open the indicated image.
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.
NRRDFormat.Metadata	parse(org.scijava.io.handle.DataHandle<org.scijava.io.location.Location> stream, NRRDFormat.Metadata meta, SCIFIOConfig config) Generic-parameterized parse method, using TypedMetadata to avoid type erasure conflicts with Parser.parse(DataHandle, Metadata).
protected void	typedParse(org.scijava.io.handle.DataHandle<org.scijava.io.location.Location> stream, NRRDFormat.Metadata meta, SCIFIOConfig config) A helper method, called by AbstractParser.parse(DataHandle, TypedMetadata).

Methods inherited from class io.scif.AbstractParser

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

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 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

Constructor Detail

Parser

public Parser()

Method Detail

getImageUsedFiles

public org.scijava.io.location.Location[] getImageUsedFiles(int imageIndex,
                                                            boolean noPixels)

Description copied from interface: Parser

Returns an array of filenames needed to open the indicated image. If the 'noPixels' flag is set, then only files that do not contain pixel data will be returned.

Specified by:

getImageUsedFiles in interface Parser

Overrides:

getImageUsedFiles in class AbstractParser<NRRDFormat.Metadata>

parse

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

Description copied from interface: TypedParser

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

Specified by:

parse in interface TypedParser<NRRDFormat.Metadata>

Overrides:

parse in class AbstractParser<NRRDFormat.Metadata>

Throws:

IOException

FormatException

See Also:

Parser.parse(DataHandle, Metadata, SCIFIOConfig)

typedParse

protected void typedParse(org.scijava.io.handle.DataHandle<org.scijava.io.location.Location> stream,
                          NRRDFormat.Metadata meta,
                          SCIFIOConfig config)
                   throws IOException,
                          FormatException

Description copied from class: AbstractParser

A helper method, called by AbstractParser.parse(DataHandle, TypedMetadata). Allows for boilerplate code to come after parsing, specifically calls to Metadata.populateImageMetadata().

This method should be implemented to populate any format-specific Metadata.

NB: if a Format requires type-specific parsing to occur before the Abstract layer, Override #parse(String, TypedMetadata) instead.

Specified by:

typedParse in class AbstractParser<NRRDFormat.Metadata>

Throws:

IOException

FormatException

hasCompanionFiles

public boolean hasCompanionFiles()

Description copied from interface: Groupable

Returns true if this format supports multi-file datasets.

Specified by:

hasCompanionFiles in interface Groupable

Overrides:

hasCompanionFiles in class AbstractGroupable

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

Overrides:

isSingleFile in class AbstractGroupable

Throws:

FormatException

IOException

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

Overrides:

fileGroupOption in class AbstractGroupable

Throws:

FormatException

IOException