arom.kernel
Class AromRecord

java.lang.Object
  |
  +--arom.kernel.AromObject
        |
        +--arom.kernel.AromEntity
              |
              +--arom.kernel.AromRecord

Direct Known Subclasses:

AromInstance, AromTuple

public abstract class AromRecord

extends AromEntity

This is an abstract superclass for classes that represents "instances" of AROM structures (class or association). There are two different type of AROM instances :

• AromInstance for instances of AROM classes.
• AromTuple for instances of AROM associations.

  Version:

  0.1, avril-octobre 1998

  Field Summary

  protected Vector	recordListeners The listeners of the record.
  protected Vector	values The accessor's values. values[i] is the value of the accessor of index i.

  Fields inherited from class arom.kernel.AromEntity

  alive, entityListeners, kb, name, namePredicate

  Fields inherited from class arom.kernel.AromObject

  bundle, doc, predicates

  Constructor Summary

  AromRecord()
  

  Method Summary

  void	addAromRecordListener(AromRecordListener listener) Add and AromRecordListener to this AROM record.
  void	delete() Delete the record from the knowledge base.
  protected void	fireAromRecordEvent(AromRecordEvent event) Send notification to all the record listeners.
  Object	getAccessorValue(AromAccessor a) Returns the value of the specified accessor.
  Object	getAccessorValue(String accessName) Returns the value of the accessor specified by it's name.
  protected void	insertInKb(AromKb kb, AromStructure struct) Insert the record in the specified knowledge base and associate it with the specified structure.
  AromStructure	isA() Returns the arom structure of this record.
  boolean	isRecordOf(AromStructure struct) Returns true if this record is an "instance" of the specified structure.
  void	removeAromRecordListener(AromRecordListener listener) Remove the AromRecordListener to the listener list of this record.
  void	setAccessorValue(AromAccessor a, Object val) Sets the value of the specified accessor.
  void	setAccessorValue(String accessName, Object val) Sets the value of the specified accessor.
  String	toString() Returns a string representation of this record.
  Iterator	values() Returns an iterator over the accessor's values for this record.

  Methods inherited from class arom.kernel.AromEntity

  addAromEntityListener, fireAromEntityEvent, getKb, getName, isAlive, removeAromEntityListener, setDocumentation, setName, write

  Methods inherited from class arom.kernel.AromObject

  check, check, getDocumentation

  Methods inherited from class java.lang.Object

  clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  Field Detail

  values

  protected Vector values

  The accessor's values. values[i] is the value of the accessor of index i.

  recordListeners

  protected Vector recordListeners

  The listeners of the record. Listeners are notified of any modification of this record (record accessor value change).

  Constructor Detail

  AromRecord

  public AromRecord()

  Method Detail

  insertInKb

  protected void insertInKb(AromKb kb,
                            AromStructure struct)

  Insert the record in the specified knowledge base and associate it with the specified structure.

  Parameters:

  kb - the knowledge base

  struct - la classe ou la association à laquelle j'appartiens

  delete

  public void delete()

  Delete the record from the knowledge base.

  Overrides:

  delete in class AromEntity

  getAccessorValue

  public Object getAccessorValue(AromAccessor a)

  Returns the value of the specified accessor. If the specified accessor is not an accessor of this record, an AromIllegalArgumentException is thrown. This is necessary since the value of the accessor can be null.

  Parameters:

  a - the accessor

  Returns:

  the value (a Java Object) of the accessor.

  Throws:

  AromIllegalArgumentException - if the specified accessor is not an accessor of this record.

  getAccessorValue

  public Object getAccessorValue(String accessName)
                          throws AromEntityNotFoundException

  Returns the value of the accessor specified by it's name.

  Parameters:

  accessName - the name of the accessor.

  Returns:

  the value (a Java Object) of the accessor.

  Throws:

  AromRuntimeException - if the specified accessor is not an accessor of this record.

  setAccessorValue

  public void setAccessorValue(AromAccessor a,
                               Object val)
                        throws AromIllegalSetValueException

  Sets the value of the specified accessor.

  Parameters:

  a - the accessor to modify.

  val - the new value (a Java Object) of the accessor.

  Throws:

  AromIllegalSetValueException - if the accessor is not an accessor of this record.

  setAccessorValue

  public void setAccessorValue(String accessName,
                               Object val)
                        throws AromEntityNotFoundException,
                               AromIllegalSetValueException

  Sets the value of the specified accessor.

  Parameters:

  accessName - the name of the accessor to modify.

  val - the new value (a Java Object) of the accessor.

  isA

  public AromStructure isA()

  Returns the arom structure of this record.

  values

  public Iterator values()

  Returns an iterator over the accessor's values for this record.

  Returns:

  a value of type 'Iterator'

  isRecordOf

  public boolean isRecordOf(AromStructure struct)

  Returns true if this record is an "instance" of the specified structure.

  Parameters:

  struct - the structure to test.

  Returns:

  true if this record is an "instance" of the specified structure.

  toString

  public String toString()

  Returns a string representation of this record. This string is the name of the structure the record belongs to concatenate with a constant string. It is recommended that all subclasses of AromRecord override this method.

  Returns:

  a string representation of this record.

  Overrides:

  toString in class AromEntity

  addAromRecordListener

  public void addAromRecordListener(AromRecordListener listener)

  Add and AromRecordListener to this AROM record. Does nothing if the listener is already an AromRecordListener of this record.

  Parameters:

  listener - the AromRecordListener to add to the record listeners.

  removeAromRecordListener

  public void removeAromRecordListener(AromRecordListener listener)

  Remove the AromRecordListener to the listener list of this record. Does nothing if the AromRecordListener is not a listener of this record.

  Parameters:

  listener - the AromRecordListener to remove to the record listeners.

  fireAromRecordEvent

  protected void fireAromRecordEvent(AromRecordEvent event)

  Send notification to all the record listeners.

  Parameters:

  event - the AromRecordEvent describing changes of the record.