|
BEA Systems, Inc. | |||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This is the FML interface. Both FML16 and FML32 implement this interface, and hence both types of buffer can be treated identically by applications.
FmlKey
,
FldTbl
,
mkfldclass
Field Summary | |
static int |
FLD_CARRAY
A field of type carray - Object: byte[] |
static int |
FLD_CHAR
A field of type char - Object: Character |
static int |
FLD_DECIMAL
A field of type decimal - Object: |
static int |
FLD_DOUBLE
A field of type double - Object: Double |
static int |
FLD_FLOAT
A field of type float - Object: Float |
static int |
FLD_FML32
An FML32 buffer field - Object: TypedFML32 |
static int |
FLD_INT
A field of type int - Object: |
static int |
FLD_LONG
A field of type long - Object: Integer |
static int |
FLD_MBSTRING
A MBSTRING buffer field - Object: TypedMBString |
static int |
FLD_PTR
A TypedBuffer field - Object: TypedBuffer |
static int |
FLD_SHORT
A field of type short - Object: Short |
static int |
FLD_STRING
A field of type string - Object: String |
static int |
FLD_VIEW32
A VIEW32 buffer field - Object: |
Method Summary | |
void |
Fchg(FmlKey key,
Object value)
Adds the given object, whose field id is contained in key to the fielded buffer. |
void |
Fchg(int fldid,
int occurance,
Object value)
Adds the given object. |
void |
Fdel(FmlKey key)
Delete given key from fielded buffer. |
void |
Fdel(int fldid,
int occurance)
Delete given element from fielded buffer. |
Object |
Fget(FmlKey key)
Retrieves a copy of the object stored in the FML buffer of the given field id and occurance number. |
Object |
Fget(int fldid,
int occurance)
Retrieves a copy of the object stored in the FML buffer of the given field id and occurance number. |
Iterator |
Fiterator()
Returns an iterator for the start of the fielded FML buffer. |
int |
Fldid(String name)
Returns the field id corresponding to the given name. |
int |
Fldno(int fldid)
Given a fieldid, this returns the field number |
int |
Fldtype(int fldid)
Given a fieldid, this returns the field type |
String |
Fname(int fldid)
Returns the string that matches the given fieldid. |
int |
Foccur(int fldid)
Returns the number of occurences of the field specified by fldid |
int |
Fused()
Returns the amount of space that this FML buffer will take when present |
FldTbl[] |
getFieldTables()
gets the current list of FldTbls that are being used by this TypedFML object to do FldId/String mappings. |
void |
setFieldTables(FldTbl[] tables)
This function sets the list of FldTbl objects that can be used for FldId/String mappings |
Field Detail |
public static final int FLD_CARRAY
public static final int FLD_CHAR
public static final int FLD_DECIMAL
public static final int FLD_DOUBLE
public static final int FLD_FLOAT
public static final int FLD_FML32
public static final int FLD_INT
public static final int FLD_LONG
public static final int FLD_MBSTRING
public static final int FLD_PTR
public static final int FLD_SHORT
public static final int FLD_STRING
public static final int FLD_VIEW32
Method Detail |
public void Fchg(FmlKey key, Object value) throws Ferror
key
- The fieldid and occurance to add to the buffervalue
- The element to add to the buffer. Note that this object
must match the type of object expected by the field type, or an
invalid cast exception will be thrown
Ferror
- usually if space is lowFmlKey
public void Fchg(int fldid, int occurance, Object value) throws Ferror
fldid
- The fieldid to add to this bufferoccurance
- The occurance number of the field to addvalue
- The element to add to the buffer. Note that this object
must match the type of object expected by the field type, or an
invalid cast exception will be thrown
Ferror
- usually if space is lowFmlKey
public void Fdel(FmlKey key) throws Ferror
key
- The field id and occurance of the element to be removed
Ferror
- if the element is not in the buffer among other reasonspublic void Fdel(int fldid, int occurance) throws Ferror
fldid
- The field id of the element to be removedoccurance
- The occurance of the element to be removed
Ferror
- if the element is not in the buffer among other reasonspublic Object Fget(FmlKey key) throws Ferror
key
- the field id and occurance number of the element to retrieve
Ferror
- if the object is not found in the buffer among other reasonspublic Object Fget(int fldid, int occurance) throws Ferror
fldid
- The field id of the element to retrieveoccurance
- The occurance number of the element to retrieve
Ferror
- if the object is not found in the buffer among other reasonspublic Iterator Fiterator() throws Ferror
Ferror
public int Fldid(String name) throws Ferror
name
- the name of the field we are trying to find
integer
field id
Ferror
- if the field id cannot be foundpublic int Fldno(int fldid)
fldid
- The field id from which to extract the field number
public int Fldtype(int fldid)
fldid
- The field id from which to extract the field type
public String Fname(int fldid) throws Ferror
fldid
- The field id to map to a string
Ferror
- if the name cannot be foundpublic int Foccur(int fldid)
fldid
- the field id to look for in the fielded FML buffer
public int Fused() throws Ferror
Ferror
public FldTbl[] getFieldTables()
public void setFieldTables(FldTbl[] tables)
tables
- The list of tables to use for FldId/String mappingsFldTbl
|
Documentation is available at http://download.oracle.com/docs/cd/E13222_01/wls/docs90 Copyright 2005 BEA Systems Inc. |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |