org.eclipse.soda.dk.segment
Class SimpleSegment

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

All Implemented Interfaces:

DataParameterService, ParameterService, SegmentService

Direct Known Subclasses:

OptionalSegment

public class SimpleSegment
extends BaseKeyParameter
implements SegmentService

Version:

1.2.0

Field Summary

static java.lang.String

SEGMENT_NAME Define the segment name (String) constant.

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

SimpleSegment()
Constructs an instance of this class.

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

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

SimpleSegment(java.lang.String key, byte[] bytes, FilterService filter, ParameterService parameter)
Constructs an instance of this class from the specified key, bytes, filter and parameter parameters.

Method Summary

boolean	checkMatches(MessageService message, ParameterCursorService cursor) Check matches with the specified container and cursor parameters and return the boolean 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, ParameterCursorService cursor) Encode value with the specified message, value and cursor parameters and return the MessageService result.
byte[]	getBytes() Gets the bytes (byte[]) value.
void	getDidNotMatch(MessageService message, byte[] compareBytes, ParameterCursorService cursor) Get did not match with the specified message parameter.
FilterService	getFilter() Gets the filter (FilterService) value.
ParameterService	getParameter() Gets the parameter (ParameterService) value.
boolean	needsCursor() Needs cursor and return the boolean result.
void	setBytes(byte[] bytes) Sets the bytes value.
void	setFilter(FilterService filter) Sets the filter value.
void	setParameter(ParameterService parameter) Sets the parameter value.

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

SEGMENT_NAME

public static final java.lang.String SEGMENT_NAME

Define the segment name (String) constant.

See Also:

Constant Field Values

Constructor Detail

SimpleSegment

public SimpleSegment()

Constructs an instance of this class.

See Also:

SimpleSegment(byte[],FilterService,ParameterService), SimpleSegment(String), SimpleSegment(String,byte[],FilterService,ParameterService)

SimpleSegment

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

SimpleSegment(), SimpleSegment(String), SimpleSegment(String,byte[],FilterService,ParameterService)

SimpleSegment

public SimpleSegment(java.lang.String key)

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

Parameters:

key - The key (String) parameter.

See Also:

SimpleSegment(), SimpleSegment(byte[],FilterService,ParameterService), SimpleSegment(String,byte[],FilterService,ParameterService)

SimpleSegment

public SimpleSegment(java.lang.String key,
                     byte[] bytes,
                     FilterService filter,
                     ParameterService parameter)

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

Parameters:

key - The key (String) parameter.

bytes - The bytes (byte[]) parameter.

filter - The filter (FilterService) parameter.

parameter - The parameter (ParameterService) parameter.

See Also:

SimpleSegment(), SimpleSegment(byte[],FilterService,ParameterService), SimpleSegment(String)

Method Detail

checkMatches

public boolean checkMatches(MessageService message,
                            ParameterCursorService cursor)

Check matches with the specified container and cursor parameters and return the boolean result.

Specified by:

checkMatches in interface SegmentService

Parameters:

message - The message (MessageService) parameter.

cursor - The cursor (ParameterCursorService) parameter.

Returns:

Results of the check matches (boolean) value.

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 BaseParameter

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 BaseParameter

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)

getBytes

public byte[] getBytes()

Gets the bytes (byte[]) value.

Returns:

The bytes (byte[]) value.

See Also:

setBytes(byte[])

getDidNotMatch

public void getDidNotMatch(MessageService message,
                           byte[] compareBytes,
                           ParameterCursorService cursor)

Get did not match with the specified message parameter.

Parameters:

message - The message (MessageService) parameter.

compareBytes - The compare bytes (byte[]) parameter.

cursor - The cursor (ParameterCursorService) parameter.

getFilter

public FilterService getFilter()

Gets the filter (FilterService) value.

Returns:

The filter (FilterService) value.

See Also:

setFilter(FilterService)

getParameter

public ParameterService getParameter()

Gets the parameter (ParameterService) value.

Returns:

The parameter (ParameterService) value.

See Also:

setParameter(ParameterService)

needsCursor

public boolean needsCursor()

Needs cursor and return the boolean result.

Overrides:

needsCursor in class BaseParameter

Returns:

Results of the needs cursor (boolean) value.

See Also:

BaseParameter.updateCursor(ParameterCursorService), BaseParameter.updateCursor(ParameterCursorService,int)

setBytes

public void setBytes(byte[] bytes)

Sets the bytes value.

Parameters:

bytes - The bytes (byte[]) parameter.

See Also:

getBytes()

setFilter

public void setFilter(FilterService filter)

Sets the filter value.

Parameters:

filter - The filter (FilterService) parameter.

See Also:

getFilter()

setParameter

public void setParameter(ParameterService parameter)

Sets the parameter value.

Parameters:

parameter - The parameter (ParameterService) parameter.

See Also:

getParameter()