system

Class GraphanaAccess

java.lang.Object

system.GraphanaAccess

public class GraphanaAccess
extends java.lang.Object

Delivers a quick and easy access to Graphana. This class takes care of initialization including default libraries and operations.

Constructor Summary

Constructors

Constructor and Description
GraphanaAccess() Creates a new instance and initializes Graphana including default operations, libraries and visualizers.
GraphanaAccess(UserInterface userInterface) Creates an instance and initializes Graphana
GraphanaAccess(UserInterface userInterface, GraphanaScriptSystemInterface scriptSystem) Creates an instance and initializes Graphana
GraphanaAccess(UserInterface userInterface, GraphanaScriptSystemInterface scriptSystem, boolean includeBasicFunctionSet, boolean includeStdLibraries, boolean includeStdVisualizers) Creates an instance and initializes Graphana

Method Summary

Modifier and Type	Method and Description
ExecutionResult<?>	execute(java.lang.String statement) Parses and executes the given statement.
boolean	executeBool(java.lang.String statement) Parses and executes the given statement and assumes the return value to be of type Boolean.
float	executeFloat(java.lang.String statement) Parses and executes the given statement and assumes the return value to be of type Float.
int	executeInt(java.lang.String statement) Parses and executes the given statement and assumes the return value to be of type Integer.
java.lang.String	executeString(java.lang.String statement) Parses and executes the given statement and assumes the return value to be of type String.
GraphLibrary<?,?>	getGraph() Returns the graph which is currently set in the main control.
ExecutionError	getLastError() Returns the last error that occurred.
MainControl	getMainControl() Returns the main control of Graphana which enables lower level access.
UserInterface	getUserInterface() Returns the programs user interface.
void	registerOperation(Operation operation) Registers the given operation.
void	registerOperations(OperationGroup operations) Registers all operations of the given group.
void	setGraph(edu.uci.ics.jung.graph.Graph<?,?> jungGraph) Converts the given JUNG2 graph and sets it as the current graph.
void	setGraph(GraphLibrary<?,?> graph) Sets the given graph as the current graph.
void	setJGraphGraph(org.jgrapht.Graph<?,?> jGraphTGraph) Converts the given JGraphT graph and sets it as the current graph.
void	setVariable(java.lang.String identifier, boolean value) Sets the Graphana variable with the given identifier to the given boolean value.
void	setVariable(java.lang.String identifier, ExecutionResult<?> value) Sets the Graphana variable with the given identifier to the given value.
void	setVariable(java.lang.String identifier, float value) Sets the Graphana variable with the given identifier to the given float value.
void	setVariable(java.lang.String identifier, int value) Sets the Graphana variable with the given identifier to the given integer value.
void	setVariable(java.lang.String identifier, java.lang.String value) Sets the Graphana variable with the given identifier to the given string value.

Methods inherited from class java.lang.Object

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

Constructor Detail

GraphanaAccess

public GraphanaAccess(UserInterface userInterface,
                      GraphanaScriptSystemInterface scriptSystem,
                      boolean includeBasicFunctionSet,
                      boolean includeStdLibraries,
                      boolean includeStdVisualizers)

Creates an instance and initializes Graphana

Parameters:

userInterface - the user interface to use. Can be null

scriptSystem - the script system to use

includeBasicFunctionSet - if true, then all default operations will be registered

includeStdLibraries - if true, then all default graph libraries will be registered

includeStdVisualizers - if true, then all default graph visiualizers will be registered

GraphanaAccess

public GraphanaAccess(UserInterface userInterface,
                      GraphanaScriptSystemInterface scriptSystem)

Creates an instance and initializes Graphana

Parameters:

userInterface - the user interface to use. Can be null

scriptSystem - the script system to use

GraphanaAccess

public GraphanaAccess(UserInterface userInterface)

Creates an instance and initializes Graphana

Parameters:

userInterface - the user interface to use. Can be null

GraphanaAccess

public GraphanaAccess()

Creates a new instance and initializes Graphana including default operations, libraries and visualizers. A console user interface is used.

Method Detail

setGraph

public void setGraph(GraphLibrary<?,?> graph)

Sets the given graph as the current graph. The given graph will be used in every execute call from then on.

Parameters:

graph - The new current graph.

setJGraphGraph

public void setJGraphGraph(org.jgrapht.Graph<?,?> jGraphTGraph)

Converts the given JGraphT graph and sets it as the current graph. A runtime exception is thrown, if the given graph is invalid.

Parameters:

jGraphTGraph - a JGraphT graph instance.

execute

public ExecutionResult<?> execute(java.lang.String statement)

Parses and executes the given statement. If an error occurs, a runtime exception is thrown and the error can be fetched with GraphanaAccess.getLastError().

Parameters:

statement - the statement to parse.

Returns:

the result of the execution.

getMainControl

public MainControl getMainControl()

Returns the main control of Graphana which enables lower level access.

Returns:

the main control.

getUserInterface

public UserInterface getUserInterface()

Returns the programs user interface.

Returns:

the user interface.

setVariable

public void setVariable(java.lang.String identifier,
                        ExecutionResult<?> value)

Sets the Graphana variable with the given identifier to the given value.

Parameters:

identifier - the identifer of the variable to set.

value - the new value of the variable.

setVariable

public void setVariable(java.lang.String identifier,
                        int value)

Sets the Graphana variable with the given identifier to the given integer value.

Parameters:

identifier - the identifer of the variable to set.

value - the new value of the variable.

setVariable

public void setVariable(java.lang.String identifier,
                        float value)

Sets the Graphana variable with the given identifier to the given float value.

Parameters:

identifier - the identifer of the variable to set.

value - the new value of the variable.

setVariable

public void setVariable(java.lang.String identifier,
                        java.lang.String value)

Sets the Graphana variable with the given identifier to the given string value.

Parameters:

identifier - the identifer of the variable to set.

value - the new value of the variable.

setVariable

public void setVariable(java.lang.String identifier,
                        boolean value)

Sets the Graphana variable with the given identifier to the given boolean value.

Parameters:

identifier - the identifer of the variable to set.

value - the new value of the variable.

registerOperation

public void registerOperation(Operation operation)

Registers the given operation.

Parameters:

operation - the operation instance to register.

registerOperations

public void registerOperations(OperationGroup operations)

Registers all operations of the given group.

Parameters:

operations - the operation group containing the operations to register.

executeInt

public int executeInt(java.lang.String statement)

Parses and executes the given statement and assumes the return value to be of type Integer.

Parameters:

statement - the statement to execute.

Returns:

the result of the execution as an int.

executeFloat

public float executeFloat(java.lang.String statement)

Parses and executes the given statement and assumes the return value to be of type Float.

Parameters:

statement - the statement to execute.

Returns:

the result of the execution as a float.

executeBool

public boolean executeBool(java.lang.String statement)

Parses and executes the given statement and assumes the return value to be of type Boolean.

Parameters:

statement - the statement to execute.

Returns:

the result of the execution as a booleans.

executeString

public java.lang.String executeString(java.lang.String statement)

Parses and executes the given statement and assumes the return value to be of type String.

Parameters:

statement - the statement to execute.

Returns:

the result of the execution as a String.

getLastError

public ExecutionError getLastError()

Returns the last error that occurred. The error will always be overwritten when a new error occurs.

Returns:

the last error or null, if no error occurred yet.

getGraph

public GraphLibrary<?,?> getGraph()

Returns the graph which is currently set in the main control.

Returns:

the current graph.

setGraph

public void setGraph(edu.uci.ics.jung.graph.Graph<?,?> jungGraph)

Converts the given JUNG2 graph and sets it as the current graph. A runtime exception is thrown, if the given graph is invalid.

Parameters:

jungGraph - a JUNG2 graph instance.