biz.onixs.sbe

Class Group

java.lang.Object

biz.onixs.sbe.Group

All Implemented Interfaces:

IFieldSet, IGroup, Cloneable

public abstract class Group
extends Object
implements IGroup

Base class for repeating groups.

Field Summary

Fields inherited from interface biz.onixs.sbe.IFieldSet

DefaultSeparator

Constructor Summary

Constructors

Constructor and Description
Group(IFieldSet parent, int numInGroupTag) Constructor.

Method Summary

Modifier and Type	Method and Description
IGroup	clone() Creates a copy of the repeating group instance, including part of underlying byte array with group data.
ScaledDecimal	createNullDecimal(int tag, ScaledDecimal ref) Create null value for the given field.
MonthYear	createNullMonthYear(int tag, MonthYear ref) Creates null MonthYear object.
SbeTimestamp	createNullTimestamp(int tag, SbeTimestamp ref) Creates null MonthYear object.
boolean	getBoolean(int tag) Gets field value by tag.
char	getChar(int tag) Gets field value by tag.
<T> T	getCustomComposite(int tag, T ref) Gets custom composite field value by tag.
ScaledDecimal	getDecimal(int tag) Gets field value by tag.
int	getEndOfGroupOffset() Returns offset of the last byte of the repeating group data in underlying data array.
int	getLength() Gets number of entries in the repeating group.
MonthYear	getMonthYear(int tag) Gets date field value by tag.
int	getOffset() Returns offset of the first byte of the repeating group data in underlying data array.
IFieldSet	getParent() Returns field set parent.
int	getPos() Gets current entry index.
int	getSize() IFieldSet implementation: will be implemented by ClassGen
int	getSizeFromOffset(byte[] data, int beginHeaderOffset) Returns size of entire group in a case the group contains nested var-legth data.
short	getUnsignedByte(int tag) Gets field value by tag.
long	getUnsignedInt(int tag) Gets field value by tag.
BigInteger	getUnsignedLong(int tag) Gets field value by tag.
int	getUnsignedShort(int tag) Gets field value by tag.
int	getVersion()
boolean	hasNext() IGroup implementation
boolean	isNullDecimal(int tag, ScaledDecimal value) Checks if the value represents null for the field with the given tag.
boolean	isNullMonthYear(int tag, MonthYear value) Checks if the value represents null for the field with the given tag.
boolean	isNullTimestamp(int tag, SbeTimestamp value) Checks if the value represents null for the field with the given tag.
boolean	next() Moves repeating group to the next entry if it is possible.
void	notifyBufferUpdate(byte[] data, int pointOfModify, int sizeDelta)
abstract void	notifyFieldSetBufferUpdate(byte[] data, int pointOfModify, int sizeDelta)
void	rewind() Resets repeating group to the initial state, when item position is before the first element (pos value = -1).
void	setBoolean(int tag, boolean value) Sets field value by tag.
void	setByte(int tag, int value) Sets field value by tag.
void	setChar(int tag, char value) Sets field value by tag.
<T> void	setCustomComposite(int tag, T value) Sets field value by tag.
void	setLength(int newLength) Sets new number of entries in the repeating group.
boolean	setPos(int pos) Sets current entry index.
void	setShort(int tag, int value) Sets field value by tag.
void	setUnsignedByte(int tag, int value) Sets field value by tag.
void	setUnsignedByte(int tag, short value) Sets field value by tag.
void	setUnsignedInt(int tag, long value) Sets field value by tag.
void	setUnsignedLong(int tag, BigInteger value) Sets field value by tag.
void	setUnsignedShort(int tag, int value) Sets field value by tag.
String	toFixString(char separator) Returns FIX string representation of the field set.
String	toString()
<T> boolean	tryGetCustomComposite(int tag, T ref) Tries to get composite field value by tag.
boolean	tryGetUnsignedByte(int tag, AtomicInteger ref) Gets field value by tag.
boolean	tryGetUnsignedInt(int tag, AtomicLong ref) Gets field value by tag.
BigInteger	tryGetUnsignedLong(int tag) Gets field value by tag.
boolean	tryGetUnsignedShort(int tag, AtomicInteger ref) Gets field value by tag.

Methods inherited from class java.lang.Object

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

Methods inherited from interface biz.onixs.sbe.IGroup

getFixedBlockLength

Methods inherited from interface biz.onixs.sbe.IFieldSet

contains, createEmptyStandardComposite, createNullDecimal, createNullMonthYear, createNullTimestamp, dataTags, fieldTags, getBoolean, getBuffer, getByte, getBytes, getChar, getCustomComposite, getDecimal, getDecimal, getGroup, getInt, getLong, getMonthYear, getMonthYear, getParent, getShort, getString, getTimestamp, getUnsignedByte, getUnsignedInt, getUnsignedLong, getUnsignedShort, getValuePtr, getVarData, groupTags, hasFieldTag, hasGroupTag, hasTag, hasVarDataTag, init, isNullDecimal, isNullMonthYear, isNullStandardComposite, isNullTimestamp, load, reset, setBoolean, setByte, setByte, setBytes, setChar, setCustomComposite, setDecimal, setInt, setLong, setMonthYear, setShort, setShort, setString, setTimestamp, setUnsignedByte, setUnsignedByte, setUnsignedInt, setUnsignedLong, setUnsignedShort, setVarData, tryGetBoolean, tryGetByte, tryGetBytes, tryGetChar, tryGetCustomComposite, tryGetDecimal, tryGetGroup, tryGetInt, tryGetLong, tryGetMonthYear, tryGetShort, tryGetString, tryGetTimestamp, tryGetUnsignedByte, tryGetUnsignedInt, tryGetUnsignedLong, tryGetUnsignedShort, tryGetValuePtr, tryGetVarData

Constructor Detail

Group

public Group(IFieldSet parent,
             int numInGroupTag)

Constructor.

Parameters:

parent - parent field set

numInGroupTag - group number of instances tag

Method Detail

getOffset

public int getOffset()

Description copied from interface: IGroup

Returns offset of the first byte of the repeating group data in underlying data array.

Specified by:

getOffset in interface IFieldSet

Specified by:

getOffset in interface IGroup

Returns:

offset of the first byte of the repeating group data in underlying data array

getSize

public int getSize()

IFieldSet implementation: will be implemented by ClassGen

Specified by:

getSize in interface IFieldSet

Returns:

size of the buffer, available for field set

hasNext

public boolean hasNext()

IGroup implementation

Specified by:

hasNext in interface IGroup

Returns:

true if repeating group can be moved to the next entry.

next

public boolean next()

Description copied from interface: IGroup

Moves repeating group to the next entry if it is possible.

Specified by:

next in interface IGroup

Returns:

true if move to the next position is successful. False if there is no more elements.

rewind

public void rewind()

Description copied from interface: IGroup

Resets repeating group to the initial state, when item position is before the first element (pos value = -1).

Specified by:

rewind in interface IGroup

getPos

public int getPos()

Description copied from interface: IGroup

Gets current entry index.

Specified by:

getPos in interface IGroup

Returns:

current entry index

setPos

public boolean setPos(int pos)

Description copied from interface: IGroup

Sets current entry index. Ignores incorrect values. Correct value must belong to the range [0…getLength()-1];

Specified by:

setPos in interface IGroup

Parameters:

pos - - a new entry index.

Returns:

true if entry index has been changed, false otherwise.

getLength

public int getLength()

Description copied from interface: IGroup

Gets number of entries in the repeating group.

Specified by:

getLength in interface IGroup

Returns:

number of entries in the repeating group

getEndOfGroupOffset

public int getEndOfGroupOffset()

Description copied from interface: IGroup

Returns offset of the last byte of the repeating group data in underlying data array.

Specified by:

getEndOfGroupOffset in interface IGroup

Returns:

offset of the last byte of the repeating group data in underlying data array.

getSizeFromOffset

public int getSizeFromOffset(byte[] data,
                             int beginHeaderOffset)

Returns size of entire group in a case the group contains nested var-legth data.

Parameters:

data - The data to use for the counting.

beginHeaderOffset - Offset of the group header in the data provided.

Returns:

Calculated size of the group.

toFixString

public String toFixString(char separator)

Returns FIX string representation of the field set. Note: by default toString() is equal to call toFixString(DefaultSeparator)

Specified by:

toFixString in interface IFieldSet

Parameters:

separator - for fields

Returns:

FIX string representation of the field set

clone

public IGroup clone()

Creates a copy of the repeating group instance, including part of underlying byte array with group data. Because this is copy, it will be "detached" from the original message.

Specified by:

clone in interface IGroup

Overrides:

clone in class Object

Returns:

a copy of the repeating group.

setLength

public void setLength(int newLength)

Description copied from interface: IGroup

Sets new number of entries in the repeating group. If new length is less than current length, group will be truncated. If new length is greater than current length, group will be extended.

Specified by:

setLength in interface IGroup

Parameters:

newLength - new number of entries in the repeating group

notifyBufferUpdate

public void notifyBufferUpdate(byte[] data,
                               int pointOfModify,
                               int sizeDelta)

getParent

public IFieldSet getParent()

Description copied from interface: IFieldSet

Returns field set parent. For Message always returns null; For message's groups returns Message instance For sub-groups returns their owner.

Specified by:

getParent in interface IFieldSet

Returns:

parent of the field set

setBoolean

public void setBoolean(int tag,
                       boolean value)

Description copied from interface: IFieldSet

Sets field value by tag. Executes only for fields, which are able to contain boolean type (up to 1 byte).

Specified by:

setBoolean in interface IFieldSet

Parameters:

tag - - integer tag id of the field.

value - - value of the field.

getBoolean

public boolean getBoolean(int tag)

Description copied from interface: IFieldSet

Gets field value by tag. Returns only fields, which are able to fit into boolean type (up to 1 byte).

Specified by:

getBoolean in interface IFieldSet

Parameters:

tag - - integer tag id of the field.

Returns:

boolean value of the field

setChar

public void setChar(int tag,
                    char value)

Description copied from interface: IFieldSet

Sets field value by tag. Executes only for fields, which are able to contain char type (up to 1 byte).

Specified by:

setChar in interface IFieldSet

Parameters:

tag - - integer tag id of the field.

value - - value of the field.

getChar

public char getChar(int tag)

Description copied from interface: IFieldSet

Gets field value by tag. Returns only fields, which are able to fit into char type (up to 1 byte).

Specified by:

getChar in interface IFieldSet

Parameters:

tag - - integer tag id of the field.

Returns:

char value of the field

setByte

public void setByte(int tag,
                    int value)

Description copied from interface: IFieldSet

Sets field value by tag. Executes only for fields, which are able to contain byte type (up to 1 byte).

Specified by:

setByte in interface IFieldSet

Parameters:

tag - - integer tag id of the field.

value - - value of the field.

setShort

public void setShort(int tag,
                     int value)

Description copied from interface: IFieldSet

Sets field value by tag. Executes only for fields, which are able to contain short type (up to 2 bytes).

Specified by:

setShort in interface IFieldSet

Parameters:

tag - - integer tag id of the field.

value - - value of the field.

getUnsignedByte

public short getUnsignedByte(int tag)

Description copied from interface: IFieldSet

Gets field value by tag. Returns only fields, which are able to fit into byte type (up to 1 bytes).

Specified by:

getUnsignedByte in interface IFieldSet

Parameters:

tag - - integer tag id of the field.

Returns:

byte value of the field

tryGetUnsignedByte

public boolean tryGetUnsignedByte(int tag,
                                  AtomicInteger ref)

Description copied from interface: IFieldSet

Gets field value by tag. Returns only fields, which are able to fit into unsigned byte type (up to 1 byte). Fills passed AtomicInteger object.

Specified by:

tryGetUnsignedByte in interface IFieldSet

Parameters:

tag - - integer tag id of the field

ref - - reference type variable to store return value of the field

Returns:

false if tag is absent, or is optional and has NULL value, or cannot be casted to unsigned byte type

setUnsignedByte

public void setUnsignedByte(int tag,
                            short value)

Description copied from interface: IFieldSet

Sets field value by tag. Executes only for fields, which are able to contain unsigned byte type (up to 1 byte).

Specified by:

setUnsignedByte in interface IFieldSet

Parameters:

tag - - integer tag id of the field.

value - - value of the field.

setUnsignedByte

public void setUnsignedByte(int tag,
                            int value)

Description copied from interface: IFieldSet

Sets field value by tag. Executes only for fields, which are able to contain unsigned byte type (up to 1 byte).

Specified by:

setUnsignedByte in interface IFieldSet

Parameters:

tag - - integer tag id of the field.

value - - value of the field.

getUnsignedShort

public int getUnsignedShort(int tag)

Description copied from interface: IFieldSet

Gets field value by tag. Returns only fields, which are able to fit into short type (up to 2 bytes).

Specified by:

getUnsignedShort in interface IFieldSet

Parameters:

tag - - integer tag id of the field.

Returns:

short value of the field

tryGetUnsignedShort

public boolean tryGetUnsignedShort(int tag,
                                   AtomicInteger ref)

Description copied from interface: IFieldSet

Gets field value by tag. Returns only fields, which are able to fit into unsigned short type (up to 2 bytes). Fills passed AtomicInteger object.

Specified by:

tryGetUnsignedShort in interface IFieldSet

Parameters:

tag - - integer tag id of the field

ref - - reference type variable to store return value of the field

Returns:

false if tag is absent, or is optional and has NULL value, or cannot be casted to unsigned short type

setUnsignedShort

public void setUnsignedShort(int tag,
                             int value)

Description copied from interface: IFieldSet

Sets field value by tag. Executes only for fields, which are able to contain unsigned short type (up to 2 bytes).

Specified by:

setUnsignedShort in interface IFieldSet

Parameters:

tag - - integer tag id of the field.

value - - value of the field.

getUnsignedInt

public long getUnsignedInt(int tag)

Description copied from interface: IFieldSet

Gets field value by tag. Returns only fields, which are able to fit into integer type (up to 4 bytes).

Specified by:

getUnsignedInt in interface IFieldSet

Parameters:

tag - - integer tag id of the field.

Returns:

integer value of the field

tryGetUnsignedInt

public boolean tryGetUnsignedInt(int tag,
                                 AtomicLong ref)

Description copied from interface: IFieldSet

Gets field value by tag. Returns only fields, which are able to fit into unsigned int type (up to 4 bytes). Fills passed AtomicLong object.

Specified by:

tryGetUnsignedInt in interface IFieldSet

Parameters:

tag - - integer tag id of the field

ref - - reference type variable to store return value of the field

Returns:

false if tag is absent, or is optional and has NULL value, or cannot be casted to unsigned int type

setUnsignedInt

public void setUnsignedInt(int tag,
                           long value)

Description copied from interface: IFieldSet

Sets field value by tag. Executes only for fields, which are able to contain unsigned int type (up to 4 bytes).

Specified by:

setUnsignedInt in interface IFieldSet

Parameters:

tag - - integer tag id of the field.

value - - value of the field.

getUnsignedLong

public BigInteger getUnsignedLong(int tag)

Description copied from interface: IFieldSet

Gets field value by tag. Returns only fields, which are able to fit into long type (up to 8 bytes). Creates new BigInteger object.

Specified by:

getUnsignedLong in interface IFieldSet

Parameters:

tag - - integer tag id of the field.

Returns:

long value of the field

tryGetUnsignedLong

public BigInteger tryGetUnsignedLong(int tag)

Description copied from interface: IFieldSet

Gets field value by tag. Returns only fields, which are able to fit into unsigned long type (up to 8 bytes). Creates new BigInteger object.

Specified by:

tryGetUnsignedLong in interface IFieldSet

Parameters:

tag - - integer tag id of the field

Returns:

null if tag is absent, or is optional and has NULL value, or cannot be casted to unsigned long type. Otherwise, returns unsigned long representation of the field

setUnsignedLong

public void setUnsignedLong(int tag,
                            BigInteger value)

Description copied from interface: IFieldSet

Sets field value by tag. Executes only for fields, which are able to contain unsigned long type (up to 8 bytes).

Specified by:

setUnsignedLong in interface IFieldSet

Parameters:

tag - - integer tag id of the field.

value - - value of the field.

getDecimal

public ScaledDecimal getDecimal(int tag)

Description copied from interface: IFieldSet

Gets field value by tag. Returns only fields, which are able to fit into ScaledDecimal. Creates new ScaledDecimal object.

Specified by:

getDecimal in interface IFieldSet

Parameters:

tag - - integer tag id of the field.

Returns:

ScaledDecimal representation of the field

getMonthYear

public MonthYear getMonthYear(int tag)

Description copied from interface: IFieldSet

Gets date field value by tag. Creates new MonthYear object.

Specified by:

getMonthYear in interface IFieldSet

Parameters:

tag - - integer tag id of the field.

Returns:

MonthYear representation of the field.

getVersion

public int getVersion()

toString

public String toString()

Overrides:

toString in class Object

createNullDecimal

public ScaledDecimal createNullDecimal(int tag,
                                       ScaledDecimal ref)

Description copied from interface: IFieldSet

Create null value for the given field.

Specified by:

createNullDecimal in interface IFieldSet

Parameters:

tag - Tag of the field which null value is requested.

ref - Object to fill (optional)

Returns:

Input object

isNullDecimal

public boolean isNullDecimal(int tag,
                             ScaledDecimal value)

Description copied from interface: IFieldSet

Checks if the value represents null for the field with the given tag.

Specified by:

isNullDecimal in interface IFieldSet

Parameters:

tag - Tag of the field.

value - Value to check.

Returns:

true if the value means null for the given field.

createNullMonthYear

public MonthYear createNullMonthYear(int tag,
                                     MonthYear ref)

Description copied from interface: IFieldSet

Creates null MonthYear object.

Specified by:

createNullMonthYear in interface IFieldSet

Parameters:

tag - field of the MonthYear type.

ref - object to fill with null data.

Returns:

input object filled by null data.

isNullMonthYear

public boolean isNullMonthYear(int tag,
                               MonthYear value)

Description copied from interface: IFieldSet

Checks if the value represents null for the field with the given tag.

Specified by:

isNullMonthYear in interface IFieldSet

Parameters:

tag - Tag of the field.

value - Value to check.

Returns:

true if the value means null for the given field.

createNullTimestamp

public SbeTimestamp createNullTimestamp(int tag,
                                        SbeTimestamp ref)

Description copied from interface: IFieldSet

Creates null MonthYear object.

Specified by:

createNullTimestamp in interface IFieldSet

Parameters:

tag - field of the MonthYear type.

ref - object to fill with null data.

Returns:

input object filled by null data.

isNullTimestamp

public boolean isNullTimestamp(int tag,
                               SbeTimestamp value)

Description copied from interface: IFieldSet

Checks if the value represents null for the field with the given tag.

Specified by:

isNullTimestamp in interface IFieldSet

Parameters:

tag - Tag of the field.

value - Value to check.

Returns:

true if the value means null for the given field.

getCustomComposite

public <T> T getCustomComposite(int tag,
                                T ref)

Description copied from interface: IFieldSet

Gets custom composite field value by tag. Fills object passed via ref argument.

Specified by:

getCustomComposite in interface IFieldSet

Type Parameters:

T - Type of the custom composite.

Parameters:

tag - Tag of teh field

ref - Custom composite object to fill.

Returns:

The ref value.

tryGetCustomComposite

public <T> boolean tryGetCustomComposite(int tag,
                                         T ref)

Description copied from interface: IFieldSet

Tries to get composite field value by tag. Fills passed object.

Specified by:

tryGetCustomComposite in interface IFieldSet

Parameters:

tag - - integer tag id of the field.

ref - - variable to store the field value. ref cannot be null. Value of ref will be rewritten.

Returns:

false if tag is absent, or is optional and has NULL value or cannot be cast to ScaledDecimal type.

setCustomComposite

public <T> void setCustomComposite(int tag,
                                   T value)

Description copied from interface: IFieldSet

Sets field value by tag. Executes only for fields, which are able to contain the custom composite type.

Specified by:

setCustomComposite in interface IFieldSet

Parameters:

tag - - integer tag id of the field.

value - - value of the field.

notifyFieldSetBufferUpdate

public abstract void notifyFieldSetBufferUpdate(byte[] data,
                                                int pointOfModify,
                                                int sizeDelta)