AbstractExpressionParameter (jipipe 1.76.1-SNAPSHOT API)

java.lang.Object
- org.hkijena.jipipe.extensions.expressions.AbstractExpressionParameter

Direct Known Subclasses:

DefaultExpressionParameter
```
public abstract class AbstractExpressionParameter
extends Object
```
A parameter that contains an expression. This allows users to set up filters etc. from within the UI. Use ExpressionParameterSettings to control the behavior of this parameter.

Constructor Summary

Constructors
Constructor and Description

AbstractExpressionParameter()

AbstractExpressionParameter(AbstractExpressionParameter other)

AbstractExpressionParameter(String expression)

Constructors
Constructor and Description
`AbstractExpressionParameter()`
`AbstractExpressionParameter(AbstractExpressionParameter other)`
`AbstractExpressionParameter(String expression)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`Object`	`evaluate(ExpressionVariables variables)` Runs the expression and returns the result.
`boolean`	`evaluateToBoolean(ExpressionVariables variables)` Runs the expression and returns the boolean result.
`Color`	`evaluateToColor(ExpressionVariables variables)` Runs the expression and returns a color result.
`double`	`evaluateToDouble(ExpressionVariables variables)` Runs the expression and returns the numeric result.
`float`	`evaluateToFloat(ExpressionVariables variables)` Runs the expression and returns the numeric result.
`int`	`evaluateToInteger(ExpressionVariables variables)` Runs the expression and returns the numeric result.
`double`	`evaluateToNumber(ExpressionVariables variables)` Runs the expression and returns the numeric result.
`String`	`evaluateToString(ExpressionVariables variables)` Runs the expression and returns the string result.
`abstract ExpressionEvaluator`	`getEvaluator()` Returns the evaluator instance that should evaluate this expression type
`String`	`getExpression()`
`boolean`	`isEmpty()` Returns true if the expression is empty
`void`	`setExpression(String expression)`
`boolean`	`test(ExpressionVariables variables)` Runs the expression and returns the boolean result.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AbstractExpressionParameter
```
public AbstractExpressionParameter()
```
  - AbstractExpressionParameter
```
public AbstractExpressionParameter(String expression)
```
  - AbstractExpressionParameter
```
public AbstractExpressionParameter(AbstractExpressionParameter other)
```
- Method Detail
  - getExpression
```
public String getExpression()
```
  - setExpression
```
public void setExpression(String expression)
```
  - getEvaluator
```
public abstract ExpressionEvaluator getEvaluator()
```
    Returns the evaluator instance that should evaluate this expression type
    
    Returns:
    
    the evaluator
  - test
```
public boolean test(ExpressionVariables variables)
```
    Runs the expression and returns the boolean result. If no boolean is returned, an error is thrown.
    
    Parameters:
    
    variables - the variables
    
    Returns:
    
    the result
  - isEmpty
```
public boolean isEmpty()
```
    Returns true if the expression is empty
    
    Returns:
    
    true if the expression is empty
  - evaluateToNumber
```
public double evaluateToNumber(ExpressionVariables variables)
```
    Runs the expression and returns the numeric result. If no number is returned, an error is thrown.
    
    Parameters:
    
    variables - the variables
    
    Returns:
    
    the result
  - evaluateToInteger
```
public int evaluateToInteger(ExpressionVariables variables)
```
    Runs the expression and returns the numeric result. If no number is returned, an error is thrown.
    
    Parameters:
    
    variables - the variables
    
    Returns:
    
    the result
  - evaluateToDouble
```
public double evaluateToDouble(ExpressionVariables variables)
```
    Runs the expression and returns the numeric result. If no number is returned, an error is thrown.
    
    Parameters:
    
    variables - the variables
    
    Returns:
    
    the result
  - evaluateToFloat
```
public float evaluateToFloat(ExpressionVariables variables)
```
    Runs the expression and returns the numeric result. If no number is returned, an error is thrown.
    
    Parameters:
    
    variables - the variables
    
    Returns:
    
    the result
  - evaluateToString
```
public String evaluateToString(ExpressionVariables variables)
```
    Runs the expression and returns the string result.
    
    Parameters:
    
    variables - the variables
    
    Returns:
    
    the result
  - evaluateToBoolean
```
public boolean evaluateToBoolean(ExpressionVariables variables)
```
    Runs the expression and returns the boolean result.
    
    Parameters:
    
    variables - the variables
    
    Returns:
    
    the result
  - evaluateToColor
```
public Color evaluateToColor(ExpressionVariables variables)
```
    Runs the expression and returns a color result. Can handle return value of type Color, hex string, named colors according to ColorUtils, Collection of RGB or RGBA values (0-255) Can also handle numeric results that are converted to int, generating a greyscale color (0-255)
    
    Parameters:
    
    variables - the variables
    
    Returns:
    
    the result
  - evaluate
```
public Object evaluate(ExpressionVariables variables)
```
    Runs the expression and returns the result.
    
    Parameters:
    
    variables - the variables
    
    Returns:
    
    the result
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class AbstractExpressionParameter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractExpressionParameter

AbstractExpressionParameter

AbstractExpressionParameter

Method Detail

getExpression

setExpression

getEvaluator

test

isEmpty

evaluateToNumber

evaluateToInteger

evaluateToDouble

evaluateToFloat

evaluateToString

evaluateToBoolean

evaluateToColor

evaluate

toString