io.scif.filters

Class AbstractMetadataWrapper

java.lang.Object

org.scijava.AbstractContextual

org.scijava.plugin.AbstractRichPlugin

io.scif.AbstractSCIFIOPlugin

io.scif.AbstractHasFormat

io.scif.AbstractHasSource

io.scif.AbstractMetadata

io.scif.filters.AbstractMetadataWrapper

All Implemented Interfaces:

MetadataWrapper, HasFormat, HasMetaTable, HasSource, Metadata, SCIFIOPlugin, TypedMetadata, Serializable, 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

Direct Known Subclasses:

ChannelFillerMetadata, DimensionSwapperMetadata, FileStitcherMetadata, PlaneSeparatorMetadata

public abstract class AbstractMetadataWrapper
extends AbstractMetadata
implements MetadataWrapper

Abstract superclass for concrete implementations of MetadataWrapper.

To create a MetadataWrapper that is paired with a specific Filter, simply extend this class, override any methods as desired, and annotate the class using Plugin as appropriate. The wrapper will automatically be discovered and applied when a new instance of its Filter is instantiated, assuming the Filter is a subclass of AbstractReaderFilter

Author:

Mark Hiner

See Also:

Plugin, MetadataWrapper, AbstractReaderFilter, Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractMetadataWrapper()
AbstractMetadataWrapper(Metadata metadata)

Method Summary

Modifier and Type	Method and Description
void	add(ImageMetadata meta) Adds the provided image metadata to this dataset metadata
void	add(ImageMetadata meta, boolean passUp)
void	close(boolean fileOnly) Closes the image source(s) associated with this component, with a toggle to determine if the component itself is reset.
Format	getFormat() Provides a link back to the format associated with this component.
String	getFormatName() Helper method for accessing Format.getFormatName().
MetaTable	getTable()
void	populateImageMetadata() Generates format-agnostic image metadata structures based on this instance's format-specific metadata.
void	setSource(org.scijava.io.handle.DataHandle<org.scijava.io.location.Location> source) Sets the input source attached to this Metadata object.
void	setSourceLocation(org.scijava.io.location.Location loc) Sets the input source location.
void	setTable(MetaTable table, boolean passUp)
Metadata	unwrap()
void	wrap(Metadata meta) Sets the Metadata this wrapper will delegate to.

Methods inherited from class io.scif.AbstractMetadata

createImageMetadata, get, getAll, getDatasetName, getDatasetSize, getDestinationLocation, getImageCount, getSource, getSourceLocation, isFiltered, setDatasetName, setDestinationLocation, setFiltered, setTable

Methods inherited from class io.scif.AbstractHasSource

close

Methods inherited from class io.scif.AbstractHasFormat

asBrowsableLocation, asBrowsableLocation

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.filters.MetadataWrapper

filterType

Methods inherited from interface io.scif.Metadata

createImageMetadata, get, getAll, getDatasetName, getDatasetSize, getDestinationLocation, getImageCount, getSource, getSourceLocation, isFiltered, setDatasetName, setDestinationLocation, setFiltered

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

setTable

Constructor Detail

AbstractMetadataWrapper

public AbstractMetadataWrapper()

AbstractMetadataWrapper

public AbstractMetadataWrapper(Metadata metadata)

Method Detail

unwrap

public Metadata unwrap()

Specified by:

unwrap in interface MetadataWrapper

Returns:

The Metadata used for delegation by this wrapper.

wrap

public void wrap(Metadata meta)

Description copied from interface: MetadataWrapper

Sets the Metadata this wrapper will delegate to. Necessary for the sake of a zero-parameter constructor to allow SezPoz discovery.

Specified by:

wrap in interface MetadataWrapper

Parameters:

meta - - The Metadata instance to wrap

getTable

public MetaTable getTable()

Specified by:

getTable in interface HasMetaTable

Overrides:

getTable in class AbstractMetadata

Returns:

the MetaTable attached to this component

setTable

public void setTable(MetaTable table,
                     boolean passUp)

Specified by:

setTable in interface MetadataWrapper

add

public void add(ImageMetadata meta,
                boolean passUp)

Specified by:

add in interface MetadataWrapper

add

public void add(ImageMetadata meta)

Description copied from interface: Metadata

Adds the provided image metadata to this dataset metadata

Specified by:

add in interface Metadata

Overrides:

add in class AbstractMetadata

setSource

public void setSource(org.scijava.io.handle.DataHandle<org.scijava.io.location.Location> source)

Description copied from interface: Metadata

Sets the input source attached to this Metadata object. Note that calling this method does not affect the structure of this Metadata object.

Specified by:

setSource in interface Metadata

Overrides:

setSource in class AbstractMetadata

Parameters:

source - - Input source for this Metadata

setSourceLocation

public void setSourceLocation(org.scijava.io.location.Location loc)

Description copied from interface: Metadata

Sets the input source location. This is an alternative to Metadata.setSource(DataHandle) for Formats that operate on Locations without a corresponding DataHandle.

Specified by:

setSourceLocation in interface Metadata

Overrides:

setSourceLocation in class AbstractMetadata

Parameters:

loc - the source location

populateImageMetadata

public void populateImageMetadata()

Description copied from interface: Metadata

Generates format-agnostic image metadata structures based on this instance's format-specific metadata.

Specified by:

populateImageMetadata in interface Metadata

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

getFormatName

public String getFormatName()

Description copied from interface: HasFormat

Helper method for accessing Format.getFormatName(). Some Formats may be polymorphic and wish to provide additional name information based on the specific dataset open - this method allows overriding of that behavior.

Specified by:

getFormatName in interface HasFormat

Overrides:

getFormatName in class AbstractHasFormat

Returns:

the name of the associated Format

close

public void close(boolean fileOnly)
           throws IOException

Description copied from interface: HasSource

Closes the image source(s) associated with this component, with a toggle to determine if the component itself is reset.

Specified by:

close in interface HasSource

Overrides:

close in class AbstractMetadata

Parameters:

fileOnly - - If true, only the associated source(s) are closed.

Throws:

IOException