biz.onixs.fix.dictionary

Class Dictionary

java.lang.Object

biz.onixs.fix.dictionary.Dictionary

public class Dictionary
extends Object

Contains information about FIX message structure and field details.

Method Summary

Modifier and Type	Method and Description
Dictionary	add(Integer tag, FieldDetails fieldDetails) Adds field details.
Dictionary	add(ValuePtr msgType, MessageDefinition msgDef) Adds FIX message low-level definition.
boolean	contains(int tag) Returns whether corresponding field details contains.
boolean	contains(ValuePtr msgType) Returns whether corresponding message definition contains.
MessageDefinition	get(ValuePtr msgType) Returns message definition corresponding to message type.
static int	getDataTagByLengthTag(int lengthTag) Returns data field tag by data length field tag.
FieldDetails	getFieldDetails(int tag) Returns field details (type and valid values) corresponding to specified tag.
Map<ValuePtr,MessageDefinition>	getMessageDefinitions() Returns message type to message definition map.
ContainerDefinition	getSkeleton() Returns skeleton(basic) message definition.
Version	getVersion() Returns FIX version.
Dictionary	init() Initializes internal state of the all containing message definition objects.
static boolean	isSessionLevel(ValuePtr msgType) Returns whether specified message type is Session level.
Dictionary	leaveOnlySessionLevelMessages() Removes all message definitions but session levels.

Methods inherited from class java.lang.Object

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

Method Detail

getMessageDefinitions

public Map<ValuePtr,MessageDefinition> getMessageDefinitions()

Returns message type to message definition map.

Returns:

message type to message definition map

getVersion

public Version getVersion()

Returns FIX version.

Returns:

FIX version

add

public Dictionary add(ValuePtr msgType,
                      MessageDefinition msgDef)

Adds FIX message low-level definition.

Parameters:

msgType - message type

msgDef - message definition

Returns:

reference to this object.

add

public Dictionary add(Integer tag,
                      FieldDetails fieldDetails)

Adds field details.

Parameters:

tag - field's tag number

fieldDetails - field details

Returns:

reference to this object.

contains

public boolean contains(ValuePtr msgType)

Returns whether corresponding message definition contains.

Parameters:

msgType - message type

Returns:

whether corresponding message definition contains

get

public MessageDefinition get(ValuePtr msgType)

Returns message definition corresponding to message type.

Parameters:

msgType - message type

Returns:

message definition

Throws:

RuntimeException - if corresponding message definition does not exists

getSkeleton

public ContainerDefinition getSkeleton()

Returns skeleton(basic) message definition.

Returns:

skeleton(basic) message definition

contains

public boolean contains(int tag)

Returns whether corresponding field details contains.

Parameters:

tag - field tag

Returns:

whether corresponding field details contains

getFieldDetails

public FieldDetails getFieldDetails(int tag)

Returns field details (type and valid values) corresponding to specified tag.

Parameters:

tag - field tag

Returns:

type and valid values of the field

Throws:

RuntimeException - if corresponding field details does not exists

leaveOnlySessionLevelMessages

public Dictionary leaveOnlySessionLevelMessages()

Removes all message definitions but session levels.

Returns:

reference to this object.

isSessionLevel

public static boolean isSessionLevel(ValuePtr msgType)

Returns whether specified message type is Session level.

Parameters:

msgType - message type

Returns:

whether specified message type is Session level

getDataTagByLengthTag

public static int getDataTagByLengthTag(int lengthTag)

Returns data field tag by data length field tag.

Parameters:

lengthTag - data length field tag

Returns:

data field tag or -1 if the length tag is not defined

init

public Dictionary init()

Initializes internal state of the all containing message definition objects.

Returns:

reference to this object.