GraphGenerator (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- net.i2p.router.web.GraphGenerator

All Implemented Interfaces:
Runnable, ClientApp
```
public class GraphGenerator
extends Object
implements Runnable, ClientApp
```
A thread started by RouterConsoleRunner that checks the configuration for stats to be tracked via jrobin, and adds or deletes RRDs as necessary. This also contains methods to generate xml or graph image output. The rendering for graphs is in GraphRenderer. To control memory, the number of simultaneous renderings is limited.

Field Summary
Fields
Modifier and Type Field and Description
static String DEFAULT_DATABASES

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_DATABASES`

Constructor Summary
Constructors
Constructor and Description
GraphGenerator(RouterContext ctx)
GraphGenerator.

Constructors
Constructor and Description
`GraphGenerator(RouterContext ctx)` GraphGenerator.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`countGraphs()`
`String`	`getDisplayName()` The display name of the ClientApp, used in user interfaces.
`List<GraphListener>`	`getListeners()` List of GraphListener instances
`String`	`getName()` The generic name of the ClientApp, used for registration, e.g.
`ClientAppState`	`getState()` The current state of the ClientApp.
`boolean`	`getXML(Rate rate, OutputStream out)` Export rate data as XML.
`static GraphGenerator`	`instance()`
`static GraphGenerator`	`instance(I2PAppContext ctx)`
`static boolean`	`isDisabled(I2PAppContext ctx)`
`Set<Rate>`	`parseSpecs(String specs)`
`boolean`	`renderCombinedGraph(OutputStream out, int width, int height, boolean hideLegend, boolean hideGrid, boolean hideTitle, boolean showEvents, int periodCount, int end, boolean showCredit)` Render the two-data bandwidth graph with the specified options.
`boolean`	`renderCombinedGraph(OutputStream out, int width, int height, boolean hideLegend, boolean hideGrid, boolean hideTitle, boolean showEvents, int periodCount, int end, boolean showCredit, boolean showRestarts)` Render the two-data bandwidth graph with the specified options.
`boolean`	`renderGraph(Rate rate, OutputStream out)` Render a single-data graph with default dimensions and options.
`boolean`	`renderGraph(Rate rate, OutputStream out, int width, int height, boolean hideLegend, boolean hideGrid, boolean hideTitle, boolean showEvents, int periodCount, int end, boolean showCredit)` Render a single-data graph with the specified options.
`boolean`	`renderGraph(Rate rate, OutputStream out, int width, int height, boolean hideLegend, boolean hideGrid, boolean hideTitle, boolean showEvents, int periodCount, int end, boolean showCredit, boolean showRestarts)` Render a single-data graph with the specified options.
`void`	`run()` run.
`(package private) void`	`setDisabled()` Disable graph generation until restart
`(package private) static void`	`setDisabled(I2PAppContext ctx)` Disable graph generation until restart
`void`	`shutdown(String[] args)` Does nothing, we aren't tracked
`void`	`startup()` Does nothing, we aren't tracked
`void`	`stop()` stop.

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

- Field Detail
  - DEFAULT_DATABASES
```
public static final String DEFAULT_DATABASES
```
    See Also:
    Constant Field Values
- Constructor Detail
  - GraphGenerator
```
public GraphGenerator(RouterContext ctx)
```
    GraphGenerator.
- Method Detail
  - countGraphs
```
public int countGraphs()
```
  - getDisplayName
```
public String getDisplayName()
```
    Description copied from interface: ClientApp
    The display name of the ClientApp, used in user interfaces. The app must translate.
    Specified by:
    getDisplayName in interface ClientApp
    Returns:
    non-null
  - getListeners
```
public List<GraphListener> getListeners()
```
    List of GraphListener instances
    Returns:
    the listeners
  - getName
```
public String getName()
```
    Description copied from interface: ClientApp
    The generic name of the ClientApp, used for registration, e.g. "console". Do not translate.
    Specified by:
    getName in interface ClientApp
    Returns:
    non-null
  - getState
```
public ClientAppState getState()
```
    Description copied from interface: ClientApp
    The current state of the ClientApp.
    Specified by:
    getState in interface ClientApp
    Returns:
    non-null
  - getXML
```
public boolean getXML(Rate rate,
                      OutputStream out)
               throws IOException
```
    Export rate data as XML.
    Parameters:
    rate - the rate to export
    out - the output stream to write the XML to
    Returns:
    true if the data was exported successfully
    Throws:
    IOException - if export fails
  - instance
```
public static GraphGenerator instance()
```
    Returns:
    null if disabled
  - instance
```
public static GraphGenerator instance(I2PAppContext ctx)
```
    Returns:
    null if disabled
  - isDisabled
```
public static boolean isDisabled(I2PAppContext ctx)
```
  - parseSpecs
```
public Set<Rate> parseSpecs(String specs)
```
    Parameters:
    specs - statName.period,statName.period,statName.period
    Returns:
    list of Rate objects
  - renderCombinedGraph
```
public boolean renderCombinedGraph(OutputStream out,
                                   int width,
                                   int height,
                                   boolean hideLegend,
                                   boolean hideGrid,
                                   boolean hideTitle,
                                   boolean showEvents,
                                   int periodCount,
                                   int end,
                                   boolean showCredit)
                            throws IOException
```
    Render the two-data bandwidth graph with the specified options. For all other graphs see renderGraph() above. Synchronized to conserve memory.
    Parameters:
    out - the output stream to write the graph image to
    width - image width in pixels
    height - image height in pixels
    hideLegend - if true, omit the legend
    hideGrid - if true, omit the grid lines
    hideTitle - if true, omit the title
    showEvents - if true, draw event markers
    periodCount - number of time periods to display, or -1 for default
    end - number of periods before now to end at
    showCredit - if true, show the I2P+ credit line
    Returns:
    success
    Throws:
    IOException - if rendering fails
  - renderCombinedGraph
```
public boolean renderCombinedGraph(OutputStream out,
                                   int width,
                                   int height,
                                   boolean hideLegend,
                                   boolean hideGrid,
                                   boolean hideTitle,
                                   boolean showEvents,
                                   int periodCount,
                                   int end,
                                   boolean showCredit,
                                   boolean showRestarts)
                            throws IOException
```
    Render the two-data bandwidth graph with the specified options.
    Parameters:
    out - the output stream to write to
    width - image width in pixels
    height - image height in pixels
    hideLegend - if true, omit the legend
    hideGrid - if true, omit the grid lines
    hideTitle - if true, omit the title
    showEvents - if true, draw event markers
    periodCount - number of time periods to display, or -1 for default
    end - number of periods before now to end at
    showCredit - if true, show the I2P+ credit line
    showRestarts - if true, draw the vertical restart lines and "Router restarted" label
    Returns:
    success
    Throws:
    IOException - if rendering fails
  - renderGraph
```
public boolean renderGraph(Rate rate,
                           OutputStream out)
                    throws IOException
```
    Render a single-data graph with default dimensions and options.
    Parameters:
    rate - the rate to graph
    out - the output stream to write the graph image to
    Returns:
    true if the graph was rendered successfully
    Throws:
    IOException - if rendering fails
  - renderGraph
```
public boolean renderGraph(Rate rate,
                           OutputStream out,
                           int width,
                           int height,
                           boolean hideLegend,
                           boolean hideGrid,
                           boolean hideTitle,
                           boolean showEvents,
                           int periodCount,
                           int end,
                           boolean showCredit)
                    throws IOException
```
    Render a single-data graph with the specified options. For the two-data bandwidth graph see renderCombinedGraph(). Synchronized to conserve memory.
    Parameters:
    rate - the rate to graph
    out - the output stream to write the graph image to
    width - image width in pixels
    height - image height in pixels
    hideLegend - if true, omit the legend
    hideGrid - if true, omit the grid lines
    hideTitle - if true, omit the title
    showEvents - if true, draw event markers
    periodCount - number of time periods to display, or -1 for default
    end - number of periods before now to end at
    showCredit - if true, show the I2P+ credit line
    Returns:
    success
    Throws:
    IOException - if rendering fails
  - renderGraph
```
public boolean renderGraph(Rate rate,
                           OutputStream out,
                           int width,
                           int height,
                           boolean hideLegend,
                           boolean hideGrid,
                           boolean hideTitle,
                           boolean showEvents,
                           int periodCount,
                           int end,
                           boolean showCredit,
                           boolean showRestarts)
                    throws IOException
```
    Render a single-data graph with the specified options.
    Parameters:
    rate - the rate to graph
    out - the output stream to write the graph image to
    width - image width in pixels
    height - image height in pixels
    hideLegend - if true, omit the legend
    hideGrid - if true, omit the grid lines
    hideTitle - if true, omit the title
    showEvents - if true, draw event markers
    periodCount - number of time periods to display, or -1 for default
    end - number of periods before now to end at
    showCredit - if true, show the I2P+ credit line
    showRestarts - if true, draw the vertical restart lines and "Router restarted" label
    Returns:
    success
    Throws:
    IOException - if rendering fails
  - run
```
public void run()
```
    run.
    Specified by:
    run in interface Runnable
  - setDisabled
```
void setDisabled()
```
    Disable graph generation until restart
  - setDisabled
```
static void setDisabled(I2PAppContext ctx)
```
    Disable graph generation until restart
  - shutdown
```
public void shutdown(String[] args)
```
    Does nothing, we aren't tracked
    Specified by:
    shutdown in interface ClientApp
    Parameters:
    args - generally null but could be stopArgs from clients.config
  - startup
```
public void startup()
```
    Does nothing, we aren't tracked
    Specified by:
    startup in interface ClientApp
  - stop
```
public void stop()
```
    stop.

Class GraphGenerator

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_DATABASES

Constructor Detail

GraphGenerator

Method Detail

countGraphs

getDisplayName

getListeners

getName

getState

getXML

instance

instance

isDisabled

parseSpecs

renderCombinedGraph

renderCombinedGraph

renderGraph

renderGraph

renderGraph

run

setDisabled

setDisabled

shutdown

startup

stop