org.hkijena.jipipe.plugins.expressions

Class AnnotationGeneratorExpression

java.lang.Object

org.hkijena.jipipe.plugins.expressions.AbstractExpressionParameter

org.hkijena.jipipe.plugins.expressions.JIPipeExpressionParameter

org.hkijena.jipipe.plugins.expressions.AnnotationGeneratorExpression

All Implemented Interfaces:

JIPipeCustomTextDescriptionParameter

public class AnnotationGeneratorExpression
extends JIPipeExpressionParameter

An expression that is used to generate annotations for data

Nested Class Summary

Nested classes/interfaces inherited from class org.hkijena.jipipe.plugins.expressions.JIPipeExpressionParameter

JIPipeExpressionParameter.Deserializer, JIPipeExpressionParameter.List, JIPipeExpressionParameter.Serializer

Constructor Summary

Constructors

Constructor and Description
AnnotationGeneratorExpression()
AnnotationGeneratorExpression(AbstractExpressionParameter other)
AnnotationGeneratorExpression(String expression)

Method Summary

Modifier and Type	Method and Description
String	generateAnnotationValue(Collection<JIPipeTextAnnotation> annotations, JIPipeExpressionVariablesMap variableSet) Generates an annotation value
boolean	test(Collection<JIPipeTextAnnotation> annotations, String dataString, JIPipeExpressionVariablesMap variables) Evaluates the expression as boolean

Methods inherited from class org.hkijena.jipipe.plugins.expressions.JIPipeExpressionParameter

escapeString, escapeString, getAdditionalUIVariables, getEvaluator, getEvaluatorInstance, isValidVariableName, setAdditionalUIVariables

Methods inherited from class org.hkijena.jipipe.plugins.expressions.AbstractExpressionParameter

equals, evaluate, evaluateToBoolean, evaluateToColor, evaluateToDouble, evaluateToDoubleList, evaluateToFloat, evaluateToInteger, evaluateToIntegerSafe, evaluateToNumber, evaluateToString, getExpression, getTextDescription, hashCode, isEmpty, setExpression, test, 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

AnnotationGeneratorExpression

public AnnotationGeneratorExpression()

AnnotationGeneratorExpression

public AnnotationGeneratorExpression(String expression)

AnnotationGeneratorExpression

public AnnotationGeneratorExpression(AbstractExpressionParameter other)

Method Detail

generateAnnotationValue

public String generateAnnotationValue(Collection<JIPipeTextAnnotation> annotations,
                                      JIPipeExpressionVariablesMap variableSet)

Generates an annotation value

Parameters:

annotations - existing annotations for the data

variableSet - existing variables

Returns:

the annotation value

test

public boolean test(Collection<JIPipeTextAnnotation> annotations,
                    String dataString,
                    JIPipeExpressionVariablesMap variables)

Evaluates the expression as boolean

Parameters:

annotations - existing annotations for the data

dataString - the data as string

variables - existing variables

Returns:

the test results.