Skip to content

Commit dfd2657

Browse files
committed
Add preprocessor that assigns default values
Unresolved module items should be assigned their default value, as given by the ModuleService#getDefaultValue() method, before anything else (even module initialization!) happens.
1 parent 74881fa commit dfd2657

File tree

1 file changed

+78
-0
lines changed

1 file changed

+78
-0
lines changed
Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
/*
2+
* #%L
3+
* SciJava Common shared library for SciJava software.
4+
* %%
5+
* Copyright (C) 2009 - 2015 Board of Regents of the University of
6+
* Wisconsin-Madison, Broad Institute of MIT and Harvard, and Max Planck
7+
* Institute of Molecular Cell Biology and Genetics.
8+
* %%
9+
* Redistribution and use in source and binary forms, with or without
10+
* modification, are permitted provided that the following conditions are met:
11+
*
12+
* 1. Redistributions of source code must retain the above copyright notice,
13+
* this list of conditions and the following disclaimer.
14+
* 2. Redistributions in binary form must reproduce the above copyright notice,
15+
* this list of conditions and the following disclaimer in the documentation
16+
* and/or other materials provided with the distribution.
17+
*
18+
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19+
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20+
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21+
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
22+
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23+
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24+
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25+
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26+
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27+
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28+
* POSSIBILITY OF SUCH DAMAGE.
29+
* #L%
30+
*/
31+
32+
package org.scijava.module.process;
33+
34+
import org.scijava.Priority;
35+
import org.scijava.module.Module;
36+
import org.scijava.module.ModuleItem;
37+
import org.scijava.module.ModuleService;
38+
import org.scijava.plugin.Parameter;
39+
import org.scijava.plugin.Plugin;
40+
41+
/**
42+
* A preprocessor plugin that populates default parameter values.
43+
* <p>
44+
* Default values are determined using {@link ModuleService#getDefaultValue}.
45+
* </p>
46+
*
47+
* @author Curtis Rueden
48+
*/
49+
@Plugin(type = PreprocessorPlugin.class, priority = Priority.VERY_HIGH_PRIORITY)
50+
public class DefaultValuePreprocessor extends AbstractPreprocessorPlugin {
51+
52+
@Parameter
53+
private ModuleService moduleService;
54+
55+
// -- ModuleProcessor methods --
56+
57+
@Override
58+
public void process(final Module module) {
59+
for (final ModuleItem<?> input : module.getInfo().inputs()) {
60+
assignDefaultValue(module, input);
61+
}
62+
for (final ModuleItem<?> output : module.getInfo().outputs()) {
63+
assignDefaultValue(module, output);
64+
}
65+
}
66+
67+
// -- Helper methods --
68+
69+
private <T> void assignDefaultValue(final Module module,
70+
final ModuleItem<T> item)
71+
{
72+
if (module.isResolved(item.getName())) return;
73+
final T defaultValue = moduleService.getDefaultValue(item);
74+
if (defaultValue == null) return;
75+
item.setValue(module, defaultValue);
76+
}
77+
78+
}

0 commit comments

Comments
 (0)