org.hkijena.jipipe.extensions.parameters.api.pairs

Class PairParameter<K,V>

java.lang.Object

org.hkijena.jipipe.extensions.parameters.api.pairs.PairParameter<K,V>

All Implemented Interfaces:

Map.Entry<K,V>, JIPipeValidatable

Direct Known Subclasses:

DoubleAndDoublePairParameter, ExpressionAndExpressionPairParameter, ExpressionTableColumnGeneratorProcessor, HyperstackDimensionPairParameter, IntegerAndIntegerPairParameter, IntRangeAndIntegerPairParameter, MeasurementColumnSortOrder, NamedStringQueryExpression, NamedTextAnnotationGeneratorExpression, StringAndStringPairParameter, StringQueryExpressionAndSortOrderPairParameter, StringQueryExpressionAndStringPairParameter, StringQueryExpressionAndStringQueryPairParameter, TableColumnGeneratorProcessor, TableColumnSourceExpressionParameter

public abstract class PairParameter<K,V>
extends Object
implements JIPipeValidatable, Map.Entry<K,V>

Parameter equivalent of Map.Entry. We suggest to use ParameterCollectionList if applicable, due to its greater flexibility.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PairParameter.Deserializer<K,V> Deserializes the parameter
static class	PairParameter.Serializer Serializes the parameter

Constructor Summary

Constructors

Constructor and Description
PairParameter(Class<K> keyClass, Class<V> valueClass)
PairParameter(PairParameter<K,V> other) Creates a copy.

Method Summary

Modifier and Type	Method and Description
K	getKey()
Class<K>	getKeyClass()
V	getValue()
Class<V>	getValueClass()
void	reportValidity(JIPipeIssueReport report) Generates a validity report
void	setKey(K key)
V	setValue(V value)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hkijena.jipipe.api.JIPipeValidatable

generateValidityReport

Methods inherited from interface java.util.Map.Entry

comparingByKey, comparingByKey, comparingByValue, comparingByValue, equals, hashCode

Constructor Detail

PairParameter

public PairParameter(Class<K> keyClass,
                     Class<V> valueClass)

Parameters:

keyClass - the key class

valueClass - the stored content

PairParameter

public PairParameter(PairParameter<K,V> other)

Creates a copy. No deep-copy is applied!

Parameters:

other - the original

Method Detail

getValueClass

public Class<V> getValueClass()

reportValidity

public void reportValidity(JIPipeIssueReport report)

Description copied from interface: JIPipeValidatable

Generates a validity report

Specified by:

reportValidity in interface JIPipeValidatable

Parameters:

report - the report to be added to

getKey

public K getKey()

Specified by:

getKey in interface Map.Entry<K,V>

setKey

public void setKey(K key)

getValue

public V getValue()

Specified by:

getValue in interface Map.Entry<K,V>

setValue

public V setValue(V value)

Specified by:

setValue in interface Map.Entry<K,V>

getKeyClass

public Class<K> getKeyClass()

toString

public String toString()

Overrides:

toString in class Object