org.scijava.command.CommandModuleItem 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
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 downstream projects in the SciJava ecosystem, such as ImageJ and SCIFIO.
/*
* #%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.command;
import java.lang.reflect.Field;
import java.lang.reflect.Type;
import java.util.ArrayList;
import java.util.List;
import org.scijava.ItemIO;
import org.scijava.ItemVisibility;
import org.scijava.Optional;
import org.scijava.module.AbstractModuleItem;
import org.scijava.module.ModuleInfo;
import org.scijava.module.ModuleItem;
import org.scijava.plugin.Attr;
import org.scijava.plugin.Parameter;
import org.scijava.util.ConversionUtils;
import org.scijava.util.Types;
/**
* {@link ModuleItem} implementation describing an input or output of a command.
*
* @author Curtis Rueden
*/
public class CommandModuleItem extends AbstractModuleItem {
private final Field field;
public CommandModuleItem(final ModuleInfo info, final Field field) {
super(info);
this.field = field;
}
// -- CommandModuleItem methods --
public Field getField() {
return field;
}
public Parameter getParameter() {
return field.getAnnotation(Parameter.class);
}
// -- ModuleItem methods --
@Override
public Class getType() {
final Class type = Types.raw(Types.fieldType(field, getDelegateClass()));
@SuppressWarnings("unchecked")
final Class typedType = (Class) type;
return typedType;
}
@Override
public Type getGenericType() {
return Types.fieldType(field, getDelegateClass());
}
@Override
public ItemIO getIOType() {
return getParameter().type();
}
@Override
public ItemVisibility getVisibility() {
return getParameter().visibility();
}
@Override
public boolean isAutoFill() {
return getParameter().autoFill();
}
@Override
public boolean isRequired() {
return getParameter().required() &&
!Optional.class.isAssignableFrom(getType());
}
@Override
public boolean isPersisted() {
return getParameter().persist();
}
@Override
public String getPersistKey() {
return getParameter().persistKey();
}
@Override
public String getInitializer() {
return getParameter().initializer();
}
@Override
public String getValidater() {
return getParameter().validater();
}
@Override
public String getCallback() {
return getParameter().callback();
}
@Override
public String getWidgetStyle() {
return getParameter().style();
}
@Override
public T getMinimumValue() {
return tValue(getParameter().min());
}
@Override
public T getMaximumValue() {
return tValue(getParameter().max());
}
@Override
public T getDefaultValue() {
// NB: The default value for a command is the initial field value.
// E.g.:
//
// @Parameter
// private int weekdays = 5;
//
// To obtain this information, we need to instantiate the module, then
// extract the value of the associated field.
//
// Of course, the command might do evil things like:
//
// @Parameter
// private long time = System.currentTimeMillis();
//
// In which case the default value will vary by instance. But there is
// nothing we can really do about that. This is only a best effort.
try {
final Object dummy = getInfo().loadDelegateClass().newInstance();
@SuppressWarnings("unchecked")
final T value = (T) getField().get(dummy);
return value;
}
catch (final InstantiationException | IllegalAccessException
| ClassNotFoundException exc)
{
throw new IllegalStateException(exc);
}
}
@Override
public Number getStepSize() {
// FIXME: stepSize should be typed on T, not Number!
final String value = getParameter().stepSize();
try {
final double stepSize = Double.parseDouble(value);
return stepSize;
}
catch (final NumberFormatException exc) {
return tValue(value, Number.class);
}
}
@Override
public int getColumnCount() {
return getParameter().columns();
}
@Override
public List getChoices() {
final String[] choices = getParameter().choices();
if (choices.length == 0) return super.getChoices();
final ArrayList choiceList = new ArrayList<>();
for (final String choice : choices) {
choiceList.add(tValue(choice));
}
return choiceList;
}
// -- BasicDetails methods --
@Override
public String getLabel() {
return getParameter().label();
}
@Override
public String getDescription() {
return getParameter().description();
}
@Override
public boolean is(final String key) {
for (final Attr attr : getParameter().attrs()) {
if (attr.name().equals(key)) return true;
}
return false;
}
@Override
public String get(final String key) {
for (final Attr attr : getParameter().attrs()) {
if (attr.name().equals(key)) return attr.value();
}
return null;
}
// -- Named methods --
@Override
public String getName() {
return field.getName();
}
// -- Helper methods --
private T tValue(final String value) {
return tValue(value, getType());
}
private D tValue(final String value, final Class type) {
if (value == null || value.isEmpty()) return null;
final Class saneType = Types.box(type);
return ConversionUtils.convert(value, saneType);
}
}