alma.asdm.BeamRow Class Reference

Inherits alma.asdm.ASDMRow.

List of all members.

---

Detailed Description

The BeamRow class is a row of a BeamTable.

Generated from model's revision 1.46, branch HEAD

Public Member Functions
BeamTable	getTable ()
	Return the table to which this row belongs.
BeamRowIDL	toIDL ()
	Return this row in the form of an IDL struct.
void	setFromIDL (BeamRowIDL x) throws ConversionException
	Fill the values of this row from the IDL struct BeamRowIDL.
String	toXML () throws ConversionException
	Return this row in the form of an XML string.
void	setFromXML (String rowDoc) throws ConversionException
	Fill the values of this row from an XML string that was produced by the toXML() method.
Tag	getBeamId ()
	Get beamId.
boolean	equalByRequiredValue (BeamRow x)
	Return true if all required attributes of the value part are equal to their homologues in x and false otherwise.
boolean	compareRequiredValue ()
Protected Member Functions
void	setBeamId (Tag beamId) throws IllegalAccessException
	Set beamId with the specified Tag value.
Package Functions
	BeamRow (BeamTable table)
	Create a BeamRow.
	BeamRow (BeamTable table, BeamRow row)
	Creates a BeamRow using a copy constructor mechanism.
void	isAdded ()
Object[]	getAttributesValues ()
	Returns all the attributes of an attribute of an ASDM table as an array of Object.

---

Constructor & Destructor Documentation

alma.asdm.BeamRow.BeamRow (  BeamTable  table  )  [package]

Create a BeamRow. This constructor has package access because only the table can create rows. All rows know the table to which they belong. Parameters: table  The table to which this row belongs.

alma.asdm.BeamRow.BeamRow (  BeamTable  table, BeamRow  row )  [package]

Creates a BeamRow using a copy constructor mechanism. Given a BeamRow row and a BeamTable table, the method creates a new BeamRow owned by table. Each attribute of the created row is a copy (deep) of the corresponding attribute of row. The method does not add the created row to its table, its simply parents it to table, a call to the add method has to be done in order to get the row added (very likely after having modified some of its attributes). If row is null then the method returns a row with default values for its attributes. This constructor has package access because only the table can create rows. All rows know the table to which they belong. Parameters: table  The table to which this row belongs. row  The row which is to be copied.

---

Member Function Documentation

boolean alma.asdm.BeamRow.equalByRequiredValue (  BeamRow  x  )

Return true if all required attributes of the value part are equal to their homologues in x and false otherwise. Parameters: x  the BeamRow whose required attributes of the value part will be compared with those of this. Returns: a boolean.

Object [] alma.asdm.BeamRow.getAttributesValues (   )  [package, virtual]

Returns all the attributes of an attribute of an ASDM table as an array of Object. Returns: an array of Object. Implements alma.asdm.ASDMRow.

Tag alma.asdm.BeamRow.getBeamId (   )

Get beamId. Returns: beamId as Tag

BeamTable alma.asdm.BeamRow.getTable (   )

Return the table to which this row belongs.

void alma.asdm.BeamRow.setBeamId (  Tag  beamId  )  throws IllegalAccessException [protected]

Set beamId with the specified Tag value. Parameters: beamId  The Tag value to which beamId is to be set. Exceptions: IllegalAccessException  If an attempt is made to change this field after is has been added to the table.

void alma.asdm.BeamRow.setFromIDL (  BeamRowIDL  x  )  throws ConversionException

Fill the values of this row from the IDL struct BeamRowIDL. Parameters: x  The IDL struct containing the values used to fill this row.

void alma.asdm.BeamRow.setFromXML (  String  rowDoc  )  throws ConversionException

Fill the values of this row from an XML string that was produced by the toXML() method. Parameters: x  The XML string being used to set the values of this row. Exceptions: ConversionException.

BeamRowIDL alma.asdm.BeamRow.toIDL (   )

Return this row in the form of an IDL struct. Returns: The values of this row as a BeamRowIDL struct.

String alma.asdm.BeamRow.toXML (   )  throws ConversionException

Return this row in the form of an XML string. Returns: The values of this row as an XML string. Exceptions: ConversionException.

---

The documentation for this class was generated from the following file:

• BeamRow.java

---