AbstractExpressionParameter (jipipe 5.1.0-SNAPSHOT API)

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

All Implemented Interfaces:

JIPipeCustomTextDescriptionParameter

Direct Known Subclasses:

JIPipeExpressionParameter
```
public abstract class AbstractExpressionParameter
extends Object
implements JIPipeCustomTextDescriptionParameter
```
A parameter that contains an expression. This allows users to set up filters etc. from within the UI. Use JIPipeExpressionParameterSettings 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
`boolean`	`equals(Object o)`
`Object`	`evaluate(JIPipeExpressionVariablesMap variables)` Runs the expression and returns the result.
`boolean`	`evaluateToBoolean(JIPipeExpressionVariablesMap variables)` Runs the expression and returns the boolean result.
`Color`	`evaluateToColor(JIPipeExpressionVariablesMap variables)` Runs the expression and returns a color result.
`double`	`evaluateToDouble(JIPipeExpressionVariablesMap variables)` Runs the expression and returns the numeric result.
`List<Double>`	`evaluateToDoubleList(JIPipeExpressionVariablesMap variables)` Runs the expression and returns the numeric result.
`float`	`evaluateToFloat(JIPipeExpressionVariablesMap variables)` Runs the expression and returns the numeric result.
`int`	`evaluateToInteger(JIPipeExpressionVariablesMap variables)` Runs the expression and returns the numeric result.
`int`	`evaluateToIntegerSafe(JIPipeExpressionVariablesMap variables, int defaultValue)` Runs the expression and returns the numeric result.
`double`	`evaluateToNumber(JIPipeExpressionVariablesMap variables)` Runs the expression and returns the numeric result.
`String`	`evaluateToString(JIPipeExpressionVariablesMap variables)` Runs the expression and returns the string result.
`abstract ExpressionEvaluator`	`getEvaluator()` Returns the evaluator instance that should evaluate this expression type
`String`	`getExpression()`
`String`	`getTextDescription()` Gets the parameter as custom text description
`int`	`hashCode()`
`boolean`	`isEmpty()` Returns true if the expression is empty
`void`	`setExpression(String expression)`
`boolean`	`test(JIPipeExpressionVariablesMap variables)` Runs the expression and returns the boolean result.
`String`	`toString()`

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

Methods inherited from interface org.hkijena.jipipe.api.parameters.JIPipeCustomTextDescriptionParameter
getTextDescriptionOf

- 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(JIPipeExpressionVariablesMap 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(JIPipeExpressionVariablesMap 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(JIPipeExpressionVariablesMap 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
  - evaluateToIntegerSafe
```
public int evaluateToIntegerSafe(JIPipeExpressionVariablesMap variables,
                                 int defaultValue)
```
    Runs the expression and returns the numeric result. If no number is returned, return the default value.
    
    Parameters:
    
    variables - the variables
    
    defaultValue - the default value
    
    Returns:
    
    the result
  - evaluateToDouble
```
public double evaluateToDouble(JIPipeExpressionVariablesMap 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
  - evaluateToDoubleList
```
public List<Double> evaluateToDoubleList(JIPipeExpressionVariablesMap 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(JIPipeExpressionVariablesMap 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(JIPipeExpressionVariablesMap variables)
```
    Runs the expression and returns the string result.
    
    Parameters:
    
    variables - the variables
    
    Returns:
    
    the result
  - evaluateToBoolean
```
public boolean evaluateToBoolean(JIPipeExpressionVariablesMap variables)
```
    Runs the expression and returns the boolean result.
    
    Parameters:
    
    variables - the variables
    
    Returns:
    
    the result
  - evaluateToColor
```
public Color evaluateToColor(JIPipeExpressionVariablesMap 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
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - evaluate
```
public Object evaluate(JIPipeExpressionVariablesMap variables)
```
    Runs the expression and returns the result.
    
    Parameters:
    
    variables - the variables
    
    Returns:
    
    the result
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getTextDescription
```
public String getTextDescription()
```
    Description copied from interface: JIPipeCustomTextDescriptionParameter
    
    Gets the parameter as custom text description
    
    Specified by:
    
    getTextDescription in interface JIPipeCustomTextDescriptionParameter
    
    Returns:
    
    the text description

Class AbstractExpressionParameter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractExpressionParameter

AbstractExpressionParameter

AbstractExpressionParameter

Method Detail

getExpression

setExpression

getEvaluator

test

isEmpty

evaluateToNumber

evaluateToInteger

evaluateToIntegerSafe

evaluateToDouble

evaluateToDoubleList

evaluateToFloat

evaluateToString

evaluateToBoolean

evaluateToColor

equals

hashCode

evaluate

toString

getTextDescription