Interface JOP.persist.SlotDefinition
All Packages  Class Hierarchy  This Package  Previous  Next  Index  Home

Interface JOP.persist.SlotDefinition

public interface SlotDefinition
extends Object

This is an INTERNAL class.

For each slot of the object, the SlotDefinition allows the slots type and name to be determined and allows the current value of the slot to be stored or retrieved.


Method Index

 o getName()
Get the name of this slot
 o getRefOid()
Return the assigned RefOid for this object
 o getRefOid(int)
Return the assigned RefOid for each slot in an array
 o getSignature()
Get the Slot's signature (Java signature as per signature.h)
 o getSignatureType()
Get the Slot's signature as an integer type code (as per JOP.persist.JavaTypes).
 o getValue()
Return an object that stores the slots value.
 o getValue(int)
Fetch the 'nth' element.
 o isArray()
Test if the slot is an array
 o isNullArray()
Return 'true' if the array is null
 o setNullArray()
Set the array to be a null array
 o setRefOid(int, ObjectIdentifier)
For object references then an object id will be assigned to the referenced object.
 o setRefOid(ObjectIdentifier)
For object references then an object id will be assigned to the referenced object.
 o setValue(int, Object)
Set the 'nth' element of an array.
 o setValue(Object)
Allows the slot's value to be set.
 o sizeArray()
Return the length of the array.

Methods

 o getSignature
  public abstract String getSignature()
Get the Slot's signature (Java signature as per signature.h)
 o getSignatureType
  public abstract int getSignatureType()
Get the Slot's signature as an integer type code (as per JOP.persist.JavaTypes).
 o getName
  public abstract String getName()
Get the name of this slot
 o getValue
  public abstract Object getValue() throws Exception
Return an object that stores the slots value. Note that where the original type of the slot was an object reference the Object returned will be of type ObjectIdentifier - and not the object.
 o setValue
  public abstract void setValue(Object obj) throws Exception
Allows the slot's value to be set. If the slot is originally a reference to a mutable object then the Object must be of type ObjectIdentifier.

Can only called if the slot is not an array

 o setRefOid
  public abstract void setRefOid(ObjectIdentifier oid)
For object references then an object id will be assigned to the referenced object. The object id will be null for all immutable objects and for scalars.

Can only be called if the slot is not an array

 o isArray
  public abstract boolean isArray()
Test if the slot is an array
 o sizeArray
  public abstract int sizeArray()
Return the length of the array.

Can only called if the slot is an array.

 o isNullArray
  public abstract boolean isNullArray()
Return 'true' if the array is null
 o setNullArray
  public abstract void setNullArray()
Set the array to be a null array
 o getValue
  public abstract Object getValue(int n)
Fetch the 'nth' element. Can only be called if the slot is an array
 o setValue
  public abstract void setValue(int n,
                                Object obj)
Set the 'nth' element of an array.
 o setRefOid
  public abstract void setRefOid(int n,
                                 ObjectIdentifier oid)
For object references then an object id will be assigned to the referenced object. The object id will be null for all immutable objects and for scalars.

Can only be called if the slot is not an array

 o getRefOid
  public abstract ObjectIdentifier getRefOid()
Return the assigned RefOid for this object
 o getRefOid
  public abstract ObjectIdentifier getRefOid(int n)
Return the assigned RefOid for each slot in an array

All Packages  Class Hierarchy  This Package  Previous  Next  Index  Home