biz.onixs.sbe

Interface IGroup

All Superinterfaces:

Cloneable, IFieldSet

All Known Implementing Classes:

Group

public interface IGroup
extends IFieldSet, Cloneable

FIX repeating group. It is an iterator over group entries with fields access to the current group entry.

Field Summary

Fields inherited from interface biz.onixs.sbe.IFieldSet

DefaultSeparator

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.
int	getEndOfGroupOffset() Returns offset of the last byte of the repeating group data in underlying data array.
int	getFixedBlockLength() Returns length of the fixed-size fields block appeared before first repeating group.
int	getHeaderOffset() Returns offset of the first byte of the repeating group data in underlying data array.
int	getLength() Gets number of entries in the repeating group.
int	getPos() Gets current entry index.
boolean	hasNext() Returns if repeating group can be moved to the next entry.
boolean	next() Moves repeating group to the next entry if it is possible.
void	rewind() Resets repeating group to the initial state, when item position is before the first element (pos value = -1).
void	setLength(int newLength) Sets new number of entries in the repeating group.
boolean	setPos(int pos) Sets current entry index.

Methods inherited from interface biz.onixs.sbe.IFieldSet

contains, createEmptyStandardComposite, createNullDecimal, createNullMonthYear, createNullTimestamp, dataTags, fieldTags, getBoolean, getByte, getBytes, getChar, getCustomComposite, getDecimal, getDecimal, getGroup, getInt, getLong, getMonthYear, getMonthYear, getParent, getShort, getStatelessComposite, getString, getTimestamp, 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, tagName, toFixString, toString, tryGetBoolean, tryGetByte, tryGetBytes, tryGetChar, tryGetCustomComposite, tryGetDecimal, tryGetGroup, tryGetInt, tryGetLong, tryGetMonthYear, tryGetShort, tryGetString, tryGetTimestamp, tryGetUnsignedByte, tryGetUnsignedInt, tryGetUnsignedLong, tryGetUnsignedShort, tryGetValuePtr, tryGetVarData

Method Detail

hasNext

boolean hasNext()

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

Returns:

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

next

boolean next()

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

Returns:

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

rewind

void rewind()

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

getPos

int getPos()

Gets current entry index.

Returns:

current entry index

setPos

boolean setPos(int pos)

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

Parameters:

pos - - a new entry index.

Returns:

true if entry index has been changed, false otherwise.

getLength

int getLength()

Gets number of entries in the repeating group.

Returns:

number of entries in the repeating group

setLength

void setLength(int newLength)

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.

Parameters:

newLength - new number of entries in the repeating group

getHeaderOffset

int getHeaderOffset()

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

Returns:

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

getEndOfGroupOffset

int getEndOfGroupOffset()

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

Returns:

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

getFixedBlockLength

int getFixedBlockLength()

Returns length of the fixed-size fields block appeared before first repeating group.

Returns:

length of fixed-size block.

clone

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.

Returns:

a copy of the repeating group.