org.eclipse.soda.dk.parameter
Class FieldParameter

java.lang.Object
  org.eclipse.soda.dk.core.EscObject
      org.eclipse.soda.dk.parameter.Parameter
          org.eclipse.soda.dk.parameter.FieldParameter

All Implemented Interfaces:

DataParameterService, ParameterService

public class FieldParameter
extends Parameter

Version:

1.0.0

Field Summary

Fields inherited from class org.eclipse.soda.dk.parameter.Parameter

MASKS, SET_MASKS, SET_TOP_MASKS

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, INTEGER_TABLE, KEY_KEY, LOG_DEBUG, LOG_ERROR, LOG_INFO, LOG_TRACE, LOG_WARNING, PREFIX_KEY, 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

Fields inherited from interface org.eclipse.soda.dk.parameter.service.ParameterService

ARRAY, ASCII, ASCIIZ, BOOLEAN, BYTE, BYTES, DOUBLE, FLOAT, HEXASCII, HEXSTRING, INSERT, INTEGER, LITTLEENDIAN, LONG, NASCII, NSTRING, NULL, SHORT, STRING, UNSIGNED

Constructor Summary

FieldParameter(java.lang.String key, java.lang.String fieldKey)
Constructs an instance of this class from the specified key and field key parameters.

FieldParameter(java.lang.String key, java.lang.String fieldKey, short style)
Constructs an instance of this class from the specified key, field key and style parameters.

FieldParameter(java.lang.String key, TransformService transform, java.lang.String fieldKey)
Constructs an instance of this class from the specified key, transform and field key parameters.

FieldParameter(java.lang.String key, TransformService transform, java.lang.String fieldKey, short style)
Constructs an instance of this class from the specified key, transform, field key and style parameters.

Method Summary

protected java.lang.Object	decodeMessage(MessageService message) Perform the decodeMessage method and return the Object result.
MessageService	encodeMessage(MessageService message, java.lang.Object value, int offset) Perform the encodeMessage method and return the MessageService result.
java.lang.String	getKey() Gets the key (String) value.

Methods inherited from class org.eclipse.soda.dk.parameter.Parameter

decode, decodeBytes, decodeEnd, decodeString, decodeValue, encode, encodeBegin, encodeBytes, encodeString, encodeValue, equals, getDefaultStyle, getLong, getStyle, getTransform, getTypeStyle, isArray, isInsert, isLittleEndian, isUnsigned, setBits, setKey, setStyle, setTransform

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

attemptRecoveryFromError, createDefaultLogService, createException, createException, createInteger, createIntegerTable, createNumber, format, getBoolean, getConfigurationService, getCurrentTimestamp, getDefaultLogService, getDefaultResource, getErrorSeverity, getFloat, getInt, getLoadLibraryName, getLogDetails, getLogDetails0, getLogDetails1, getLogDetails2, getLogDetails3, getLogDetails4, getLogDetails5, getLogDetails6, getLogDetails7, getLogService, getLong, getObject, getOutputName, getResource, getSimpleClassName, getStaticBoolean, getStaticFloat, getStaticInt, getStaticLong, getStaticObject, getStaticString, getString, getTraceLevel, getVmLibraryVersion, handleError, handleError, handleError, handleStaticError, handleStaticException, isDebug, isTrace, loadService, log, log, report, report, report, report, report, report, reportError, reportSystemInfo, setDebug, setDefaultLogService, setLogService, setTraceLevel, shouldLog, sleep, startupEscStatic, toString, toStringConfigurationKeys, toStringInfo

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldParameter

public FieldParameter(java.lang.String key,
                      TransformService transform,
                      java.lang.String fieldKey,
                      short style)

Constructs an instance of this class from the specified key, transform, field key and style parameters.

Parameters:

key - The key (String) parameter.

transform - The transform (TransformService) parameter.

fieldKey - The field key (String) parameter.

style - The style (short) parameter.

See Also:

FieldParameter(String,String,short), FieldParameter(String,String), FieldParameter(String,TransformService,String)

FieldParameter

public FieldParameter(java.lang.String key,
                      java.lang.String fieldKey,
                      short style)

Constructs an instance of this class from the specified key, field key and style parameters.

Parameters:

key - The key (String) parameter.

fieldKey - The field key (String) parameter.

style - The style (short) parameter.

See Also:

FieldParameter(String,TransformService,String,short), FieldParameter(String,String), FieldParameter(String,TransformService,String)

FieldParameter

public FieldParameter(java.lang.String key,
                      java.lang.String fieldKey)

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

Parameters:

key - The key (String) parameter.

fieldKey - The field key (String) parameter.

See Also:

FieldParameter(String,TransformService,String,short), FieldParameter(String,String,short), FieldParameter(String,TransformService,String)

FieldParameter

public FieldParameter(java.lang.String key,
                      TransformService transform,
                      java.lang.String fieldKey)

Constructs an instance of this class from the specified key, transform and field key parameters.

Parameters:

key - The key (String) parameter.

transform - The transform (TransformService) parameter.

fieldKey - The field key (String) parameter.

See Also:

FieldParameter(String,TransformService,String,short), FieldParameter(String,String,short), FieldParameter(String,String)

Method Detail

decodeMessage

protected java.lang.Object decodeMessage(MessageService message)

Perform the decodeMessage method and return the Object result.

Overrides:

decodeMessage in class Parameter

Parameters:

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

Returns:

Results of the decode message (Object) value.

See Also:

encodeMessage(MessageService,Object,int)

encodeMessage

public MessageService encodeMessage(MessageService message,
                                    java.lang.Object value,
                                    int offset)

Perform the encodeMessage method and return the MessageService result.

Overrides:

encodeMessage in class Parameter

Parameters:

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

value - java.lang.Object

offset - int

Returns:

Results of the encode message (MessageService) value.

See Also:

decodeMessage(MessageService)

getKey

public java.lang.String getKey()

Gets the key (String) value.

Specified by:

getKey in interface ParameterService

Overrides:

getKey in class Parameter

Returns:

The key (String) value.

See Also:

Parameter.setKey(String)