io.scif.services

Class DefaultTranslatorService

java.lang.Object

org.scijava.AbstractContextual

org.scijava.plugin.AbstractRichPlugin

org.scijava.service.AbstractService

org.scijava.plugin.AbstractPTService<PT>

org.scijava.plugin.AbstractSingletonService<Translator>

io.scif.services.DefaultTranslatorService

All Implemented Interfaces:

SCIFIOService, TranslatorService, Comparable<org.scijava.Prioritized>, org.scijava.Contextual, org.scijava.Disposable, org.scijava.Identifiable, org.scijava.Initializable, org.scijava.Locatable, org.scijava.log.Logged, org.scijava.plugin.HasPluginInfo, org.scijava.plugin.PTService<Translator>, org.scijava.plugin.RichPlugin, org.scijava.plugin.SciJavaPlugin, org.scijava.plugin.SingletonService<Translator>, org.scijava.Prioritized, org.scijava.service.Service, org.scijava.Versioned

public class DefaultTranslatorService
extends org.scijava.plugin.AbstractSingletonService<Translator>
implements TranslatorService

Default TranslatorService implementation. If a false exact flag is passed to findTranslator(Metadata, Metadata, boolean) and an exact translator can not be found, this service will first try to match the destination type, then source type, then will accept any generic Metadata translator.

Author:

Mark Hiner

Constructor Summary

Constructors

Constructor and Description
DefaultTranslatorService()

Method Summary

Modifier and Type	Method and Description
Translator	findTranslator(Class<? extends Metadata> source, Class<? extends Metadata> dest, boolean exact) Returns a translator capable of translating from the source Metadata to the dest Metadata type, or null if no such Translator exists.
Translator	findTranslator(Metadata source, Metadata dest, boolean exact) Returns a translator capable of translating from the source Metadata to the dest Metadata type, or null if no such Translator exists.
Class<Translator>	getPluginType()
boolean	translate(Metadata source, Metadata dest, boolean exact) Convenience method to immediately translate from the source Metadata to the dest Metadata type, assuming an appropriate Translator is found.

Methods inherited from class org.scijava.plugin.AbstractSingletonService

getInstance, getInstances, objectService, onEvent, onEvent

Methods inherited from class org.scijava.plugin.AbstractPTService

pluginService

Methods inherited from class org.scijava.service.AbstractService

getContext, setContext, toString

Methods inherited from class org.scijava.plugin.AbstractRichPlugin

getInfo, getPriority, setInfo, setPriority

Methods inherited from class org.scijava.AbstractContextual

context

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.scijava.plugin.SingletonService

create, filterInstances, getInstance, getInstances, initialize, objectService

Methods inherited from interface org.scijava.plugin.PTService

getPlugins, getPluginService, pluginService

Methods inherited from interface org.scijava.service.Service

registerEventHandlers

Methods inherited from interface org.scijava.plugin.RichPlugin

getIdentifier, log

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 org.scijava.Versioned

getVersion

Methods inherited from interface org.scijava.Disposable

dispose

Constructor Detail

DefaultTranslatorService

public DefaultTranslatorService()

Method Detail

findTranslator

public Translator findTranslator(Metadata source,
                                 Metadata dest,
                                 boolean exact)

Description copied from interface: TranslatorService

Returns a translator capable of translating from the source Metadata to the dest Metadata type, or null if no such Translator exists.

Specified by:

findTranslator in interface TranslatorService

Parameters:

source - - Metadata to read from

dest - - Metadata to populate

exact - - true if a translator that exactly matches these Metadata is desired

Returns:

Translator whose translate method will accept these Metadata instances

findTranslator

public Translator findTranslator(Class<? extends Metadata> source,
                                 Class<? extends Metadata> dest,
                                 boolean exact)

Description copied from interface: TranslatorService

Returns a translator capable of translating from the source Metadata to the dest Metadata type, or null if no such Translator exists.

Specified by:

findTranslator in interface TranslatorService

Parameters:

source - - Metadata to read from

dest - - Metadata to populate

exact - - true if a translator that exactly matches these Metadata is desired

Returns:

Translator whose translate method will accept these Metadata instances

translate

public boolean translate(Metadata source,
                         Metadata dest,
                         boolean exact)

Description copied from interface: TranslatorService

Convenience method to immediately translate from the source Metadata to the dest Metadata type, assuming an appropriate Translator is found.

Useful if you don't need a handle on the Translator itself.

Specified by:

translate in interface TranslatorService

Parameters:

source - - Metadata to read from

dest - - Metadata to populate

exact - - true if a translator that exactly matches these Metadata is desired

Returns:

true if translation was successful, and false otherwise.

getPluginType

public Class<Translator> getPluginType()

Specified by:

getPluginType in interface org.scijava.plugin.PTService<Translator>