org.scijava.module.process.LoadInputsPreprocessor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of scijava-common Show documentation

SciJava Common is a shared library for SciJava software. It provides a plugin framework, with an extensible mechanism for service discovery, backed by its own annotation processor, so that plugins can be loaded dynamically. It is used by both ImageJ and SCIFIO.

There is a newer version: 2.99.0

Show newest version

/*
 * #%L
 * SciJava Common shared library for SciJava software.
 * %%
 * Copyright (C) 2009 - 2016 Board of Regents of the University of
 * Wisconsin-Madison, Broad Institute of MIT and Harvard, and Max Planck
 * Institute of Molecular Cell Biology and Genetics.
 * %%
 * 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.module.process;

import org.scijava.convert.ConvertService;
import org.scijava.module.Module;
import org.scijava.module.ModuleItem;
import org.scijava.module.ModuleService;
import org.scijava.plugin.Parameter;
import org.scijava.plugin.Plugin;
import org.scijava.util.ConversionUtils;
import org.scijava.widget.InputHarvester;

/**
 * A preprocessor for loading populated input values from persistent storage.
 * 
 * This preprocessor runs late in the chain, to give other preprocessors a
 * chance to populate the inputs first. However, its priority immediately
 * precedes the {@link org.scijava.widget.InputHarvester}'s, so that user-specified
 * values from last time are populated in the user dialog.
 * 
 * 
 * @author Curtis Rueden
 */
@Plugin(type = PreprocessorPlugin.class,
	priority = InputHarvester.PRIORITY + 1)
public class LoadInputsPreprocessor extends AbstractPreprocessorPlugin {

	@Parameter
	private ModuleService moduleService;

	@Parameter
	private ConvertService conversionService;

	// -- ModuleProcessor methods --

	@Override
	public void process(final Module module) {
		final Iterable> inputs = module.getInfo().inputs();
		for (final ModuleItem item : inputs) {
			loadValue(module, item);
		}
	}

	// -- Helper methods --

	/** Loads the value of the given module item from persistent storage. */
	private  void loadValue(final Module module, final ModuleItem item) {
		// skip input that has already been resolved
		if (module.isResolved(item.getName())) return;

		final T prefValue = moduleService.load(item);
		final Class type = item.getType();
		final T defaultValue = item.getValue(module);
		final T value = getBestValue(prefValue, defaultValue, type);
		item.setValue(module, value);
	}

	private  T getBestValue(final Object prefValue,
		final Object defaultValue, final Class type)
	{
		if (prefValue != null) return conversionService.convert(prefValue, type);
		if (defaultValue != null) {
			return conversionService.convert(defaultValue, type);
		}
		return ConversionUtils.getNullValue(type);
	}

}