org.eclipse.soda.dk.command
Class TransformCommand

java.lang.Object
  org.eclipse.soda.dk.core.EscObject
      org.eclipse.soda.dk.device.Control
          org.eclipse.soda.dk.command.Command
              org.eclipse.soda.dk.command.DeviceCommand
                  org.eclipse.soda.dk.command.SimpleMessageCommand
                      org.eclipse.soda.dk.command.MessageCommand
                          org.eclipse.soda.dk.command.DataCommand
                              org.eclipse.soda.dk.command.TransformCommand

All Implemented Interfaces:

CommandService, MessageHandler, ControlService, DeviceControl, MeasurementListener, SignalListener, ErrorListener, MessageListener

Direct Known Subclasses:

ParameterCommand

public class TransformCommand
extends DataCommand

The TransformCommand class implements the CommandService interface.

Version:

1.1.0

See Also:

Command, Control, DeviceCommand, MessageCommand, CommandService, ControlService, DeviceControl, ErrorListener, MeasurementListener, MessageHandler, SignalListener, TransformService, TransportListener

Field Summary

Fields inherited from class org.eclipse.soda.dk.command.SimpleMessageCommand

message

Fields inherited from class org.eclipse.soda.dk.device.Control

EXCEPTION_READ_FAILED_RESOURCE, SETVALUEEXCEPTION_RESOURCE

Fields inherited from class org.eclipse.soda.dk.core.EscObject

CLONE_EXCEPTION_RESOURCE, EMPTY_BYTES, EMPTY_STRING, ERROR_OCCURRED_EXCEPTION_RESOURCE, ID_FILTER_KEY, ID_KEY, ID_KEY_ANY, ID_NAME_KEY, INTEGER_TABLE, INTEGER_TABLE_SIZE, KEY_KEY, LOG_DEBUG, LOG_DEFAULT, LOG_ERROR, LOG_INFO, LOG_LEVEL_KEY, LOG_TRACE, LOG_WARNING, LONG_TABLE, LONG_TABLE_SIZE, PREFIX_KEY, READONLY_EMPTY_COLLECTION, READONLY_EMPTY_LIST, READONLY_EMPTY_MAP, RESOURCE_BUNDLE, SLEEP_EXCEPTION_RESOURCE, SYSTEM_INFO_RESOURCE, TO_STRING_CONFIGURATION_KEYS, TRACE_LEVEL_HIGH, TRACE_LEVEL_LOW, TRACE_LEVEL_MAX, TRACE_LEVEL_MIN, TRACE_LEVEL_NONE, TRACE_LEVEL_NORMAL, TRACELEVEL_KEY, UNKNOWN_ERROR_RESOURCE

Constructor Summary

TransformCommand(java.lang.String key, MessageService message)
Constructs an instance of this class from the specified key and message parameters.

TransformCommand(java.lang.String key, MessageService message, TransformService transform)
Constructs an TransformCommand object using the input parameter(s).

Method Summary

java.lang.Object	decode(java.lang.Object data) Perform the encode method and return the Object result.
java.lang.Object	encode(java.lang.Object data) Perform the encode method and return the Object result.
void	execute(java.lang.Object data) Perform the execute action method.
TransformService	getTransform() Gets the TransformService transform property value.
void	messageReceived(TransportService transportService, java.lang.Object timestamp, MessageService message) This API will be called each time the TransportService receives a valid message.
void	setTransform(TransformService transform) Sets the transform property.

Methods inherited from class org.eclipse.soda.dk.command.SimpleMessageCommand

execute, getMessage, setMessage

Methods inherited from class org.eclipse.soda.dk.command.DeviceCommand

getDevice, setDevice

Methods inherited from class org.eclipse.soda.dk.command.Command

addCommandListener, fireCommandExecuted, fireCommandExecuted, fireErrorOccurred, fireErrorOccurred, getCommandListener, measurementChanged, removeCommandListener, reportError, setCommandListener, signalOccurred

Methods inherited from class org.eclipse.soda.dk.device.Control

attemptRecoveryFromError, equalsValue, errorOccurred, findMethod, getCodeKey, getErrorSeverity, getKey, getQualifiedKey, getResource, setKey, setQualifiedKey, toString

Methods inherited from class org.eclipse.soda.dk.core.EscObject

createDefaultLogService, createException, createException, createInteger, createIntegerTable, createLong, createLongTable, createNumber, format, getBoolean, getConfigurationService, getCurrentTimestamp, getDefaultLogService, getDefaultResource, getFloat, getId, getIdName, getInt, getLoadLibraryName, getLogDetails, getLogDetails0, getLogDetails1, getLogDetails2, getLogDetails3, getLogDetails4, getLogDetails5, getLogDetails6, getLogDetails7, getLogLevel, getLogService, getLong, getObject, getOutputName, getReadOnlyEmptyCollection, getReadOnlyEmptyList, getReadOnlyEmptyMap, getSimpleClassName, getStaticBoolean, getStaticFloat, getStaticInt, getStaticLong, getStaticObject, getStaticString, getString, getTraceLevel, getVmLibraryVersion, handleError, handleError, handleError, handleError, handleErrorInternal, handleStaticError, handleStaticException, isDebug, isLogging, isTrace, loadService, log, log, log, report, report, report, report, report, report, reportSystemInfo, setDebug, setDefaultLogService, setLogService, setTraceLevel, shouldLog, sleep, startupEscStatic, toStringConfigurationKeys, toStringInfo

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.soda.dk.device.MessageHandler

getMessage

Methods inherited from interface org.eclipse.soda.dk.transport.service.ErrorListener

errorOccurred

Methods inherited from interface org.eclipse.soda.dk.device.service.ControlService

getKey

Constructor Detail

TransformCommand

public TransformCommand(java.lang.String key,
                        MessageService message)

Constructs an instance of this class from the specified key and message parameters.

Parameters:

key - The key (String) parameter.

message - The message (MessageService) parameter.

See Also:

TransformCommand(String,MessageService,TransformService)

TransformCommand

public TransformCommand(java.lang.String key,
                        MessageService message,
                        TransformService transform)

Constructs an TransformCommand object using the input parameter(s).

Parameters:

key - java.lang.String

message - org.eclipse.soda.dk.message.service.MessageService

transform - org.eclipse.soda.dk.transform.service.TransformService

See Also:

TransformCommand(String,MessageService)

Method Detail

decode

public java.lang.Object decode(java.lang.Object data)

Perform the encode method and return the Object result.

Parameters:

data - java.lang.Object

Returns:

Results of the decode (Object) value.

encode

public java.lang.Object encode(java.lang.Object data)

Perform the encode method and return the Object result.

Parameters:

data - java.lang.Object

Returns:

Results of the encode (Object) value.

execute

public void execute(java.lang.Object data)

Perform the execute action method.

Specified by:

execute in interface CommandService

Overrides:

execute in class DataCommand

Parameters:

data - java.lang.Object

See Also:

CommandService.execute(Object)

getTransform

public TransformService getTransform()

Gets the TransformService transform property value.

Returns:

Results of the get transform (TransformService) value.

See Also:

setTransform(TransformService)

messageReceived

public void messageReceived(TransportService transportService,
                            java.lang.Object timestamp,
                            MessageService message)

This API will be called each time the TransportService receives a valid message. Since other notifications are blocked until this method returns, implementors of this method should:

• Not cause the device or transport to be blocked (eg calling read on a measuremnt).
• Handle this call quickly and return.

Specified by:

messageReceived in interface MessageListener

Overrides:

messageReceived in class DataCommand

Parameters:

transportService - The transport that received the message.

timestamp - The timestamp when the message was detected.

message - The message received.

setTransform

public void setTransform(TransformService transform)

Sets the transform property.

Parameters:

transform - The new property value (org.eclipse.soda.dk.transform.service.TransformService).

See Also:

getTransform()