com.ergotech.vib.manipulators

Class TrueFalseManipulator

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

public class TrueFalseManipulator
extends SimpleManipulator

This manipulator returns a boolean "true" if the input matches one of the tokens in the comma separated list of "true" values, otherwise it returns a "false" value. Specification: If the input converts to a String that matches one of the tokens in the list of valid "true" values then the output is a Boolean true (1); otherwise the output is a boolean false (0). The "true" list defaults to "true, ok, yes, on". By default the comparison is case insensitive but can be set to be case sensitive. If any property change would result in a changed output, then this output change is immediate.

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

Modifier and Type	Field and Description
boolean	caseSensitive Whether or not the input is to be treated as case sensitive.
static java.lang.String	cvsRev
java.lang.String	trueString A comma separated list of Strings that will convert to "true".
ValueObjectInterface	value This is the input value received at the valueChanged input.

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
TrueFalseManipulator() Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	getCaseSensitive() This is if the strings (both true and false) are case sensitive or not.
java.lang.String	getTrueString() This returns a comma separated list of all the possible strings that represent true.
void	setCaseSensitive(boolean newValue) This is if the strings (both true and false) are case sensitive or not.
void	setTrueString(java.lang.String newValue) This sets the comma separated list of all the possible strings that represent true.
void	update() This will calculate the new output value and update connectors.
void	valueInput(ValueChangedEvent newEvent) This is the input method.

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

Field Detail

caseSensitive

public boolean caseSensitive

Whether or not the input is to be treated as case sensitive. This defaults to false.

cvsRev

public static final java.lang.String cvsRev

See Also:

Constant Field Values

trueString

public java.lang.String trueString

A comma separated list of Strings that will convert to "true".

value

public transient ValueObjectInterface value

This is the input value received at the valueChanged input.

Constructor Detail

TrueFalseManipulator

public TrueFalseManipulator()

Constructor.

Method Detail

getCaseSensitive

public boolean getCaseSensitive()

This is if the strings (both true and false) are case sensitive or not.

See Also:

setCaseSensitive(boolean)

getTrueString

public java.lang.String getTrueString()

This returns a comma separated list of all the possible strings that represent true.

See Also:

setTrueString(java.lang.String)

setCaseSensitive

public void setCaseSensitive(boolean newValue)

This is if the strings (both true and false) are case sensitive or not.

See Also:

getCaseSensitive()

setTrueString

public void setTrueString(java.lang.String newValue)

This sets the comma separated list of all the possible strings that represent true.

See Also:

getTrueString()

update

public void update()
            throws VIBUpdateFailedException

This will calculate the new output value and update connectors.

Throws:

VIBUpdateFailedException

valueInput

public void valueInput(ValueChangedEvent newEvent)
                throws VIBUpdateFailedException

This is the input method. It also updates the current value. At this point no type checking of the ValueObject is made.

Overrides:

valueInput in class Manipulator

Parameters:

newEvent - an event from the registered data source

Throws:

VIBUpdateFailedException