Class BuiltInFrame

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

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


Constructor Index

 o BuiltInFrame(BuiltIn)
Constructs this frame by plugging in the given exjava BuiltIn object (it does so by copying the reference, which is maximally efficient but the client should not then alter the BuiltIn directly, as that would compromise the integrity of the frame).
 o BuiltInFrame(BuiltIn, Hashtable)
Constructs this frame by plugging in the given exjava BuiltIn object (it does so by copying the reference, which is maximally efficient, but the client should not then alter the BuiltIn 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 BuiltIn object.
 o buildQueuedFrames()
Builds any BuiltIn 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 BuiltInFrame class by setting the class variable _frameClass after looking up the `built_in_constant' entity in the given EXPRESS (meta)model.
 o readClass(ObjectInput)
Deserialises the static data members (class variables) of BuiltInFrame.
 o writeClass(ObjectOutput)
Serialises the static data members (class variables) of BuiltInFrame.

Constructors

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

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

Parameters:
instanceData - An exjava BuiltIn object to wrap in this frame.
moreInstanceData - Extra slots to tag this built-in constant frame with.
Throws: FrameAlreadyExists
If an BuiltIn has already been constructed for `instanceData'.

Methods

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

Parameters:
metamodel - An EXPRESS metamodel, which is expected to contain the entity `built_in_constant'.
 o buildQueuedFrames
 public static void buildQueuedFrames()
Builds any BuiltIn 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 BuiltIn 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 BuiltInFrame.

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 BuiltInFrame.

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