alma.asdm.FocusRow Class Reference

Inherits alma.asdm.ASDMRow.

List of all members.

---

Detailed Description

The FocusRow class is a row of a FocusTable.

Generated from model's revision 1.46, branch HEAD

Public Member Functions
FocusTable	getTable ()
	Return the table to which this row belongs.
FocusRowIDL	toIDL ()
	Return this row in the form of an IDL struct.
void	setFromIDL (FocusRowIDL x) throws ConversionException
	Fill the values of this row from the IDL struct FocusRowIDL.
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.
ArrayTimeInterval	getTimeInterval ()
	Get timeInterval.
void	setTimeInterval (ArrayTimeInterval timeInterval) throws IllegalAccessException
	Set timeInterval with the specified ArrayTimeInterval value.
Length	getXFocusPosition ()
	Get xFocusPosition.
void	setXFocusPosition (Length xFocusPosition) throws IllegalAccessException
	Set xFocusPosition with the specified Length value.
Length	getYFocusPosition ()
	Get yFocusPosition.
void	setYFocusPosition (Length yFocusPosition) throws IllegalAccessException
	Set yFocusPosition with the specified Length value.
Length	getZFocusPosition ()
	Get zFocusPosition.
void	setZFocusPosition (Length zFocusPosition) throws IllegalAccessException
	Set zFocusPosition with the specified Length value.
boolean	getFocusTracking ()
	Get focusTracking.
void	setFocusTracking (boolean focusTracking) throws IllegalAccessException
	Set focusTracking with the specified boolean value.
Length	getXFocusOffset ()
	Get xFocusOffset.
void	setXFocusOffset (Length xFocusOffset) throws IllegalAccessException
	Set xFocusOffset with the specified Length value.
Length	getYFocusOffset ()
	Get yFocusOffset.
void	setYFocusOffset (Length yFocusOffset) throws IllegalAccessException
	Set yFocusOffset with the specified Length value.
Length	getZFocusOffset ()
	Get zFocusOffset.
void	setZFocusOffset (Length zFocusOffset) throws IllegalAccessException
	Set zFocusOffset with the specified Length value.
Tag	getAntennaId ()
	Get antennaId.
void	setAntennaId (Tag antennaId) throws IllegalAccessException
	Set antennaId with the specified Tag value.
int	getFeedId ()
	Get feedId.
void	setFeedId (int feedId) throws IllegalAccessException
	Set feedId with the specified int value.
Tag	getFocusModelId ()
	Get focusModelId.
void	setFocusModelId (Tag focusModelId) throws IllegalAccessException
	Set focusModelId with the specified Tag value.
FocusModelRow	getFocusModelUsingFocusModelId ()
	Returns the pointer to the row in the FocusModel table having FocusModel.focusModelId == focusModelId.
FeedRow[]	getFeeds () throws InvalidAccessException, NoSuchRow
	Get the collection of rows in the Feed table having feedId == this.feedId.
AntennaRow	getAntennaUsingAntennaId ()
	Returns the pointer to the row in the Antenna table having Antenna.antennaId == antennaId.
boolean	compareNoAutoInc (Tag antennaId, int feedId, ArrayTimeInterval timeInterval, Tag focusModelId, Length xFocusPosition, Length yFocusPosition, Length zFocusPosition, boolean focusTracking, Length xFocusOffset, Length yFocusOffset, Length zFocusOffset)
	Compare each attribute except the autoincrementable one of this FocusRow with the corresponding parameters and return true if there is a match and false otherwise.
boolean	equalByRequiredValue (FocusRow x)
	Return true if all required attributes of the value part are equal to their homologues in x and false otherwise.
boolean	compareRequiredValue (Tag focusModelId, Length xFocusPosition, Length yFocusPosition, Length zFocusPosition, boolean focusTracking, Length xFocusOffset, Length yFocusOffset, Length zFocusOffset)
Package Functions
	FocusRow (FocusTable table)
	Create a FocusRow.
	FocusRow (FocusTable table, FocusRow row)
	Creates a FocusRow 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.
Package Attributes
ArrayTimeInterval	timeInterval

---

Constructor & Destructor Documentation

alma.asdm.FocusRow.FocusRow (  FocusTable  table  )  [package]

Create a FocusRow. 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.FocusRow.FocusRow (  FocusTable  table, FocusRow  row )  [package]

Creates a FocusRow using a copy constructor mechanism. Given a FocusRow row and a FocusTable table, the method creates a new FocusRow 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.FocusRow.compareNoAutoInc (  Tag  antennaId, int  feedId, ArrayTimeInterval  timeInterval, Tag  focusModelId, Length  xFocusPosition, Length  yFocusPosition, Length  zFocusPosition, boolean  focusTracking, Length  xFocusOffset, Length  yFocusOffset, Length  zFocusOffset )

Compare each attribute except the autoincrementable one of this FocusRow with the corresponding parameters and return true if there is a match and false otherwise.

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

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

Tag alma.asdm.FocusRow.getAntennaId (   )

Get antennaId. Returns: antennaId as Tag

AntennaRow alma.asdm.FocusRow.getAntennaUsingAntennaId (   )

Returns the pointer to the row in the Antenna table having Antenna.antennaId == antennaId. Returns: a AntennaRow

Object [] alma.asdm.FocusRow.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.

int alma.asdm.FocusRow.getFeedId (   )

Get feedId. Returns: feedId as int

Tag alma.asdm.FocusRow.getFocusModelId (   )

Get focusModelId. Returns: focusModelId as Tag

FocusModelRow alma.asdm.FocusRow.getFocusModelUsingFocusModelId (   )

Returns the pointer to the row in the FocusModel table having FocusModel.focusModelId == focusModelId. Returns: a FocusModelRow

boolean alma.asdm.FocusRow.getFocusTracking (   )

Get focusTracking. Returns: focusTracking as boolean

FocusTable alma.asdm.FocusRow.getTable (   )

Return the table to which this row belongs.

ArrayTimeInterval alma.asdm.FocusRow.getTimeInterval (   )

Get timeInterval. Returns: timeInterval as ArrayTimeInterval

Length alma.asdm.FocusRow.getXFocusOffset (   )

Get xFocusOffset. Returns: xFocusOffset as Length

Length alma.asdm.FocusRow.getXFocusPosition (   )

Get xFocusPosition. Returns: xFocusPosition as Length

Length alma.asdm.FocusRow.getYFocusOffset (   )

Get yFocusOffset. Returns: yFocusOffset as Length

Length alma.asdm.FocusRow.getYFocusPosition (   )

Get yFocusPosition. Returns: yFocusPosition as Length

Length alma.asdm.FocusRow.getZFocusOffset (   )

Get zFocusOffset. Returns: zFocusOffset as Length

Length alma.asdm.FocusRow.getZFocusPosition (   )

Get zFocusPosition. Returns: zFocusPosition as Length

void alma.asdm.FocusRow.setAntennaId (  Tag  antennaId  )  throws IllegalAccessException

Set antennaId with the specified Tag value. Parameters: antennaId  The Tag value to which antennaId 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.FocusRow.setFeedId (  int  feedId  )  throws IllegalAccessException

Set feedId with the specified int value. Parameters: feedId  The int value to which feedId 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.FocusRow.setFocusModelId (  Tag  focusModelId  )  throws IllegalAccessException

Set focusModelId with the specified Tag value. Parameters: focusModelId  The Tag value to which focusModelId 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.FocusRow.setFocusTracking (  boolean  focusTracking  )  throws IllegalAccessException

Set focusTracking with the specified boolean value. Parameters: focusTracking  The boolean value to which focusTracking 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.FocusRow.setFromIDL (  FocusRowIDL  x  )  throws ConversionException

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

void alma.asdm.FocusRow.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.

void alma.asdm.FocusRow.setTimeInterval (  ArrayTimeInterval  timeInterval  )  throws IllegalAccessException

Set timeInterval with the specified ArrayTimeInterval value. Parameters: timeInterval  The ArrayTimeInterval value to which timeInterval 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.FocusRow.setXFocusOffset (  Length  xFocusOffset  )  throws IllegalAccessException

Set xFocusOffset with the specified Length value. Parameters: xFocusOffset  The Length value to which xFocusOffset 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.FocusRow.setXFocusPosition (  Length  xFocusPosition  )  throws IllegalAccessException

Set xFocusPosition with the specified Length value. Parameters: xFocusPosition  The Length value to which xFocusPosition 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.FocusRow.setYFocusOffset (  Length  yFocusOffset  )  throws IllegalAccessException

Set yFocusOffset with the specified Length value. Parameters: yFocusOffset  The Length value to which yFocusOffset 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.FocusRow.setYFocusPosition (  Length  yFocusPosition  )  throws IllegalAccessException

Set yFocusPosition with the specified Length value. Parameters: yFocusPosition  The Length value to which yFocusPosition 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.FocusRow.setZFocusOffset (  Length  zFocusOffset  )  throws IllegalAccessException

Set zFocusOffset with the specified Length value. Parameters: zFocusOffset  The Length value to which zFocusOffset 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.FocusRow.setZFocusPosition (  Length  zFocusPosition  )  throws IllegalAccessException

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

FocusRowIDL alma.asdm.FocusRow.toIDL (   )

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

String alma.asdm.FocusRow.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:

• FocusRow.java

---