org.eclipse.soda.dk.segment
Class MultiSegment

java.lang.Object
  org.eclipse.soda.dk.core.EscObject
      org.eclipse.soda.dk.parameter.BaseParameter
          org.eclipse.soda.dk.parameter.BaseKeyParameter
              org.eclipse.soda.dk.segment.SimpleSegment
                  org.eclipse.soda.dk.segment.OptionalSegment
                      org.eclipse.soda.dk.segment.MultiSegment

All Implemented Interfaces:

DataParameterService, ParameterService, SegmentService

Direct Known Subclasses:

ChoiceSegment

public class MultiSegment
extends OptionalSegment

Version:

1.2.0

Field Summary

protected static java.lang.Object

EMPTY_LIST Define the empty list (Object) constant.

Fields inherited from class org.eclipse.soda.dk.segment.SimpleSegment

SEGMENT_NAME

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

key

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

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

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

SERVICE_NAME

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, UNLIMITED, UNSIGNED, USE_CURSOR, USE_CURSOR_INSERT

Constructor Summary

MultiSegment()
Constructs an instance of this class.

MultiSegment(byte[] bytes, FilterService filter, ParameterService parameter)
Constructs an instance of this class from the specified bytes, filter and parameter parameters.

MultiSegment(byte[] bytes, FilterService filter, ParameterService parameter, int occursMinimum, int occursMaximum)
Constructs an instance of this class from the specified bytes, filter, parameter, occurs minimum and occurs maximum parameters.

MultiSegment(java.lang.String key)
Constructs an instance of this class from the specified key parameter.

MultiSegment(java.lang.String key, byte[] bytes, FilterService filter, ParameterService parameter, int occursMinimum, int occursMaximum)
Constructs an instance of this class from the specified key, bytes, filter, parameter, occurs minimum and occurs maximum parameters.

Method Summary

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, ParameterCursorService cursor) Encode value with the specified message, value and cursor parameters and return the MessageService result.
int	getOccursMaximum() Gets the occurs maximum (int) value.
int	getOccursMinimum() Gets the occurs minimum (int) value.
void	setOccursMaximum(int occursMaximum) Sets the occurs maximum value.
void	setOccursMinimum(int occursMinimum) Sets the occurs minimum value.

Methods inherited from class org.eclipse.soda.dk.segment.OptionalSegment

getDidNotMatch, isInsert

Methods inherited from class org.eclipse.soda.dk.segment.SimpleSegment

checkMatches, getBytes, getFilter, getParameter, needsCursor, setBytes, setFilter, setParameter

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

getKey, setKey

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

createCursorChild, decode, decodeBytes, decodeEnd, decodeString, decodeValue, encode, encodeBytes, encodeData, encodeString, encodeValue, expand, expand, getAbsoluteOffset, getBytes, getDefaultStyle, getLength, getLength, getLittleEndianLong, getLong, getOffset, getOffsetAbsolute, getOffsetDefault, getOffsetLength, getOffsetValue, getUnsignedInteger, getUnsignedLittleEndianLong, getUnsignedLittleEngianLong, getUnsignedLong, isConstantParameter, isInsert, setBits, setBits, setBits, setBitsLittleEngian, setBytes, setBytes, setBytes, setBytesLittleEndian, updateCursor, updateCursor

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

attemptRecoveryFromError, createBoolean, createDefaultLogService, createException, createException, createInteger, createIntegerTable, createLong, createLongTable, createNumber, format, getBoolean, getByte, getChar, getConfigurationService, getCurrentTimestamp, getDefaultLogService, getDefaultResource, getDouble, getErrorSeverity, getFloat, getId, getIdName, getInt, getLoadLibraryName, getLogDetails, getLogDetails, getLogDetails0, getLogDetails1, getLogDetails2, getLogDetails3, getLogDetails4, getLogDetails5, getLogDetails6, getLogDetails7, getLogLevel, getLogService, getLong, getObject, getOutputName, getReadOnlyEmptyCollection, getReadOnlyEmptyList, getReadOnlyEmptyMap, getResource, getShort, getSimpleClassName, getStaticBoolean, getStaticByte, getStaticChar, getStaticDouble, getStaticFloat, getStaticInt, getStaticLong, getStaticObject, getStaticShort, getStaticString, getString, getTraceLevel, getVmLibraryVersion, handleError, handleError, handleError, handleError, handleErrorInternal, handleStaticError, handleStaticException, isBackward, isDebug, isLogging, isTrace, isUnmodifiable, loadService, log, log, log, report, report, report, report, report, report, report, reportError, reportSystemInfo, setBackward, setDebug, setDefaultLogService, setLogService, setTraceLevel, setUnmodifiable, shouldLog, sleep, startupEscStatic, toString, 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.parameter.service.ParameterService

decodeValue, encodeValue, getKey, isConstantParameter

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

decode, encode

Field Detail

EMPTY_LIST

protected static final java.lang.Object EMPTY_LIST

Define the empty list (Object) constant.

Constructor Detail

MultiSegment

public MultiSegment()

Constructs an instance of this class.

See Also:

MultiSegment(byte[],FilterService,ParameterService), MultiSegment(byte[],FilterService,ParameterService,int,int), MultiSegment(String), MultiSegment(String,byte[],FilterService,ParameterService,int,int)

MultiSegment

public MultiSegment(byte[] bytes,
                    FilterService filter,
                    ParameterService parameter)

Constructs an instance of this class from the specified bytes, filter and parameter parameters.

Parameters:

bytes - The bytes (byte[]) parameter.

filter - The filter (FilterService) parameter.

parameter - The parameter (ParameterService) parameter.

See Also:

MultiSegment(), MultiSegment(byte[],FilterService,ParameterService,int,int), MultiSegment(String), MultiSegment(String,byte[],FilterService,ParameterService,int,int)

MultiSegment

public MultiSegment(byte[] bytes,
                    FilterService filter,
                    ParameterService parameter,
                    int occursMinimum,
                    int occursMaximum)

Constructs an instance of this class from the specified bytes, filter, parameter, occurs minimum and occurs maximum parameters.

Parameters:

bytes - The bytes (byte[]) parameter.

filter - The filter (FilterService) parameter.

parameter - The parameter (ParameterService) parameter.

occursMinimum - The occurs minimum (int) parameter.

occursMaximum - The occurs maximum (int) parameter.

See Also:

MultiSegment(), MultiSegment(byte[],FilterService,ParameterService), MultiSegment(String), MultiSegment(String,byte[],FilterService,ParameterService,int,int)

MultiSegment

public MultiSegment(java.lang.String key)

Constructs an instance of this class from the specified key parameter.

Parameters:

key - The key (String) parameter.

See Also:

MultiSegment(), MultiSegment(byte[],FilterService,ParameterService), MultiSegment(byte[],FilterService,ParameterService,int,int), MultiSegment(String,byte[],FilterService,ParameterService,int,int)

MultiSegment

public MultiSegment(java.lang.String key,
                    byte[] bytes,
                    FilterService filter,
                    ParameterService parameter,
                    int occursMinimum,
                    int occursMaximum)

Constructs an instance of this class from the specified key, bytes, filter, parameter, occurs minimum and occurs maximum parameters.

Parameters:

key - The key (String) parameter.

bytes - The bytes (byte[]) parameter.

filter - The filter (FilterService) parameter.

parameter - The parameter (ParameterService) parameter.

occursMinimum - The occurs minimum (int) parameter.

occursMaximum - The occurs maximum (int) parameter.

See Also:

MultiSegment(), MultiSegment(byte[],FilterService,ParameterService), MultiSegment(byte[],FilterService,ParameterService,int,int), MultiSegment(String)

Method Detail

decodeValue

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

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

Specified by:

decodeValue in interface ParameterService

Overrides:

decodeValue in class SimpleSegment

Parameters:

message - The message (MessageService) parameter.

cursor - The cursor (ParameterCursorService) parameter.

Returns:

Results of the decode value (Object) value.

See Also:

encodeValue(MessageService,Object,ParameterCursorService)

encodeValue

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

Specified by:

encodeValue in interface ParameterService

Overrides:

encodeValue in class SimpleSegment

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

getOccursMaximum

public int getOccursMaximum()

Gets the occurs maximum (int) value.

Returns:

The occurs maximum (int) value.

See Also:

setOccursMaximum(int)

getOccursMinimum

public int getOccursMinimum()

Gets the occurs minimum (int) value.

Returns:

The occurs minimum (int) value.

See Also:

setOccursMinimum(int)

setOccursMaximum

public void setOccursMaximum(int occursMaximum)

Sets the occurs maximum value.

Parameters:

occursMaximum - The occurs maximum (int) parameter.

See Also:

getOccursMaximum()

setOccursMinimum

public void setOccursMinimum(int occursMinimum)

Sets the occurs minimum value.

Parameters:

occursMinimum - The occurs minimum (int) parameter.

See Also:

getOccursMinimum()