com.legstar.coxb
Interface ICobolArrayBinding

All Superinterfaces:

ICobolBinding, ICobolElement

All Known Subinterfaces:

ICobolArrayBinaryBinding, ICobolArrayComplexBinding, ICobolArrayDbcsBinding, ICobolArrayDoubleBinding, ICobolArrayFloatBinding, ICobolArrayNationalBinding, ICobolArrayNumericBinding, ICobolArrayOctetStreamBinding, ICobolArrayPackedDecimalBinding, ICobolArrayStringBinding, ICobolArrayZonedDecimalBinding

All Known Implementing Classes:

CArrayBinding, CArrayComplexBinding

public interface ICobolArrayBinding
extends ICobolBinding

This interface groups methods that are common to all arrays.

Author:

Fady Moussallam

Method Summary

int	calcItemByteLength() The method calculates the exact host byte length for one individual item of this Cobol binding.
int	getCurrentOccurs() Fixed size arrays return the maximum number of occurrences while variable size arrays dynamically compute their dimension.
int	getItemByteLength() In COBOL, arrays are collections of items with a fixed size.
void	setItemByteLength(int itemByteLength) Set the individual item host byte size.

Methods inherited from interface com.legstar.coxb.ICobolBinding

accept, calcByteLength, getBindingName, getJaxbName, getJaxbType, getObjectValue, getParentBinding, isBound, isSet, setObjectValue

Methods inherited from interface com.legstar.coxb.ICobolElement

getByteLength, getCobolName, getCobolType, getDefaultValue, getDependingOn, getFractionDigits, getLevelNumber, getMarshalChoiceStrategyClassName, getMaxOccurs, getMinOccurs, getPicture, getRedefines, getSrceLine, getTotalDigits, getUnmarshalChoiceStrategyClassName, getUsage, isCustomVariable, isJustifiedRight, isODOObject, isRedefined, isSigned, isSignLeading, isSignSeparate, setByteLength, setCobolName, setCobolType, setDefaultValue, setDependingOn, setFractionDigits, setIsCustomVariable, setIsJustifiedRight, setIsODOObject, setIsRedefined, setIsSigned, setIsSignLeading, setIsSignSeparate, setLevelNumber, setMarshalChoiceStrategyClassName, setMaxOccurs, setMinOccurs, setPicture, setRedefines, setSrceLine, setTotalDigits, setUnmarshalChoiceStrategyClassName, setUsage

Method Detail

getCurrentOccurs

int getCurrentOccurs()
                     throws HostException

Fixed size arrays return the maximum number of occurrences while variable size arrays dynamically compute their dimension.

Returns:

the current number of items

Throws:

HostException - if count cannot be computed

getItemByteLength

int getItemByteLength()

In COBOL, arrays are collections of items with a fixed size. This method returns an individual item host byte size.

Returns:

Cobol array individual item length in bytes.

setItemByteLength

void setItemByteLength(int itemByteLength)

Set the individual item host byte size.

Parameters:

itemByteLength - Cobol array individual item length in bytes.

calcItemByteLength

int calcItemByteLength()

The method calculates the exact host byte length for one individual item of this Cobol binding.

Returns:

the host byte length of an individual item of this binding