|
Rational Developer for Power Systems Software V7.6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.ibm.etools.iseries.comm.interfaces.ISeriesHostObjectNameOnly com.ibm.etools.iseries.comm.interfaces.ISeriesHostRecordNameOnly com.ibm.etools.iseries.comm.interfaces.ISeriesHostFieldNameOnly com.ibm.etools.iseries.comm.interfaces.ISeriesHostFieldBasic com.ibm.etools.iseries.comm.interfaces.ISeriesHostDatabaseField
public class ISeriesHostDatabaseField
This class represents the information for a field in an iSeries database.
Field Summary | |
---|---|
static String |
Copyright
|
Fields inherited from class com.ibm.etools.iseries.comm.interfaces.ISeriesHostFieldBasic |
---|
alternativeName, dataCCSID, datatype, decPos, dftValue, digits, dlControl, dlIntegrity, dlReadPermission, dlRecovery, dlUnlinkAction, dlWritePermission, dtFormat, dtSep, edtcde, edtwrd, edtwrdCCSID, hasHostVariable, hdg1, hdg2, hdg3, hdgCCSID, inputBufferPos, internalName, length, maxLOBlen, maxLOBpadlen, nbrDBCSchars, nullValuesAllowed, outputBufferPos, text, textCCSID, ucs2Len, udtLib, udtName, use, varLen |
Fields inherited from class com.ibm.etools.iseries.comm.interfaces.ISeriesHostFieldNameOnly |
---|
record |
Fields inherited from class com.ibm.etools.iseries.comm.interfaces.ISeriesHostRecordNameOnly |
---|
file, fileType |
Fields inherited from class com.ibm.etools.iseries.comm.interfaces.ISeriesHostObjectNameOnly |
---|
library, name |
Fields inherited from interface com.ibm.etools.iseries.comm.interfaces.IDataBaseFieldConstants |
---|
FLDTYPE_ALPHA, FLDTYPE_BINARY, FLDTYPE_DATE, FLDTYPE_DBCS, FLDTYPE_FLOAT, FLDTYPE_FLOATD, FLDTYPE_GRAPHIC, FLDTYPE_HEX, FLDTYPE_MAX, FLDTYPE_PACKED, FLDTYPE_PUREDBCS, FLDTYPE_TIME, FLDTYPE_TIMESTAMP, FLDTYPE_UNKNOWN, FLDTYPE_VALPHA, FLDTYPE_VDBCS, FLDTYPE_VGRAPHIC, FLDTYPE_ZONED |
Constructor Summary | |
---|---|
ISeriesHostDatabaseField()
|
Method Summary | |
---|---|
void |
addKeyword(String name,
String[] parameters)
Add a keyword to the list of keywords stored for this field. |
int |
getAllocatedLength()
Returns the length. |
byte |
getDerivedOperator()
Derived Operator (for logical fiel fields) |
int |
getDisplayLength()
Get the display length. |
int |
getDTFlags()
Date Time flags |
char |
getEditCodeSymbol()
Returns the floating currency symbol used by the edit code. |
int |
getEncodingScheme()
Sets the encoding scheme for this field. |
Collection |
getKeywords()
Get the keywords specified for this field. |
String |
getReferencedField()
Referenced field (for logical file fields) |
char |
getReferenceShift()
Returns the referenceShift. |
int |
getSubstringEnd()
Substring keyword ending position |
int |
getSubstringStart()
Substring keyword starting position |
boolean |
isCCSIDSpecified()
Returns the ccsidSpecified. |
boolean |
isConvertUCS2()
Get whether or not to convert UCS2 characters before printing. |
boolean |
isDBCSAlternateTypeField()
Check if this field's alternate type contains DBCS data. |
boolean |
isDBCSColumnHeadings()
Check if this field's column headings contain DBCS data |
boolean |
isDBCSTextDescription()
Check if this field's text description contains DBCS data. |
boolean |
isDBCSValidityCheckingLiterals()
Check if this field's validity checking literals (COMP, RANE, VALUES) contain DBCS data. |
boolean |
isDisplayLengthSpecified()
When referenced by a display file, if true then the DDS for the field provided the allowed number of display positions as returned by getDisplayLength() This method is only supported on i5/OS V5R4 and higher. |
boolean |
isMinimumDisplayLength()
When referenced by a display file, if true then getDisplayLength() contains the number of display positions allowed (and is equal to the field length defined in the DDS.) This method is only supported on i5/OS V5R4 and higher. |
void |
setAllocatedLength(int length)
Sets the length. |
void |
setCCSIDSpecified(boolean ccsidSpecified)
Sets the ccsidSpecified. |
void |
setDBCSAlternateTypeField(boolean flag)
Set whether this field's alternate type contains DBCS data |
void |
setDBCSColumnHeadings(boolean flag)
Set whether this field's column headings contain DBCS data |
void |
setDBCSTextDescription(boolean flag)
Set whether this field's text description contains DBCS data |
void |
setDBCSValidityCheckingLiterals(boolean flag)
Set whether this field's validity checking literals (COMP, RANGE, VALUES) contain DBCS data. |
void |
setDerivedOperator(byte operator)
Derived Operator (for logical file fields) |
void |
setDisplayLength(int length)
Set the display length. |
void |
setDTFlags(int flag)
Date Time Flags |
void |
setEditCodeSymbol(char symbol)
Set the floating currency symbol used by the edit code. |
void |
setEncodingScheme(int encodingScheme)
Sets the encoding scheme for this field. |
void |
setIsConvertUCS2(boolean convert)
Set whether or not to convert UCS2 characters before printing. |
void |
setIsDisplayLengthSpecified(boolean value)
When referenced by a display file, if true then the DDS for the field provided the allowed number of display positions as returned by getDisplayLength() This method is only supported on i5/OS V5R4 and higher. |
void |
setIsMinimumDisplayLength(boolean value)
When referenced by a display file, if true then getDisplayLength() contains the number of display positions allowed (and is equal to the field length defined in the DDS.) This method is only supported on i5/OS V5R4 and higher. |
void |
setReferencedField(String referencedField)
Referenced field (for logical file fields) |
void |
setReferenceShift(char referenceShift)
Sets the referenceShift. |
void |
setSubstringEnd(int end)
Substring keyword ending position |
void |
setSubstringStart(int start)
Substring keyword starting position |
String |
toString()
For printing to a stream file |
Methods inherited from class com.ibm.etools.iseries.comm.interfaces.ISeriesHostFieldNameOnly |
---|
getRecord, setRecord |
Methods inherited from class com.ibm.etools.iseries.comm.interfaces.ISeriesHostRecordNameOnly |
---|
getFile, getFileType, setFile, setFileType |
Methods inherited from class com.ibm.etools.iseries.comm.interfaces.ISeriesHostObjectNameOnly |
---|
getLibrary, getName, setLibrary, setName |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostDatabaseField |
---|
getLength |
Methods inherited from interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostFieldNameOnly |
---|
getRecord, setRecord, writeObjectInfo |
Methods inherited from interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostRecordNameOnly |
---|
getFile, getFileType, setFile, setFileType |
Methods inherited from interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectNameOnly |
---|
getLibrary, getName, setLibrary, setName |
Field Detail |
---|
public static final String Copyright
Constructor Detail |
---|
public ISeriesHostDatabaseField()
Method Detail |
---|
public int getAllocatedLength()
getAllocatedLength
in interface IISeriesHostDatabaseField
public void setAllocatedLength(int length)
setAllocatedLength
in interface IISeriesHostDatabaseField
length
- The length to setpublic char getReferenceShift()
getReferenceShift
in interface IISeriesHostDatabaseField
public void setReferenceShift(char referenceShift)
setReferenceShift
in interface IISeriesHostDatabaseField
referenceShift
- The referenceShift to setpublic void addKeyword(String name, String[] parameters)
IISeriesHostDatabaseField
addKeyword
in interface IISeriesHostDatabaseField
public Collection getKeywords()
IISeriesHostDatabaseField
getKeywords
in interface IISeriesHostDatabaseField
IISeriesHostFieldKeyword
public boolean isCCSIDSpecified()
isCCSIDSpecified
in interface IISeriesHostDatabaseField
public void setCCSIDSpecified(boolean ccsidSpecified)
setCCSIDSpecified
in interface IISeriesHostDatabaseField
ccsidSpecified
- The ccsidSpecified to setpublic void setEditCodeSymbol(char symbol)
setEditCodeSymbol
in interface IISeriesHostDatabaseField
public char getEditCodeSymbol()
getEditCodeSymbol
in interface IISeriesHostDatabaseField
public String toString()
ISeriesHostFieldNameOnly
toString
in interface IISeriesHostFieldNameOnly
toString
in interface IISeriesHostObjectNameOnly
toString
in interface IISeriesHostRecordNameOnly
toString
in class ISeriesHostFieldNameOnly
Object.toString()
public boolean isDBCSAlternateTypeField()
IISeriesHostDatabaseField
isDBCSAlternateTypeField
in interface IISeriesHostDatabaseField
IISeriesHostDatabaseField.isDBCSAlternateTypeField()
public boolean isDBCSColumnHeadings()
IISeriesHostDatabaseField
isDBCSColumnHeadings
in interface IISeriesHostDatabaseField
IISeriesHostDatabaseField.isDBCSColumnHeadings()
public boolean isDBCSTextDescription()
IISeriesHostDatabaseField
isDBCSTextDescription
in interface IISeriesHostDatabaseField
IISeriesHostDatabaseField.isDBCSTextDescription()
public boolean isDBCSValidityCheckingLiterals()
IISeriesHostDatabaseField
isDBCSValidityCheckingLiterals
in interface IISeriesHostDatabaseField
IISeriesHostDatabaseField.isDBCSValidityCheckingLiterals()
public void setDBCSAlternateTypeField(boolean flag)
IISeriesHostDatabaseField
setDBCSAlternateTypeField
in interface IISeriesHostDatabaseField
IISeriesHostDatabaseField.setDBCSAlternateTypeField(boolean)
public void setDBCSColumnHeadings(boolean flag)
IISeriesHostDatabaseField
setDBCSColumnHeadings
in interface IISeriesHostDatabaseField
IISeriesHostDatabaseField.setDBCSColumnHeadings(boolean)
public void setDBCSTextDescription(boolean flag)
IISeriesHostDatabaseField
setDBCSTextDescription
in interface IISeriesHostDatabaseField
IISeriesHostDatabaseField.setDBCSTextDescription(boolean)
public void setDBCSValidityCheckingLiterals(boolean flag)
IISeriesHostDatabaseField
setDBCSValidityCheckingLiterals
in interface IISeriesHostDatabaseField
IISeriesHostDatabaseField.setDBCSValidityCheckingLiterals(boolean)
public void setDerivedOperator(byte operator)
IISeriesHostDatabaseField
setDerivedOperator
in interface IISeriesHostDatabaseField
IISeriesHostDatabaseField.setDerivedOperator(byte)
public void setReferencedField(String referencedField)
IISeriesHostDatabaseField
setReferencedField
in interface IISeriesHostDatabaseField
IISeriesHostDatabaseField.setReferencedField(String)
public void setSubstringEnd(int end)
IISeriesHostDatabaseField
setSubstringEnd
in interface IISeriesHostDatabaseField
IISeriesHostDatabaseField.setSubstringEnd(int)
public void setSubstringStart(int start)
IISeriesHostDatabaseField
setSubstringStart
in interface IISeriesHostDatabaseField
IISeriesHostDatabaseField.setSubstringStart(int)
public byte getDerivedOperator()
IISeriesHostDatabaseField
getDerivedOperator
in interface IISeriesHostDatabaseField
IISeriesHostDatabaseField.getDerivedOperator()
public String getReferencedField()
IISeriesHostDatabaseField
getReferencedField
in interface IISeriesHostDatabaseField
IISeriesHostDatabaseField.getReferencedField()
public int getSubstringEnd()
IISeriesHostDatabaseField
getSubstringEnd
in interface IISeriesHostDatabaseField
IISeriesHostDatabaseField.getSubstringEnd()
public int getSubstringStart()
IISeriesHostDatabaseField
getSubstringStart
in interface IISeriesHostDatabaseField
IISeriesHostDatabaseField.getSubstringStart()
public int getDTFlags()
IISeriesHostDatabaseField
getDTFlags
in interface IISeriesHostDatabaseField
IISeriesHostDatabaseField.getDTFlags()
public void setDTFlags(int flag)
IISeriesHostDatabaseField
setDTFlags
in interface IISeriesHostDatabaseField
IISeriesHostDatabaseField.setDTFlags(int)
public int getDisplayLength()
IISeriesHostDatabaseField
getDisplayLength
in interface IISeriesHostDatabaseField
public boolean isConvertUCS2()
IISeriesHostDatabaseField
isConvertUCS2
in interface IISeriesHostDatabaseField
public boolean isMinimumDisplayLength()
IISeriesHostDatabaseField
isMinimumDisplayLength
in interface IISeriesHostDatabaseField
public boolean isDisplayLengthSpecified()
IISeriesHostDatabaseField
isDisplayLengthSpecified
in interface IISeriesHostDatabaseField
public int getEncodingScheme()
IISeriesHostDatabaseField
getEncodingScheme
in interface IISeriesHostDatabaseField
public void setDisplayLength(int length)
IISeriesHostDatabaseField
setDisplayLength
in interface IISeriesHostDatabaseField
public void setIsConvertUCS2(boolean convert)
IISeriesHostDatabaseField
setIsConvertUCS2
in interface IISeriesHostDatabaseField
public void setIsMinimumDisplayLength(boolean value)
IISeriesHostDatabaseField
setIsMinimumDisplayLength
in interface IISeriesHostDatabaseField
public void setIsDisplayLengthSpecified(boolean value)
IISeriesHostDatabaseField
setIsDisplayLengthSpecified
in interface IISeriesHostDatabaseField
public void setEncodingScheme(int encodingScheme)
IISeriesHostDatabaseField
setEncodingScheme
in interface IISeriesHostDatabaseField
|
Rational Developer for Power Systems Software V7.6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |