org.hkijena.jipipe.extensions.parameters.api.functions

Class FunctionParameter<I,P,O>

java.lang.Object

org.hkijena.jipipe.extensions.parameters.api.functions.FunctionParameter<I,P,O>

All Implemented Interfaces:

JIPipeValidatable

Direct Known Subclasses:

ConvertingTableColumnProcessorParameter, ExpressionTableColumnProcessorParameter, IntegratingTableColumnProcessorParameter, StringPatternExtractionFunction

public abstract class FunctionParameter<I,P,O>
extends Object
implements JIPipeValidatable

A parameter that allows to model a function with an input, an output, and parameters. This can be used if PairParameter is not sufficient 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	FunctionParameter.Deserializer<I,P,O> Deserializes the parameter
static class	FunctionParameter.Serializer Serializes the parameter

Constructor Summary

Constructors

Constructor and Description
FunctionParameter(Class<I> inputClass, Class<P> parameterClass, Class<O> outputClass) Creates a new instance
FunctionParameter(FunctionParameter<I,P,O> other)

Method Summary

Modifier and Type	Method and Description
I	getInput()
Class<I>	getInputClass()
O	getOutput()
Class<O>	getOutputClass()
P	getParameter()
Class<P>	getParameterClass()
String	renderInputName()
String	renderOutputName()
String	renderParameterName()
void	reportValidity(JIPipeIssueReport report) Generates a validity report
void	setInput(I input)
void	setOutput(O output)
void	setParameter(P parameter)
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

Constructor Detail

FunctionParameter

public FunctionParameter(Class<I> inputClass,
                         Class<P> parameterClass,
                         Class<O> outputClass)

Creates a new instance

Parameters:

inputClass - the input class

parameterClass - the parameter class

outputClass - the output class

FunctionParameter

public FunctionParameter(FunctionParameter<I,P,O> other)

Method Detail

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

getInput

public I getInput()

setInput

public void setInput(I input)

getParameter

public P getParameter()

setParameter

public void setParameter(P parameter)

getOutput

public O getOutput()

setOutput

public void setOutput(O output)

getInputClass

public Class<I> getInputClass()

getParameterClass

public Class<P> getParameterClass()

getOutputClass

public Class<O> getOutputClass()

renderInputName

public String renderInputName()

Returns:

The name used for the input in the UI

renderParameterName

public String renderParameterName()

Returns:

The name used for the parameters in the UI

renderOutputName

public String renderOutputName()

Returns:

The name used for the output in the UI

toString

public String toString()

Overrides:

toString in class Object