uk.co.real_logic.sbe.xml

Class Message

java.lang.Object

uk.co.real_logic.sbe.xml.Message

public class Message
extends java.lang.Object

An SBE message containing a list of Field objects and SBE message attributes.

What is difference between Message and the Intermediate Representation (IR)?

• IR is intentionally platform, schema, and language independent.
• IR is abstract layout and encoding only.
• IR is a flat representation without cycles or hierarchy.
• Message is FIX/SBE XML Schema specific.

Constructor Summary

Constructors

Constructor and Description
Message(org.w3c.dom.Node messageNode, java.util.Map<java.lang.String,Type> typeByNameMap) Construct a new message from XML Schema.

Method Summary

Modifier and Type	Method and Description
int	blockLength() Return the encodedLength of the Message in bytes including any padding.
int	deprecated() Version in which message was deprecated.
java.lang.String	description() The description of the message (if set) or null
java.util.List<Field>	fields() Return the list of fields in the message
int	id() Return the template schemaId of the message
java.lang.String	name() Return the name of the message
java.lang.String	semanticType() The semanticType of the message (if set) or null
int	sinceVersion() The version since this was added to the template.

Methods inherited from class java.lang.Object

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

Constructor Detail

Message

public Message(org.w3c.dom.Node messageNode,
               java.util.Map<java.lang.String,Type> typeByNameMap)
        throws javax.xml.xpath.XPathExpressionException

Construct a new message from XML Schema.

Parameters:

messageNode - from the XML Schema Parsing

typeByNameMap - holding type information for message

Throws:

javax.xml.xpath.XPathExpressionException - on invalid XPath

Method Detail

id

public int id()

Return the template schemaId of the message

Returns:

schemaId of the message

name

public java.lang.String name()

Return the name of the message

Returns:

name of the message

description

public java.lang.String description()

The description of the message (if set) or null

Returns:

description set by the message or null

semanticType

public java.lang.String semanticType()

The semanticType of the message (if set) or null

Returns:

the semanticType of the message (if set) or null

sinceVersion

public int sinceVersion()

The version since this was added to the template.

Returns:

version since this was added to the template.

deprecated

public int deprecated()

Version in which message was deprecated. Only valid if greater than zero.

Returns:

version in which the message was deprecated.

fields

public java.util.List<Field> fields()

Return the list of fields in the message

Returns:

List of the Field objects in this Message

blockLength

public int blockLength()

Return the encodedLength of the Message in bytes including any padding.

Returns:

the encodedLength of the Message in bytes including any padding.