CobolVarHelper (Veryant isCOBOL Java Documentation)

java.lang.Object
- com.iscobol.java.CobolVarHelper

All Implemented Interfaces:

CobolVarHelperConst

Direct Known Subclasses:

CobolVarExternalHelper
```
public class CobolVarHelper
extends Object
implements CobolVarHelperConst
```
The aim of this class is to ease the creation of COBOL variables, both structured and elementary. The declaration consists in a sequence of method invocations, each declaring a COBOL variable or giving some attributes to the last declared variable. For example the COBOL declaration
```
      01 VAR-1.
         03 VAR-2 PIC X(30) JUSTIFIED RIGHT.
         03 VAR-3.
            05 VAR-4 PIC S9(5)V9(2) LEADING SEPARATE.
         03 VAR-5 PIC 9(5)V9(2) COMP-3 OCCURS 3.
```
can be expressed in Java the following way:
```
    CobolVarHelper myVar = new CobolVarHelper ("VAR-1", CobolVarHelper._DCA)
      .picX ("VAR-2", 30).justRight(true)
      .group ("VAR-3")
         .picS9 ("VAR-4", 5, 2).signSeparate(true).signLeading(true)
      .endGroup ()
      .pic9Comp3 ("VAR-5", 5, 2).occurs (3)
      ;
```
The created object it is not the COBOL variable to use in the call to a COBOL subroutine; those variables are created automatically inside the object and they can be extracted using the get methods. For example:
```
    ICobolVar var2 = myVar.get ("VAR-2");
    ICobolVar var4 = myVar.get ("VAR-4");
    ICobolVar var5 = myVar.get ("VAR-5");
 
```
ICobolVar is an interface that allows setting/getting values to/from the variables, for example
```
    var2.set ("set in java");
    var4.set (12345.67);
    var5.intIAt(2).set (23456.78);
    System.out.println (var2);
    System.out.println (var4);
    System.out.println (var5.intIAt(2));
 
```
In order to call a COBOL subroutine one of this variable, elementary or structured, can be used with the IsCobol class. For example
```
    int rc = IsCobol.call("COBPROG", new Object[] { myVar.get() });
 
```
This class can be used also in accessing data from a standard Java class called by a standard isCOBOL program as if it were a COBOL subroutine, using the method link of the class ICobolVar, e.g.:
```
    myVar.get().link((ICobolVar) argv[0]);
 
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CobolVarHelper.Occurs

static class CobolVarHelper.OccursDynamic

static class CobolVarHelper.XmlAttrs

Nested Classes
Modifier and Type	Class and Description
`static class`	`CobolVarHelper.Occurs`
`static class`	`CobolVarHelper.OccursDynamic`
`static class`	`CobolVarHelper.XmlAttrs`

Field Summary

Fields
Modifier and Type Field and Description

boolean decimalPointIsComma

static String LINKAGE_SECTION_NAME

String name

int opts
- Fields inherited from interface com.iscobol.java.CobolVarHelperConst
  _CP, _CV, _D64, _DC_MASK, _DCA, _DCB, _DCD, _DCDM, _DCI, _DCII, _DCM, _DCMI, _DCN, _DCR, _DCV, _DPNTCO, _DZ, T_DOUBLE, T_FLOAT, T_GROUP, T_INT, T_LONG, T_NATIVEINT, T_NATIVELONG, T_NATIVESHORT, T_OBJECTVAR, T_PIC1, T_PIC1BIT, T_PIC9COMP1, T_PIC9COMP2, T_PIC9COMP3, T_PIC9COMP4, T_PIC9COMP5, T_PIC9COMP6, T_PIC9COMP9, T_PIC9COMPN, T_PIC9COMPX, T_PIC9DISPLAY, T_PICALPEDIT, T_PICG, T_PICGANYLEN, T_PICN, T_PICNANYLEN, T_PICNUMEDIT, T_PICX, T_PICXANYLEN, T_POINTER, T_SHORT

Fields
Modifier and Type	Field and Description
`boolean`	`decimalPointIsComma`
`static String`	`LINKAGE_SECTION_NAME`
`String`	`name`
`int`	`opts`

Constructor Summary

Constructors
Constructor and Description

CobolVarHelper(String name, int opts)
Constructs an helper variable that allows to declare a COBOL structured variable.

Constructors
Constructor and Description
`CobolVarHelper(String name, int opts)` Constructs an helper variable that allows to declare a COBOL structured variable.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Enumeration<CobolVarHelper>`	`childrenElements()`
`CobolVarHelper`	`condName(String name, ICobolVar falseVal, ICobolVar[]... intervals)`
`CobolVarHelper`	`endGroup()` Closes a structured variable.
`ICobolVar`	`get()` Returns the global ICobolVar created by this object.
`ICobolVar`	`get(String n)` Returns the ICobolVar whose name is specified as argument.
`ICobolVar[]`	`getAllElementary()` Returns an array of ICobolVar that are elementary items.
`int`	`getBitLength()`
`int`	`getBitOffset()`
`CondName`	`getCondName(String n)`
`int`	`getDecimals()`
`CobolVarHelper.OccursDynamic`	`getDynamicData()`
`CobolVarExternalHelper`	`getExternalHelper()`
`CobolVarHelper`	`getHelper(String n)`
`int`	`getLength()`
`INumericVar`	`getNum(String n)` Returns the INumericVar whose name is specified as argument.
`int[]`	`getNumDimension()`
`CobolVarHelper.Occurs`	`getOccurs()`
`int`	`getOffset()`
`CobolVarHelper`	`getParent()`
`String`	`getPicture()`
`String`	`getRedefines()`
`String[]`	`getRenames()`
`static CobolVarHelper`	`getSectionHelper(String sectionName, int opts)`
`int[]`	`getSizeDimension()`
`int`	`getSizeInBytes()`
`int`	`getType()`
`ICobolVar`	`getValue()`
`CobolVarHelper.XmlAttrs`	`getXmlAttributes()`
`CobolVarHelper`	`group(String name)` Declares a structured variable without any PICTURE.
`boolean`	`isInDynamic()`
`boolean`	`isJustified()`
`boolean`	`isLinkage()`
`boolean`	`isSection()`
`boolean`	`isSigned()`
`boolean`	`isSignLeading()`
`boolean`	`isSignSeparate()`
`CobolVarHelper`	`justRight(boolean b)` Add/remove the attribute of JUSTIFIED RIGHT to the last declared variable.
`CobolVarHelper`	`objectVar(String name)`
`CobolVarHelper`	`occurs(int n)` Add the attribute of OCCURS to the last declared variable.
`CobolVarHelper`	`occurs(int n, String depOn, String[] indexed)`
`CobolVarHelper`	`occursDynamic(ICobolVar capacity, int uLimit, boolean init)` Add the attribute of OCCURS DYNAMIC to the last declared variable.
`CobolVarHelper`	`occursDynamic(String capacity, int uLimit, boolean init)`
`CobolVarHelper`	`pic1(String name, int len)` Declares a variable whose picture is made by all '1'.
`CobolVarHelper`	`pic1Bit(String name, int len, int bitOffset, int bitLen)` Declares a variable whose picture is made by all '1' and has usage BIT.
`CobolVarHelper`	`pic9(String name, int intPart, int decPart)` Declares an unsigned numeric variable whose usage is DISPLAY.
`CobolVarHelper`	`pic9Comp(String name, int intPart, int decPart)` Declares an unsigned numeric variable whose usage is COMP.
`CobolVarHelper`	`pic9Comp1(String name)` Declares an unsigned numeric variable whose usage is COMP-1.
`CobolVarHelper`	`pic9Comp2(String name, int intPart, int decPart)` Declares an unsigned numeric variable whose usage is COMP-2.
`CobolVarHelper`	`pic9Comp3(String name, int intPart, int decPart)` Declares an unsigned numeric variable whose usage is COMP-3.
`CobolVarHelper`	`pic9Comp4(String name, int intPart, int decPart)` Declares an unsigned numeric variable whose usage is COMP-4.
`CobolVarHelper`	`pic9Comp5(String name, int intPart, int decPart)` Declares an unsigned numeric variable whose usage is COMP-5.
`CobolVarHelper`	`pic9Comp6(String name, int intPart, int decPart)` Declares an unsigned numeric variable whose usage is COMP-6.
`CobolVarHelper`	`pic9Comp9(String name, int intPart, int decPart)` Declares an unsigned numeric variable whose usage is COMP-9.
`CobolVarHelper`	`pic9CompN(String name, int size)` Declares an unsigned numeric variable whose usage is COMP-N.
`CobolVarHelper`	`pic9CompX(String name, int size)` Declares an unsigned numeric variable whose usage is COMP-X.
`CobolVarHelper`	`picAlphaEdit(String name, int len, String pic)`
`CobolVarHelper`	`picBinary(String name, int intPart, int decPart, int size)`
`CobolVarHelper`	`picDouble(String name)` Declares a signed numeric variable whose usage is DOUBLE.
`CobolVarHelper`	`picFloat(String name)` Declares a signed numeric variable whose usage is FLOAT.
`CobolVarHelper`	`picG(String name, int len)` Declares a variable whose picture is made by all 'G'.
`CobolVarHelper`	`picGAnyLength(String name)` Declares a variable whose picture is G ANY LENGTH.
`CobolVarHelper`	`picInt(String name)` Declares a signed numeric variable whose usage is INT.
`CobolVarHelper`	`picLong(String name)` Declares a signed numeric variable whose usage is LONG.
`CobolVarHelper`	`picN(String name, int len)` Declares a variable whose picture is made by all 'N'.
`CobolVarHelper`	`picNAnyLength(String name)` Declares a variable whose picture is N ANY LENGTH.
`CobolVarHelper`	`picNativeInt(String name)`
`CobolVarHelper`	`picNativeLong(String name)`
`CobolVarHelper`	`picNativeShort(String name)`
`CobolVarHelper`	`picNumEdit(String name, int len, String pic)`
`CobolVarHelper`	`picS9(String name, int intPart, int decPart)` Declares a signed numeric variable whose usage is DISPLAY.
`CobolVarHelper`	`picS9Comp(String name, int intPart, int decPart)` Declares a signed numeric variable whose usage is COMP.
`CobolVarHelper`	`picS9Comp2(String name, int intPart, int decPart)` Declares a signed numeric variable whose usage is COMP-2.
`CobolVarHelper`	`picS9Comp3(String name, int intPart, int decPart)` Declares a signed numeric variable whose usage is COMP-3.
`CobolVarHelper`	`picS9Comp4(String name, int intPart, int decPart)` Declares a signed numeric variable whose usage is COMP-4.
`CobolVarHelper`	`picS9Comp5(String name, int intPart, int decPart)` Declares a signed numeric variable whose usage is COMP-5.
`CobolVarHelper`	`picS9Comp9(String name, int intPart, int decPart)` Declares a signed numeric variable whose usage is COMP-9.
`CobolVarHelper`	`picSBinary(String name, int intPart, int decPart, int size)`
`CobolVarHelper`	`picShort(String name)` Declares a signed numeric variable whose usage is SHORT.
`CobolVarHelper`	`picSNativeInt(String name)`
`CobolVarHelper`	`picSNativeLong(String name)`
`CobolVarHelper`	`picSNativeShort(String name)`
`CobolVarHelper`	`picX(String name, int len)` Declares a variable whose picture is made by all 'X'.
`CobolVarHelper`	`picXAnyLength(String name)` Declares a variable whose picture is X ANY LENGTH.
`CobolVarHelper`	`pointer(String name)`
`CobolVarHelper`	`redefines(String name)`
`CobolVarHelper`	`renames(String name, String rename, String thru)`
`void`	`setOffset(int offs)`
`void`	`setVariable(ICobolVar v)`
`CobolVarHelper`	`signLeading(boolean b)` Add/remove the attribute of SIGN IS LEADING to the last declared variable.
`CobolVarHelper`	`signSeparate(boolean b)` Add/remove the attribute of SIGN IS SEPARATE to the last declared variable.
`CobolVarHelper`	`value(ICobolVar v)`
`CobolVarHelper`	`xmlAttribute(boolean v)`
`CobolVarHelper`	`xmlBase64Binary(boolean v)`
`CobolVarHelper`	`xmlBoolean(boolean v)`
`CobolVarHelper`	`xmlCdata(boolean v)`
`CobolVarHelper`	`xmlCount(ICobolVar v)`
`CobolVarHelper`	`xmlCount(String v)`
`CobolVarHelper`	`xmlHexBinary(boolean v)`
`CobolVarHelper`	`xmlIdentifier(ICobolVar v)`
`CobolVarHelper`	`xmlIdentifier(String v)`
`CobolVarHelper`	`xmlNamespace(ICobolVar v)`
`CobolVarHelper`	`xmlNamespace(String v)`
`CobolVarHelper`	`xmlNullable(boolean v)`
`CobolVarHelper`	`xmlProcessingInstruction(boolean v)`
`CobolVarHelper`	`xmlRaw(boolean v)`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - LINKAGE_SECTION_NAME
```
public static final String LINKAGE_SECTION_NAME
```
    See Also:
    
    Constant Field Values
  - opts
```
public final int opts
```
  - name
```
public final String name
```
  - decimalPointIsComma
```
public final boolean decimalPointIsComma
```
- Constructor Detail
  - CobolVarHelper
```
public CobolVarHelper(String name,
                      int opts)
```
    Constructs an helper variable that allows to declare a COBOL structured variable. A list of options can be passed as second argument. The option must be one of the following integer, according to the compiler options
```
:
    CobolVarHelper._DCA
    CobolVarHelper._DCI
    CobolVarHelper._DCM
    CobolVarHelper._DCMI
    CobolVarHelper._DCII
    CobolVarHelper._DCD
    CobolVarHelper._DCN
    CobolVarHelper._DCDM
    CobolVarHelper._DCB
    CobolVarHelper._DCR
    CobolVarHelper._DCV
 
```
    to this value, one or more of the following values can be 'ored':
```
    CobolVarHelper._CP
    CobolVarHelper._CV
    CobolVarHelper._DZ
    CobolVarHelper._DPNTCO
 
```
    The last one doesn't correspond to a compiler option, it means that the COBOL program to call uses the clause DECIMAL POINT IS COMMA and it is useful only for displaying purposes.
    Parameters:
    
    name - variable name, can be null
    
    opts - options used in compiling the program to call
- Method Detail
  - getSectionHelper
```
public static CobolVarHelper getSectionHelper(String sectionName,
                                              int opts)
```
  - group
```
public CobolVarHelper group(String name)
```
    Declares a structured variable without any PICTURE. If any attributes is added to such variable, then it is inherited by all its children.
    
    Parameters:
    
    name - variable name, can be null
    
    Returns:
    
    the object itself in order to allow concatenation of methods
  - endGroup
```
public CobolVarHelper endGroup()
```
    Closes a structured variable.
    
    Returns:
    
    the object itself in order to allow concatenation of methods
  - picX
```
public CobolVarHelper picX(String name,
                           int len)
```
    Declares a variable whose picture is made by all 'X'.
    
    Parameters:
    
    name - variable name, can be null
    
    len - the len of the alphanumeric variable
    
    Returns:
    
    the object itself in order to allow concatenation of methods
  - pic1
```
public CobolVarHelper pic1(String name,
                           int len)
```
    Declares a variable whose picture is made by all '1'.
    
    Parameters:
    
    name - variable name, can be null
    
    len - the len of the variable
    
    Returns:
    
    the object itself in order to allow concatenation of methods
  - pic1Bit
```
public CobolVarHelper pic1Bit(String name,
                              int len,
                              int bitOffset,
                              int bitLen)
```
    Declares a variable whose picture is made by all '1' and has usage BIT.
    
    Parameters:
    
    name - variable name, can be null
    
    len - the len of the variable
    
    bitOffset - the bit offset of the variable
    
    bitLen - the bit len of the variable
    
    Returns:
    
    the object itself in order to allow concatenation of methods
  - picXAnyLength
```
public CobolVarHelper picXAnyLength(String name)
```
    Declares a variable whose picture is X ANY LENGTH.
    
    Parameters:
    
    name - variable name, can be null
    
    Returns:
    
    the object itself in order to allow concatenation of methods
  - picN
```
public CobolVarHelper picN(String name,
                           int len)
```
    Declares a variable whose picture is made by all 'N'.
    
    Parameters:
    
    name - variable name, can be null
    
    len - the len of the alphanumeric variable
    
    Returns:
    
    the object itself in order to allow concatenation of methods
  - picNAnyLength
```
public CobolVarHelper picNAnyLength(String name)
```
    Declares a variable whose picture is N ANY LENGTH.
    
    Parameters:
    
    name - variable name, can be null
    
    Returns:
    
    the object itself in order to allow concatenation of methods
  - picG
```
public CobolVarHelper picG(String name,
                           int len)
```
    Declares a variable whose picture is made by all 'G'.
    
    Parameters:
    
    name - variable name, can be null
    
    len - the len of the alphanumeric variable
    
    Returns:
    
    the object itself in order to allow concatenation of methods
  - picGAnyLength
```
public CobolVarHelper picGAnyLength(String name)
```
    Declares a variable whose picture is G ANY LENGTH.
    
    Parameters:
    
    name - variable name, can be null
    
    Returns:
    
    the object itself in order to allow concatenation of methods
  - pic9
```
public CobolVarHelper pic9(String name,
                           int intPart,
                           int decPart)
```
    Declares an unsigned numeric variable whose usage is DISPLAY.
    
    Parameters:
    
    name - variable name, can be null
    
    intPart - number of digit of the integer part
    
    decPart - number of digit of the decimal part
    
    Returns:
    
    the object itself in order to allow concatenation of methods
  - objectVar
```
public CobolVarHelper objectVar(String name)
```
  - pointer
```
public CobolVarHelper pointer(String name)
```
  - picS9
```
public CobolVarHelper picS9(String name,
                            int intPart,
                            int decPart)
```
    Declares a signed numeric variable whose usage is DISPLAY.
    
    See Also:
    
    pic9(java.lang.String, int, int)
  - pic9Comp1
```
public CobolVarHelper pic9Comp1(String name)
```
    Declares an unsigned numeric variable whose usage is COMP-1.
    
    Parameters:
    
    name - variable name, can be null
    
    Returns:
    
    the object itself in order to allow concatenation of methods
  - pic9Comp2
```
public CobolVarHelper pic9Comp2(String name,
                                int intPart,
                                int decPart)
```
    Declares an unsigned numeric variable whose usage is COMP-2.
    
    See Also:
    
    pic9(java.lang.String, int, int)
  - picS9Comp2
```
public CobolVarHelper picS9Comp2(String name,
                                 int intPart,
                                 int decPart)
```
    Declares a signed numeric variable whose usage is COMP-2.
    
    See Also:
    
    pic9(java.lang.String, int, int)
  - pic9Comp3
```
public CobolVarHelper pic9Comp3(String name,
                                int intPart,
                                int decPart)
```
    Declares an unsigned numeric variable whose usage is COMP-3.
    
    See Also:
    
    pic9(java.lang.String, int, int)
  - picS9Comp3
```
public CobolVarHelper picS9Comp3(String name,
                                 int intPart,
                                 int decPart)
```
    Declares a signed numeric variable whose usage is COMP-3.
    
    See Also:
    
    pic9(java.lang.String, int, int)
  - pic9Comp4
```
public CobolVarHelper pic9Comp4(String name,
                                int intPart,
                                int decPart)
```
    Declares an unsigned numeric variable whose usage is COMP-4.
    
    See Also:
    
    pic9(java.lang.String, int, int)
  - picSBinary
```
public CobolVarHelper picSBinary(String name,
                                 int intPart,
                                 int decPart,
                                 int size)
```
  - picBinary
```
public CobolVarHelper picBinary(String name,
                                int intPart,
                                int decPart,
                                int size)
```
  - picS9Comp4
```
public CobolVarHelper picS9Comp4(String name,
                                 int intPart,
                                 int decPart)
```
    Declares a signed numeric variable whose usage is COMP-4.
    
    See Also:
    
    pic9(java.lang.String, int, int)
  - pic9Comp
```
public CobolVarHelper pic9Comp(String name,
                               int intPart,
                               int decPart)
```
    Declares an unsigned numeric variable whose usage is COMP.
    
    See Also:
    
    pic9(java.lang.String, int, int)
  - picS9Comp
```
public CobolVarHelper picS9Comp(String name,
                                int intPart,
                                int decPart)
```
    Declares a signed numeric variable whose usage is COMP.
    
    See Also:
    
    pic9(java.lang.String, int, int)
  - pic9Comp5
```
public CobolVarHelper pic9Comp5(String name,
                                int intPart,
                                int decPart)
```
    Declares an unsigned numeric variable whose usage is COMP-5.
    
    See Also:
    
    pic9(java.lang.String, int, int)
  - picS9Comp5
```
public CobolVarHelper picS9Comp5(String name,
                                 int intPart,
                                 int decPart)
```
    Declares a signed numeric variable whose usage is COMP-5.
    
    See Also:
    
    pic9(java.lang.String, int, int)
  - pic9Comp6
```
public CobolVarHelper pic9Comp6(String name,
                                int intPart,
                                int decPart)
```
    Declares an unsigned numeric variable whose usage is COMP-6.
    
    See Also:
    
    pic9(java.lang.String, int, int)
  - pic9Comp9
```
public CobolVarHelper pic9Comp9(String name,
                                int intPart,
                                int decPart)
```
    Declares an unsigned numeric variable whose usage is COMP-9.
    
    See Also:
    
    pic9(java.lang.String, int, int)
  - picS9Comp9
```
public CobolVarHelper picS9Comp9(String name,
                                 int intPart,
                                 int decPart)
```
    Declares a signed numeric variable whose usage is COMP-9.
    
    See Also:
    
    pic9(java.lang.String, int, int)
  - pic9CompN
```
public CobolVarHelper pic9CompN(String name,
                                int size)
```
    Declares an unsigned numeric variable whose usage is COMP-N.
    
    Parameters:
    
    name - variable name, can be null
    
    size - dimension of the variable expressed in bytes
    
    Returns:
    
    the object itself in order to allow concatenation of methods
  - pic9CompX
```
public CobolVarHelper pic9CompX(String name,
                                int size)
```
    Declares an unsigned numeric variable whose usage is COMP-X.
    
    Parameters:
    
    name - variable name, can be null
    
    size - dimension of the variable expressed in bytes
    
    Returns:
    
    the object itself in order to allow concatenation of methods
  - picFloat
```
public CobolVarHelper picFloat(String name)
```
    Declares a signed numeric variable whose usage is FLOAT.
    
    Parameters:
    
    name - variable name, can be null
    
    Returns:
    
    the object itself in order to allow concatenation of methods
  - picDouble
```
public CobolVarHelper picDouble(String name)
```
    Declares a signed numeric variable whose usage is DOUBLE.
    
    Parameters:
    
    name - variable name, can be null
    
    Returns:
    
    the object itself in order to allow concatenation of methods
  - picShort
```
public CobolVarHelper picShort(String name)
```
    Declares a signed numeric variable whose usage is SHORT.
    
    Parameters:
    
    name - variable name, can be null
    
    Returns:
    
    the object itself in order to allow concatenation of methods
  - picInt
```
public CobolVarHelper picInt(String name)
```
    Declares a signed numeric variable whose usage is INT.
    
    Parameters:
    
    name - variable name, can be null
    
    Returns:
    
    the object itself in order to allow concatenation of methods
  - picLong
```
public CobolVarHelper picLong(String name)
```
    Declares a signed numeric variable whose usage is LONG.
    
    Parameters:
    
    name - variable name, can be null
    
    Returns:
    
    the object itself in order to allow concatenation of methods
  - picSNativeShort
```
public CobolVarHelper picSNativeShort(String name)
```
  - picNativeShort
```
public CobolVarHelper picNativeShort(String name)
```
  - picSNativeInt
```
public CobolVarHelper picSNativeInt(String name)
```
  - picNativeInt
```
public CobolVarHelper picNativeInt(String name)
```
  - picSNativeLong
```
public CobolVarHelper picSNativeLong(String name)
```
  - picNativeLong
```
public CobolVarHelper picNativeLong(String name)
```
  - occurs
```
public CobolVarHelper occurs(int n)
```
    Add the attribute of OCCURS to the last declared variable. This method can be invoked only once for each variable. This method cannot be invoked by a variable whose parent has invoked the occursDynamic method and vice versa.
    
    Parameters:
    
    n - the occurence count
    
    Returns:
    
    the object itself in order to allow concatenation of methods
    
    See Also:
    
    occursDynamic(ICobolVar capacity, int uLimit, boolean init)
  - occurs
```
public CobolVarHelper occurs(int n,
                             String depOn,
                             String[] indexed)
```
  - occursDynamic
```
public CobolVarHelper occursDynamic(ICobolVar capacity,
                                    int uLimit,
                                    boolean init)
```
    Add the attribute of OCCURS DYNAMIC to the last declared variable. This method can be invoked only once for each variable. This method cannot be invoked by a variable whose parent has invoked the occurs method and vice versa.
    
    Parameters:
    
    capacity - an ICobolVar that contains the capacity, it can be null
    
    uLimit - the upper limint of the table, 0 = no limit
    
    init - if true the table is initialized
    
    Returns:
    
    the object itself in order to allow concatenation of methods
    
    See Also:
    
    occurs(int n)
  - occursDynamic
```
public CobolVarHelper occursDynamic(String capacity,
                                    int uLimit,
                                    boolean init)
```
  - justRight
```
public CobolVarHelper justRight(boolean b)
```
    Add/remove the attribute of JUSTIFIED RIGHT to the last declared variable.
    
    Parameters:
    
    b - if the attribute must be set or reset
    
    Returns:
    
    the object itself in order to allow concatenation of methods
  - signSeparate
```
public CobolVarHelper signSeparate(boolean b)
```
    Add/remove the attribute of SIGN IS SEPARATE to the last declared variable.
    
    Parameters:
    
    b - if the attribute must be set or reset
    
    Returns:
    
    the object itself in order to allow concatenation of methods
  - signLeading
```
public CobolVarHelper signLeading(boolean b)
```
    Add/remove the attribute of SIGN IS LEADING to the last declared variable.
    
    Parameters:
    
    b - if the attribute must be set or reset
    
    Returns:
    
    the object itself in order to allow concatenation of methods
  - getSizeInBytes
```
public int getSizeInBytes()
```
  - getOffset
```
public int getOffset()
```
  - setOffset
```
public void setOffset(int offs)
```
  - getSizeDimension
```
public int[] getSizeDimension()
```
  - getNumDimension
```
public int[] getNumDimension()
```
  - isJustified
```
public boolean isJustified()
```
  - isSigned
```
public boolean isSigned()
```
  - isSignSeparate
```
public boolean isSignSeparate()
```
  - isSignLeading
```
public boolean isSignLeading()
```
  - isInDynamic
```
public boolean isInDynamic()
```
  - getLength
```
public int getLength()
```
  - getDecimals
```
public int getDecimals()
```
  - getParent
```
public CobolVarHelper getParent()
```
  - childrenElements
```
public Enumeration<CobolVarHelper> childrenElements()
```
  - setVariable
```
public void setVariable(ICobolVar v)
```
  - get
```
public ICobolVar get()
```
    Returns the global ICobolVar created by this object. This method must be invoked only after all the COBOL variables are defined.
    
    Returns:
    
    the ICobolVar object built according to all th definitions
  - get
```
public ICobolVar get(String n)
```
    Returns the ICobolVar whose name is specified as argument. This method must be invoked only after all the COBOL variables are defined. If a variable with the given name doesn't exist, then null is returned.
    
    Parameters:
    
    n - the name of the variable to get
    
    Returns:
    
    the ICobolVar object built according to all th definitions
  - getHelper
```
public CobolVarHelper getHelper(String n)
```
  - getNum
```
public INumericVar getNum(String n)
```
    Returns the INumericVar whose name is specified as argument. This method must be invoked only after all the COBOL variables are defined. If a variable with the given name doesn't exist, or it exists but it is not numeric then null is returned.
    
    Parameters:
    
    n - the name of the variable to get
    
    Returns:
    
    the ICobolVar object built according to all th definitions
  - getDynamicData
```
public CobolVarHelper.OccursDynamic getDynamicData()
```
  - getOccurs
```
public CobolVarHelper.Occurs getOccurs()
```
  - getAllElementary
```
public ICobolVar[] getAllElementary()
```
    Returns an array of ICobolVar that are elementary items. This method must be invoked only after all the COBOL variables are defined.
    
    Returns:
    
    an ICobolVar array
  - picNumEdit
```
public CobolVarHelper picNumEdit(String name,
                                 int len,
                                 String pic)
```
  - picAlphaEdit
```
public CobolVarHelper picAlphaEdit(String name,
                                   int len,
                                   String pic)
```
  - condName
```
public CobolVarHelper condName(String name,
                               ICobolVar falseVal,
                               ICobolVar[]... intervals)
```
  - redefines
```
public CobolVarHelper redefines(String name)
```
  - renames
```
public CobolVarHelper renames(String name,
                              String rename,
                              String thru)
```
  - value
```
public CobolVarHelper value(ICobolVar v)
```
  - xmlIdentifier
```
public CobolVarHelper xmlIdentifier(ICobolVar v)
```
  - xmlIdentifier
```
public CobolVarHelper xmlIdentifier(String v)
```
  - xmlNamespace
```
public CobolVarHelper xmlNamespace(ICobolVar v)
```
  - xmlNamespace
```
public CobolVarHelper xmlNamespace(String v)
```
  - xmlCount
```
public CobolVarHelper xmlCount(ICobolVar v)
```
  - xmlCount
```
public CobolVarHelper xmlCount(String v)
```
  - xmlAttribute
```
public CobolVarHelper xmlAttribute(boolean v)
```
  - xmlProcessingInstruction
```
public CobolVarHelper xmlProcessingInstruction(boolean v)
```
  - xmlRaw
```
public CobolVarHelper xmlRaw(boolean v)
```
  - xmlBase64Binary
```
public CobolVarHelper xmlBase64Binary(boolean v)
```
  - xmlHexBinary
```
public CobolVarHelper xmlHexBinary(boolean v)
```
  - xmlNullable
```
public CobolVarHelper xmlNullable(boolean v)
```
  - xmlBoolean
```
public CobolVarHelper xmlBoolean(boolean v)
```
  - xmlCdata
```
public CobolVarHelper xmlCdata(boolean v)
```
  - getValue
```
public ICobolVar getValue()
```
  - getXmlAttributes
```
public CobolVarHelper.XmlAttrs getXmlAttributes()
```
  - getCondName
```
public CondName getCondName(String n)
```
  - getPicture
```
public String getPicture()
```
  - getRedefines
```
public String getRedefines()
```
  - getRenames
```
public String[] getRenames()
```
  - isLinkage
```
public boolean isLinkage()
```
  - isSection
```
public boolean isSection()
```
  - getType
```
public int getType()
```
  - getExternalHelper
```
public CobolVarExternalHelper getExternalHelper()
```
  - getBitOffset
```
public int getBitOffset()
```
  - getBitLength
```
public int getBitLength()
```

Class CobolVarHelper

Nested Class Summary

Field Summary

Fields inherited from interface com.iscobol.java.CobolVarHelperConst

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LINKAGE_SECTION_NAME

opts

name

decimalPointIsComma

Constructor Detail

CobolVarHelper

Method Detail

getSectionHelper

group

endGroup

picX

pic1

pic1Bit

picXAnyLength

picN

picNAnyLength

picG

picGAnyLength

pic9

objectVar

pointer

picS9

pic9Comp1

pic9Comp2

picS9Comp2

pic9Comp3

picS9Comp3

pic9Comp4

picSBinary

picBinary

picS9Comp4

pic9Comp

picS9Comp

pic9Comp5

picS9Comp5

pic9Comp6

pic9Comp9

picS9Comp9

pic9CompN

pic9CompX

picFloat

picDouble

picShort

picInt

picLong

picSNativeShort

picNativeShort

picSNativeInt

picNativeInt

picSNativeLong

picNativeLong

occurs

occurs

occursDynamic

occursDynamic

justRight

signSeparate

signLeading

getSizeInBytes

getOffset

setOffset

getSizeDimension

getNumDimension

isJustified

isSigned

isSignSeparate

isSignLeading

isInDynamic

getLength

getDecimals

getParent

childrenElements