|
iSeries Remote Systems v6.0.1 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.etools.iseries.editor.generator.model.RPGCommon
com.ibm.etools.iseries.editor.generator.model.DataStructureDSpec
Field Summary | |
---|---|
protected boolean |
altSeq
|
protected boolean |
based
|
protected String |
basedName
|
protected boolean |
dataArea
|
protected String |
dataAreaName
|
protected boolean |
exportField
|
protected String |
exportFieldName
|
protected boolean |
importField
|
protected String |
importFieldName
|
protected boolean |
inz
|
protected int |
occurs
|
protected boolean |
qualified
|
protected boolean |
staticValue
|
protected Vector |
subFields
|
Fields inherited from class com.ibm.etools.iseries.editor.generator.model.RPGCommon |
---|
fieldName, purpose |
Fields inherited from interface com.ibm.etools.iseries.editor.generator.model.IDSpec |
---|
DATEFMT_DMY, DATEFMT_EUR, DATEFMT_ISO, DATEFMT_JIS, DATEFMT_JUL, DATEFMT_MDY, DATEFMT_NONE, DATEFMT_USA, DATEFMT_YMD, DT_AMPERSAND, DT_COLON, DT_COMMA, DT_DASH, DT_NONE, DT_PERIOD, DT_SLASH, INFDS_DB, INFDS_DSPF_ATTR, INFDS_DSPF_DEV, INFDS_FILE, INFDS_ICF_ATTR, INFDS_ICF_DEV, INFDS_IO, INFDS_OPEN, INFDS_PRTF, MSG_ERR_REQ_FIELD, RPGARRAYKWD_B, RPGARRAYKWD_F, RPGARRAYKWD_I, RPGARRAYKWD_L, RPGARRAYKWD_P, RPGARRAYKWD_R, RPGARRAYKWD_S, RPGARRAYKWD_U, RPGTYPE_A, RPGTYPE_AV, RPGTYPE_B, RPGTYPE_C, RPGTYPE_CV, RPGTYPE_D, RPGTYPE_F, RPGTYPE_G, RPGTYPE_GV, RPGTYPE_I, RPGTYPE_I2, RPGTYPE_N, RPGTYPE_P, RPGTYPE_S, RPGTYPE_STAR, RPGTYPE_T, RPGTYPE_U, RPGTYPE_U2, RPGTYPE_Z, TIMEFMT_EUR, TIMEFMT_HMS, TIMEFMT_ISO, TIMEFMT_JIS, TIMEFMT_NONE, TIMEFMT_USA |
Constructor Summary | |
---|---|
DataStructureDSpec()
|
Method Summary | |
---|---|
void |
addSubField(SubField sf)
Adds sb to the collection of SubFields belonging to this data structure. |
String |
getBasedName()
|
String |
getDataAreaName()
|
String |
getExportFieldName()
|
String |
getImportFieldName()
|
int |
getOccurs()
|
SubField |
getSubField(int i)
|
Vector |
getSubFields()
|
boolean |
ignoreAltSeq()
|
boolean |
isAssociatedWithDataArea()
|
boolean |
isBased()
|
boolean |
isExportField()
|
boolean |
isImportField()
|
boolean |
isInz()
|
boolean |
isQualified()
|
boolean |
isStatic()
|
boolean |
isValid()
|
void |
removeSubField(int i)
Removes the i'th SubField from the collection of SubFields belonging to this data structure |
void |
removeSubField(SubField sf)
Removes sf from the collection of SubFields belonging to this data structure, or has no effect if sf is not in the collection |
void |
setAssociatedWithDataArea(boolean b)
Sets whether the data structure is associated with a data area (*DTAARA) |
void |
setBased(boolean b)
Sets whether the memory address of the data structure is based on the current address in a basing pointer field (BASED) |
void |
setBasedName(String name)
Sets the name of the basing pointer field, if the data structure is declared to be based on the contents therein, has no effect otherwise |
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. |
void |
setExportField(boolean accessible)
Sets whether this data structure is available or accessible to other modules |
void |
setExportFieldName(String name)
Sets the name of this field given to external callers, if the data structure is available/accessible to other modules, has no effect otherwise. |
void |
setIgnoreAltSeq(boolean ignore)
Sets whether or not to ignore alternating collating sequence for this data structure |
void |
setImportField(boolean b)
Sets whether this data structure is defined in other modules and bound into this program or service program. |
void |
setImportFieldName(String name)
Sets the name of the field given to external callers, if the field is defined in another module, has no effect otherwise. |
void |
setInz(boolean initialize)
Sets whether or not to initialize all subfields to values dependent on their types, ie: 0 for numeric, blanks for characters, etc. |
void |
setOccurs(int i)
Sets the number of occurrences of this data structure. |
void |
setQualified(boolean b)
Sets whether or not to qualify data structure subfields using the data structure name. |
void |
setStatic(boolean b)
Sets whether this data structure holds its data value between procedure calls. |
void |
swapSubFields(int i,
int j)
Swaps the i'th and j'th subfields in the list of subfields. |
Methods inherited from class com.ibm.etools.iseries.editor.generator.model.RPGCommon |
---|
getMessages, getName, getPurpose, setFieldName, setPurpose |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected boolean altSeq
protected boolean staticValue
protected boolean qualified
protected boolean inz
protected boolean based
protected String basedName
protected boolean dataArea
protected String dataAreaName
protected boolean importField
protected String importFieldName
protected boolean exportField
protected String exportFieldName
protected int occurs
protected Vector subFields
Constructor Detail |
public DataStructureDSpec()
Method Detail |
public boolean ignoreAltSeq()
setIgnoreAltSeq(boolean b)
public boolean isBased()
getBasedName()
,
setBasedName(String)
,
setBased(boolean)
public String getBasedName()
isBased()
,
setBasedName(String)
,
setBased(boolean)
public boolean isAssociatedWithDataArea()
setAssociatedWithDataArea(boolean)
,
setDataAreaName(String)
,
getDataAreaName()
public String getDataAreaName()
isAssociatedWithDataArea()
,
setDataAreaName(String)
,
setAssociatedWithDataArea(boolean)
public boolean isExportField()
getExportFieldName()
,
setExportFieldName(String)
,
setExportField(boolean)
public String getExportFieldName()
isExportField()
,
setExportFieldName(String)
,
setExportField(boolean)
public boolean isImportField()
setImportField(boolean)
,
getImportFieldName()
,
setImportFieldName(String)
public String getImportFieldName()
setImportFieldName(String)
,
isImportField()
,
setImportField(boolean)
public boolean isInz()
setInz(boolean)
public int getOccurs()
setOccurs(int)
public boolean isQualified()
setQualified(boolean)
public boolean isStatic()
setStatic(boolean)
public Vector getSubFields()
SubField
public SubField getSubField(int i)
i
- the index of the SubField to return
public void setIgnoreAltSeq(boolean ignore)
ignore
- true for ignore or ALTSEQ(*NONE), false otherwiseignoreAltSeq()
public void setBased(boolean b)
b
- is true if the data structure is BASED, false otherwiseisBased()
,
getBasedName()
,
setBasedName(String)
public void setBasedName(String name)
name
- the name of the basing pointer fieldgetBasedName()
,
#getBased()
,
setBased(boolean)
public void setAssociatedWithDataArea(boolean b)
b
- true if the data structure is to be associated with a
data area, false otherwiseisAssociatedWithDataArea()
,
getDataAreaName()
,
#setDataAreaName()
public void setDataAreaName(String name)
name
- The name of the data area.isAssociatedWithDataArea()
,
getDataAreaName()
,
setAssociatedWithDataArea(boolean)
public void setExportField(boolean accessible)
accessible
- true if the data structure is
available/accessible to other modules, false otherwiseisExportField()
,
getExportFieldName()
,
setExportFieldName(String)
public void setExportFieldName(String name)
name
- the name of the field given to external callersisExportField()
,
getExportFieldName()
,
setExportField(boolean)
public void setImportField(boolean b)
b
- true if this data structure is defined in other modules,
false otherwiseisImportField()
,
getImportFieldName()
,
setImportFieldName(String)
public void setImportFieldName(String name)
name
- the name of the field given to external callersisImportField()
,
getImportFieldName()
,
setImportField(boolean)
public void setInz(boolean initialize)
initialize
- true if the subfields are to be initialized
to values dependent on their types, false if they are to be
initialized to blanks onlyisInz()
public void setOccurs(int i)
i
- the number of occurrencesgetOccurs()
public void setQualified(boolean b)
b
- true if the subfields will be qualified using
the data structure name, false otherwiseisQualified()
public void setStatic(boolean b)
b
- true if the data structure is static, false otherwiseisStatic()
public void addSubField(SubField sf)
sf
- the SubField to add.getSubFields()
,
SubField
,
removeSubField(int)
public void removeSubField(int i)
i
- the index of the SubField to removepublic void removeSubField(SubField sf)
sf
- the SubField to remove.public void swapSubFields(int i, int j)
i
- the position of the subfield that will be
swapped with the j'th subfieldj
- the position of the subfield that will be
swapped with the i'th subfieldpublic boolean isValid()
isValid
in class RPGCommon
|
iSeries Remote Systems v6.0.1 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |