Class BuiltInFnCallFrame

java.lang.Object
   |
   +----Frame
           |
           +----BuiltInFnCallFrame

public class BuiltInFnCallFrame
extends Frame
The class `BuiltInFnCallFrame', a subclass of Frame, represents a frame internally as an exjava BuiltInFnCall object - such frames should only be used to represent built-in function calls in EXPRESS models.


Constructor Index

 o BuiltInFnCallFrame(BuiltInFnCall, Frame)
Constructs this frame by plugging in the given exjava BuiltInFnCall object (it does so by copying the reference, which is maximally efficient but the client should not then alter the BuiltInFnCall directly, as that would compromise the integrity of the frame).
 o BuiltInFnCallFrame(BuiltInFnCall, Frame, Hashtable)
Constructs this frame by plugging in the given exjava BuiltInFnCall object (it does so by copying the reference, which is maximally efficient, but the client should not then alter the BuiltInFnCall directly, as that would compromise the integrity of the frame).

Method Index

 o buildFrame()
Fills in the slots for this frame from the underlying exjava BuiltInFnCall object.
 o buildQueuedFrames()
Builds any BuiltInFnCall Frames that are queued to be built (those that were constructed before the frame class was constructed).
 o getFrameClass()
Returns the frame class of this frame.
 o initialise(Express)
Initialises the BuiltInFnCallFrame class by setting the class variable _frameClass after looking up the `built_in_function_call' entity in the given EXPRESS (meta)model.
 o readClass(ObjectInput)
Deserialises the static data members (class variables) of BuiltInFnCallFrame.
 o writeClass(ObjectOutput)
Serialises the static data members (class variables) of BuiltInFnCallFrame.

Constructors

 o BuiltInFnCallFrame
 public BuiltInFnCallFrame(BuiltInFnCall instanceData,
                           Frame theEntity) throws FrameAlreadyExists
Constructs this frame by plugging in the given exjava BuiltInFnCall object (it does so by copying the reference, which is maximally efficient but the client should not then alter the BuiltInFnCall directly, as that would compromise the integrity of the frame).

Parameters:
instanceData - An exjava BuiltInFnCall object to wrap in this frame.
theEntity - The entity which contains this function call.
Throws: FrameAlreadyExists
If an BuiltInFnCall has already been constructed for `instanceData'.
 o BuiltInFnCallFrame
 public BuiltInFnCallFrame(BuiltInFnCall instanceData,
                           Frame theEntity,
                           Hashtable moreInstanceData) throws FrameAlreadyExists
Constructs this frame by plugging in the given exjava BuiltInFnCall object (it does so by copying the reference, which is maximally efficient, but the client should not then alter the BuiltInFnCall directly, as that would compromise the integrity of the frame). This constructor allows the function call frame to be tagged with extra slots, given in a hash table.

Parameters:
instanceData - An exjava BuiltInFnCall object to wrap in this frame.
theEntity - The entity which contains this function call.
moreInstanceData - Extra slots to tag this function call frame with.
Throws: FrameAlreadyExists
If an BuiltInFnCall has already been constructed for `instanceData'.

Methods

 o initialise
 public static void initialise(Express metamodel)
Initialises the BuiltInFnCallFrame class by setting the class variable _frameClass after looking up the `built_in_function_call' entity in the given EXPRESS (meta)model.

Parameters:
metamodel - An EXPRESS metamodel, which is expected to contain the entity `built_in_function_call'.
 o buildQueuedFrames
 public static void buildQueuedFrames()
Builds any BuiltInFnCall Frames that are queued to be built (those that were constructed before the frame class was constructed). Their slots are filled from the exjava objects with which they were constructed, and they are then validated.

 o buildFrame
 public void buildFrame()
Fills in the slots for this frame from the underlying exjava BuiltInFnCall object.

 o getFrameClass
 public FrameClass getFrameClass()
Returns the frame class of this frame.

Returns:
The frame class of this frame.
Overrides:
getFrameClass in class Frame
 o writeClass
 public static void writeClass(ObjectOutput oo) throws IOException
Serialises the static data members (class variables) of BuiltInFnCallFrame.

Parameters:
oo - An output object to save the class data to.
Throws: IOException
If an I/O exception occurs.
 o readClass
 public static void readClass(ObjectInput oi) throws IOException
Deserialises the static data members (class variables) of BuiltInFnCallFrame.

Parameters:
ois - An input object to save the class data to.
Throws: IOException
If an I/O exception occurs.