com.legstar.coxb
Interface ICobolElement

All Known Subinterfaces:

ICobolArrayBinaryBinding, ICobolArrayBinding, ICobolArrayComplexBinding, ICobolArrayDbcsBinding, ICobolArrayDoubleBinding, ICobolArrayFloatBinding, ICobolArrayNationalBinding, ICobolArrayNumericBinding, ICobolArrayOctetStreamBinding, ICobolArrayPackedDecimalBinding, ICobolArrayStringBinding, ICobolArrayZonedDecimalBinding, ICobolBinaryBinding, ICobolBinding, ICobolChoiceBinding, ICobolComplexBinding, ICobolDbcsBinding, ICobolDoubleBinding, ICobolFloatBinding, ICobolNationalBinding, ICobolNumericBinding, ICobolOctetStreamBinding, ICobolPackedDecimalBinding, ICobolStringBinding, ICobolZonedDecimalBinding

All Known Implementing Classes:

CArrayBinding, CArrayComplexBinding, CBinding, CChoiceBinding, CComplexBinding

public interface ICobolElement

This interface describes a cobol element. It is almost identical to the annotation interface com.legstar.binding.CobolElement but it is recommended not to use annotation interfaces as super interfaces.

Author:

Fady Moussallam

Method Summary

int	getByteLength()
String	getCobolName()
CobolType	getCobolType()
String	getDefaultValue()
String	getDependingOn()
int	getFractionDigits()
int	getLevelNumber()
String	getMarshalChoiceStrategyClassName()
int	getMaxOccurs()
int	getMinOccurs()
String	getPicture()
String	getRedefines()
int	getSrceLine()
int	getTotalDigits()
String	getUnmarshalChoiceStrategyClassName()
String	getUsage()
boolean	isCustomVariable()
boolean	isJustifiedRight()
boolean	isODOObject()
boolean	isRedefined()
boolean	isSigned()
boolean	isSignLeading()
boolean	isSignSeparate()
void	setByteLength(int byteLength)
void	setCobolName(String cobolName)
void	setCobolType(CobolType type)
void	setDefaultValue(String defaultValue)
void	setDependingOn(String dependingOn)
void	setFractionDigits(int fractionDigits)
void	setIsCustomVariable(boolean isCustomVariable)
void	setIsJustifiedRight(boolean isJustifiedRight)
void	setIsODOObject(boolean isODOObject)
void	setIsRedefined(boolean isRedefined)
void	setIsSigned(boolean isSigned)
void	setIsSignLeading(boolean isSignLeading)
void	setIsSignSeparate(boolean isSignSeparate)
void	setLevelNumber(int levelNumber)
void	setMarshalChoiceStrategyClassName(String marshalChoiceStrategyClassName)
void	setMaxOccurs(int maxOccurs)
void	setMinOccurs(int minOccurs)
void	setPicture(String picture)
void	setRedefines(String redefines)
void	setSrceLine(int srceLine)
void	setTotalDigits(int totalDigits)
void	setUnmarshalChoiceStrategyClassName(String unmarshalChoiceStrategyClassName)
void	setUsage(String usage)

Method Detail

getCobolName

String getCobolName()

Returns:

Cobol element name.

setCobolName

void setCobolName(String cobolName)

Parameters:

cobolName - the Cobol element name to set

getCobolType

CobolType getCobolType()

Returns:

Cobol element type.

setCobolType

void setCobolType(CobolType type)

Parameters:

type - the Cobol element type to set

getByteLength

int getByteLength()

Returns:

Cobol element length in bytes.

setByteLength

void setByteLength(int byteLength)

Parameters:

byteLength - the Cobol element length in bytes to set

isJustifiedRight

boolean isJustifiedRight()

Returns:

String justification.

setIsJustifiedRight

void setIsJustifiedRight(boolean isJustifiedRight)

Parameters:

isJustifiedRight - true if String is right justified

getTotalDigits

int getTotalDigits()

Returns:

Numerics total number of digits (including fractional).

setTotalDigits

void setTotalDigits(int totalDigits)

Parameters:

totalDigits - the total number of digits to set

getFractionDigits

int getFractionDigits()

Returns:

Numerics fractional number of digits.

setFractionDigits

void setFractionDigits(int fractionDigits)

Parameters:

fractionDigits - the fractional number of digits to set

isSigned

boolean isSigned()

Returns:

Numerics signed or unsigned.

setIsSigned

void setIsSigned(boolean isSigned)

Parameters:

isSigned - true if signed

isSignLeading

boolean isSignLeading()

Returns:

Numerics sign in leading byte or trailing byte.

setIsSignLeading

void setIsSignLeading(boolean isSignLeading)

Parameters:

isSignLeading - true if sign in leading byte

isSignSeparate

boolean isSignSeparate()

Returns:

Numerics sign occupies a separate byte.

setIsSignSeparate

void setIsSignSeparate(boolean isSignSeparate)

Parameters:

isSignSeparate - true if sign occupies a separate byte

getMinOccurs

int getMinOccurs()

Returns:

Arrays minimum number of occurences.

setMinOccurs

void setMinOccurs(int minOccurs)

Parameters:

minOccurs - the minimum number of occurences to set

getMaxOccurs

int getMaxOccurs()

Returns:

Arrays maximum number of occurences.

setMaxOccurs

void setMaxOccurs(int maxOccurs)

Parameters:

maxOccurs - the maximum number of occurences to set

getDependingOn

String getDependingOn()

Returns:

Cobol element giving array actual size.

setDependingOn

void setDependingOn(String dependingOn)

Parameters:

dependingOn - the Cobol element giving array actual size to set

isODOObject

boolean isODOObject()

Returns:

Determines the size of a variable size array.

setIsODOObject

void setIsODOObject(boolean isODOObject)

Parameters:

isODOObject - true if array is variable size

getRedefines

String getRedefines()

Returns:

Cobol element share the same memory location as object.

setRedefines

void setRedefines(String redefines)

Parameters:

redefines - Cobol element sharing same memory location to set

isRedefined

boolean isRedefined()

Returns:

Element is redefined by at least one other element.

setIsRedefined

void setIsRedefined(boolean isRedefined)

Parameters:

isRedefined - true if redefined by at least one other element

isCustomVariable

boolean isCustomVariable()

Returns:

True if this element is used in custom code.

setIsCustomVariable

void setIsCustomVariable(boolean isCustomVariable)

Parameters:

isCustomVariable - true if element is used in custom code

getUnmarshalChoiceStrategyClassName

String getUnmarshalChoiceStrategyClassName()

Returns:

Name of class providing logic to help with alternative selection (Host to Java).

setUnmarshalChoiceStrategyClassName

void setUnmarshalChoiceStrategyClassName(String unmarshalChoiceStrategyClassName)

Parameters:

unmarshalChoiceStrategyClassName - the the name of a class providing additional logic to select an alternative within a choice element at unmarshaling (Host to Java) time.

getMarshalChoiceStrategyClassName

String getMarshalChoiceStrategyClassName()

Returns:

Name of class providing logic to help with alternative selection (Java to Host).

setMarshalChoiceStrategyClassName

void setMarshalChoiceStrategyClassName(String marshalChoiceStrategyClassName)

Parameters:

marshalChoiceStrategyClassName - the name of a class providing additional logic to select an alternative within a choice element at marshaling (Java to Host) time.

getLevelNumber

int getLevelNumber()

Returns:

Level in the hierarchy this element was parsed from.

setLevelNumber

void setLevelNumber(int levelNumber)

Parameters:

levelNumber - the Level in the hierarchy to set

getPicture

String getPicture()

Returns:

Cobol picture clause.

setPicture

void setPicture(String picture)

Parameters:

picture - the Cobol picture clause to set

getUsage

String getUsage()

Returns:

Cobol usage.

setUsage

void setUsage(String usage)

Parameters:

usage - the Cobol usage to set

getDefaultValue

String getDefaultValue()

Returns:

Cobol default value.

setDefaultValue

void setDefaultValue(String defaultValue)

Parameters:

defaultValue - the Cobol default value to set

getSrceLine

int getSrceLine()

Returns:

Line number in the original source file this element was parsed from.

setSrceLine

void setSrceLine(int srceLine)

Parameters:

srceLine - the Line number in the original source file to set