org.hkijena.jipipe.plugins.expressions

Class StringQueryExpression

java.lang.Object

org.hkijena.jipipe.plugins.expressions.AbstractExpressionParameter

org.hkijena.jipipe.plugins.expressions.JIPipeExpressionParameter

org.hkijena.jipipe.plugins.expressions.StringQueryExpression

All Implemented Interfaces:

Predicate<String>, JIPipeCustomTextDescriptionParameter

public class StringQueryExpression
extends JIPipeExpressionParameter
implements Predicate<String>

Expression for querying strings

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
StringQueryExpression()
StringQueryExpression(String expression)
StringQueryExpression(StringQueryExpression other)

Method Summary

Modifier and Type	Method and Description
String	generate(JIPipeExpressionVariablesMap expressionVariables) Attempts to run the expression.
List<String>	queryAll(Collection<String> strings, JIPipeExpressionVariablesMap expressionVariables) Generates an annotation value
String	queryFirst(Collection<String> strings, JIPipeExpressionVariablesMap expressionVariables) Queries a string out of the list
boolean	test(String string) Returns true if the query matches the string
boolean	test(String string, JIPipeExpressionVariablesMap expressionVariables) Returns true if the query matches the string
boolean	testAnyOf(Collection<String> strings) Returns true of one of the strings matches the query.

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 java.util.function.Predicate

and, isEqual, negate, or

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

getTextDescriptionOf

Constructor Detail

StringQueryExpression

public StringQueryExpression()

StringQueryExpression

public StringQueryExpression(String expression)

StringQueryExpression

public StringQueryExpression(StringQueryExpression other)

Method Detail

generate

public String generate(JIPipeExpressionVariablesMap expressionVariables)

Attempts to run the expression. If this fails, the expression itself is returned.

Parameters:

expressionVariables - expression parameters

Returns:

expression result or the expression itself

queryFirst

public String queryFirst(Collection<String> strings,
                         JIPipeExpressionVariablesMap expressionVariables)

Queries a string out of the list

Parameters:

strings - existing annotations for the data

expressionVariables - expression parameters

Returns:

the annotation that matches the query or null if none matches

queryAll

public List<String> queryAll(Collection<String> strings,
                             JIPipeExpressionVariablesMap expressionVariables)

Generates an annotation value

Parameters:

strings - existing annotations for the data

expressionVariables - expression parameters

Returns:

the annotation that matches the query or null if none matches

test

public boolean test(String string)

Returns true if the query matches the string

Specified by:

test in interface Predicate<String>

Parameters:

string - the string

Returns:

if the query matches

test

public boolean test(String string,
                    JIPipeExpressionVariablesMap expressionVariables)

Returns true if the query matches the string

Parameters:

string - the string

Returns:

if the query matches

testAnyOf

public boolean testAnyOf(Collection<String> strings)

Returns true of one of the strings matches the query.

Parameters:

strings - the strings

Returns:

if one string matches