MainControl

java.lang.Object
- graphana.MainControl

```
public class MainControl
extends java.lang.Object
```
The main control of Graphana. This class enables access to all program functionalities.

Author:

Andreas Fender

Constructor Summary

Constructors
Constructor and Description
`MainControl(UserInterface userInterface, GraphanaScriptSystemInterface scriptSystem)` The constructor needs a user interface to do user output and input and a script system in which the script language is implemented.

Method Summary

Methods
Modifier and Type	Method and Description
`ScriptCallSignature`	`createScriptCallSignature(java.lang.String scriptFilename)` Creates a new uninitialized script call signature.
`ExecutionReturn`	`execFile(java.lang.String filename)` Parses and executes the file which is given as a filename.
`ExecutionReturn`	`execute(java.lang.String source)` Parses and executes the given source whereas HELP is disabled.
`ExecutionReturn`	`execute(java.lang.String source, boolean helpEnabled)` Parses and executes the given source string.
`int`	`getAlgorithmTime()` Returns the current timer value of the algorithm timer.
`long`	`getAlgorithmTimeout()` Returns the maximum algorithm computation time.
`java.lang.String`	`getCurrentDirectory()` Returns the current directory where to find sub directories etc. of the program.
`GraphLibrary<?,?>`	`getCurrentGraph()` Returns the current graph on which graph operations are applied.
`GraphLibManager`	`getGraphLibManager()` Returns the manager for the graph libraries.
`java.io.FileWriter`	`getInputStreamFile()` Returns the current input stream file.
`OperationSet`	`getOperationSet()` Returns the operation set which contains all registered operations.
`java.io.FileWriter`	`getOutputStreamFile()` Returns the current output stream file.
`ScriptSignatureSet`	`getScriptSignatures()` Returns all registered script signatures.
`GraphanaScriptSystemInterface`	`getScriptSystem()` Returns the script system of the main control.
`long`	`getScriptTimeout()` Returns the maximum script execution time.
`UserInterface`	`getUserInterface()` Returns the user interface which handles user input and output.
`VisualizationManager`	`getVisualizationManager()` Returns the manager for the graph visualizations.
`boolean`	`hasCurrentGraph()` Returns true, if and only if a current graph is set.
`void`	`incAlgorithmTimer(long value)` Increments the algorithm timer by the given time value.
`boolean`	`isAlgoTimerActive()` Tells whether or not the algorithm timer is running.
`boolean`	`isCachingOn()` Tells whether or not caching of algorithm results is activated.
`boolean`	`isPrintStackTraces()` Returns whether or not exceptions are printed using the console output.
`ExecutionError`	`registerOperation(Operation operation)` Adds the given operation to the operation set.
`ExecutionError`	`registerOperations(OperationGroup operationGroup)` Registers all operations of the given operation group in the operation set.
`void`	`setAlgorithmTimeout(long timeOut)` Sets the maximum computation time for an algorithm.
`void`	`setAlgoTimerActive(boolean active)` Activates or deactivates the algorithm timer without setting it to zero.
`void`	`setCachingOn(boolean cachingOn)` Enables or disables caching of algorithm results.
`void`	`setCurrentGraph(GraphLibrary<?,?> graph)` Sets the current graph.
`void`	`setInputStreamFile(java.io.FileWriter inputStreamFile)` Sets the current input stream file.
`void`	`setOutputStreamFile(java.io.FileWriter curOutputFile)` Sets the output stream file.
`void`	`setPrintStackTraces(boolean enable)` If enabled, then exceptions will be directly printed.
`void`	`setScriptTimeout(long timeOut)` Sets the maximum script execution time.
`void`	`startAlgorithmTimer()` Activates the algorithm timer.
`void`	`writeInputStream(java.lang.String input)` Writes the given string into the file which was set as the input stream file before.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MainControl
```
public MainControl(UserInterface userInterface,
           GraphanaScriptSystemInterface scriptSystem)
```
    The constructor needs a user interface to do user output and input and a script system in which the script language is implemented.
    
    Parameters:
    userInterface - A user interface for output and input
    scriptSystem - A script system to handle string statements to parse and execute them
- Method Detail
  - getScriptSystem
```
public GraphanaScriptSystemInterface getScriptSystem()
```
    Returns the script system of the main control.
    
    Returns:
    the script system.
  - setPrintStackTraces
```
public void setPrintStackTraces(boolean enable)
```
    If enabled, then exceptions will be directly printed.
    
    Parameters:
    enable - if true, exceptions will be printed using the console output.
  - isPrintStackTraces
```
public boolean isPrintStackTraces()
```
    Returns whether or not exceptions are printed using the console output.
    
    Returns:
    true, iff exceptions are printed using the console output.
  - execute
```
public ExecutionReturn execute(java.lang.String source,
                      boolean helpEnabled)
```
    Parses and executes the given source string. Supports HELP functions.
    
    Parameters:
    source - the source string in correct syntax.
    helpEnabled - determines, whether the string shall be checked if it starts with 'HELP' and call the help functionality, which is not part of the script system.
    
    Returns:
    an execution return value which might be an error, too.
  - execute
```
public ExecutionReturn execute(java.lang.String source)
```
    Parses and executes the given source whereas HELP is disabled.
    
    Parameters:
    source - the source string in correct syntax.
    
    Returns:
    an execution return value which might be an error, too.
  - execFile
```
public ExecutionReturn execFile(java.lang.String filename)
```
    Parses and executes the file which is given as a filename.
    
    Parameters:
    filename - the relative or absolute path to the source file.
    
    Returns:
    an execution return value which might be an error, too.
  - getInputStreamFile
```
public java.io.FileWriter getInputStreamFile()
```
    Returns the current input stream file.
    
    Returns:
    the current input stream file.
  - setInputStreamFile
```
public void setInputStreamFile(java.io.FileWriter inputStreamFile)
```
    Sets the current input stream file. The purpose of this file is to write user inputs into it so after every user input, writeInputStream should be called.
    
    Parameters:
    inputStreamFile - a file writer to write to when there is an user input.
  - writeInputStream
```
public void writeInputStream(java.lang.String input)
```
    Writes the given string into the file which was set as the input stream file before.
    
    Parameters:
    input - The string which shall be written.
  - isCachingOn
```
public boolean isCachingOn()
```
    Tells whether or not caching of algorithm results is activated.
    
    Returns:
    true if and only if algorithm caching is activated.
  - setCachingOn
```
public void setCachingOn(boolean cachingOn)
```
    Enables or disables caching of algorithm results.
    
    Parameters:
    cachingOn - Sets caching on or off, respectively.
  - getCurrentGraph
```
public GraphLibrary<?,?> getCurrentGraph()
```
    Returns the current graph on which graph operations are applied.
    
    Returns:
    the current graph.
  - setCurrentGraph
```
public void setCurrentGraph(GraphLibrary<?,?> graph)
```
    Sets the current graph. Every graph operation will operate on the given graph.
    
    Parameters:
    graph - The graph which shall be set as the current graph.
  - getUserInterface
```
public UserInterface getUserInterface()
```
    Returns the user interface which handles user input and output.
    
    Returns:
    the user interface.
  - getOperationSet
```
public OperationSet getOperationSet()
```
    Returns the operation set which contains all registered operations.
    
    Returns:
    the operation set.
  - registerOperation
```
public ExecutionError registerOperation(Operation operation)
```
    Adds the given operation to the operation set.
    
    Parameters:
    operation - the operation to register.
    
    Returns:
    null, if no error occurred. The error otherwise.
  - registerOperations
```
public ExecutionError registerOperations(OperationGroup operationGroup)
```
    Registers all operations of the given operation group in the operation set.
    
    Parameters:
    operationGroup - operations the operation group containing the operations to add.
    
    Returns:
    null, if no error occurred. The error otherwise.
  - getGraphLibManager
```
public GraphLibManager getGraphLibManager()
```
    Returns the manager for the graph libraries. The manager contains all registered graph libraries.
    
    Returns:
    the graph library manager.
  - getVisualizationManager
```
public VisualizationManager getVisualizationManager()
```
    Returns the manager for the graph visualizations. The manager contains all registered visualizers.
    
    Returns:
    the graph visualization manager.
  - getAlgorithmTimeout
```
public long getAlgorithmTimeout()
```
    Returns the maximum algorithm computation time.
    
    Returns:
    the algorithm timeout.
  - setAlgorithmTimeout
```
public void setAlgorithmTimeout(long timeOut)
```
    Sets the maximum computation time for an algorithm. If a computation exceeds this time, then it will be aborted.
    
    Parameters:
    timeOut - the maximum computation time for algorithms.
  - getScriptTimeout
```
public long getScriptTimeout()
```
    Returns the maximum script execution time.
    
    Returns:
    the algorithm timeout.
  - setScriptTimeout
```
public void setScriptTimeout(long timeOut)
```
    Sets the maximum script execution time. If a script execution exceeds this time, then it will be aborted.
    
    Parameters:
    timeOut - the maximum execution time for scripts.
  - startAlgorithmTimer
```
public void startAlgorithmTimer()
```
    Activates the algorithm timer. The algorithm timer will then increase whenever an algorithm is executed.
  - getAlgorithmTime
```
public int getAlgorithmTime()
```
    Returns the current timer value of the algorithm timer. The timer keeps running afterwards.
    
    Returns:
    the current algorithm timer value.
  - incAlgorithmTimer
```
public void incAlgorithmTimer(long value)
```
    Increments the algorithm timer by the given time value.
    
    Parameters:
    value - the value by which the algorithm timer shall be increased.
  - isAlgoTimerActive
```
public boolean isAlgoTimerActive()
```
    Tells whether or not the algorithm timer is running.
    
    Returns:
    true iff the algorithm timer is running.
  - setAlgoTimerActive
```
public void setAlgoTimerActive(boolean active)
```
    Activates or deactivates the algorithm timer without setting it to zero.
    
    Parameters:
    active - if true, the algorithm timer is activated
  - setOutputStreamFile
```
public void setOutputStreamFile(java.io.FileWriter curOutputFile)
```
    Sets the output stream file. Every file write operation invoked by the user is supposed to be written into this file.
    
    Parameters:
    curOutputFile - the new output stream file.
  - getOutputStreamFile
```
public java.io.FileWriter getOutputStreamFile()
```
    Returns the current output stream file.
    
    Returns:
    the current output stream file.
  - hasCurrentGraph
```
public boolean hasCurrentGraph()
```
    Returns true, if and only if a current graph is set.
    
    Returns:
    true, if and only if a current graph is set.
  - getCurrentDirectory
```
public java.lang.String getCurrentDirectory()
```
    Returns the current directory where to find sub directories etc. of the program.
  - getScriptSignatures
```
public ScriptSignatureSet getScriptSignatures()
```
    Returns all registered script signatures.
  - createScriptCallSignature
```
public ScriptCallSignature createScriptCallSignature(java.lang.String scriptFilename)
```
    Creates a new uninitialized script call signature.
    
    Parameters:
    scriptFilename - the file name of the script.
    
    Returns:
    a new script call signature.

Class MainControl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MainControl

Method Detail

getScriptSystem

setPrintStackTraces

isPrintStackTraces

execute

execute

execFile

getInputStreamFile

setInputStreamFile

writeInputStream

isCachingOn

setCachingOn

getCurrentGraph

setCurrentGraph

getUserInterface

getOperationSet

registerOperation

registerOperations

getGraphLibManager

getVisualizationManager

getAlgorithmTimeout

setAlgorithmTimeout

getScriptTimeout

setScriptTimeout

startAlgorithmTimer

getAlgorithmTime

incAlgorithmTimer

isAlgoTimerActive

setAlgoTimerActive

setOutputStreamFile

getOutputStreamFile

hasCurrentGraph

getCurrentDirectory

getScriptSignatures

createScriptCallSignature