com.ergotech.vib.manipulators

Class PropertyFilter

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

public class PropertyFilter
extends SimpleManipulator

The PropertyFilter changes one or more properties of the input ValueObject. It can change the Color, the Quality, and/or the TimeStamp. The Quality will be changed if a new quality other than "no change" is selected. The Color will be changed to the new changeColorTo Color. If a null Color (no Color) is needed, the String "null" can be entered in the changeColor property to remove the color. If left blank (or whitespace) no Color change will be made (Color in original Value Object is not washed). The Timestamp will be changed to the current time if changeTime is set to true. If non-zero, the timeOffset will be applied to either the current time (if changeTime is true), or to the current timeStamp.

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
PropertyFilter() Generic Constructor, Color set to null in currentValue.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getChangeColorTo()
boolean	getChangeTime() Get whether or not to change the time in the outgoing ValueObject.
int	getQuality() Get the quality value for out-going valueObjects.
boolean	getSendOnPropertyChange() Get whether or not to send a new ValueObject every time the quality, color, or timestamp of the data is changed.
long	getTimeOffset() Get the timeOffset to be applied to the timestamp of the out-going ValueObject.
java.awt.Color	parseString(java.lang.String value) This will parse a string.
void	setChangeColorTo(java.lang.String colorString) This sets the Color to be used in the outgoing ValueObject.
void	setChangeTime(boolean changeTime) Set whether or not to change the timestamp to the current time for the outgoing ValueObject.
void	setQuality(int quality) Set the quality value for all out-going value objects.
void	setSendOnPropertyChange(boolean sendOnPropertyChange) Set whether or not to send a new ValueObject every time the quality, color, or timestamp of the data is changed.
void	setTimeOffset(long timeOffset) Set the timeOffset (in millseconds) for all out-going value objects.
java.lang.String	toString() Provides a description of the current values and states.
void	update(ValueObjectInterface newValue) This takes the incoming value and sets the quality of the data.
ValueObjectInterface	updateColor(ValueObjectInterface newValueObject) The superclass sets the color according to values/levels which is not what we want for this component.
void	valueInput(ValueChangedEvent e) This will take the string out the the event, and parse it.

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

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyFilter

public PropertyFilter()

Generic Constructor, Color set to null in currentValue.

Method Detail

getChangeColorTo

public java.lang.String getChangeColorTo()

Returns:

Returns the changeColorTo.

getChangeTime

public boolean getChangeTime()

Get whether or not to change the time in the outgoing ValueObject.

Returns:

a boolean which is whether or not to change the timestamp.

getQuality

public int getQuality()

Get the quality value for out-going valueObjects. The quality is one of the pre-set values in ValueObjectInterface.

Returns:

an int which is one of the ValueObjectInterface quality numbers

See Also:

ValueObjectInterface

getSendOnPropertyChange

public boolean getSendOnPropertyChange()

Get whether or not to send a new ValueObject every time the quality, color, or timestamp of the data is changed.

Returns:

a boolean which is whether or not to send an output when the quality, color, or timestamp is changed.

getTimeOffset

public long getTimeOffset()

Get the timeOffset to be applied to the timestamp of the out-going ValueObject.

Returns:

a long which is the timestamp offset in milliseconds

See Also:

ValueObjectInterface

parseString

public java.awt.Color parseString(java.lang.String value)

This will parse a string. The string should represent a color as three values. The format of the string is r,g,b.

Returns:

the color formed from parsing the string.

setChangeColorTo

public void setChangeColorTo(java.lang.String colorString)
                      throws BadParameterException

This sets the Color to be used in the outgoing ValueObject. Accepted formats are:

(R,G,B)
R,G,B
R=x,G=y,B=z


If the String input is blank, the Color will not be changed (if the input ValueObject has a Color set or is null, the output will also have this Color set, or remain null). If the String is any case of "null" then the Color will be set to null (washes any Color in the input ValueObject).

Parameters:

changeColorTo - The changeColorTo to set.

Throws:

BadParameterException

setChangeTime

public void setChangeTime(boolean changeTime)

Set whether or not to change the timestamp to the current time for the outgoing ValueObject. If true, the timestamp will be set to the current system time. If timeOffset is non-zero, it will also be used to adjust the timestamp.

Parameters:

changeTime - if true the ValueObject's timestamp will be set to the current System time

setQuality

public void setQuality(int quality)

Set the quality value for all out-going value objects. The quality is one of the pre-set values in ValueObjectInterface.

Parameters:

newQuality - a valid ValueObjectInterface quality value

See Also:

ValueObjectInterface

setSendOnPropertyChange

public void setSendOnPropertyChange(boolean sendOnPropertyChange)

Set whether or not to send a new ValueObject every time the quality, color, or timestamp of the data is changed.

Parameters:

sendOnPropertyChange - if true then every time a property is changed a new ValueObject will be sent.

setTimeOffset

public void setTimeOffset(long timeOffset)

Set the timeOffset (in millseconds) for all out-going value objects. This changes the timestamp of the ValueObject if this is a non-zero value. If changeTime is false then this offset is applied to the original timestamp of the ValueObject. If changeTime is true, then this offset is applied to the current time (not necessarily the same as the timestamp in the input ValueObject) when the new timestamp is calculated.

Parameters:

timeOffset - time (plus or minus) in milliseconds to apply to the timestamp

See Also:

ValueObjectInterface

toString

public java.lang.String toString()

Provides a description of the current values and states.

Overrides:

toString in class Manipulator

Returns:

a string description of this server

update

public void update(ValueObjectInterface newValue)
            throws VIBUpdateFailedException

This takes the incoming value and sets the quality of the data.

Throws:

VIBUpdateFailedException

updateColor

public ValueObjectInterface updateColor(ValueObjectInterface newValueObject)

The superclass sets the color according to values/levels which is not what we want for this component. This returns the ValueObject with the correct color set (or not) depending on if sendColors is true or not.

Overrides:

updateColor in class DataSource

valueInput

public void valueInput(ValueChangedEvent e)
                throws VIBUpdateFailedException

This will take the string out the the event, and parse it.

Overrides:

valueInput in class Manipulator

Parameters:

e - The ValueChangedEvent that the bean or data source has sent.

Throws:

VIBUpdateFailedException