org.eclipse.soda.dk.parameter.service
Interface ParameterService

All Superinterfaces:

DataParameterService

All Known Subinterfaces:

BlockService, CountBlockService, LengthBlockService, MessageLengthBlockService, SegmentLengthBlockService, SegmentService

All Known Implementing Classes:

ArrayParameter, BaseKeyParameter, BaseParameter, BitOffsetParameter, BitsParameter, Block, BooleanParameter, BooleanStringParameter, ByteLengthBlock, ByteOffsetParameter, ByteParameter, BytesBlock, BytesParameter, ChoiceSegment, ConstantBlock, ConstantOffsetParameter, CountBlock, DoubleParameter, FieldParameter, FillStreamParameter, FloatParameter, IdentifierBlock, IntegerParameter, LengthBlock, ListParameter, ListParameters, LittleEndianIntegerParameter, LittleEndianLongParameter, LongParameter, MapParameter, MapParameters, MessageLengthBlock, MessageSizeBlock, MultiParameter, MultiSegment, NumberParameter, NumberStringParameter, OffsetParameter, OptionalSegment, Parameter, Parameters, ReserveBlock, SegmentLengthBlock, SegmentSizeBlock, ShortLittleEndianParameter, ShortParameter, SimpleBooleanParameter, SimpleByteParameter, SimpleDoubleParameter, SimpleFloatParameter, SimpleIntegerParameter, SimpleLittleEndianIntegerParameter, SimpleLittleEndianLongParameter, SimpleLittleEndianShortParameter, SimpleLongParameter, SimpleParameter, SimplerParameter, SimpleSegment, SimpleShortParameter, SimpleUnsignedByteParameter, SimpleUnsignedIntegerParameter, SimpleUnsignedLongParameter, SimpleUnsignedShortParameter, SingleParameter, SizeBlock, StreamLengthParameter, StreamOffsetParameter, StreamParameter, StringParameter, TagParameter, TypeBlock, UnsignedByteParameter, UnsignedIntegerParameter, UnsignedLongParameter, UnsignedShortParameter, Utf8StringParameter, VariableLengthParameter, VariableListParameters, VersionBlock

public interface ParameterService
extends DataParameterService

The ParameterService interface defines the ParameterService concept. A ParameterService is used to describe the location and type of a piece of data contained within a message. A ParameterService knows how to encode itself into a message, as well as how to extract itself from a message.

Since:

1.0

Version:

1.2.0

See Also:

MessageService

Field Summary

static short	ARRAY Define the array (short) constant.
static short	ASCII Define the ASCII parameter type style.
static short	ASCIIZ Define the ASCIIZ (zero terminated) parameter type style.
static short	BOOLEAN Define the boolean parameter type style.
static short	BYTE Define the byte parameter type style.
static short	BYTES Define the byte[] parameter type style.
static short	DOUBLE Define the double parameter type style.
static short	FLOAT Define the float parameter type style.
static short	HEXASCII Define the hex ASCII parameter type style.
static short	HEXSTRING Define the hex string parameter type style.
static short	INSERT Define the insert parameter style.
static short	INTEGER Define the integer parameter type style.
static short	LITTLEENDIAN Define the little endian parameter style.
static short	LONG Define the long (short) constant.
static short	NASCII Define the numeric ASCII parameter type style.
static short	NSTRING Define the numeric string parameter type style.
static short	NULL Define the null parameter style.
static java.lang.String	SERVICE_NAME Define the OSGi service name.
static short	SHORT Define the short parameter type style.
static short	STRING Define the String parameter type style.
static int	UNLIMITED Define the unlimited (int) constant.
static short	UNSIGNED Define the unsigned parameter style.
static int	USE_CURSOR Define the offset use cursor (int) constant.
static int	USE_CURSOR_INSERT Define the offset use cursor insert (int) constant.

Method Summary

java.lang.Object	decodeValue(MessageService message) Perform the decodeValue method and return the Object result.
java.lang.Object	decodeValue(MessageService message, ParameterCursorService cursor) Decode value with the specified message and cursor parameters and return the Object result.
MessageService	encodeValue(MessageService message, java.lang.Object value) Perform the encodeValue method and return the MessageService result.
MessageService	encodeValue(MessageService message, java.lang.Object value, ParameterCursorService cursor) Encode value with the specified message, value and cursor parameters and return the MessageService result.
java.lang.String	getKey() Return the key of this parameter.
boolean	isConstantParameter() Gets the constant parameter (boolean) value.

Methods inherited from interface org.eclipse.soda.dk.data.parameter.service.DataParameterService

decode, encode

Field Detail

SERVICE_NAME

static final java.lang.String SERVICE_NAME

Define the OSGi service name.

UNLIMITED

static final int UNLIMITED

Define the unlimited (int) constant.

See Also:

Constant Field Values

NULL

static final short NULL

Define the null parameter style.

See Also:

Constant Field Values

UNSIGNED

static final short UNSIGNED

Define the unsigned parameter style.

See Also:

Constant Field Values

LITTLEENDIAN

static final short LITTLEENDIAN

Define the little endian parameter style.

See Also:

Constant Field Values

INSERT

static final short INSERT

Define the insert parameter style.

See Also:

Constant Field Values

ARRAY

static final short ARRAY

Define the array (short) constant.

See Also:

Constant Field Values

INTEGER

static final short INTEGER

Define the integer parameter type style.

See Also:

Constant Field Values

BYTE

static final short BYTE

Define the byte parameter type style.

See Also:

Constant Field Values

SHORT

static final short SHORT

Define the short parameter type style.

See Also:

Constant Field Values

BOOLEAN

static final short BOOLEAN

Define the boolean parameter type style.

See Also:

Constant Field Values

STRING

static final short STRING

Define the String parameter type style.

See Also:

Constant Field Values

BYTES

static final short BYTES

Define the byte[] parameter type style.

See Also:

Constant Field Values

NSTRING

static final short NSTRING

Define the numeric string parameter type style.

See Also:

Constant Field Values

ASCII

static final short ASCII

Define the ASCII parameter type style.

See Also:

Constant Field Values

NASCII

static final short NASCII

Define the numeric ASCII parameter type style.

See Also:

Constant Field Values

ASCIIZ

static final short ASCIIZ

Define the ASCIIZ (zero terminated) parameter type style.

See Also:

Constant Field Values

FLOAT

static final short FLOAT

Define the float parameter type style.

See Also:

Constant Field Values

DOUBLE

static final short DOUBLE

Define the double parameter type style.

See Also:

Constant Field Values

HEXSTRING

static final short HEXSTRING

Define the hex string parameter type style.

See Also:

Constant Field Values

HEXASCII

static final short HEXASCII

Define the hex ASCII parameter type style.

See Also:

Constant Field Values

LONG

static final short LONG

Define the long (short) constant.

See Also:

Constant Field Values

USE_CURSOR

static final int USE_CURSOR

Define the offset use cursor (int) constant.

See Also:

Constant Field Values

USE_CURSOR_INSERT

static final int USE_CURSOR_INSERT

Define the offset use cursor insert (int) constant.

See Also:

Constant Field Values

Method Detail

decodeValue

java.lang.Object decodeValue(MessageService message)

Perform the decodeValue method and return the Object result. This API takes a message as a parameter and extracts the appropriate parameter information from the message, returning it in the appropriate form.

Parameters:

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

Returns:

Results of the decode value (Object) value.

See Also:

decodeValue(MessageService,ParameterCursorService), encodeValue(MessageService,Object), encodeValue(MessageService,Object,ParameterCursorService)

decodeValue

java.lang.Object decodeValue(MessageService message,
                             ParameterCursorService cursor)

Decode value with the specified message and cursor parameters and return the Object result.

Parameters:

message - The message (MessageService) parameter.

cursor - The cursor (ParameterCursorService) parameter.

Returns:

Results of the decode value (Object) value.

See Also:

decodeValue(MessageService), encodeValue(MessageService,Object), encodeValue(MessageService,Object,ParameterCursorService)

encodeValue

MessageService encodeValue(MessageService message,
                           java.lang.Object value)

Perform the encodeValue method and return the MessageService result. This API takes the value specified in the value parameter, and properly encodes the value into the message parameter, and returns the encoded MessageService.

Parameters:

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

value - java.lang.Object

Returns:

Results of the encode value (MessageService) value.

See Also:

decodeValue(MessageService), decodeValue(MessageService,ParameterCursorService), encodeValue(MessageService,Object,ParameterCursorService)

encodeValue

MessageService encodeValue(MessageService message,
                           java.lang.Object value,
                           ParameterCursorService cursor)

Encode value with the specified message, value and cursor parameters and return the MessageService result.

Parameters:

message - The message (MessageService) parameter.

value - The value (Object) parameter.

cursor - The cursor (ParameterCursorService) parameter.

Returns:

Results of the encode value (MessageService) value.

See Also:

decodeValue(MessageService), decodeValue(MessageService,ParameterCursorService), encodeValue(MessageService,Object)

getKey

java.lang.String getKey()

Return the key of this parameter. The key must be unique to set of parameters to a message. This API returns the tag as specified in the CML file. If is not specified, then the result is the id attribute.

Returns:

Object The parameter key.

isConstantParameter

boolean isConstantParameter()

Gets the constant parameter (boolean) value.

Returns:

The constant parameter (boolean) value.