|
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||
Encapsulates the meta-data of either a parameter list, a structure, or a table. Each element of meta-data describes a field of a parameter list, a field of a structure, or a column of a table in terms of name, type, length, etc. Meta-data objects are used to create parameter list, structures, or tables of a certain layout.
JCO.ParameterList,
JCO.Structure,
JCO.Table| Field Summary | |
static int |
EXPORT_PARAMETER
Flag that indicates a export parameter |
static int |
IMPORT_PARAMETER
Flag that indicates a import parameter |
static int |
INACTIVE_PARAMETER
Flag that indicates that the parameter is being excluded from a call |
static int |
NESTED_TYPE1_STRUCTURE
Flag that indicates a nested TYPE1 structure, i.e. a structure with a fixed length in memory, but a nested layout |
static int |
OPTIONAL_PARAMETER
Flag that indicates a export parameter |
static int |
TYPE_BCD
Packed BCD number, any length between 1 and 16 bytes. |
static int |
TYPE_BYTE
Raw data, binary, fixed length, zero padded. |
static int |
TYPE_CHAR
1-byte or multibyte character.Fixed sized, blank padded. |
static int |
TYPE_DATE
Date ( YYYYYMMDD ). |
static int |
TYPE_EXCEPTION
ABAP exception. |
static int |
TYPE_FLOAT
Floating point,double precission. |
static int |
TYPE_INT
4-byte integer . |
static int |
TYPE_INT1
1-byte integer . |
static int |
TYPE_INT2
2-byte integer . |
static int |
TYPE_INVALID
The field info does not contain a valid JCO type |
static int |
TYPE_ITAB
Internal table. |
static int |
TYPE_NUM
Digits, fixed size,'0' padded. |
static int |
TYPE_STRING
UTF8 encoded string of variable length. |
static int |
TYPE_STRUCTURE
A heterogeneous structure. |
static int |
TYPE_TABLE
A Table. |
static int |
TYPE_TIME
Time (HHMMSS). |
static int |
TYPE_XSTRING
Byte array of variable length. |
static int |
UNINITIALIZED
The field info was not initialized yet |
static int |
UNINITIALIZED_PARAMETER
Flag that indicates a uninitialized parameter |
| Method Summary | |
void |
addInfo(java.lang.String name,
int type,
int length,
int offset,
int decimals,
int flags,
java.lang.Object tab_meta_data)
Adds a new field descriptor to the meta-data object |
void |
addInfo(java.lang.String name,
int type,
int length,
int offset,
int decimals,
java.lang.String defaults,
java.lang.String description,
int flags,
java.lang.Object tab_meta_data,
com.sap.mw.jco.IExtendedFieldMetaData extended)
Adds a new field descriptor to the meta-data object |
java.lang.Object |
clone()
Creates an returns a copy of the IMetaData object. |
int |
getDecimals(int index)
Returns the number of decimals of the data field at the specified index Decimals are only necessary for the JCO data types TYPE_BCD and TYPE_FLOAT, respectively. |
int |
getDecimals(java.lang.String field_name)
Returns the number of decimals for the field with the specified name Decimals are only necessary for the JCO data types TYPE_BCD and TYPE_FLOAT, respectively. |
java.lang.String |
getDefault(int index)
Returns the default value of the data field at the specified index |
java.lang.String |
getDefault(java.lang.String field_name)
Returns the default value for the field with the specified name |
java.lang.String |
getDescription(int index)
Returns the descriptional text of the data field at the specified index |
java.lang.String |
getDescription(java.lang.String field_name)
Returns the descriptional text for the field with the specified name |
com.sap.mw.jco.IExtendedFieldMetaData |
getExtendedFieldMetaData(int index)
Returns the extended field meta-data object at the specified index |
com.sap.mw.jco.IExtendedFieldMetaData |
getExtendedFieldMetaData(java.lang.String field_name)
Returns the extended meta-data object for the field with the specified name |
int |
getFieldCount()
Returns the number of entries (fields) |
int |
getInternalLength(int index)
Returns the internal length of the data field at the specified index |
int |
getInternalLength(java.lang.String field_name)
Returns the internal length of the field with the specified name |
int |
getLength(int index)
Returns the length of the data field at the specified index |
int |
getLength(java.lang.String field_name)
Returns the length of the field with the specified name |
IMetaData |
getMetaData(int index)
Returns the meta-data if the specified data field is a table or structure. |
IMetaData |
getMetaData(java.lang.String field_name)
Returns the meta-data if the specified data field is a table or structure. |
java.lang.String |
getName()
Returns the name of the table/structure this meta-data describes |
java.lang.String |
getName(int index)
Returns the field name of the data field at the specified index The field name is used for identfying a field in a structure or table row. |
int |
getOffset(int index)
Deprecated. only used for internal purposes |
int |
getOffset(java.lang.String field_name)
Deprecated. only used for internal purposes |
int |
getTabLength()
Returns the total length of a structure or single row of a table. |
java.lang.String |
getTabName(int index)
Returns the table/structure name of the data field or null if no table name is available |
java.lang.String |
getTabName(java.lang.String field_name)
Returns the table/structure name of the data field or null if no table name is available |
int |
getType(int index)
Returns the JCO type of the data field at the specified index |
int |
getType(java.lang.String field_name)
Returns the type of the data for the field with the specified name |
java.lang.String |
getTypeAsString(int index)
Returns the type of the data field at the specified index |
java.lang.String |
getTypeAsString(java.lang.String field_name)
Returns the type of the data field for the field with the specified name |
boolean |
hasField(java.lang.String name)
Checks whether a named field exists |
int |
indexOf(java.lang.String name)
Returns the index of the named field info |
boolean |
isException(int index)
Checks whether this field is a exception |
boolean |
isException(java.lang.String field_name)
Checks whether this field with the specified name is a exception |
boolean |
isExport(int index)
Checks whether the field at the specified index is an export parameter |
boolean |
isExport(java.lang.String field_name)
Checks whether the field with the specified name is an export parameter |
boolean |
isImport(int index)
Checks whether the field at the specified index is an import parameter |
boolean |
isImport(java.lang.String field_name)
Checks whether the field with the specified name is an import parameter |
boolean |
isNestedType1Structure()
Checks whether this IMetaData is a nested TYPE1 structure, which is a structure with a fixed length in memory, but with a nested layout |
boolean |
isNestedType1Structure(int index)
Checks whether the field at the specified index is a nested TYPE1 structure, which is a structure with a fixed length in memory, but with a nested layout |
boolean |
isNestedType1Structure(java.lang.String field_name)
Checks whether the field with the specified name is a nested TYPE1 structure, which is a structure with a fixed length in memory, but with a nested layout |
boolean |
isOptional(int index)
Checks whether the field at the specified index is an optional parameter |
boolean |
isOptional(java.lang.String field_name)
Checks whether the field with the specified name is an optional parameter |
boolean |
isStructure(int index)
Checks whether the field at the specified index is a structure parameter |
boolean |
isStructure(java.lang.String field_name)
Checks whether the field with the specified name is a structure parameter |
boolean |
isTable(int index)
Checks whether the field is a table parameter |
boolean |
isTable(java.lang.String field_name)
Checks whether the field with the specified name is a table parameter |
java.lang.String |
toString()
Returns a string representation of the meta-data |
| Field Detail |
public static final int UNINITIALIZED
public static final int TYPE_INVALID
public static final int TYPE_CHAR
public static final int TYPE_DATE
public static final int TYPE_BCD
public static final int TYPE_TIME
public static final int TYPE_BYTE
public static final int TYPE_ITAB
public static final int TYPE_NUM
public static final int TYPE_FLOAT
public static final int TYPE_INT
public static final int TYPE_INT2
public static final int TYPE_INT1
public static final int TYPE_STRUCTURE
public static final int TYPE_STRING
public static final int TYPE_XSTRING
public static final int TYPE_TABLE
public static final int TYPE_EXCEPTION
public static final int IMPORT_PARAMETER
public static final int EXPORT_PARAMETER
public static final int OPTIONAL_PARAMETER
public static final int UNINITIALIZED_PARAMETER
public static final int INACTIVE_PARAMETER
public static final int NESTED_TYPE1_STRUCTURE
| Method Detail |
public java.lang.Object clone()
public int indexOf(java.lang.String name)
name - the name of the field for which the index is being returnedJCO.Exception - if the field could not be foundpublic boolean hasField(java.lang.String name)
name - the name of the field to check for existencetrue if the field with the specified name exist,
false otherwisepublic java.lang.String getName()
index - the index of the fieldpublic int getFieldCount()
public void addInfo(java.lang.String name,
int type,
int length,
int offset,
int decimals,
int flags,
java.lang.Object tab_meta_data)
name - Field name for identifying this data fieldtype - Data field typelength - Data field length in bytesoffset - Data field offset in the internal JCO data bufferdecimals - Data field number of decimals (only necessary for the data types TYPE_BCD and TYPE_FLOAT)flags - Bit-vector for additional attributes of the field. The vector can be ORed together from| Flag | Description |
|---|---|
| IMPORT_PARAMETER | The field is an import parameter |
| EXPORT_PARAMETER | The field is an export parameter |
| OPTIONAL_PARAMETER | The field is an optional parameter |
| INACTIVATE_PARAMETER | Only used for table parameters, indicating that the content of the table will not be sent to the server |
| NESTED_TYPE1_STRUCTURE | The field is a nested TYPE1 structure, i.e. a structure with a fixed length in memory, but not a flat layout |
tab_meta - meta-data if the field is a complex field, i.e. structure or table, null otherwise
public void addInfo(java.lang.String name,
int type,
int length,
int offset,
int decimals,
java.lang.String defaults,
java.lang.String description,
int flags,
java.lang.Object tab_meta_data,
com.sap.mw.jco.IExtendedFieldMetaData extended)
name - Field name for identifying this data fieldtype - Data field typelength - Data field length in bytesoffset - Data field offset in the internal JCO data bufferdecimals - Data field number of decimals (only necessary for the data types TYPE_BCD and TYPE_FLOAT)sdefault - Data Field default valuedescription - Descriptional text of the data fieldflags - Bit-vector for additional attributes of the field. The vector can be ORed together from| Flag | Description |
|---|---|
| IMPORT_PARAMETER | The field is an import parameter |
| EXPORT_PARAMETER | The field is an export parameter |
| OPTIONAL_PARAMETER | The field is an optional parameter |
| INACTIVATE_PARAMETER | Only used for table parameters, indicating that the content of the table will not be sent to the server |
| NESTED_TYPE1_STRUCTURE | The field is a nested TYPE1 structure, i.e. a structure with a fixed length in memory, but not a flat layout |
tab_meta - meta-data if the field is a complex field, i.e. structure or table, null otherwiseextented - extended meta-data for this field or null if none available.public java.lang.String getName(int index)
index - the index of the fieldpublic java.lang.String getTabName(int index)
null if no table name is availableindex - the index of the fieldpublic java.lang.String getTabName(java.lang.String field_name)
null if no table name is availablefield_name - the name of the fieldpublic IMetaData getMetaData(int index)
null if no meta-data are availableindex - the index of the fieldnullpublic IMetaData getMetaData(java.lang.String field_name)
null if no meta-data are availablefield_name - the name of the fieldnullpublic com.sap.mw.jco.IExtendedFieldMetaData getExtendedFieldMetaData(int index)
index - the index of the fieldnull if not availablepublic com.sap.mw.jco.IExtendedFieldMetaData getExtendedFieldMetaData(java.lang.String field_name)
field_name - the name of the fieldnull if not availablepublic int getLength(int index)
index - the index of the fieldpublic int getLength(java.lang.String field_name)
field_name - the name of the fieldpublic int getInternalLength(int index)
index - the index of the fieldpublic int getInternalLength(java.lang.String field_name)
field_name - the name of the fieldpublic int getOffset(int index)
index - the index of the fieldpublic int getOffset(java.lang.String field_name)
field_name - the name of the fieldpublic int getType(int index)
index - the index of the fieldpublic int getType(java.lang.String field_name)
field_name - the name of the fieldpublic java.lang.String getTypeAsString(int index)
index - the index of the fieldpublic java.lang.String getTypeAsString(java.lang.String field_name)
field_name - the name of the fieldpublic int getDecimals(int index)
index - the index of the fieldpublic int getDecimals(java.lang.String field_name)
field_name - the name of the fieldpublic java.lang.String getDefault(int index)
index - the index of the fieldpublic java.lang.String getDefault(java.lang.String field_name)
field_name - the name of the fieldpublic java.lang.String getDescription(int index)
index - the index of the fieldpublic java.lang.String getDescription(java.lang.String field_name)
field_name - the name of the fieldpublic boolean isOptional(int index)
index - the index of the fieldtrue if the specified field is an optional parameter, false otherwisepublic boolean isOptional(java.lang.String field_name)
field_name - the name of the fieldtrue if the specified field is an optional parameter, false otherwisepublic boolean isImport(int index)
index - the index of the fieldtrue if the specified field is an import parameter, false otherwisepublic boolean isImport(java.lang.String field_name)
field_name - the name of the fieldtrue if the specified field is an import parameter, false otherwisepublic boolean isExport(int index)
index - the index of the fieldtrue if the specified field is an export parameter, false otherwisepublic boolean isExport(java.lang.String field_name)
field_name - the name of the fieldtrue if the specified field is an export parameter, false otherwisepublic boolean isStructure(int index)
index - the index of the fieldtrue if the specified field is a structure parameter, false otherwisepublic boolean isStructure(java.lang.String field_name)
field_name - the name of the fieldtrue if the specified field is a structure parameter, false otherwisepublic boolean isNestedType1Structure(int index)
index - the index of the fieldtrue if the specified field is a nested TYPE1 structure, false otherwisepublic boolean isNestedType1Structure(java.lang.String field_name)
field_name - the name of the fieldtrue if the specified field is a nested TYPE1 structure, false otherwisepublic boolean isTable(int index)
index - the index of the fieldtrue if the specified field is a table parameter, false otherwisepublic boolean isTable(java.lang.String field_name)
field_name - the name of the fieldtrue if the specified field is a table parameter, false otherwisepublic boolean isException(int index)
index - the index of the fieldtrue if the specified field is an exception, false otherwisepublic boolean isException(java.lang.String field_name)
field_name - the name of the fieldtrue if the specified field is an exception, false otherwisepublic int getTabLength()
public boolean isNestedType1Structure()
field_name - the name of the fieldtrue if the IMetaData is a nested TYPE1 structure, false otherwisepublic java.lang.String toString()
toString in class java.lang.Object
|
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||