|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface JCoRecord
Base interface for all data containers used throughout the JCo framework.
Implementations take care of internal bookkeeping of buffers, metadata, etc.
In addition it provides a rich set of get/set methods which
allow a convenient access to the individual fields that make up
a record. Getter and setter methods support conversion of field values
which are summarized by the following table:
Getter-Method / Datatype | JCoMetaData.TYPE_CHAR | JCoMetaData.TYPE_INT1 | JCoMetaData.TYPE_INT2 | JCoMetaData.TYPE_INT | JCoMetaData.TYPE_NUM | JCoMetaData.TYPE_BCD | JCoMetaData.TYPE_FLOAT | JCoMetaData.TYPE_BYTE | JCoMetaData.TYPE_DATE | JCoMetaData.TYPE_TIME | JCoMetaData.TYPE_STRING | JCoMetaData.TYPE_XSTRING | JCoMetaData.TYPE_DECF16 | JCoMetaData.TYPE_DECF34 | JCoMetaData.TYPE_STRUCTURE | JCoMetaData.TYPE_TABLE |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
java.lang.Object getValue() | String | Integer | Integer | Integer | String | BigDecimal | Double | byte[] | Date | Date | String | byte[] | BigDecimal | BigDecimal | JCoStructure | JCoTable |
java.lang.String getString() | String | String | String | String | String | String | String | String (hexadecimal) | String | String | String | String (hexadecimal) | String | String | String (structure name) | String (table name) |
char getChar() | char | --- | --- | --- | --- | --- | --- | --- | --- | --- | char | --- | --- | --- | --- | --- |
char[] getCharArray() | char[] | --- | --- | --- | char[] | --- | --- | --- | char[] | char[] | char[] | --- | --- | --- | --- | --- |
byte getByte() | byte | byte | byte | byte | byte | --- | --- | byte | --- | --- | byte | byte | --- | --- | --- | --- |
short getShort() | short | short | short | short | short | --- | --- | short | --- | --- | short | short | --- | --- | --- | --- |
int getInt() | int | int | int | int | int | --- | --- | int | --- | --- | int | int | --- | --- | --- | --- |
long getLong() | long | long | long | long | long | --- | --- | long | --- | --- | long | long | --- | --- | --- | --- |
java.math.BigInteger getBigInteger() | BigInteger | BigInteger | BigInteger | BigInteger | BigInteger | BigInteger | --- | --- | --- | --- | BigInteger | --- | --- | --- | --- | --- |
double getFloat() | float | float | float | float | float | float | float | --- | --- | --- | float | --- | --- | --- | --- | --- |
double getDouble() | double | double | double | double | double | double | double | --- | --- | --- | double | --- | --- | --- | --- | --- |
java.math.BigDecimal getBigDecimal() | BigDecimal | BigDecimal | BigDecimal | BigDecimal | BigDecimal | BigDecimal | BigDecimal | --- | --- | --- | BigDecimal | --- | BigDecimal | BigDecimal | --- | --- |
java.util.Date getDate() | Date | --- | --- | --- | --- | --- | --- | --- | Date | Date | Date | --- | --- | --- | --- | --- |
java.util.Date getTime() | Date | --- | --- | --- | --- | --- | --- | --- | Date | Date | Date | --- | --- | --- | --- | --- |
byte[] getByteArray() | byte[] | --- | --- | --- | --- | --- | --- | byte[] | --- | --- | byte[] | byte[] | byte[] | byte[] | --- | --- |
java.io.InputStream getBinaryStream() | InputStream | --- | --- | --- | --- | --- | --- | InputStream | --- | --- | InputStream | InputStream | --- | --- | --- | --- |
java.io.Reader getCharacterStream() | Reader | --- | --- | --- | --- | --- | --- | --- | --- | --- | Reader | --- | --- | --- | --- | --- |
com.sap.conn.jco.JCoStructure getStructure() | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | JCoStructure | --- |
com.sap.conn.jco.JCoTable getTable() | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | JCoTable |
Method Summary | |
---|---|
void |
clear()
Clears the record and resets everything to its initial state. |
java.lang.Object |
clone()
Clones the record instance. |
int |
copyFrom(JCoRecord source)
Copies the matching fields from the source record into this record. |
JCoAbapObject |
getAbapObject(int index)
Returns the value of the specified field as a JCoAbapObject . |
JCoAbapObject |
getAbapObject(java.lang.String fieldName)
Returns the value of the specified field as a JCoAbapObject . |
java.math.BigDecimal |
getBigDecimal(int index)
Returns the value of the i'th field as a BigDecimal object. |
java.math.BigDecimal |
getBigDecimal(java.lang.String fieldName)
Returns the value of the i'th field as a BigDecimal object. |
java.math.BigInteger |
getBigInteger(int index)
Returns the value of the i'th field as a BigInteger object. |
java.math.BigInteger |
getBigInteger(java.lang.String fieldName)
Returns the value of the i'th field as a BigInteger object. |
java.io.InputStream |
getBinaryStream(int index)
Returns the value of the i'th field as a stream of uninterpreted bytes in form of a java.io.InputStream object. |
java.io.InputStream |
getBinaryStream(java.lang.String fieldName)
Returns the value of the named field as a stream of uninterpreted bytes in form of a java.io.InputStream object. |
byte |
getByte(int index)
Returns the value of the i'th field as a byte. |
byte |
getByte(java.lang.String fieldName)
Returns the value of the named field as a byte. |
byte[] |
getByteArray(int index)
Returns the value of the i'th field as a byte array. |
byte[] |
getByteArray(java.lang.String fieldName)
Returns the value of the named field as a byte array. |
char |
getChar(int index)
Returns the value of the i'th field as a char. |
char |
getChar(java.lang.String fieldName)
Returns the value of the named field as a char. |
java.io.Reader |
getCharacterStream(int index)
Returns the value of the i'th field as a java.io.Reader object. |
java.io.Reader |
getCharacterStream(java.lang.String fieldName)
Returns the value of the named field as a stream of characters in form of a java.io.Reader object. |
char[] |
getCharArray(int index)
Returns the value of the i'th field as a char array. |
char[] |
getCharArray(java.lang.String fieldName)
Returns the value of the named field as a char array. |
java.lang.String |
getClassNameOfValue(java.lang.String fieldName)
Returns the fully qualified name of the Java class whose instances are manufactured if the methods getValue(int index) or getValue(String fieldName) are called to retrieve a value from the field. |
java.util.Date |
getDate(int index)
Returns the value of the i'th field as a Date object. |
java.util.Date |
getDate(java.lang.String fieldName)
Returns the value of the named field as a Date object. |
double |
getDouble(int index)
Returns the value of the i'th field as a double. |
double |
getDouble(java.lang.String fieldName)
Returns the value of the named field as a double. |
int |
getFieldCount()
Returns the number of fields in this container. |
JCoFieldIterator |
getFieldIterator()
Returns a JCoFieldIterator. |
float |
getFloat(int index)
Returns the value of the i'th field as a float. |
float |
getFloat(java.lang.String fieldName)
Returns the value of the named field as a float. |
int |
getInt(int index)
Returns the value of the i'th field as an integer. |
int |
getInt(java.lang.String fieldName)
Returns the value of the named field as an integer. |
long |
getLong(int index)
Returns the value of the i'th field as a long. |
long |
getLong(java.lang.String fieldName)
Returns the value of the named field as a long. |
JCoMetaData |
getMetaData()
Returns the appropriated metadata object that was used for creation of this record. |
short |
getShort(int index)
Returns the value of the i'th field as a short. |
short |
getShort(java.lang.String fieldName)
Returns the value of the named field as a short. |
java.lang.String |
getString(int index)
Returns the value of the i'th field as a String. |
java.lang.String |
getString(java.lang.String fieldName)
Returns the value of the named field as a String object. |
JCoStructure |
getStructure(int index)
Returns the value of the i'th field as a JCoStructure. |
JCoStructure |
getStructure(java.lang.String fieldName)
Returns the value of the named field as a JCoStructure object. |
JCoTable |
getTable(int index)
Returns the value of the i'th field as a table. |
JCoTable |
getTable(java.lang.String fieldName)
Returns the value of the named field as a JCoTable object. |
java.util.Date |
getTime(int index)
Returns the value of the i'th field as a Date object. |
java.util.Date |
getTime(java.lang.String fieldName)
Returns the value of the named field as a Date object. |
java.lang.Object |
getValue(int index)
Generic method that returns the value of the i'th field as an object. |
java.lang.Object |
getValue(java.lang.String fieldName)
Returns the value of the named field as an object. |
boolean |
isInitialized(int index)
Checks whether this field has been initialized. |
boolean |
isInitialized(java.lang.String fieldName)
Checks whether this field has been initialized. |
java.util.Iterator<JCoField> |
iterator()
Returns an Iterator. |
void |
setValue(int index,
java.math.BigDecimal value)
Sets the BigDecimal as the value for the i'th field. |
void |
setValue(int index,
byte value)
Sets the byte as the value for the i'th field. |
void |
setValue(int index,
byte[] value)
Sets the byte array as the value for the i'th field. |
void |
setValue(int index,
char value)
Sets the specified character as the field's value. |
void |
setValue(int index,
char[] value)
Sets the specified character array as the field's value. |
void |
setValue(int index,
char[] value,
int from,
int length)
Sets a sequence of characters from the specified character array as the field's value. |
void |
setValue(int index,
double value)
Sets the double as the value for the i'th field. |
void |
setValue(int index,
float value)
Sets the float as the value for the i'th field. |
void |
setValue(int index,
int value)
Sets the int as the value for the i'th field. |
void |
setValue(int index,
JCoAbapObject abapObject)
Sets the value of the specified field to be the given JCoAbapObject . |
void |
setValue(int index,
JCoStructure value)
Sets the structure as the value for the i'th field. |
void |
setValue(int index,
JCoTable value)
Sets the table as the value for the i'th field. |
void |
setValue(int index,
long value)
Sets the long as the value for the i'th field. |
void |
setValue(int index,
java.lang.Object value)
Sets the object as the value for the i'th field. |
void |
setValue(int index,
short value)
Sets the short as the value for the i'th field. |
void |
setValue(int index,
java.lang.String value)
Sets the specified string as the field's value. |
void |
setValue(java.lang.String name,
java.math.BigDecimal value)
Sets the BigDecimal as the value for the named field. |
void |
setValue(java.lang.String name,
byte value)
Sets the byte as the value for the named field. |
void |
setValue(java.lang.String name,
byte[] value)
Sets the byte array as the value for the named field. |
void |
setValue(java.lang.String name,
char value)
Sets the character as the value for the named field. |
void |
setValue(java.lang.String name,
char[] value)
Sets the specified character array as the value for the named field. |
void |
setValue(java.lang.String name,
char[] value,
int from,
int length)
Sets a sequence of characters from the specified character array as the value for the named field. |
void |
setValue(java.lang.String name,
double value)
Sets the double as the value for the named field. |
void |
setValue(java.lang.String name,
float value)
Sets the float as the value for the named field. |
void |
setValue(java.lang.String name,
int value)
Sets the int as the value for the named field. |
void |
setValue(java.lang.String fieldName,
JCoAbapObject abapObject)
Sets the value of the specified field to be the given JCoAbapObject . |
void |
setValue(java.lang.String name,
JCoStructure value)
Sets the structure as the value for the named field. |
void |
setValue(java.lang.String name,
JCoTable value)
Sets the table as the value for the named field. |
void |
setValue(java.lang.String name,
long value)
Sets the long as the value for the named field. |
void |
setValue(java.lang.String name,
java.lang.Object value)
Sets the object as the value for the named field. |
void |
setValue(java.lang.String name,
short value)
Sets the short as the value for the named field. |
void |
setValue(java.lang.String name,
java.lang.String value)
Sets the string as the value for the named field. |
java.lang.String |
toXML()
Returns the whole record in XML format. |
java.lang.String |
toXML(int index)
Returns the value of the i'th field as an XML string. |
java.lang.String |
toXML(java.lang.String fieldName)
Returns the value of named field as an XML string. |
java.io.Writer |
write(int index,
java.io.Writer writer)
Writes the field specified by the index to the provided Writer. |
java.io.Writer |
write(java.lang.String fieldName,
java.io.Writer writer)
Writes the named field to the provided Writer. |
Method Detail |
---|
JCoMetaData getMetaData()
void clear()
java.lang.Object clone()
int copyFrom(JCoRecord source)
source
- the source record from which to copy the data
JCoRuntimeException
- if something went wrongint getFieldCount()
java.lang.Object getValue(int index)
Field datatype | Object |
---|---|
JCoMetaData.TYPE_CHAR | java.lang.String |
JCoMetaData.TYPE_INT1 | java.lang.Integer |
JCoMetaData.TYPE_INT2 | java.lang.Integer |
JCoMetaData.TYPE_INT | java.lang.Integer |
JCoMetaData.TYPE_NUM | java.lang.String |
JCoMetaData.TYPE_BCD | java.math.BigDecimal |
JCoMetaData.TYPE_FLOAT | java.lang.Double |
JCoMetaData.TYPE_BYTE | byte[] |
JCoMetaData.TYPE_DATE | java.util.Date |
JCoMetaData.TYPE_TIME | java.util.Date |
JCoMetaData.TYPE_STRING | java.lang.String |
JCoMetaData.TYPE_XSTRING | byte[] |
JCoMetaData.TYPE_DECF16 | java.math.BigDecimal |
JCoMetaData.TYPE_DECF34 | java.math.BigDecimal |
JCoMetaData.TYPE_STRUCTURE | com.sap.conn.jco.JCoStructure |
JCoMetaData.TYPE_TABLE | com.sap.conn.jco.JCoTable |
JCoMetaData.TYPE_ABAPOBJECT | com.sap.conn.jco.JCoAbapObject |
index
- the field index
ConversionException
- thrown if the value could not be converted to an object
java.lang.IndexOutOfBoundsException
- thrown if the index is out of rangejava.lang.Object getValue(java.lang.String fieldName)
Field datatype | Object |
---|---|
JCoMetaData.TYPE_CHAR | java.lang.String |
JCoMetaData.TYPE_INT1 | java.lang.Integer |
JCoMetaData.TYPE_INT2 | java.lang.Integer |
JCoMetaData.TYPE_INT | java.lang.Integer |
JCoMetaData.TYPE_NUM | java.lang.String |
JCoMetaData.TYPE_BCD | java.math.BigDecimal |
JCoMetaData.TYPE_FLOAT | java.lang.Double |
JCoMetaData.TYPE_BYTE | byte[] |
JCoMetaData.TYPE_DATE | java.util.Date |
JCoMetaData.TYPE_TIME | java.util.Date |
JCoMetaData.TYPE_STRING | java.lang.String |
JCoMetaData.TYPE_XSTRING | byte[] |
JCoMetaData.TYPE_DECF16 | java.math.BigDecimal |
JCoMetaData.TYPE_DECF34 | java.math.BigDecimal |
JCoMetaData.TYPE_STRUCTURE | com.sap.conn.jco.JCoStructure |
JCoMetaData.TYPE_TABLE | com.sap.conn.jco.JCoTable |
JCoMetaData.TYPE_ABAPOBJECT | com.sap.conn.jco.JCoAbapObject |
fieldName
- the name of the field
ConversionException
- thrown if the value could not be converted to an object
JCoRuntimeException
- thrown with group JCO_ERROR_FIELD_NOT_FOUND if a field with the specified name does not existjava.lang.String getString(int index)
Note: If the data type of the field is TYPE_CHAR, this method trims all trailing blanks from the returned string. For the data types TYPE_DATE and TYPE_TIME the returned date and time strings are formatted using the patterns "yyyy-MM-dd" and "HH:mm:ss", respectively.
index
- the index of the field
ConversionException
- thrown if the value could not be converted to a String
java.lang.IndexOutOfBoundsException
- thrown if the index is out of rangejava.lang.String getString(java.lang.String fieldName)
Note: If the datatype of the field is TYPE_CHAR, this method trims all trailing blanks from the returned string. For the datatypes TYPE_DATE and TYPE_TIME the returned date and time strings are formatted using the patterns "yyyy-MM-dd" and "HH:mm:ss", respectively.
fieldName
- the name of the field
ConversionException
- thrown if the value could not be converted to a String
JCoRuntimeException
- thrown with group JCO_ERROR_FIELD_NOT_FOUND if a field with the specified name does not existchar getChar(int index)
index
- the index of the field
ConversionException
- thrown if the value could not be converted to a char,
i.e. if the underlying field contained more than one character
java.lang.IndexOutOfBoundsException
- thrown if the index is out of rangechar getChar(java.lang.String fieldName)
fieldName
- the name of the field
ConversionException
- thrown if the value could not be converted to a char
JCoRuntimeException
- thrown with group JCO_ERROR_FIELD_NOT_FOUND if a field with the specified name does not existchar[] getCharArray(int index)
Note: In contrast to getString(int index)
this method
does not trim trailing blanks and it does not format date and time fields
with :
or -
separator chars.
index
- the field index
ConversionException
- thrown if the value could not be converted to a char array
java.lang.IndexOutOfBoundsException
- thrown if the index is out of rangechar[] getCharArray(java.lang.String fieldName)
Note: In contrast to getString(String fieldName)
this method
does not trim trailing blanks and it does not format date and time fields
with :
or -
separator chars.
fieldName
- the name of the field
ConversionException
- thrown if the value could not be converted to a char array
JCoRuntimeException
- thrown with group JCO_ERROR_FIELD_NOT_FOUND if a field with the specified name does not existbyte getByte(int index)
index
- the index of the field
ConversionException
- thrown if the value could not be converted to a byte
java.lang.IndexOutOfBoundsException
- thrown if the index is out of rangebyte getByte(java.lang.String fieldName)
fieldName
- the name of the field
ConversionException
- thrown if the value could not be converted to a byte
JCoRuntimeException
- thrown with group JCO_ERROR_FIELD_NOT_FOUND if a field with the specified name does not existbyte[] getByteArray(int index)
index
- the field index
ConversionException
- thrown if the value could not be converted to a byte array
java.lang.IndexOutOfBoundsException
- thrown if the index is out of rangebyte[] getByteArray(java.lang.String fieldName)
fieldName
- the name of the field
ConversionException
- thrown if the value could not be converted to a byte array
JCoRuntimeException
- thrown with group JCO_ERROR_FIELD_NOT_FOUND if a field with the specified name does not existshort getShort(int index)
index
- the index of the field
ConversionException
- thrown if the value could not be converted to a shortshort getShort(java.lang.String fieldName)
fieldName
- the name of the field
ConversionException
- thrown if the value could not be converted to a short
JCoRuntimeException
- thrown with group JCO_ERROR_FIELD_NOT_FOUND if a field with the specified name does not existint getInt(int index)
index
- the index of the field
ConversionException
- thrown if the value could not be converted to an intint getInt(java.lang.String fieldName)
fieldName
- the name of the field
ConversionException
- thrown if the value could not be converted to an int
JCoRuntimeException
- thrown with group JCO_ERROR_FIELD_NOT_FOUND if a field with the specified name does not existlong getLong(int index)
index
- the index of the field
ConversionException
- thrown if the value could not be converted to an long
java.lang.IndexOutOfBoundsException
- thrown if the index is out of rangelong getLong(java.lang.String fieldName)
fieldName
- the name of the field
ConversionException
- thrown if the value could not be converted to a long
JCoRuntimeException
- thrown with group JCO_ERROR_FIELD_NOT_FOUND if a field with the specified name does not existfloat getFloat(int index)
index
- the index of the field
ConversionException
- thrown if the value could not be converted to a floatfloat getFloat(java.lang.String fieldName)
fieldName
- the name of the field
ConversionException
- thrown if the value could not be converted to a float
JCoRuntimeException
- thrown with group JCO_ERROR_FIELD_NOT_FOUND if a field with the specified name does not existdouble getDouble(int index)
index
- the index of the field
ConversionException
- thrown if the value could not be converted to a double
java.lang.IndexOutOfBoundsException
- thrown if the index is out of rangedouble getDouble(java.lang.String fieldName)
fieldName
- the name of the field
ConversionException
- thrown if the value could not be converted to a double
JCoRuntimeException
- thrown with group JCO_ERROR_FIELD_NOT_FOUND if a field with the specified name does not existjava.math.BigInteger getBigInteger(int index)
index
- the index of the field
ConversionException
- thrown if the value could not be converted to a BigInteger
java.lang.IndexOutOfBoundsException
- thrown if the index is out of rangejava.math.BigInteger getBigInteger(java.lang.String fieldName)
fieldName
- the name of the field
ConversionException
- thrown if the value could not be converted to a BigInteger
JCoRuntimeException
- thrown with group JCO_ERROR_FIELD_NOT_FOUND if a field with the specified name does not existjava.math.BigDecimal getBigDecimal(int index)
index
- the index of the field
ConversionException
- thrown if the value could not be converted to a BigDecimal
java.lang.IndexOutOfBoundsException
- thrown if the index is out of rangejava.math.BigDecimal getBigDecimal(java.lang.String fieldName)
fieldName
- the name of the field
ConversionException
- thrown if the value could not be converted to a BigDecimal
JCoRuntimeException
- thrown with group JCO_ERROR_FIELD_NOT_FOUND if a field with the specified name does not existjava.util.Date getDate(int index)
index
- the index of the field
ConversionException
- thrown if the value could not be converted to a Date
java.lang.IndexOutOfBoundsException
- thrown if the index is out of rangejava.util.Date getDate(java.lang.String fieldName)
fieldName
- the name of the field
ConversionException
- thrown if the value could not be converted to a Date
JCoRuntimeException
- thrown with group JCO_ERROR_FIELD_NOT_FOUND if a field with the specified name does not existjava.util.Date getTime(int index)
index
- the index of the field
ConversionException
- thrown if the value could not be converted to a Date
java.lang.IndexOutOfBoundsException
- thrown if the index is out of rangejava.util.Date getTime(java.lang.String fieldName)
fieldName
- the name of the field
ConversionException
- thrown if the value could not be converted to a Date
JCoRuntimeException
- thrown with group JCO_ERROR_FIELD_NOT_FOUND if a field with the specified name does not existjava.io.InputStream getBinaryStream(int index)
index
- the index of the field
ConversionException
- thrown if the value could not be
converted to a java.io.InputStream
java.lang.IndexOutOfBoundsException
- thrown if the index is out of rangejava.io.InputStream getBinaryStream(java.lang.String fieldName)
fieldName
- the name of the field
ConversionException
- thrown if the value could not be converted to a java.io.InputStream
JCoRuntimeException
- thrown with group JCO_ERROR_FIELD_NOT_FOUND if a field with the specified name does not existjava.io.Reader getCharacterStream(int index)
index
- the index of the field
ConversionException
- thrown if the value could not be converted to a java.io.Reader
java.lang.IndexOutOfBoundsException
- thrown if the index is out of rangejava.io.Reader getCharacterStream(java.lang.String fieldName)
fieldName
- the name of the field
ConversionException
- thrown if the value could not be converted to a java.io.Reader
JCoRuntimeException
- thrown with group JCO_ERROR_FIELD_NOT_FOUND if a field with the specified name does not existJCoStructure getStructure(int index)
index
- the index of the field
ConversionException
- thrown if the value could not be converted to a JCoStructure
java.lang.IndexOutOfBoundsException
- thrown if the index is out of rangeJCoStructure
JCoStructure getStructure(java.lang.String fieldName)
fieldName
- the name of the field
ConversionException
- thrown if the value could not be converted to a JCoStructure
JCoRuntimeException
- thrown with group JCO_ERROR_FIELD_NOT_FOUND if a field with the specified name does not existJCoTable getTable(int index)
index
- the index of the field
ConversionException
- thrown if the value could not be converted to a JCoTable
java.lang.IndexOutOfBoundsException
- thrown if the index is out of rangeJCoTable
JCoTable getTable(java.lang.String fieldName)
fieldName
- the name of the field
ConversionException
- thrown if the value could not be converted to a JCoTable
JCoRuntimeException
- thrown with group JCO_ERROR_FIELD_NOT_FOUND if a field with the specified name does not existJCoAbapObject getAbapObject(int index)
JCoAbapObject
.
index
- the index of the field
JCoAbapObject
JCoAbapObject getAbapObject(java.lang.String fieldName)
JCoAbapObject
.
fieldName
- the name of the field
JCoAbapObject
java.lang.String getClassNameOfValue(java.lang.String fieldName)
fieldName
- the name of the field
JCoRuntimeException
- thrown with group JCO_ERROR_FIELD_NOT_FOUND if a field with the specified name does not existvoid setValue(int index, java.lang.String value)
value
- the value to set for the fieldindex
- the index of the field
ConversionException
- thrown if the value could not be converted to its internal representationvoid setValue(java.lang.String name, java.lang.String value)
value
- the value to set for the fieldname
- the name of the field to set
ConversionException
- thrown if the value could not be converted to its internal representation
JCoRuntimeException
- thrown with group JCO_ERROR_FIELD_NOT_FOUND if a field with the specified name does not existvoid setValue(int index, char value)
value
- the value to set for the fieldindex
- the index of the field
java.lang.IndexOutOfBoundsException
- thrown if the index is out of rangevoid setValue(java.lang.String name, char value)
value
- the value to set for the fieldname
- the name of the field to set
ConversionException
- thrown if the value could not be converted to its internal representation
JCoRuntimeException
- thrown with group JCO_ERROR_FIELD_NOT_FOUND if a field with the specified name does not existvoid setValue(int index, char[] value)
value
- the value to set for the fieldindex
- the index of the field
ConversionException
- thrown if the value could not be converted to its internal representation
java.lang.IndexOutOfBoundsException
- thrown if the index is out of rangevoid setValue(java.lang.String name, char[] value)
value
- the value to set for the fieldname
- the name of the field to set
ConversionException
- thrown if the value could not be converted to its internal representation
JCoRuntimeException
- thrown with group JCO_ERROR_FIELD_NOT_FOUND if a field with the specified name does not existvoid setValue(int index, char[] value, int from, int length)
value
- the array to copy the character sequence from for setting the fieldindex
- the index of the fieldfrom
- index of the first character in the char[] to copy fromlength
- the number of characters to copy
ConversionException
- thrown if the value could not be converted to its internal representation
java.lang.IndexOutOfBoundsException
- thrown if the index is out of rangevoid setValue(java.lang.String name, char[] value, int from, int length)
value
- the array to copy the character sequence from for setting the fieldname
- the name of the field to setfrom
- index of the first character in the char[] to copy fromlength
- the number of characters to copy
ConversionException
- thrown if the value could not be converted to its internal representation
JCoRuntimeException
- thrown with group JCO_ERROR_FIELD_NOT_FOUND if a field with the specified name does not existvoid setValue(int index, short value)
value
- the value to set for the fieldindex
- the index of the field
ConversionException
- thrown if the value could not be converted to its internal representation
java.lang.IndexOutOfBoundsException
- thrown if the index is out of rangevoid setValue(java.lang.String name, short value)
value
- the value to set for the fieldname
- the name of the field to set
ConversionException
- thrown if the value could not be converted to its internal representation
JCoRuntimeException
- thrown with group JCO_ERROR_FIELD_NOT_FOUND if a field with the specified name does not existvoid setValue(int index, int value)
value
- the value to set for the fieldindex
- the index of the field
ConversionException
- thrown if the value could not be converted to its internal representation
java.lang.IndexOutOfBoundsException
- thrown if the index is out of rangevoid setValue(java.lang.String name, int value)
value
- the value to set for the fieldname
- the name of the field to set
ConversionException
- thrown if the value could not be converted to its internal representation
JCoRuntimeException
- thrown with group JCO_ERROR_FIELD_NOT_FOUND if a field with the specified name does not existvoid setValue(int index, long value)
value
- the value to set for the fieldindex
- the index of the field
ConversionException
- thrown if the value could not be converted to its internal representation
java.lang.IndexOutOfBoundsException
- thrown if the index is out of rangevoid setValue(java.lang.String name, long value)
value
- the value to set for the fieldname
- the name of the field to set
ConversionException
- thrown if the value could not be converted to its internal representation
JCoRuntimeException
- thrown with group JCO_ERROR_FIELD_NOT_FOUND if a field with the specified name does not existvoid setValue(int index, float value)
value
- the value to set for the fieldindex
- the index of the field
ConversionException
- thrown if the value could not be converted to its internal representation
java.lang.IndexOutOfBoundsException
- thrown if the index is out of rangevoid setValue(java.lang.String name, float value)
value
- the value to set for the fieldname
- the name of the field to set
ConversionException
- thrown if the value could not be converted to its internal representation
JCoRuntimeException
- thrown with group JCO_ERROR_FIELD_NOT_FOUND if a field with the specified name does not existvoid setValue(int index, double value)
value
- the value to set for the fieldindex
- the index of the field
ConversionException
- thrown if the value could not be converted to its internal representation
java.lang.IndexOutOfBoundsException
- thrown if the index is out of rangevoid setValue(java.lang.String name, double value)
value
- the value to set for the fieldname
- the name of the field to set
ConversionException
- thrown if the value could not be converted to its internal representation
JCoRuntimeException
- thrown with group JCO_ERROR_FIELD_NOT_FOUND if a field with the specified name does not existvoid setValue(int index, byte value)
value
- the value to set for the fieldindex
- the index of the field
ConversionException
- thrown if the value could not be converted to its internal representation
java.lang.IndexOutOfBoundsException
- thrown if the index is out of rangevoid setValue(java.lang.String name, byte value)
value
- the value to set for the fieldname
- the name of the field to set
ConversionException
- thrown if the value could not be converted to its internal representation
JCoRuntimeException
- thrown with group JCO_ERROR_FIELD_NOT_FOUND if a field with the specified name does not existvoid setValue(int index, byte[] value)
value
- the value to set for the fieldindex
- the index of the field
ConversionException
- thrown if the value could not be converted to its internal representation
java.lang.IndexOutOfBoundsException
- thrown if the index is out of rangevoid setValue(java.lang.String name, byte[] value)
value
- the value to set for the fieldname
- the name of the field to set
ConversionException
- thrown if the value could not be converted to its internal representation
JCoRuntimeException
- thrown with group JCO_ERROR_FIELD_NOT_FOUND if a field with the specified name does not existvoid setValue(int index, java.math.BigDecimal value)
value
- the value to set for the fieldindex
- the index of the field
ConversionException
- thrown if the value could not be converted to its internal representation
java.lang.IndexOutOfBoundsException
- thrown if the index is out of rangevoid setValue(java.lang.String name, java.math.BigDecimal value)
value
- the value to set for the fieldname
- the name of the field to set
ConversionException
- thrown if the value could not be converted to its internal representation
JCoRuntimeException
- thrown with group JCO_ERROR_FIELD_NOT_FOUND if a field with the specified name does not existvoid setValue(int index, JCoStructure value)
value
- the value to set for the fieldindex
- the index of the field
ConversionException
- thrown if the value could not be converted to its internal representation
java.lang.IndexOutOfBoundsException
- thrown if the index is out of rangevoid setValue(java.lang.String name, JCoStructure value)
value
- the value to set for the fieldname
- the name of the field to set
ConversionException
- thrown if the value could not be converted to its internal representation
JCoRuntimeException
- thrown with group JCO_ERROR_FIELD_NOT_FOUND if a field with the specified name does not existvoid setValue(int index, JCoTable value)
value
- the value to set for the fieldindex
- the index of the field
ConversionException
- thrown if the value could not be converted to its internal representation
java.lang.IndexOutOfBoundsException
- thrown if the index is out of rangevoid setValue(java.lang.String name, JCoTable value)
value
- the value to set for the fieldname
- the name of the field to set
ConversionException
- thrown if the value could not be converted to its internal representation
JCoRuntimeException
- thrown with group JCO_ERROR_FIELD_NOT_FOUND if a field with the specified name does not existvoid setValue(int index, JCoAbapObject abapObject)
JCoAbapObject
.
index
- the index of the fieldabapObject
- the value, a JCoAbapObject
void setValue(java.lang.String fieldName, JCoAbapObject abapObject)
JCoAbapObject
.
fieldName
- the name of the fieldabapObject
- the value, a JCoAbapObject
void setValue(int index, java.lang.Object value)
value
- the value to set for the fieldindex
- the index of the field
ConversionException
- thrown if the value could not be converted to its internal representation
java.lang.IndexOutOfBoundsException
- thrown if the index is out of rangevoid setValue(java.lang.String name, java.lang.Object value)
value
- the value to set for the fieldname
- the name of the field to set
ConversionException
- thrown if the value could not be converted to its internal representation
JCoRuntimeException
- thrown with group JCO_ERROR_FIELD_NOT_FOUND if a field with the specified name does not existboolean isInitialized(int index)
index
- of field that will be checked
java.lang.IndexOutOfBoundsException
- thrown if the index is out of rangeboolean isInitialized(java.lang.String fieldName)
fieldName
- of field that will be checked
JCoRuntimeException
- thrown with group JCO_ERROR_FIELD_NOT_FOUND if a field with the specified name does not existjava.lang.String toXML(int index)
Note:All documents generated here are comply strictly to the encoding scheme as described for the method toXML().
index
- the index of the field
ConversionException
- thrown if the value could not be converted to a String
java.lang.IndexOutOfBoundsException
- thrown if the index is out of rangejava.lang.String toXML(java.lang.String fieldName)
fieldName
- the name of the field
ConversionException
- thrown if the value could not be converted to a String
JCoRuntimeException
- thrown with group JCO_ERROR_FIELD_NOT_FOUND if a field with the specified name does not existjava.lang.String toXML()
Note:All documents generated here are comply strictly to the encoding scheme as described for the method toXML().
ConversionException
- thrown if the value could not be converted to a Stringjava.io.Writer write(int index, java.io.Writer writer) throws java.io.IOException
Field datatype | Output to the Writer instance |
---|---|
JCoMetaData.TYPE_CHAR | char buffer without trailing spaces |
JCoMetaData.TYPE_DATE | chars in format yyyyMMdd |
JCoMetaData.TYPE_TIME | chars in format HHmmss |
JCoMetaData.TYPE_NUM | char buffer |
JCoMetaData.TYPE_STRING | string chars buffer |
JCoMetaData.TYPE_XSTRING | hexadecimal representation of the xstring byte buffer |
JCoMetaData.TYPE_BYTE | hexadecimal representation of the byte buffer |
JCoMetaData.TYPE_BCD | char based representation of the number |
JCoMetaData.TYPE_FLOAT | char based representation of the number |
JCoMetaData.TYPE_INT | char based representation of the number |
JCoMetaData.TYPE_INT2 | char based representation of the number |
JCoMetaData.TYPE_INT1 | char based representation of the number |
JCoMetaData.TYPE_DECF16 | char based representation of the number |
JCoMetaData.TYPE_DECF34 | char based representation of the number |
JCoMetaData.TYPE_STRUCTURE | not possible, exception will be thrown |
JCoMetaData.TYPE_TABLE | not possible, exception will be thrown |
JCoMetaData.TYPE_ABAPOBJECT | not possible, exception will be thrown |
index
- of the field that should be written to outwriter
- writer instance used to write
ConversionException
- if the field is complex
JCoRuntimeException
- with the key JCoException.JCO_ERROR_FIELD_NOT_FOUND if the field with the name is not available
java.io.IOException
- if writer throws IOExceptionjava.io.Writer write(java.lang.String fieldName, java.io.Writer writer) throws java.io.IOException
Field datatype | Output to the Writer instance |
---|---|
JCoMetaData.TYPE_CHAR | char buffer without trailing spaces |
JCoMetaData.TYPE_DATE | chars in format yyyyMMdd |
JCoMetaData.TYPE_TIME | chars in format HHmmss |
JCoMetaData.TYPE_NUM | char buffer |
JCoMetaData.TYPE_STRING | string chars buffer |
JCoMetaData.TYPE_XSTRING | hexadecimal representation of the xstring byte buffer |
JCoMetaData.TYPE_BYTE | hexadecimal representation of the byte buffer |
JCoMetaData.TYPE_BCD | char based representation of the number |
JCoMetaData.TYPE_FLOAT | char based representation of the number |
JCoMetaData.TYPE_INT | char based representation of the number |
JCoMetaData.TYPE_INT2 | char based representation of the number |
JCoMetaData.TYPE_INT1 | char based representation of the number |
JCoMetaData.TYPE_DECF16 | char based representation of the number |
JCoMetaData.TYPE_DECF34 | char based representation of the number |
JCoMetaData.TYPE_STRUCTURE | not possible, exception will be thrown |
JCoMetaData.TYPE_TABLE | not possible, exception will be thrown |
JCoMetaData.TYPE_ABAPOBJECT | not possible, exception will be thrown |
fieldName
- name of the fieldwriter
- write that is used to write operation
ConversionException
- if the field is complex
JCoRuntimeException
- with the key JCoException.JCO_ERROR_FIELD_NOT_FOUND if the field with the name is not available
java.io.IOException
- if writer throws IOExceptionwrite(int, Writer)
java.util.Iterator<JCoField> iterator()
Note: Method remove()
is not supported.
iterator
in interface java.lang.Iterable<JCoField>
JCoFieldIterator getFieldIterator()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |