org.hkijena.jipipe.api.parameters

Interface JIPipeParameterAccess

All Known Implementing Classes:

FunctionParameterInputAccess, FunctionParameterOutputAccess, FunctionParameterParameterAccess, GraphNodeParameterReferenceAccess, JIPipeManualParameterAccess, JIPipeMultiParameterAccess, JIPipeMutableParameterAccess, JIPipeReflectionParameterAccess, ListParameterItemParameterAccess, OptionalParameterContentAccess, PairParameterKeyAccess, PairParameterValueAccess, ParameterTableCellAccess

public interface JIPipeParameterAccess

Interface around accessing a parameter

Method Summary

Modifier and Type	Method and Description
static int	comparePriority(JIPipeParameterAccess lhs, JIPipeParameterAccess rhs) Compares the priority
<T> T	get(Class<T> klass) Gets the parameter value
<T extends Annotation> T	getAnnotationOfType(Class<T> klass) Gets an annotation for this parameter
Collection<Annotation>	getAnnotations() Gets all available annotations for this parameter
default <T extends Annotation> List<T>	getAnnotationsOfType(Class<T> klass) Gets annotations for this parameter (including the field class) Please note that there is no guarantee that repeatable annotations are resolved properly.
String	getDescription() Returns a description
Class<?>	getFieldClass() Returns the parameter data type
String	getKey() Returns the unique ID of this parameter
String	getName() Returns the parameter name that is displayed to the user
default JIPipeParameterPersistence	getPersistence() Controls the persistence of the parameter
double	getPriority() Returns the priority for (de)serializing this parameter.
String	getShortKey() Returns a short form of the ID used, for example to generate a parameter string.
JIPipeParameterCollection	getSource() Gets the object that holds the parameter
int	getUIOrder() Controls how the parameter is ordered within the user interface
boolean	isHidden() Returns if the parameter should be hidden from the user
boolean	isImportant() Returns true if the parameter should be marked in the UI as important
default boolean	isPinned() Returns true if the parameter is pinned to the top
<T> boolean	set(T value) Sets the parameter value

Method Detail

comparePriority

static int comparePriority(JIPipeParameterAccess lhs,
                           JIPipeParameterAccess rhs)

Compares the priority

Parameters:

lhs - access

rhs - access

Returns:

the order

getKey

String getKey()

Returns the unique ID of this parameter

Returns:

Unique parameter key

getName

String getName()

Returns the parameter name that is displayed to the user

Returns:

Parameter name

getDescription

String getDescription()

Returns a description

Returns:

Parameter description

isHidden

boolean isHidden()

Returns if the parameter should be hidden from the user

Returns:

Parameter visibility

isImportant

boolean isImportant()

Returns true if the parameter should be marked in the UI as important

Returns:

if the parameter is important

isPinned

default boolean isPinned()

Returns true if the parameter is pinned to the top

Returns:

if the parameter is pinned to the top

getAnnotationOfType

<T extends Annotation> T getAnnotationOfType(Class<T> klass)

Gets an annotation for this parameter

Type Parameters:

T - Annotation type

Parameters:

klass - Annotation class

Returns:

Annotation or null if not found

getAnnotationsOfType

default <T extends Annotation> List<T> getAnnotationsOfType(Class<T> klass)

Gets annotations for this parameter (including the field class) Please note that there is no guarantee that repeatable annotations are resolved properly. This is an oversight of Java and cannot be resolved on our side. We recommend to check both for the repeatable and container annotations.

Type Parameters:

T - the annotation class

Parameters:

klass - the annotation class

Returns:

the list of annotations

getAnnotations

Collection<Annotation> getAnnotations()

Gets all available annotations for this parameter

Returns:

the annotations

getFieldClass

Class<?> getFieldClass()

Returns the parameter data type

Returns:

Parameter class

get

<T> T get(Class<T> klass)

Gets the parameter value

Type Parameters:

T - Parameter data type

Parameters:

klass - Parameter data type

Returns:

Parameter value

set

<T> boolean set(T value)

Sets the parameter value

Type Parameters:

T - Parameter data type

Parameters:

value - Parameter value

Returns:

If setting the value was successful

getSource

JIPipeParameterCollection getSource()

Gets the object that holds the parameter

Returns:

the object that holds the parameter

getPriority

double getPriority()

Returns the priority for (de)serializing this parameter. Please use the priority constants provided by Priority

Returns:

the priority

getShortKey

String getShortKey()

Returns a short form of the ID used, for example to generate a parameter string. Might return getKey() if none was provided

Returns:

a short form of the ID used, for example to generate a parameter string

getUIOrder

int getUIOrder()

Controls how the parameter is ordered within the user interface

Returns:

a low number indicates that this parameter is put first, while a high number indicates that this parameter is put last

getPersistence

default JIPipeParameterPersistence getPersistence()

Controls the persistence of the parameter

Returns:

the persistence