uk.co.real_logic.sbe.xml

Class MessageSchema

java.lang.Object

uk.co.real_logic.sbe.xml.MessageSchema

public class MessageSchema
extends java.lang.Object

Message schema composite for schema attributes, messageHeader, and reference for multiple Message objects.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	HEADER_TYPE_DEFAULT

Constructor Summary

Constructors

Constructor and Description
MessageSchema(org.w3c.dom.Node schemaNode, java.util.Map<java.lang.String,Type> typeByNameMap, java.util.Map<java.lang.Long,Message> messageByIdMap)

Method Summary

Modifier and Type	Method and Description
java.nio.ByteOrder	byteOrder() Return the byte order specified by the messageSchema
java.lang.String	description() The description of the schema.
Message	getMessage(long messageId) Return a given Message object with the given messageId.
int	id() The id number of the schema.
CompositeType	messageHeader() The Schema headerType for message headers.
java.util.Collection<Message>	messages() Get the Collection of Messages for this Schema.
java.lang.String	packageName() The package name for the schema.
java.lang.String	semanticVersion() The semantic version number of the schema.
int	version() The version number of the schema.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

HEADER_TYPE_DEFAULT

public static final java.lang.String HEADER_TYPE_DEFAULT

See Also:

Constant Field Values

Constructor Detail

MessageSchema

public MessageSchema(org.w3c.dom.Node schemaNode,
                     java.util.Map<java.lang.String,Type> typeByNameMap,
                     java.util.Map<java.lang.Long,Message> messageByIdMap)

Method Detail

messageHeader

public CompositeType messageHeader()

The Schema headerType for message headers. This should be a CompositeType.

Returns:

the Schema headerType for message headers

packageName

public java.lang.String packageName()

The package name for the schema.

Returns:

he package name for the schema.

description

public java.lang.String description()

The description of the schema.

Returns:

the description of the schema.

id

public int id()

The id number of the schema.

Returns:

the id number of the schema.

version

public int version()

The version number of the schema.

Returns:

the version number of the schema.

semanticVersion

public java.lang.String semanticVersion()

The semantic version number of the schema. Typically use to reference a third party standard such as FIX.

Returns:

the semantic version number of the schema.

getMessage

public Message getMessage(long messageId)

Return a given Message object with the given messageId.

Parameters:

messageId - of the message to return.

Returns:

a given Message for the messageId.

messages

public java.util.Collection<Message> messages()

Get the Collection of Messages for this Schema.

Returns:

the Collection of Messages for this Schema.

byteOrder

public java.nio.ByteOrder byteOrder()

Return the byte order specified by the messageSchema

Returns:

ByteOrder of the message encoding.