io.scif.filters

Interface MetadataWrapper

All Superinterfaces:

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

All Known Implementing Classes:

AbstractMetadataWrapper, ChannelFillerMetadata, DimensionSwapperMetadata, FileStitcherMetadata, PlaneSeparatorMetadata

public interface MetadataWrapper
extends Metadata

Wrapper for Metadata. Used to create defensive copies of metadata for manipulation by ReaderFilters, while allowing for API modification if needed.

If a Reader-based Filter requires special functionality from its Metadata, a companion MetadataWrapper can be implemented. Concrete implementations of this interface should always be annotated with Plugin so they can be dynamically found when constructing new Filters.

NB: This interface duplicates the Metadata setter signatures, with the addition of a passUp flag. If this flag is true, the wrapped metadata will also have the corresponding value set. If not, only the wrapper will be modified.

Author:

Mark Hiner

See Also:

AbstractReaderFilter

Method Summary

Modifier and Type	Method and Description
void	add(ImageMetadata meta, boolean passUp)
Class<? extends Filter>	filterType()
void	setTable(MetaTable table, boolean passUp)
Metadata	unwrap()
void	wrap(Metadata meta) Sets the Metadata this wrapper will delegate to.

Methods inherited from interface io.scif.Metadata

add, createImageMetadata, get, getAll, getDatasetName, getDatasetSize, getDestinationLocation, getImageCount, getSource, getSourceLocation, isFiltered, populateImageMetadata, setDatasetName, setDestinationLocation, setFiltered, setSource, setSourceLocation

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

getTable, setTable

Method Detail

unwrap

Metadata unwrap()

Returns:

The Metadata used for delegation by this wrapper.

wrap

void wrap(Metadata meta)

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

Parameters:

meta - - The Metadata instance to wrap

filterType

Class<? extends Filter> filterType()

Returns:

The class of the Filter this MetadataWrapper is compatible with.

setTable

void setTable(MetaTable table,
              boolean passUp)

add

void add(ImageMetadata meta,
         boolean passUp)