org.primordion.xholon.io

Class ChartViewerNVD3

java.lang.Object

org.primordion.xholon.base.Xholon

org.primordion.xholon.io.AbstractChartViewer

org.primordion.xholon.io.ChartViewerNVD3

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable, IXholon, XholonMarker, IChartViewer

public class ChartViewerNVD3
extends AbstractChartViewer
implements IChartViewer

Captures data, and displays the data in a web browser as a NVD3.js line chart. NVD3 builds "Re-usable charts for d3.js".

Complete working example of a NVD3 line chart:

TODO -

Since:

0.9.1 (Created on March 16, 2014)

See Also:

Xholon Project website, NVD3 website, NVD3 simple sample line chart, Serialized Form

Field Summary

Fields inherited from interface org.primordion.xholon.io.IChartViewer

WRITE_AS_DOUBLE, WRITE_AS_FLOAT, WRITE_AS_INT, WRITE_AS_LONG, WRITE_AS_NULL, WRITE_AS_SHORT, 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

Constructor Summary

Constructors

Constructor and Description
ChartViewerNVD3() default constructor

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) Used only by some of the ealontro models.
void	chart() Produce a chart from the captured data.
void	chart(boolean showLegend) Produce a chart from the captured data.
void	createXySeries(int seriesCount, java.lang.String[] seriesName) TODO fix this, or delete
int	getHeight()
int	getWidth()
void	initialize(IXholon chartRoot, int nameConcatLevels, java.lang.String typeOfData, int writeType, java.lang.String pathName)
void	remove() Remove this node from the model, by recursively removing all children and next siblings, and by then returning it to the factory.
void	setHeight(int height)
void	setWidth(int width)

Methods inherited from class org.primordion.xholon.io.AbstractChartViewer

createChart, hasAnnotation, setXRange, setYFormat, setYRange

Methods inherited from class org.primordion.xholon.base.Xholon

act, actNr, appendChild, appendChild, appendChild, appendsOwnChildren, bindPorts, cleanup, compareTo, configure, configure, consoleLog, decVal, decVal, depth, doAction, equals, findFirstChildWithXhClass, findFirstChildWithXhClass, forwardMessage, forwardSyncMessage, getActionList, getAllPorts, getAnnotation, getApp, getAttributeNodeXh, getAttributeXh, getChildNodes, getClassNode, getClassNode, getFactory, getFirstChild, getFirstSibling, getId, getInteraction, getInteractionsEnabled, getIQueueImplName, getLastChild, getLastSibling, getLogger, getMsgQ, getName, getName, getNeighbors, getNextSibling, getNthChild, getNthSibling, getNumChildren, getNumLevels, getNumSiblings, getParentNode, getPort, getPort, getPreviousSibling, getRoleName, getRootNode, getSelfAndSiblings, getSelfAndSiblingsIndex, getService, getSiblings, getSystemMsgQ, 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, getXPath, handleNodeSelection, handleNodeSelection, hasAncestor, 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, searchForReferencingNodesRecurse, 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, toString, toXml, toXmlAttribute, toXmlAttributes, toXmlText, treeSize, visit

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.primordion.xholon.io.IChartViewer

createChart, setXRange, setYFormat, setYRange

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

Constructor Detail

ChartViewerNVD3

public ChartViewerNVD3()

default constructor

Method Detail

initialize

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

Specified by:

initialize in interface IChartViewer

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.

pathName - One or more additional comma-separated parameters.

createXySeries

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

TODO fix this, or delete

Specified by:

createXySeries in interface IChartViewer

Parameters:

seriesCount - Number of xy series.

seriesName - Name of each xy series.

See Also:

IChartViewer.createXySeries(int, java.lang.String[])

capture

public void capture(double timeStep)

Description copied from interface: IChartViewer

Capture data at each timestep.

Specified by:

capture in interface IChartViewer

Specified by:

capture in class AbstractChartViewer

Parameters:

timeStep - Time step, or other time interval.

capture

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

Used only by some of the ealontro models. TODO this code needs to be fixed before it can be used

Specified by:

capture in interface IChartViewer

Specified by:

capture in class AbstractChartViewer

Parameters:

numTimeSeries - Number of time series indices.

xVal - X Value.

yVal - Y Values.

See Also:

IChartViewer.capture(int, double, double[])

chart

public void chart()

Description copied from interface: IChartViewer

Produce a chart from the captured data.

Specified by:

chart in interface IChartViewer

Specified by:

chart in class AbstractChartViewer

chart

public void chart(boolean showLegend)

Description copied from interface: IChartViewer

Produce a chart from the captured data.

Specified by:

chart in interface IChartViewer

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.

remove

public void remove()

Description copied from interface: IXholon

Remove this node from the model, by recursively removing all children and next siblings, and by then returning it to the factory.

Specified by:

remove in interface IXholon

Specified by:

remove in interface IChartViewer

Specified by:

remove in class AbstractChartViewer

getWidth

public int getWidth()

setWidth

public void setWidth(int width)

getHeight

public int getHeight()

setHeight

public void setHeight(int height)