org.hkijena.jipipe.utils

Class ParameterUtils

java.lang.Object

org.hkijena.jipipe.utils.ParameterUtils

public class ParameterUtils
extends Object

Method Summary

Modifier and Type	Method and Description
static void	deserializeParametersFromJson(JIPipeParameterCollection target, com.fasterxml.jackson.databind.JsonNode node, JIPipeIssueReport issues) Deserializes parameters from JSON
static <T> T	getParameter(JIPipeParameterCollection collection, String key, Class<T> klass) Gets a parameter from a JIPipeParameterCollection
static boolean	isHiddenLocalParameter(JIPipeParameterTree tree, JIPipeParameterAccess access, String... keys) Returns true if the provided parameter is local (i.e. only shown if its not a sub-parameter) and therefore should be hidden
static boolean	isHiddenLocalParameterCollection(JIPipeParameterTree tree, JIPipeParameterCollection collection, String... keys) Returns true if the collection is not a direct child of the tree root
static void	serializeParametersToJson(JIPipeParameterCollection target, com.fasterxml.jackson.core.JsonGenerator jsonGenerator) Serializes parameters to JSON using a generator
static void	serializeParametersToJson(JIPipeParameterCollection target, com.fasterxml.jackson.core.JsonGenerator jsonGenerator, Predicate<Map.Entry<String,JIPipeParameterAccess>> filter) Serializes parameters to JSON using a generator
static boolean	setParameter(JIPipeParameterCollection collection, String key, Object value) Sets a parameter of a JIPipeParameterCollection and triggers the associated events

Methods inherited from class java.lang.Object

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

Method Detail

deserializeParametersFromJson

public static void deserializeParametersFromJson(JIPipeParameterCollection target,
                                                 com.fasterxml.jackson.databind.JsonNode node,
                                                 JIPipeIssueReport issues)

Deserializes parameters from JSON

Parameters:

target - the target object that contains the parameters

node - the JSON node

issues - issues during deserialization

serializeParametersToJson

public static void serializeParametersToJson(JIPipeParameterCollection target,
                                             com.fasterxml.jackson.core.JsonGenerator jsonGenerator)
                                      throws IOException

Serializes parameters to JSON using a generator

Parameters:

target - the serialized parameter collection

jsonGenerator - the JSON target

Throws:

IOException

serializeParametersToJson

public static void serializeParametersToJson(JIPipeParameterCollection target,
                                             com.fasterxml.jackson.core.JsonGenerator jsonGenerator,
                                             Predicate<Map.Entry<String,JIPipeParameterAccess>> filter)
                                      throws IOException

Serializes parameters to JSON using a generator

Parameters:

target - the serialized parameter collection

jsonGenerator - the JSON target

filter - filter to conditionally serialize entries. can be null

Throws:

IOException

setParameter

public static boolean setParameter(JIPipeParameterCollection collection,
                                   String key,
                                   Object value)

Sets a parameter of a JIPipeParameterCollection and triggers the associated events

Parameters:

collection - the collection

key - the parameter key

value - the parameter value

Returns:

if the parameter could be set

getParameter

public static <T> T getParameter(JIPipeParameterCollection collection,
                                 String key,
                                 Class<T> klass)

Gets a parameter from a JIPipeParameterCollection

Type Parameters:

T - the parameter class

Parameters:

collection - the collection

key - the parameter key

klass - the parameter class

Returns:

the current value

isHiddenLocalParameter

public static boolean isHiddenLocalParameter(JIPipeParameterTree tree,
                                             JIPipeParameterAccess access,
                                             String... keys)

Returns true if the provided parameter is local (i.e. only shown if its not a sub-parameter) and therefore should be hidden

Parameters:

tree - the parameter tree

access - the tested parameter

keys - list of local parameter keys. only parameters in the key set are tested. If empty, all keys are tested

Returns:

if the parameter is hidden

isHiddenLocalParameterCollection

public static boolean isHiddenLocalParameterCollection(JIPipeParameterTree tree,
                                                       JIPipeParameterCollection collection,
                                                       String... keys)

Returns true if the collection is not a direct child of the tree root

Parameters:

tree - the parameter tree

collection - the collection to be tested

keys - list of collection local keys. only collections with these keys are tested. If empty, all collections are tested.

Returns:

if the collection is hidden