com.ergotech.vib.manipulators.array

Class StatisticalTimeCategorizer

java.lang.Object

com.ergotech.vib.servers.DataSource

com.ergotech.vib.servers.SimpleDataSource

com.ergotech.vib.manipulators.Manipulator

com.ergotech.vib.manipulators.SimpleManipulator

com.ergotech.vib.manipulators.BroadcastServer

com.ergotech.vib.manipulators.array.StatisticalTimeCategorizer

public class StatisticalTimeCategorizer
extends BroadcastServer

Group values by mean, median, min, max or range. This is useful to create categories for Bar Charts.

Nested Class Summary

Nested classes/interfaces inherited from class com.ergotech.vib.servers.SimpleDataSource

SimpleDataSource.NameEditorData

Nested classes/interfaces inherited from class com.ergotech.vib.servers.DataSource

DataSource.Writable

Field Summary

Fields inherited from class com.ergotech.vib.manipulators.BroadcastServer

cvsRev

Fields inherited from class com.ergotech.vib.manipulators.Manipulator

UPDATE_DISPLAYED_VALUE, VALUE_INPUT

Fields inherited from class com.ergotech.vib.servers.SimpleDataSource

customTimer, EXPORT_READ_ONLY, EXPORT_READ_WRITE, NO_EXPORT, requiresSyncWrite, sharedTimer, syncWriteTimeout, timebase

Fields inherited from class com.ergotech.vib.servers.DataSource

autoSuspend, AUTOSUSPEND_DEFAULT, AUTOSUSPEND_NEVER, AUTOSUSPEND_NO_LISTENERS, AUTOSUSPEND_NO_LISTENERS_AND_NO_SOURCES, colorHi, colorHiHi, colorLo, colorLoLo, colorNormal, connectors, consoleLogger, currentColor, currentValue, debugLevel, DEFAULT_AUTOSUSPEND, dontConnect, gwtLog, hardSuspended, popupLogger, PRIMARYOUTPORTNAME, sendColors, stopped, suspended, timedPopupLogger, traceLogger, valueHi, valueHiHi, valueLo, valueLoLo

Constructor Summary

Constructors

Constructor and Description
StatisticalTimeCategorizer()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCategoryTimebase()
java.lang.String	getCategoryType()
void	setCategoryTimebase(java.lang.String categoryTimebase)
void	setCategoryType(java.lang.String categoryType)
void	valueInput(ValueChangedEvent newEvent) This is the primary input method that accepts a ValueChangedEvent.

Methods inherited from class com.ergotech.vib.manipulators.BroadcastServer

setValueObject

Methods inherited from class com.ergotech.vib.manipulators.SimpleManipulator

getDefaultQualityForLocation

Methods inherited from class com.ergotech.vib.manipulators.Manipulator

getInPortNames, getStaticLocationFor, setBooleanValue, setBoolValue, setByteValue, setDoubleValue, setFloatValue, setIntValue, setLongValue, setShortValue, setStringValue, toString, valueChanged

Methods inherited from class com.ergotech.vib.servers.SimpleDataSource

addConnector, addConnector, addDataSource, addPropertyChangeListener, addValueChangedListener, addVetoableChangeListener, authenticatedClientRequest, clientRequest, clientResponse, destroy, determineSuspendedStatus, getClassLicenseManager, getContainer, getCustomTimer, getDataSource, getDataSources, getDisplayName, getExportCriteria, getExposeComponentConnections, getName, getOutPortNames, getPullFromServers, getPushData, getPushName, getPushToServers, getServerListData, getTimebase, getTrace, isActive, isScreenLocal, refreshCurrentValue, removeConnector, removeDataSource, removePropertyChangeListener, removeValueChangedListener, removeVetoableChangeListener, requestSyncWrite, setAutoSuspend, setClassLicenseManager, setContainer, setCustomTimer, setDataSourceName, setExportCriteria, setExposeComponentConnections, setName, setPullFromServers, setPushData, setPushName, setPushToServers, setScreenLocal, setServerListData, setTimebase, setTrace, start, stop, tick, VIBEvent

Methods inherited from class com.ergotech.vib.servers.DataSource

addVIBEventListener, checkScript, executeInScriptInternal, executeScript, executeScriptInternal, executeScriptInternal, getAutoSuspend, getBooleanValue, getBoolValue, getColorHi, getColorHiHi, getColorLo, getColorLoLo, getColorNormal, getConnectors, getConsoleLogger, getCurrentColor, getDataSourceName, getDoubleValue, getFloatValue, getGWTLogger, getIncomingValueObject, getInScript, getIntValue, getLongValue, getParent, getPopupLogger, getScript, getScriptEngine, getSendColors, getSources, getStringValue, getSyncWriteTimeout, getTimedPopupLogger, getTraceLogger, getValueHi, getValueHiHi, getValueLo, getValueLoLo, getValueObject, init, isHardSuspended, isRunning, isSendOnlyChangedValuesDefault, isSuspended, logException, logGWT, logGWT, logMessage, logTrace, n2sortConnectors, performScriptSubstitutions, popupMessage, post, removeConnector, removeVIBEventListener, replaceConnectors, scriptExtensionSubstition, setColorHi, setColorHiHi, setColorLo, setColorLoLo, setColorNormal, setConsoleLogger, setGWTLogger, setHardSuspended, setInScript, setParent, setPopupLogger, setScript, setSendColors, setSendOnlyChangedValuesDefault, setSyncWriteTimeout, setTimedPopupLogger, setTraceLogger, setValueHi, setValueHiHi, setValueLo, setValueLoLo, updateColor, updateListeners, updateListeners, updateListeners, whoAmI

Methods inherited from class java.lang.Object

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

Constructor Detail

StatisticalTimeCategorizer

public StatisticalTimeCategorizer()

Method Detail

getCategoryTimebase

public java.lang.String getCategoryTimebase()

getCategoryType

public java.lang.String getCategoryType()

setCategoryTimebase

public void setCategoryTimebase(java.lang.String categoryTimebase)
                         throws VIBUpdateFailedException

Throws:

VIBUpdateFailedException

setCategoryType

public void setCategoryType(java.lang.String categoryType)
                     throws VIBUpdateFailedException

Throws:

VIBUpdateFailedException

valueInput

public void valueInput(ValueChangedEvent newEvent)
                throws VIBUpdateFailedException

This is the primary input method that accepts a ValueChangedEvent. The event must contain either an ArrayValueObject or a TwoDimensionalArrayValueObject. It will set the value of the bean to a ValueObject of the same type as the event contained, where the values in the object will be accumulated into time categories based on the set categoryType. For example, if the categoryTimebase is one hour, and the categoryType is mean, when given an ArrayValueObject it will output an ArrayValueObject which has one value for each hour of input data where each value is the mean of the input values over that hour.

Overrides:

valueInput in class BroadcastServer

Parameters:

newEvent - an event from the registered data source

Throws:

VIBUpdateFailedException

See Also:

BroadcastServer.setValueObject(ValueObjectInterface)