org.hkijena.jipipe.extensions.expressions

Class ExpressionFunction

java.lang.Object

com.fathzer.soft.javaluator.Function

org.hkijena.jipipe.extensions.expressions.ExpressionFunction

Direct Known Subclasses:

AccumulateFunction, CaseFunction, ClampFunction, ColumnOperationAdapterFunction, ContainsStringPredicateFunction, CopyNFunction, CreateArrayFunction, CreateHSBColorFunction, CreateLABColorFunction, CreateMapFunction, CreatePairArrayFunction, CreateRGBColorFunction, CumulativeTransformArrayFunction, DefineUserFunction, DoubleToStringFunction, EqualsStringPredicateFunction, EvaluateFunction, EvaluateUserFunction, ExpressionSequenceFunction, ExtractRegexMatchesFunction, FalseColorsFunction, FirstIndexOfFunction, ForEachFunction, GetDateDayFunction, GetDateMonthFunction, GetDateYearFunction, GetFirstItemFunction, GetItemFunction, GetLastItemFunction, GetMapKeysFunction, GetMapValuesFunction, GetParentDirectoryFunction, GetPathNameFunction, GetTimeHoursFunction, GetTimeMinutesFunction, GetTimeSecondsFunction, GetVariableFunction, GetVariableKeysFunction, GetVariablesAsMapFunction, GetVariableValuesFunction, GlobStringPredicateFunction, HasVariableFunction, HexToRGBFunction, HistogramFunction, HistogramThresholdFunction, HSBToLABFunction, HSBToRGBFunction, IfElseExprFunction, IfElseFunction, InvertFunction, IsDirectoryFunction, IsFileFunction, IsNullFunction, LABToHSBFunction, LABToRGBFunction, LastIndexOfFunction, LengthFunction, ParseJsonFunction, PathCombineFunction, PathExistsFunction, PercentageFunction, PercentileFunction, PrintFunction, QuantityConvertFunction, QuantityGetUnitFunction, QuantityGetValueFunction, RandomFunction, RegexStringPredicateFunction, RemoveDuplicatesFunction, RGBToHexFunction, RGBToHSBFunction, RGBToLABFunction, RoundToDecimalsFunction, RunFunctionFunction, SequenceFunction, SetMissingVariableFunction, SetVariableFunction, SetVariableIfFunction, SetVariablesFunction, SliceFunction, SortAscendingArrayFunction, SortDescendingArrayFunction, StringEndsWithPredicateFunction, StringFirstIndexOfFunction, StringFormatFunction, StringJoinFunction, StringLastIndexOfFunction, StringRegexReplaceFunction, StringReplaceFunction, StringSliceBeforeFunction, StringSliceFunction, StringSplitFunction, StringStartsWithPredicateFunction, StringToLowerCaseFunction, StringToUpperCaseFunction, StringTruncateFunction, SummarizeAnnotationsMapFunction, SummarizeMapFunction, SummarizeVariablesFunction, SwitchCaseFunction, SwitchFunction, ToBooleanFunction, ToIntegerFunction, ToJsonFunction, ToNumber2Function, ToNumberFunction, ToStringFunction, TransformArrayFunction, VariableExistsFunction, WhereFunction

public abstract class ExpressionFunction
extends com.fathzer.soft.javaluator.Function

Function that can be utilized in DefaultExpressionEvaluator.

Constructor Summary

Constructors

Constructor and Description
ExpressionFunction(String name, int argumentCount)
ExpressionFunction(String name, int minArgumentCount, int maxArgumentCount)

Method Summary

Modifier and Type	Method and Description
abstract Object	evaluate(List<Object> parameters, ExpressionVariables variables) Runs the function on given parameters
ParameterInfo	getParameterInfo(int index) Returns info about the parameter at index
String	getSignature() Returns the signature of the function
String	getTemplate() Returns a template function that can be used to get users started

Methods inherited from class com.fathzer.soft.javaluator.Function

getMaximumArgumentCount, getMinimumArgumentCount, getName

Methods inherited from class java.lang.Object

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

Constructor Detail

ExpressionFunction

public ExpressionFunction(String name,
                          int argumentCount)

ExpressionFunction

public ExpressionFunction(String name,
                          int minArgumentCount,
                          int maxArgumentCount)

Method Detail

evaluate

public abstract Object evaluate(List<Object> parameters,
                                ExpressionVariables variables)

Runs the function on given parameters

Parameters:

parameters - the parameters

variables - the set of current variables

Returns:

the result

getParameterInfo

public ParameterInfo getParameterInfo(int index)

Returns info about the parameter at index

Parameters:

index - the parameter index

Returns:

the info

getTemplate

public String getTemplate()

Returns a template function that can be used to get users started

Returns:

the template

getSignature

public String getSignature()

Returns the signature of the function

Returns:

the signature