com.ergotech.vib.manipulators

Class ReportLabelingManipulator

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.ReportLabelingManipulator

public class ReportLabelingManipulator
extends SimpleManipulator

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.SimpleManipulator

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
ReportLabelingManipulator()

Method Summary

Modifier and Type	Method and Description
static int	extractFormatType(SecsFormat obj)
int	getHistoryLength()
java.lang.String	getJsonDirectory()
int	getStaticLocationFor(java.lang.String method) This is used by the StaticMethodEvent to determine which valueChanged method to call.
void	init() By default this method does nothing.
void	labels(ValueChangedEvent e) Accepts a JSON string with the following format: { rptid: int, labels: [string] } or { rptids: [ { rptid: int, labels: [string] } ] }
void	report(ValueChangedEvent e)
void	setHistoryLength(int historyLength)
void	setJsonDirectory(java.lang.String jsonDirectory)
void	valueChanged(int methodIndex, ValueChangedEvent e) This calls the proper valueChanged method based on the return from the getStaticLocationFor method.

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

getDefaultQualityForLocation

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

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

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, setValueObject, 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, 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

ReportLabelingManipulator

public ReportLabelingManipulator()

Method Detail

extractFormatType

public static int extractFormatType(SecsFormat obj)

getHistoryLength

public int getHistoryLength()

getJsonDirectory

public java.lang.String getJsonDirectory()

getStaticLocationFor

public int getStaticLocationFor(java.lang.String method)
                         throws BadParameterException

This is used by the StaticMethodEvent to determine which valueChanged method to call. An integer index is returned which is used by the valueChanged (int,ValueChangedEvent) method.

Overrides:

getStaticLocationFor in class Manipulator

Throws:

BadParameterException

init

public void init()
          throws BadParameterException

Description copied from class: DataSource

By default this method does nothing.

Overrides:

init in class DataSource

Throws:

BadParameterException

labels

public void labels(ValueChangedEvent e)
            throws VIBUpdateFailedException

Accepts a JSON string with the following format: { rptid: int, labels: [string] } or { rptids: [ { rptid: int, labels: [string] } ] }

Parameters:

e -

Throws:

VIBUpdateFailedException

report

public void report(ValueChangedEvent e)
            throws VIBUpdateFailedException

Throws:

VIBUpdateFailedException

setHistoryLength

public void setHistoryLength(int historyLength)

setJsonDirectory

public void setJsonDirectory(java.lang.String jsonDirectory)

valueChanged

public void valueChanged(int methodIndex,
                         ValueChangedEvent e)
                  throws VIBUpdateFailedException,
                         BadParameterException

This calls the proper valueChanged method based on the return from the getStaticLocationFor method.

Overrides:

valueChanged in class Manipulator

Throws:

VIBUpdateFailedException

BadParameterException