Package org.cytoscape.equations
Interface Interpreter
public interface Interpreter
Executes the code represented by an equation.
Module: equations-api
To use this in your app, include the following dependency in your POM:
<dependency> <groupId>org.cytoscape</groupId> <artifactId>equations-api</artifactId> </dependency>
Cytoscape Backwards Compatibility (API Interface): We expect that this interface will be used but not implemented by developers using this interface. As such, we reserve the right to add methods to the interface as part of minor version upgrades. We will not remove methods for any changes other than major version upgrades.
-
Method Summary
-
Method Details
-
execute
Object execute(Equation equation, Map<String, IdentDescriptor> variableNameToDescriptorMap) throws NullPointerException, ArithmeticException, IllegalArgumentException, IllegalStateExceptionExecutes the code represented by "equation".- Parameters:
equation
- compiled code and metadatavariableNameToDescriptorMap
- a mapping of equation variable references to their types and current values- Returns:
- a Double, Boolean or String object that is the result of a successful execution.
- Throws:
NullPointerException
- thrown if either "equation" or "variableNameToDescriptorMap" are nullArithmeticException
- thrown if an arithmetic error was detected like a division by zero etc.IllegalArgumentException
- thrown if a function invocation resulted in a function detecting an invalid argumentIllegalStateException
- thrown if an invalid interpreter internal state was reached Please note that for each variable reference in "equation" there needs to be an entry in "variableNameToDescriptorMap"
-