uk.co.real_logic.sbe.xml

Class CompositeType

java.lang.Object

uk.co.real_logic.sbe.xml.Type

uk.co.real_logic.sbe.xml.CompositeType

public class CompositeType
extends Type

SBE compositeType.

Field Summary

Fields inherited from class uk.co.real_logic.sbe.xml.Type

DEFAULT_PRESENCE

Constructor Summary

Constructors

Constructor and Description
CompositeType(Node node) Construct a new compositeType from XML Schema.

Method Summary

Modifier and Type	Method and Description
void	checkForValidOffsets(Node node) Check the composite for any specified offsets and validate they are correctly specified.
void	checkForWellFormedGroupSizeEncoding(Node node) Check the composite for being a well formed group size encoding.
void	checkForWellFormedMessageHeader(Node node) Check the composite for being a well formed message headerStructure encoding.
void	checkForWellFormedVariableLengthDataEncoding(Node node) Check the composite for being a well formed variable length data encoding.
EncodedDataType	getType(String name) Return the EncodedDataType within this composite with the given name
List<EncodedDataType>	getTypeList() Return list of the EncodedDataTypes that compose this composite
void	makeDataFieldCompositeType() Make this composite type, if it has a varData member, variable length by making the EncodedDataType with the name "varData" be variable length.
int	sinceVersion() Return the sinceVersion value of the CompositeType
int	size() The size (in octets) of the list of EncodedDataTypes

Methods inherited from class uk.co.real_logic.sbe.xml.Type

description, name, presence, semanticType

Methods inherited from class java.lang.Object

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

Constructor Detail

CompositeType

public CompositeType(Node node)
              throws XPathExpressionException

Construct a new compositeType from XML Schema.

Parameters:

node - from the XML Schema Parsing

Throws:

XPathExpressionException - if the XPath is invalid.

Method Detail

getType

public EncodedDataType getType(String name)

Return the EncodedDataType within this composite with the given name

Parameters:

name - of the EncodedDataType to return

Returns:

type requested

size

public int size()

The size (in octets) of the list of EncodedDataTypes

Specified by:

size in class Type

Returns:

size of the compositeType

sinceVersion

public int sinceVersion()

Return the sinceVersion value of the CompositeType

Returns:

the sinceVersion of the CompositeType

getTypeList

public List<EncodedDataType> getTypeList()

Return list of the EncodedDataTypes that compose this composite

Returns:

List that holds the types in this composite

makeDataFieldCompositeType

public void makeDataFieldCompositeType()

Make this composite type, if it has a varData member, variable length by making the EncodedDataType with the name "varData" be variable length.

checkForWellFormedGroupSizeEncoding

public void checkForWellFormedGroupSizeEncoding(Node node)

Check the composite for being a well formed group size encoding. This means that there are the fields "blockLength" and "numInGroup" present.

Parameters:

node - of the XML for this composite

checkForWellFormedVariableLengthDataEncoding

public void checkForWellFormedVariableLengthDataEncoding(Node node)

Check the composite for being a well formed variable length data encoding. This means that there are the fields "length" and "varData" present.

Parameters:

node - of the XML for this composite

checkForWellFormedMessageHeader

public void checkForWellFormedMessageHeader(Node node)

Check the composite for being a well formed message headerStructure encoding. This means that there are the fields "blockLength", "templateId" and "version" present.

Parameters:

node - of the XML for this composite

checkForValidOffsets

public void checkForValidOffsets(Node node)

Check the composite for any specified offsets and validate they are correctly specified.

Parameters:

node - of the XML for this composite