com.caplin.datasource.messaging.record

Interface RecordMessage

All Superinterfaces:

Message

All Known Subinterfaces:

GenericMessage, RecordType1Message, RecordType2Message, RecordType3Message

public interface RecordMessage
extends Message

Base interface for all Record messages.

You do not need to implement this interface. Instead use one of its derived interfaces:

• RecordType1Message
• RecordType2Message
• RecordType3Message
• GenericMessage

Objects implementing these interfaces cannot be instantiated directly, but can be constructed using the MessageFactory that is available on the Publisher interface.

Method Summary

Methods

Modifier and Type	Method and Description
void	addLatencyChainPoint(java.lang.String pointName, long milliseconds) Adds a latency chain point
void	clearFields() Removes all the fields previously added to this RecordMessage
boolean	containsField(java.lang.String fieldName) Determines whether the message contains the specified field
java.lang.String	getField(java.lang.String fieldName) Gets the value of the specified field.
java.util.List<Field>	getFields() Gets the fields within this RecordMessage.
void	removeField(java.lang.String fieldName) Removes all occurrences of the given field from this RecordMessage.
void	setField(java.lang.String fieldName, java.lang.String value) Sets a field value.
void	setInitialLatencyChainTime(long milliseconds) Starts a latency chain if enabled using the latencyChainManager configuration option.

Methods inherited from interface com.caplin.datasource.messaging.Message

getSubject, isImage, setImage

Method Detail

clearFields

void clearFields()

Removes all the fields previously added to this RecordMessage

containsField

boolean containsField(java.lang.String fieldName)

Determines whether the message contains the specified field

Parameters:

fieldName - Name of the field.

Returns:

true if the message contains the field, otherwise, false.

getFields

java.util.List<Field> getFields()

Gets the fields within this RecordMessage.

Returns:

A read-only list of the fields.

setField

void setField(java.lang.String fieldName,
            java.lang.String value)

Sets a field value.

If the field does not exist in this RecordMessage, the field is added to it. Otherwise the existing occurrence of the field is updated to the new value.

Parameters:

fieldName - The name of the field.

value - The new value of the field.

Throws:

java.lang.IllegalArgumentException - Raised when the fieldName is not defined in the Fields configuration file.

getField

java.lang.String getField(java.lang.String fieldName)

Gets the value of the specified field. If the field does not exist in this RecordMessage, null is returned.

Parameters:

fieldName - The name of the field to get.

Returns:

The value of the field with the name fieldName, or null if there is no such field in this RecordMessage.

Throws:

java.lang.IllegalArgumentException - Raised when the fieldName is not defined in the Fields configuration file.

removeField

void removeField(java.lang.String fieldName)

Removes all occurrences of the given field from this RecordMessage.

Parameters:

fieldName - The name of the field to remove.

setInitialLatencyChainTime

void setInitialLatencyChainTime(long milliseconds)

Starts a latency chain if enabled using the latencyChainManager configuration option.

Parameters:

milliseconds - The first time in the latency chain in milliseconds since midnight, January 1, 1970 UTC. This could be: the time the data was created; the time the data entered the DataSource adaptor; or the time the data entered the DataSource API. The time is of the same form as the value of System.currentTimeMillis().

Throws:

java.lang.IllegalStateException - Raised when called twice on the same RecordMessage instance.

addLatencyChainPoint

void addLatencyChainPoint(java.lang.String pointName,
                        long milliseconds)

Adds a latency chain point

Parameters:

pointName - The name associated with the latency measurement.

milliseconds - The timestamp in milliseconds since midnight, January 1, 1970 UTC. The time is of the same form as the value of System.currentTimeMillis().

Throws:

java.lang.IllegalStateException - Raised when the initial timestamp has not be initialised.