org.primordion.xholon.io

Interface IChartViewer

All Superinterfaces:

IXholon, XholonMarker

All Known Implementing Classes:

AbstractChartViewer, ChartViewerC3, ChartViewerGnuplot, ChartViewerGoogle2, ChartViewerNVD3

public interface IChartViewer
extends IXholon

This interface should be implemented by concrete classes that capture data and display the data in a chart.

Since:

0.3 (Created on April 24, 2006)

See Also:

Xholon Project website

Field Summary

Fields

Modifier and Type	Field and Description
static int	WRITE_AS_DOUBLE
static int	WRITE_AS_FLOAT
static int	WRITE_AS_INT
static int	WRITE_AS_LONG
static int	WRITE_AS_NULL
static int	WRITE_AS_SHORT
static int	WRITE_TIME_IN_HEADING

Fields inherited from interface org.primordion.xholon.base.IXholon

DEFAULT_SIZE_MSG_Q, DEFAULT_SIZE_SYSTEM_MSG_Q, GETNAME_DEFAULT, GETNAME_LOCALPART_ID, GETNAME_NOROLENAME, GETNAME_ROLENAME_OR_CLASSNAME, GETNAME_ROLENAMESEP_, GETNAME_SIZE_TEMPLATE, NINCLUDE_PSC, NINCLUDE_PSx, NINCLUDE_PxC, NINCLUDE_Pxx, NINCLUDE_xSC, NINCLUDE_xSx, NINCLUDE_xxC, NINCLUDE_xxx, XHOLON_ID_DEFAULT, XHOLON_ID_NULL

Method Summary

Methods

Modifier and Type	Method and Description
void	capture(double timeStep) Capture data at each timestep.
void	capture(int numTimeSeries, double xVal, double[] yVal) Capture specified data at each time interval.
void	chart() Produce a chart from the captured data.
void	chart(boolean showLegend) Produce a chart from the captured data.
java.lang.Object	createChart(boolean showLegend) Create a chart from the captured data, and return the chart object without displaying it.
void	createXySeries(int seriesCount, java.lang.String[] xySeriesName) Create one or more xy data series.
void	initialize(IXholon chartRoot, int nameConcatLevels, java.lang.String typeOfData, int writeType, java.lang.String params)
void	remove() Remove the chart from the screen.
void	setXRange(double min, double max) Set the X range of the chart.
void	setYFormat(java.lang.String yFormat) Set the format of the y axis of the chart.
void	setYRange(double min, double max) Set the Y range of the chart.

Methods inherited from interface org.primordion.xholon.base.IXholon

act, actNr, appendChild, appendChild, appendChild, appendsOwnChildren, bindPorts, cleanup, configure, configure, consoleLog, decVal, decVal, depth, doAction, findFirstChildWithXhClass, findFirstChildWithXhClass, forwardMessage, forwardSyncMessage, getActionList, getAllPorts, getAnnotation, getApp, getAttributeNodeXh, getAttributeXh, getChildNodes, getClassNode, getClassNode, getFirstChild, getFirstSibling, getId, getLastChild, getLastSibling, getName, getName, getNeighbors, getNextSibling, getNthChild, getNthSibling, getNumChildren, getNumLevels, getNumSiblings, getParentNode, getPort, getPort, getPreviousSibling, getRoleName, getRootNode, getSelfAndSiblings, getSelfAndSiblingsIndex, getService, getSiblings, getUid, getUri, getVal_boolean, getVal_byte, getVal_char, getVal_double, getVal_float, getVal_int, getVal_long, getVal_Object, getVal_short, getVal_String, getVal, getXhc, getXhcId, getXhcName, getXholon2Xml, getXhType, getXml2Xholon, handleNodeSelection, handleNodeSelection, hasAncestor, hasAnnotation, hasAttributeXh, hasChildNodes, hasChildOrSiblingNodes, hasNextSibling, hasParentNode, hasSiblingNodes, height, incVal, incVal, initialize, initStatics, inOrderPrint, insertAfter, insertAfter, insertAfter, insertBefore, insertBefore, insertBefore, insertFirstChild, isActiveObject, isAttributeHandler, isBound, isContainer, isExternal, isInternal, isLeaf, isPassiveObject, isRootNode, isUniqueSibling, isUniqueSiblingRoleName, performActivity, performActivity, performBooleanActivity, performBooleanActivity, performDoubleActivity, performGuard, performVoidActivity, postAct, postConfigure, postOrderPrint, postReconfigure, preAct, preConfigure, preOrderPrint, preReconfigure, print, println, processMessageQ, processReceivedMessage, processReceivedSyncMessage, processSystemMessageQ, reconfigure, registerMessageForwardee, removeAttributeNodeXh, removeAttributeXh, removeChild, replaceNode, searchForReferencingNodes, sendMessage, sendMessage, sendMessage, sendSyncMessage, sendSyncMessage, sendSyncMessage, sendSystemMessage, sendSystemMessage, setActionList, setAnnotation, setApp, setAttributeNodeXh, setAttributeVal, setAttributeXh, setFirstChild, setId, setName, setNextSibling, setParentChildLinks, setParentNode, setParentSiblingLinks, setPort, setPort, setPorts, setRoleName, setUid, setUri, setVal_boolean, setVal_byte, setVal_char, setVal_double, setVal_float, setVal_int, setVal_long, setVal_Object, setVal_short, setVal_String, setVal, setVal, setVal, setVal, setVal, setVal, setVal, setVal, setVal, setVal, setXhc, showAnnotation, swapNode, terminate, toXml, toXmlAttribute, toXmlAttributes, toXmlText, treeSize, visit

Field Detail

WRITE_TIME_IN_HEADING

static final int WRITE_TIME_IN_HEADING

See Also:

Constant Field Values

WRITE_AS_NULL

static final int WRITE_AS_NULL

See Also:

Constant Field Values

WRITE_AS_INT

static final int WRITE_AS_INT

See Also:

Constant Field Values

WRITE_AS_LONG

static final int WRITE_AS_LONG

See Also:

Constant Field Values

WRITE_AS_SHORT

static final int WRITE_AS_SHORT

See Also:

Constant Field Values

WRITE_AS_FLOAT

static final int WRITE_AS_FLOAT

See Also:

Constant Field Values

WRITE_AS_DOUBLE

static final int WRITE_AS_DOUBLE

See Also:

Constant Field Values

Method Detail

initialize

void initialize(IXholon chartRoot,
              int nameConcatLevels,
              java.lang.String typeOfData,
              int writeType,
              java.lang.String params)

Parameters:

chartRoot - XYChart node.

nameConcatLevels - Number of composite levels to concatenate in deriving series name.

typeOfData - The type of data will be included as part of the file name.

writeType - Whether the data will be written out as int, long, float, double.

params - One or more additional comma-separated parameters.

capture

void capture(double timeStep)

Capture data at each timestep.

Parameters:

timeStep - Time step, or other time interval.

capture

void capture(int numTimeSeries,
           double xVal,
           double[] yVal)

Capture specified data at each time interval.

Parameters:

numTimeSeries - Number of time series indices.

xVal - X Value.

yVal - Y Values.

chart

void chart()

Produce a chart from the captured data.

createChart

java.lang.Object createChart(boolean showLegend)

Create a chart from the captured data, and return the chart object without displaying it. This is mostly intended to be used with JFreeChart.

Parameters:

showLegend -

Returns:

chart

void chart(boolean showLegend)

Produce a chart from the captured data.

Parameters:

showLegend - Whether or not to show the legend. The legend shows the name and color of all data series. If there are a lot of different series, then the legend can get too big.

createXySeries

void createXySeries(int seriesCount,
                  java.lang.String[] xySeriesName)

Create one or more xy data series.

Parameters:

seriesCount - Number of xy series.

xySeriesName - Name of each xy series.

setXRange

void setXRange(double min,
             double max)

Set the X range of the chart.

Parameters:

min - Minimum cutoff value to show in the chart.

max - Maximum cutoff value to show in the chart.

setYRange

void setYRange(double min,
             double max)

Set the Y range of the chart.

Parameters:

min - Minimum cutoff value to show in the chart.

max - Maximum cutoff value to show in the chart.

setYFormat

void setYFormat(java.lang.String yFormat)

Set the format of the y axis of the chart. This is specific to gnuplot.

Parameters:

yFormat - A format string (ex: "%.4f" or "%.0f")

remove

void remove()

Remove the chart from the screen.

Specified by:

remove in interface IXholon