io.scif

Class DefaultParser

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

io.scif.DefaultParser

All Implemented Interfaces:

DefaultComponent, Groupable, HasFormat, HasSource, Parser, SCIFIOPlugin, TypedParser<DefaultMetadata>, 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

public class DefaultParser
extends AbstractParser<DefaultMetadata>
implements DefaultComponent

Default Parser implementation.

Populates the following fields:

• Metadata.isFiltered()
• Metadata.getSource()
• Metadata.getDatasetName()

Author:

Mark Hiner

See Also:

Parser

Constructor Summary

Constructors

Constructor and Description
DefaultParser()

Method Summary

Modifier and Type	Method and Description
Format	getFormat() Provides a link back to the format associated with this component.
protected void	typedParse(org.scijava.io.handle.DataHandle<org.scijava.io.location.Location> stream, DefaultMetadata meta, SCIFIOConfig config) A helper method, called by AbstractParser.parse(DataHandle, TypedMetadata).

Methods inherited from class io.scif.AbstractParser

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

Methods inherited from class io.scif.AbstractGroupable

fileGroupOption, hasCompanionFiles, isSingleFile

Methods inherited from class io.scif.AbstractHasSource

close

Methods inherited from class io.scif.AbstractHasFormat

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

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

Methods inherited from interface io.scif.Groupable

fileGroupOption, hasCompanionFiles, isSingleFile

Constructor Detail

DefaultParser

public DefaultParser()

Method Detail

getFormat

public Format getFormat()

Description copied from interface: HasFormat

Provides a link back to the format associated with this component.

Specified by:

getFormat in interface HasFormat

Overrides:

getFormat in class AbstractHasFormat

Returns:

the associated Format

typedParse

protected void typedParse(org.scijava.io.handle.DataHandle<org.scijava.io.location.Location> stream,
                          DefaultMetadata 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<DefaultMetadata>

Throws:

IOException

FormatException