com.ibm.etools.iseries.editor.generator.model
Class SubField
java.lang.Object
com.ibm.etools.iseries.editor.generator.model.RPGCommon
com.ibm.etools.iseries.editor.generator.model.RPGDSpec
com.ibm.etools.iseries.editor.generator.model.FieldDSpec
com.ibm.etools.iseries.editor.generator.model.SubField
- public class SubField
- extends FieldDSpec
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
packEven
protected boolean packEven
dataArea
protected boolean dataArea
dataAreaName
protected String dataAreaName
overlay
protected boolean overlay
overlayName
protected String overlayName
overlayStartingPosition
protected int overlayStartingPosition
SubField
public SubField()
isAssociatedWithDataArea
public boolean isAssociatedWithDataArea()
- Returns:
- Whether the data structure is associated with a data area
(*DTAARA)
- See Also:
setAssociatedWithDataArea(boolean)
,
setDataAreaName(String)
,
getDataAreaName()
getDataAreaName
public String getDataAreaName()
- Returns:
- If the data structure is associated with a data area,
returns the name of the data area, or "*LDA" (local data area)
if one has not been specified. If the data structure is not
currently associated with a data area, returns "".
- See Also:
isAssociatedWithDataArea()
,
setDataAreaName(String)
,
setAssociatedWithDataArea(boolean)
isOverlay
public boolean isOverlay()
- Returns:
- Whether this subfield overlays another subfield in
the data structure. The other subfield is specified using
setOverlayName(String).
- See Also:
getOverlayName()
,
getOverlayStartingPosition()
,
setOverlay(boolean)
,
setOverlayName(String)
,
setOverlayStartingPosition(int)
getOverlayName
public String getOverlayName()
- Returns:
- The name of the subfield that this subfield overlays,
if it overlays another subfield, otherwise returns ""
- See Also:
isOverlay()
,
getOverlayStartingPosition()
,
setOverlay(boolean)
,
setOverlayName(String)
,
setOverlayStartingPosition(int)
getOverlayStartingPosition
public int getOverlayStartingPosition()
- Returns:
- The position at which to start overlaying, if this
subfield overlays another subfield, otherwise returns -1. If
overlaying is to begin at the next possible position in the
specified subfield, then this method returns 0.
- See Also:
isOverlay()
,
getOverlayName()
,
setOverlay(boolean)
,
setOverlayName(String)
,
setOverlayStartingPosition(int)
isPackEven
public boolean isPackEven()
- Returns:
- For packed decimal data types, is true if and only
if the packed subfield has an even number of digits.
- See Also:
setPackEven(boolean)
setAssociatedWithDataArea
public void setAssociatedWithDataArea(boolean b)
- Sets whether the data structure is associated with a data area
(*DTAARA)
- Parameters:
b
- true if the data structure is to be associated with a
data area, false otherwise- See Also:
isAssociatedWithDataArea()
,
getDataAreaName()
,
#setDataAreaName()
setDataAreaName
public void setDataAreaName(String name)
- If the data structure is associated with a data area,
sets the name of the data area, otherwise has no effect.
- Parameters:
name
- The name of the data area.- See Also:
isAssociatedWithDataArea()
,
getDataAreaName()
,
setAssociatedWithDataArea(boolean)
setOverlay
public void setOverlay(boolean b)
- Sets whether this subfield overlays another subfield in
the data structure. The other subfield is specified using
setOverlayName(String).
- Parameters:
b
- - See Also:
getOverlayName()
,
getOverlayStartingPosition()
,
isOverlay()
,
setOverlayName(String)
,
setOverlayStartingPosition(int)
setOverlayName
public void setOverlayName(String name)
- Sets the name of the subfield that this subfield overlays,
if it overlays another subfield, otherwise has no effect.
- Parameters:
name
- - See Also:
isOverlay()
,
getOverlayStartingPosition()
,
setOverlay(boolean)
,
getOverlayName()
,
setOverlayStartingPosition(int)
setOverlayStartingPosition
public void setOverlayStartingPosition(int i)
- Sets the position at which to start overlaying, if this
subfield overlays another subfield.
- Parameters:
i
- Set this to the position at which to start overlaying
the other subfield. Set i to 0 if you wish to start overlaying
at the next possible position (*NEXT).- See Also:
isOverlay()
,
getOverlayName()
,
setOverlay(boolean)
,
setOverlayName(String)
,
getOverlayStartingPosition()
setPackEven
public void setPackEven(boolean b)
- Sets for packed decimal data types, whether or not
the packed subfield has an even number of digits.
- Parameters:
b
- is true if and only if the number of digits is even- See Also:
isPackEven()
isStatic
public boolean isStatic()
setStatic
public void setStatic(boolean b)
isExportField
public boolean isExportField()
setExportField
public void setExportField(boolean b)
getExportFieldName
public String getExportFieldName()
setExportFieldName
public void setExportFieldName(String str)
isImportField
public boolean isImportField()
setImportField
public void setImportField(boolean b)
getImportFieldName
public String getImportFieldName()
setImportFieldName
public void setImportFieldName(String str)
isOptimized
public boolean isOptimized()
setOptimized
public void setOptimized(boolean b)
isBased
public boolean isBased()
setBased
public void setBased(boolean b)
getBasedName
public String getBasedName()
setBasedName
public void setBasedName(String str)
Copyright © 2005 IBM Corp. All Rights Reserved.
Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.