io.scif

Class AbstractTranslator<M extends Metadata,N extends Metadata>

java.lang.Object

org.scijava.AbstractContextual

org.scijava.plugin.AbstractRichPlugin

io.scif.AbstractSCIFIOPlugin

io.scif.AbstractTranslator<M,N>

Type Parameters:

M - - The source Metadata type required by this Translator

N - - The destination Metadata type required by this Translator

All Implemented Interfaces:

SCIFIOPlugin, Translator, 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.plugin.SingletonPlugin, org.scijava.Prioritized, org.scijava.Versioned

Direct Known Subclasses:

APNGFormat.APNGTranslator, AVIFormat.Translator, DefaultTranslator, ICSFormat.ICSTranslator, ImageIOFormat.ImageIOTranslator, LegacyQTFormat.LegacyQTTranslator, NativeQTFormat.NativeQTTranslator, TestImgFormat.TestImgTranslator, TIFFFormat.TIFFTranslator

public abstract class AbstractTranslator<M extends Metadata,N extends Metadata>
extends AbstractSCIFIOPlugin
implements Translator

Abstract superclass of all SCIFIO Translator components.

NB: this class provides a special abstract method: typedTranslate(Metadata, Metadata). That is the method which should be overridden when extending this class, and not translate(Metadata, Metadata) - which has been set up to translate the type-general Metadata information, delegate to typedTranslate, and then populate the ImageMetadata of the destination.

Author:

Mark Hiner

See Also:

Translator, TranslatorService, Metadata

Constructor Summary

Constructors

Constructor and Description
AbstractTranslator()

Method Summary

Modifier and Type	Method and Description
void	translate(Metadata source, List<ImageMetadata> sourceImgMeta, Metadata dest) As Translator.translate(Metadata, Metadata) with the format-specific and image metadata explicitly split out.
void	translate(Metadata source, Metadata dest) Uses the source Metadata to populate the destination Metadata.
protected void	translateFormatMetadata(M source, N dest) Use format-specific metadata from the source to populate the destination's format-specific metadata.
protected abstract void	translateImageMetadata(List<ImageMetadata> source, N dest) Use format-agnostic metadata (ImageMetadata to populate the destination's format-specific metadata.
protected void	typedTranslate(M typedSource, List<ImageMetadata> sourceImgMeta, N typedDest) This method provides a hook for subclasses that need access to both the Metadata and ImageMetadata.

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

dest, source

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

Constructor Detail

AbstractTranslator

public AbstractTranslator()

Method Detail

translate

public void translate(Metadata source,
                      Metadata dest)

Description copied from interface: Translator

Uses the source Metadata to populate the destination Metadata. Specifically, the format-specific metadata and/or ImageMetadata of the source are used to populate the format- specific metadata of the destination (from which the destination's ImageMetadata can be derived}.

Note that the destination does not have to be empty, but can be built up through multiple translations. However each translation step is assumed to overwrite any previously existing data.

For a reference to a fresh Metadata instance to use in translation, consider the Format.createMetadata() method.

Specified by:

translate in interface Translator

Parameters:

source - Metadata to use to populate

dest - Metadata to be populated

See Also:

Format.createMetadata()

translate

public void translate(Metadata source,
                      List<ImageMetadata> sourceImgMeta,
                      Metadata dest)

Description copied from interface: Translator

As Translator.translate(Metadata, Metadata) with the format-specific and image metadata explicitly split out.

NB: it is NOT GUARANTEED that the Metadata.getAll() method of the source here will provide equivalent ImageMetadata as sourceImgMeta. For example, if a MetadataWrapper was used, the two are unlikely to match up. This is necessary, as Translator discovery depends on the format of source and destination, but augmentation via wrapping must affect the underlying ImageMetadata non-destructively.

Specified by:

translate in interface Translator

Parameters:

source - Metadata to use to populate

sourceImgMeta - ImageMetadata to use to populate

dest - Metadata to be populated

typedTranslate

protected void typedTranslate(M typedSource,
                              List<ImageMetadata> sourceImgMeta,
                              N typedDest)

This method provides a hook for subclasses that need access to both the Metadata and ImageMetadata. It is provided with concrete typing for convenience and to limit code duplication.

NB: if this method is just used as a hook to perform some operation mid-translation, then super.typedTranslate should be called at the end of the method to continue the normal translation process.

translateImageMetadata

protected abstract void translateImageMetadata(List<ImageMetadata> source,
                                               N dest)

Use format-agnostic metadata (ImageMetadata to populate the destination's format-specific metadata.

This method must be implemented by every AbstractTranslator subclass, as it covers the general case - agnostic of the source.

Parameters:

source -

dest -

translateFormatMetadata

protected void translateFormatMetadata(M source,
                                       N dest)

Use format-specific metadata from the source to populate the destination's format-specific metadata.

NB: Override this method when writing a translator from a concrete Metadata type.

Parameters:

source -

dest -