org.eclipse.soda.dk.segment
Class ChoiceSegment

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
                          org.eclipse.soda.dk.segment.ChoiceSegment

All Implemented Interfaces:

DataParameterService, ParameterService, SegmentService

public class ChoiceSegment
extends MultiSegment

Version:

1.2.0

Field Summary

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

EMPTY_LIST

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

ChoiceSegment()
Constructs an instance of this class.

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

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

ChoiceSegment(SimpleSegment[] segments)
Constructs an instance of this class from the specified segments parameter.

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

ChoiceSegment(java.lang.String key, ParameterService parameter)
Constructs an instance of this class from the specified key and parameter parameters.

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

ChoiceSegment(java.lang.String key, ParameterService parameter, int occursMinimum, int occursMaximum)
Constructs an instance of this class from the specified key, parameter, occurs minimum and occurs maximum parameters.

ChoiceSegment(java.lang.String key, SegmentService[] segments)
Constructs an instance of this class from the specified key and segments parameters.

ChoiceSegment(java.lang.String key, SegmentService[] segments, int occursMinimum, int occursMaximum)
Constructs an instance of this class from the specified key, segments, occurs minimum and occurs maximum parameters.

ChoiceSegment(java.lang.String key, SegmentService segment, int occursMinimum, int occursMaximum)
Constructs an instance of this class from the specified key, segment, 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.
SegmentService[]	getSegments() Gets the segments (SegmentService[]) value.
void	setParameters(ParameterService[] parameters) Sets the parameters value.
void	setSegments(SegmentService[] segments) Sets the segments value.

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

getOccursMaximum, getOccursMinimum, setOccursMaximum, setOccursMinimum

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

Constructor Detail

ChoiceSegment

public ChoiceSegment()

Constructs an instance of this class.

See Also:

ChoiceSegment(byte[],FilterService,ParameterService), ChoiceSegment(byte[],ParameterService,int,int), ChoiceSegment(SimpleSegment[]), ChoiceSegment(String), ChoiceSegment(String,ParameterService), ChoiceSegment(String,ParameterService,int,int), ChoiceSegment(String,ParameterService[],int,int), ChoiceSegment(String,SegmentService,int,int), ChoiceSegment(String,SegmentService[]), ChoiceSegment(String,SegmentService[],int,int)

ChoiceSegment

public ChoiceSegment(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:

ChoiceSegment(), ChoiceSegment(byte[],ParameterService,int,int), ChoiceSegment(SimpleSegment[]), ChoiceSegment(String), ChoiceSegment(String,ParameterService), ChoiceSegment(String,ParameterService,int,int), ChoiceSegment(String,ParameterService[],int,int), ChoiceSegment(String,SegmentService,int,int), ChoiceSegment(String,SegmentService[]), ChoiceSegment(String,SegmentService[],int,int)

ChoiceSegment

public ChoiceSegment(byte[] bytes,
                     ParameterService parameter,
                     int occursMinimum,
                     int occursMaximum)

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

Parameters:

bytes - The bytes (byte[]) parameter.

parameter - The parameter (ParameterService) parameter.

occursMinimum - The occurs minimum (int) parameter.

occursMaximum - The occurs maximum (int) parameter.

See Also:

ChoiceSegment(), ChoiceSegment(byte[],FilterService,ParameterService), ChoiceSegment(SimpleSegment[]), ChoiceSegment(String), ChoiceSegment(String,ParameterService), ChoiceSegment(String,ParameterService,int,int), ChoiceSegment(String,ParameterService[],int,int), ChoiceSegment(String,SegmentService,int,int), ChoiceSegment(String,SegmentService[]), ChoiceSegment(String,SegmentService[],int,int)

ChoiceSegment

public ChoiceSegment(SimpleSegment[] segments)

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

Parameters:

segments - The segments (SimpleSegment[]) parameter.

See Also:

ChoiceSegment(), ChoiceSegment(byte[],FilterService,ParameterService), ChoiceSegment(byte[],ParameterService,int,int), ChoiceSegment(String), ChoiceSegment(String,ParameterService), ChoiceSegment(String,ParameterService,int,int), ChoiceSegment(String,ParameterService[],int,int), ChoiceSegment(String,SegmentService,int,int), ChoiceSegment(String,SegmentService[]), ChoiceSegment(String,SegmentService[],int,int)

ChoiceSegment

public ChoiceSegment(java.lang.String key)

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

Parameters:

key - The key (String) parameter.

See Also:

ChoiceSegment(), ChoiceSegment(byte[],FilterService,ParameterService), ChoiceSegment(byte[],ParameterService,int,int), ChoiceSegment(SimpleSegment[]), ChoiceSegment(String,ParameterService), ChoiceSegment(String,ParameterService,int,int), ChoiceSegment(String,ParameterService[],int,int), ChoiceSegment(String,SegmentService,int,int), ChoiceSegment(String,SegmentService[]), ChoiceSegment(String,SegmentService[],int,int)

ChoiceSegment

public ChoiceSegment(java.lang.String key,
                     ParameterService parameter)

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

Parameters:

key - The key (String) parameter.

parameter - The parameter (ParameterService) parameter.

See Also:

ChoiceSegment(), ChoiceSegment(byte[],FilterService,ParameterService), ChoiceSegment(byte[],ParameterService,int,int), ChoiceSegment(SimpleSegment[]), ChoiceSegment(String), ChoiceSegment(String,ParameterService,int,int), ChoiceSegment(String,ParameterService[],int,int), ChoiceSegment(String,SegmentService,int,int), ChoiceSegment(String,SegmentService[]), ChoiceSegment(String,SegmentService[],int,int)

ChoiceSegment

public ChoiceSegment(java.lang.String key,
                     ParameterService parameter,
                     int occursMinimum,
                     int occursMaximum)

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

Parameters:

key - The key (String) parameter.

parameter - The parameter (ParameterService) parameter.

occursMinimum - The occurs minimum (int) parameter.

occursMaximum - The occurs maximum (int) parameter.

See Also:

ChoiceSegment(), ChoiceSegment(byte[],FilterService,ParameterService), ChoiceSegment(byte[],ParameterService,int,int), ChoiceSegment(SimpleSegment[]), ChoiceSegment(String), ChoiceSegment(String,ParameterService), ChoiceSegment(String,ParameterService[],int,int), ChoiceSegment(String,SegmentService,int,int), ChoiceSegment(String,SegmentService[]), ChoiceSegment(String,SegmentService[],int,int)

ChoiceSegment

public ChoiceSegment(java.lang.String key,
                     ParameterService[] parameters,
                     int occursMinimum,
                     int occursMaximum)

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

Parameters:

key - The key (String) parameter.

parameters - The parameters (ParameterService[]) parameter.

occursMinimum - The occurs minimum (int) parameter.

occursMaximum - The occurs maximum (int) parameter.

See Also:

ChoiceSegment(), ChoiceSegment(byte[],FilterService,ParameterService), ChoiceSegment(byte[],ParameterService,int,int), ChoiceSegment(SimpleSegment[]), ChoiceSegment(String), ChoiceSegment(String,ParameterService), ChoiceSegment(String,ParameterService,int,int), ChoiceSegment(String,SegmentService,int,int), ChoiceSegment(String,SegmentService[]), ChoiceSegment(String,SegmentService[],int,int)

ChoiceSegment

public ChoiceSegment(java.lang.String key,
                     SegmentService segment,
                     int occursMinimum,
                     int occursMaximum)

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

Parameters:

key - The key (String) parameter.

segment - The segment (SegmentService) parameter.

occursMinimum - The occurs minimum (int) parameter.

occursMaximum - The occurs maximum (int) parameter.

See Also:

ChoiceSegment(), ChoiceSegment(byte[],FilterService,ParameterService), ChoiceSegment(byte[],ParameterService,int,int), ChoiceSegment(SimpleSegment[]), ChoiceSegment(String), ChoiceSegment(String,ParameterService), ChoiceSegment(String,ParameterService,int,int), ChoiceSegment(String,ParameterService[],int,int), ChoiceSegment(String,SegmentService[]), ChoiceSegment(String,SegmentService[],int,int)

ChoiceSegment

public ChoiceSegment(java.lang.String key,
                     SegmentService[] segments)

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

Parameters:

key - The key (String) parameter.

segments - The segments (SegmentService[]) parameter.

See Also:

ChoiceSegment(), ChoiceSegment(byte[],FilterService,ParameterService), ChoiceSegment(byte[],ParameterService,int,int), ChoiceSegment(SimpleSegment[]), ChoiceSegment(String), ChoiceSegment(String,ParameterService), ChoiceSegment(String,ParameterService,int,int), ChoiceSegment(String,ParameterService[],int,int), ChoiceSegment(String,SegmentService,int,int), ChoiceSegment(String,SegmentService[],int,int)

ChoiceSegment

public ChoiceSegment(java.lang.String key,
                     SegmentService[] segments,
                     int occursMinimum,
                     int occursMaximum)

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

Parameters:

key - The key (String) parameter.

segments - The segments (SegmentService[]) parameter.

occursMinimum - The occurs minimum (int) parameter.

occursMaximum - The occurs maximum (int) parameter.

See Also:

ChoiceSegment(), ChoiceSegment(byte[],FilterService,ParameterService), ChoiceSegment(byte[],ParameterService,int,int), ChoiceSegment(SimpleSegment[]), ChoiceSegment(String), ChoiceSegment(String,ParameterService), ChoiceSegment(String,ParameterService,int,int), ChoiceSegment(String,ParameterService[],int,int), ChoiceSegment(String,SegmentService,int,int), ChoiceSegment(String,SegmentService[])

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 MultiSegment

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 MultiSegment

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)

getSegments

public SegmentService[] getSegments()

Gets the segments (SegmentService[]) value.

Returns:

The segments (SimpleSegment[]) value.

See Also:

setSegments(SegmentService[])

setParameters

public void setParameters(ParameterService[] parameters)

Sets the parameters value.

Parameters:

parameters - The parameters (ParameterService[]) parameter.

setSegments

public void setSegments(SegmentService[] segments)

Sets the segments value.

Parameters:

segments - The segments (SegmentService[]) parameter.

See Also:

getSegments()