org.hkijena.jipipe.api.parameters

Class JIPipeMutableParameterAccess

java.lang.Object

org.hkijena.jipipe.api.parameters.JIPipeMutableParameterAccess

All Implemented Interfaces:

JIPipeParameterAccess

public class JIPipeMutableParameterAccess
extends Object
implements JIPipeParameterAccess

A mutable implementation of JIPipeParameterAccess The class is partially JSON-serializable (Annotations, for example, are excluded)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JIPipeMutableParameterAccess.Deserializer Deserializes JIPipeMutableParameterAccess

Constructor Summary

Constructors

Constructor and Description
JIPipeMutableParameterAccess() Creates a new instance
JIPipeMutableParameterAccess(JIPipeMutableParameterAccess other) Copies the parameter access
JIPipeMutableParameterAccess(JIPipeParameterAccess other) Creates a new independent parameter from the provided access
JIPipeMutableParameterAccess(JIPipeParameterCollection parameterHolder, String key, Class<?> fieldClass) Creates a new instance

Method Summary

Modifier and Type	Method and Description
<T> T	get(Class<T> klass) Gets the parameter value
Multimap<Class<? extends Annotation>,Annotation>	getAnnotationMap() Mutable access to the annotations
<T extends Annotation> T	getAnnotationOfType(Class<T> klass) Gets an annotation for this parameter
Collection<Annotation>	getAnnotations() Gets all available annotations for this parameter
<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	getFieldClassInfoId()
String	getKey() Returns the unique ID of this parameter
String	getName() Returns the parameter name that is displayed to the user
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
Object	getValue()
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
boolean	isPinned() Returns true if the parameter is pinned to the top
<T> boolean	set(T value) Sets the parameter value
void	setAnnotationMap(Multimap<Class<? extends Annotation>,Annotation> annotationMap)
void	setDescription(String description) Sets the description
void	setFieldClass(Class<?> fieldClass) For internal usage only
void	setFieldClassInfoId(String id)
void	setHidden(boolean hidden)
void	setImportant(boolean important)
void	setKey(String key) For internal use only
void	setName(String name) Sets the name
void	setPersistence(JIPipeParameterPersistence persistence)
void	setPriority(double priority)
void	setShortKey(String shortKey)
void	setSource(JIPipeParameterCollection parameterHolder) For internal usage only
void	setUIOrder(int uiOrder)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hkijena.jipipe.api.parameters.JIPipeParameterAccess

comparePriority

Constructor Detail

JIPipeMutableParameterAccess

public JIPipeMutableParameterAccess()

Creates a new instance

JIPipeMutableParameterAccess

public JIPipeMutableParameterAccess(JIPipeParameterAccess other)

Creates a new independent parameter from the provided access

Parameters:

other - the parameter

JIPipeMutableParameterAccess

public JIPipeMutableParameterAccess(JIPipeParameterCollection parameterHolder,
                                    String key,
                                    Class<?> fieldClass)

Creates a new instance

Parameters:

parameterHolder - The object that holds the parameter

key - Unique parameter key

fieldClass - Parameter field type

JIPipeMutableParameterAccess

public JIPipeMutableParameterAccess(JIPipeMutableParameterAccess other)

Copies the parameter access

Parameters:

other - The original

Method Detail

isPinned

public boolean isPinned()

Description copied from interface: JIPipeParameterAccess

Returns true if the parameter is pinned to the top

Specified by:

isPinned in interface JIPipeParameterAccess

Returns:

if the parameter is pinned to the top

isImportant

public boolean isImportant()

Description copied from interface: JIPipeParameterAccess

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

Specified by:

isImportant in interface JIPipeParameterAccess

Returns:

if the parameter is important

setImportant

public void setImportant(boolean important)

getKey

public String getKey()

Description copied from interface: JIPipeParameterAccess

Returns the unique ID of this parameter

Specified by:

getKey in interface JIPipeParameterAccess

Returns:

Unique parameter key

setKey

public void setKey(String key)

For internal use only

Parameters:

key - key of this access

getName

public String getName()

Description copied from interface: JIPipeParameterAccess

Returns the parameter name that is displayed to the user

Specified by:

getName in interface JIPipeParameterAccess

Returns:

Parameter name

setName

public void setName(String name)

Sets the name

Parameters:

name - The name

getDescription

public String getDescription()

Description copied from interface: JIPipeParameterAccess

Returns a description

Specified by:

getDescription in interface JIPipeParameterAccess

Returns:

Parameter description

setDescription

public void setDescription(String description)

Sets the description

Parameters:

description - The description

isHidden

public boolean isHidden()

Description copied from interface: JIPipeParameterAccess

Returns if the parameter should be hidden from the user

Specified by:

isHidden in interface JIPipeParameterAccess

Returns:

Parameter visibility

setHidden

public void setHidden(boolean hidden)

getAnnotationOfType

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

Description copied from interface: JIPipeParameterAccess

Gets an annotation for this parameter

Specified by:

getAnnotationOfType in interface JIPipeParameterAccess

Type Parameters:

T - Annotation type

Parameters:

klass - Annotation class

Returns:

Annotation or null if not found

getAnnotations

public Collection<Annotation> getAnnotations()

Description copied from interface: JIPipeParameterAccess

Gets all available annotations for this parameter

Specified by:

getAnnotations in interface JIPipeParameterAccess

Returns:

the annotations

getFieldClass

public Class<?> getFieldClass()

Description copied from interface: JIPipeParameterAccess

Returns the parameter data type

Specified by:

getFieldClass in interface JIPipeParameterAccess

Returns:

Parameter class

setFieldClass

public void setFieldClass(Class<?> fieldClass)

For internal usage only

Parameters:

fieldClass - The parameter class

getFieldClassInfoId

public String getFieldClassInfoId()

setFieldClassInfoId

public void setFieldClassInfoId(String id)

getValue

public Object getValue()

get

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

Description copied from interface: JIPipeParameterAccess

Gets the parameter value

Specified by:

get in interface JIPipeParameterAccess

Type Parameters:

T - Parameter data type

Parameters:

klass - Parameter data type

Returns:

Parameter value

set

public <T> boolean set(T value)

Description copied from interface: JIPipeParameterAccess

Sets the parameter value

Specified by:

set in interface JIPipeParameterAccess

Type Parameters:

T - Parameter data type

Parameters:

value - Parameter value

Returns:

If setting the value was successful

getSource

public JIPipeParameterCollection getSource()

Description copied from interface: JIPipeParameterAccess

Gets the object that holds the parameter

Specified by:

getSource in interface JIPipeParameterAccess

Returns:

the object that holds the parameter

setSource

public void setSource(JIPipeParameterCollection parameterHolder)

For internal usage only

Parameters:

parameterHolder - The object that holds the parameter

getPriority

public double getPriority()

Description copied from interface: JIPipeParameterAccess

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

Specified by:

getPriority in interface JIPipeParameterAccess

Returns:

the priority

setPriority

public void setPriority(double priority)

getAnnotationMap

public Multimap<Class<? extends Annotation>,Annotation> getAnnotationMap()

Mutable access to the annotations

Returns:

access to the annotations

setAnnotationMap

public void setAnnotationMap(Multimap<Class<? extends Annotation>,Annotation> annotationMap)

getAnnotationsOfType

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

Description copied from interface: JIPipeParameterAccess

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.

Specified by:

getAnnotationsOfType in interface JIPipeParameterAccess

Type Parameters:

T - the annotation class

Parameters:

klass - the annotation class

Returns:

the list of annotations

getShortKey

public String getShortKey()

Description copied from interface: JIPipeParameterAccess

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

Specified by:

getShortKey in interface JIPipeParameterAccess

Returns:

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

setShortKey

public void setShortKey(String shortKey)

getUIOrder

public int getUIOrder()

Description copied from interface: JIPipeParameterAccess

Controls how the parameter is ordered within the user interface

Specified by:

getUIOrder in interface JIPipeParameterAccess

Returns:

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

setUIOrder

public void setUIOrder(int uiOrder)

getPersistence

public JIPipeParameterPersistence getPersistence()

Description copied from interface: JIPipeParameterAccess

Controls the persistence of the parameter

Specified by:

getPersistence in interface JIPipeParameterAccess

Returns:

the persistence

setPersistence

public void setPersistence(JIPipeParameterPersistence persistence)