org.hkijena.jipipe.api.parameters

Class JIPipeParameterCollectionVisibilities

java.lang.Object

org.hkijena.jipipe.api.parameters.JIPipeParameterCollectionVisibilities

public class JIPipeParameterCollectionVisibilities
extends Object

Used as parameter to control the visibility of an existing parameter collection

Constructor Summary

Constructors

Constructor and Description
JIPipeParameterCollectionVisibilities() Creates new instance
JIPipeParameterCollectionVisibilities(JIPipeParameterCollectionVisibilities other) Creates a copy

Method Summary

Modifier and Type	Method and Description
Map<String,JIPipeParameterAccess>	getAvailableParameters() An optional reference of all available parameters.
Set<String>	getVisibleParameters()
boolean	isVisible(String key) Returns if the parameter is visible
void	setAvailableParameters(Map<String,JIPipeParameterAccess> availableParameters) Sets the list of available parameters
void	setVisibility(String key, boolean visible) Sets the visibility of parameter with specified key
void	setVisibleParameters(Set<String> visibleParameters) Sets visible parameters

Methods inherited from class java.lang.Object

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

Constructor Detail

JIPipeParameterCollectionVisibilities

public JIPipeParameterCollectionVisibilities()

Creates new instance

JIPipeParameterCollectionVisibilities

public JIPipeParameterCollectionVisibilities(JIPipeParameterCollectionVisibilities other)

Creates a copy

Parameters:

other - the original

Method Detail

getAvailableParameters

public Map<String,JIPipeParameterAccess> getAvailableParameters()

An optional reference of all available parameters. This is not serialized and can be null

Returns:

reference of all available parameters

setAvailableParameters

public void setAvailableParameters(Map<String,JIPipeParameterAccess> availableParameters)

Sets the list of available parameters

Parameters:

availableParameters - list of available parameters

setVisibility

public void setVisibility(String key,
                          boolean visible)

Sets the visibility of parameter with specified key

Parameters:

key - Unique parameter key

visible - Visibility

getVisibleParameters

public Set<String> getVisibleParameters()

Returns:

Visible parameters

setVisibleParameters

public void setVisibleParameters(Set<String> visibleParameters)

Sets visible parameters

Parameters:

visibleParameters - visible parameters

isVisible

public boolean isVisible(String key)

Returns if the parameter is visible

Parameters:

key - Parameter key

Returns:

If visible