com.ergotech.vib.manipulators.datetime

Class DateCreator

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.datetime.DateCreator

public class DateCreator
extends SimpleManipulator

This will take integers from multiple servers (for year, month, day of the month, hour, minutes, and seconds, and when triggered, create new GenericValueObject with a timestamp generated from these values. Specification: This requires six parameters to be set: the year (full year, such as 1999, month (zero based, so 0 = January), day of the month (must be > 0), hour, minute, and second. The defaults for all these values are 0, except the day which is 1. Therefore, if you send in just a year, such as 1968, the resulting timestamp will be 1968-Jan-1 12:00 AM.

The new GenericValueObject (with the generated timestamp) is not sent out until the trigger input is received. This is triggered by sending any value to the valueChanged input.

The quality of the resuling GenericValueObject will be the worst of the current input qualities.

If the input exceeds the normal range of values for that entity, such as >24 for hours, or >59 for minutes, the value will "wrap" and the excess will be used. For example, if you enter 36 for the hours, you will be adding 1 day and 12 hours to the date. This effect is accumulative. If you use 34 days, and the month is currently set to July, the result will be 3 days in August PLUS the additional 1 day from the previously set 36 hours. If you send in a negative number, for example, -15 for the minutes, this time is subtracted from the date that would be generated for the rest of the input values. A day of the month value of "0" will result in the last day of the previous month. All of these calculations are taken care of by the Java Calendar object and full documentation for this behavior is given in the Java API documentation. The Calendar used in this component is a "lenient" Gregorian Calendar.

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
static java.lang.String	cvsRev
ValueObjectInterface	day
ValueObjectInterface	hour
ValueObjectInterface	minute
ValueObjectInterface	month
ValueObjectInterface	seconds
java.util.Calendar	timeKeeper
ValueObjectInterface	year

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

Method Summary

Modifier and Type	Method and Description
void	day(ValueChangedEvent newEvent) This is used to set the day of month.
int	getStaticLocationFor(java.lang.String loc) This is used by the StaticMethodEvent to determine which valueChanged method to call.
void	hour(ValueChangedEvent newEvent) This is used to set the hour of the day.
boolean	isJanIsOne()
void	minute(ValueChangedEvent newEvent) This is used to set the minute of the hour.
void	month(ValueChangedEvent newEvent) This is used to set the month.
void	seconds(ValueChangedEvent newEvent) This is used to set the seconds of the minute.
void	setJanIsOne(boolean janIsOne)
void	trigger(ValueChangedEvent newEvent) When this manipulator receives a "trigger" input (valueChangedEvent on this port) the new GenericValueObject will be created with the date composed from the inputs.
void	valueChanged(int loc, ValueChangedEvent e) This calls the proper valueChanged method based on the return from the getStaticLocationFor method.
void	year(ValueChangedEvent newEvent) This is used to set the year.

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

cvsRev

public static final java.lang.String cvsRev

See Also:

Constant Field Values

day

public transient ValueObjectInterface day

hour

public transient ValueObjectInterface hour

minute

public transient ValueObjectInterface minute

month

public transient ValueObjectInterface month

seconds

public transient ValueObjectInterface seconds

timeKeeper

public transient java.util.Calendar timeKeeper

year

public transient ValueObjectInterface year

Constructor Detail

DateCreator

public DateCreator()

Generic Constructor.

Method Detail

day

public void day(ValueChangedEvent newEvent)
         throws VIBUpdateFailedException

This is used to set the day of month.

Throws:

VIBUpdateFailedException

getStaticLocationFor

public int getStaticLocationFor(java.lang.String loc)
                         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

hour

public void hour(ValueChangedEvent newEvent)
          throws VIBUpdateFailedException

This is used to set the hour of the day.

Throws:

VIBUpdateFailedException

isJanIsOne

public boolean isJanIsOne()

Returns:

Returns the janIsOne.

minute

public void minute(ValueChangedEvent newEvent)
            throws VIBUpdateFailedException

This is used to set the minute of the hour.

Throws:

VIBUpdateFailedException

month

public void month(ValueChangedEvent newEvent)
           throws VIBUpdateFailedException

This is used to set the month. The month is 0 based (0=January)

Throws:

VIBUpdateFailedException

seconds

public void seconds(ValueChangedEvent newEvent)
             throws VIBUpdateFailedException

This is used to set the seconds of the minute.

Throws:

VIBUpdateFailedException

setJanIsOne

public void setJanIsOne(boolean janIsOne)

Parameters:

janIsOne - The janIsOne to set.

trigger

public void trigger(ValueChangedEvent newEvent)
             throws VIBUpdateFailedException

When this manipulator receives a "trigger" input (valueChangedEvent on this port) the new GenericValueObject will be created with the date composed from the inputs. The quality of the GenericValueObject will be set to the WORST quality of any of the inputs.

Throws:

VIBUpdateFailedException

valueChanged

public void valueChanged(int loc,
                         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:

BadParameterException

VIBUpdateFailedException

year

public void year(ValueChangedEvent newEvent)
          throws VIBUpdateFailedException

This is used to set the year.

Throws:

VIBUpdateFailedException