All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.scijava.convert.AbstractConvertService Maven / Gradle / Ivy

/*
 * #%L
 * SciJava Common shared library for SciJava software.
 * %%
 * Copyright (C) 2009 - 2017 Board of Regents of the University of
 * Wisconsin-Madison, Broad Institute of MIT and Harvard, Max Planck
 * Institute of Molecular Cell Biology and Genetics, University of
 * Konstanz, and KNIME GmbH.
 * %%
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 * #L%
 */

package org.scijava.convert;

import java.lang.reflect.Type;
import java.util.Collection;
import java.util.HashSet;
import java.util.LinkedHashSet;
import java.util.Set;

import org.scijava.plugin.AbstractHandlerService;
import org.scijava.util.ConversionUtils;

/**
 * Abstract superclass for {@link ConvertService} implementations. Sets this
 * service as the active delegate service in {@link ConversionUtils}.
 *
 * @author Mark Hiner
 */
public abstract class AbstractConvertService extends AbstractHandlerService>
		implements ConvertService {

	// -- ConversionService methods --
	@SuppressWarnings({ "unchecked", "rawtypes" })
	@Override
	public Class> getPluginType() {
		return (Class) Converter.class;
	}

	@Override
	public Class getType() {
		return ConversionRequest.class;
	}

	@Override
	public Converter getHandler(final Object src, final Class dest) {
		return getHandler(new ConversionRequest(src, dest));
	}

	@Override
	public Converter getHandler(final Class src, final Class dest) {
		return getHandler(new ConversionRequest(src, dest));
	}

	@Override
	public Converter getHandler(final Object src, final Type dest) {
		return getHandler(new ConversionRequest(src, dest));
	}

	@Override
	public Converter getHandler(final Class src, final Type dest) {
		return getHandler(new ConversionRequest(src, dest));
	}

	@Override
	public boolean supports(final Object src, final Class dest) {
		return supports(new ConversionRequest(src, dest));
	}

	@Override
	public boolean supports(final Class src, final Class dest) {
		return supports(new ConversionRequest(src, dest));
	}

	@Override
	public boolean supports(final Object src, final Type dest) {
		return supports(new ConversionRequest(src, dest));
	}

	@Override
	public boolean supports(final Class src, final Type dest) {
		return supports(new ConversionRequest(src, dest));
	}

	@Override
	public Collection getCompatibleInputs(final Class dest) {
		final Set objects = new LinkedHashSet<>();

		for (final Converter c : getInstances()) {
			if (dest.isAssignableFrom(c.getOutputType())) {
				c.populateInputCandidates(objects);
			}
		}

		return objects;
	}

	@Override
	public Object convert(final Object src, final Type dest) {
		return convert(new ConversionRequest(src, dest));
	}

	@Override
	public  T convert(final Object src, final Class dest) {
		// NB: repeated code with convert(ConversionRequest), because the
		// handler's convert method respects the T provided
		final Converter handler = getHandler(src, dest);
		return handler == null ? null : handler.convert(src, dest);
	}

	@Override
	public Object convert(final ConversionRequest request) {
		final Converter handler = getHandler(request);
		return handler == null ? null : handler.convert(request);
	}

	@Override
	public Collection> getCompatibleInputClasses(final Class dest) {
		final Set> compatibleClasses = new HashSet<>();

		for (final Converter converter : getInstances()) {
			addIfMatches(dest, converter.getOutputType(), converter.getInputType(), compatibleClasses);
		}

		return compatibleClasses;
	}

	@Override
	public Collection> getCompatibleOutputClasses(final Class source) {
		final Set> compatibleClasses = new HashSet<>();

		for (final Converter converter : getInstances()) {
			addIfMatches(source, converter.getInputType(), converter.getOutputType(), compatibleClasses);
		}

		return compatibleClasses;
	}

	// -- Service methods --

	@Override
	public void initialize() {
		ConversionUtils.setDelegateService(this, getPriority());
	}

	// -- Helper methods --

	/**
	 * Test two classes; if they match, a third class is added to the provided
	 * set of classes.
	 */
	private void addIfMatches(final Class c1, final Class c2, final Class toAdd, final Set> classes) {
		if (c1 == c2)
			classes.add(toAdd);
	}
}