org.hkijena.jipipe.api.registries

Class JIPipeExpressionRegistry

java.lang.Object

org.hkijena.jipipe.api.registries.JIPipeExpressionRegistry

public class JIPipeExpressionRegistry
extends Object

Registry for table operations and other functional expressions

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JIPipeExpressionRegistry.ColumnOperationEntry A column operation entry
static class	JIPipeExpressionRegistry.ExpressionFunctionEntry

Constructor Summary

Constructors

Constructor and Description
JIPipeExpressionRegistry(JIPipe jiPipe)

Method Summary

Modifier and Type	Method and Description
JIPipeExpressionRegistry.ColumnOperationEntry	getColumnOperationById(String id) Returns an operation by ID
JIPipe	getJIPipe()
Map<String,JIPipeExpressionRegistry.ExpressionFunctionEntry>	getRegisteredExpressionFunctions() Registered expression functions.
Map<String,JIPipeExpressionRegistry.ColumnOperationEntry>	getRegisteredTableColumnOperations() The registered column operations.
Map<String,JIPipeExpressionRegistry.ColumnOperationEntry>	getTableColumnOperationsOfType(Class<? extends ColumnOperation> filterClass) Returns all operations that are assignable to the filter class
void	registerColumnOperation(String id, ColumnOperation operation, String name, String shortName, String description) Registers a new operation.
void	registerExpressionFunction(ExpressionFunction function, String name, String description) Registers an new function that will be usable within expressions.

Methods inherited from class java.lang.Object

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

Constructor Detail

JIPipeExpressionRegistry

public JIPipeExpressionRegistry(JIPipe jiPipe)

Method Detail

getRegisteredTableColumnOperations

public Map<String,JIPipeExpressionRegistry.ColumnOperationEntry> getRegisteredTableColumnOperations()

The registered column operations. Column operations can work on arrays of String or Double

Returns:

all registered column operations

getRegisteredExpressionFunctions

public Map<String,JIPipeExpressionRegistry.ExpressionFunctionEntry> getRegisteredExpressionFunctions()

Registered expression functions. Utilized within DefaultExpressionEvaluator.

Returns:

the registered functions

registerColumnOperation

public void registerColumnOperation(String id,
                                    ColumnOperation operation,
                                    String name,
                                    String shortName,
                                    String description)

Registers a new operation. The expression function will use the upper-case short name as function name and replace all spaces with underscores.

Parameters:

id - unique id

operation - operation instance

name - name

shortName - a short name that will be used in table headers (e.g. avg, var, ...)

description - a description

registerExpressionFunction

public void registerExpressionFunction(ExpressionFunction function,
                                       String name,
                                       String description)

Registers an new function that will be usable within expressions.

Parameters:

function - the function instance. Its name will be used as identifier.

name - the human-readable name

description - a description

getColumnOperationById

public JIPipeExpressionRegistry.ColumnOperationEntry getColumnOperationById(String id)

Returns an operation by ID

Parameters:

id - the ID

Returns:

the operation

getTableColumnOperationsOfType

public Map<String,JIPipeExpressionRegistry.ColumnOperationEntry> getTableColumnOperationsOfType(Class<? extends ColumnOperation> filterClass)

Returns all operations that are assignable to the filter class

Parameters:

filterClass - the filter class

Returns:

all operations that are assignable to the filter class

getJIPipe

public JIPipe getJIPipe()