alma.asdm.AntennaRow Class Reference

Inherits alma.asdm.ASDMRow.

List of all members.

---

Detailed Description

The AntennaRow class is a row of a AntennaTable.

Generated from model's revision 1.41, branch HEAD

Public Member Functions
AntennaTable	getTable ()
	Return the table to which this row belongs.
AntennaRowIDL	toIDL ()
	Return this row in the form of an IDL struct.
void	setFromIDL (AntennaRowIDL x) throws ConversionException
	Fill the values of this row from the IDL struct AntennaRowIDL.
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	getAntennaId ()
	Get antennaId.
String	getName ()
	Get name.
void	setName (String name)
	Set name with the specified String value.
AntennaMake	getAntennaMake ()
	Get antennaMake.
void	setAntennaMake (AntennaMake antennaMake)
	Set antennaMake with the specified AntennaMake value.
AntennaType	getAntennaType ()
	Get antennaType.
void	setAntennaType (AntennaType antennaType)
	Set antennaType with the specified AntennaType value.
Length	getXPosition ()
	Get xPosition.
void	setXPosition (Length xPosition)
	Set xPosition with the specified Length value.
Length	getYPosition ()
	Get yPosition.
void	setYPosition (Length yPosition)
	Set yPosition with the specified Length value.
Length	getZPosition ()
	Get zPosition.
void	setZPosition (Length zPosition)
	Set zPosition with the specified Length value.
ArrayTime	getTime ()
	Get time.
void	setTime (ArrayTime time)
	Set time with the specified ArrayTime value.
Length	getXOffset ()
	Get xOffset.
void	setXOffset (Length xOffset)
	Set xOffset with the specified Length value.
Length	getYOffset ()
	Get yOffset.
void	setYOffset (Length yOffset)
	Set yOffset with the specified Length value.
Length	getZOffset ()
	Get zOffset.
void	setZOffset (Length zOffset)
	Set zOffset with the specified Length value.
Length	getDishDiameter ()
	Get dishDiameter.
void	setDishDiameter (Length dishDiameter)
	Set dishDiameter with the specified Length value.
boolean	getFlagRow ()
	Get flagRow.
void	setFlagRow (boolean flagRow)
	Set flagRow with the specified boolean value.
boolean	isAssocAntennaIdExists ()
	The attribute assocAntennaId is optional.
Tag	getAssocAntennaId () throws IllegalAccessException
	Get assocAntennaId, which is optional.
void	setAssocAntennaId (Tag assocAntennaId)
	Set assocAntennaId with the specified Tag value.
void	clearAssocAntennaId ()
	Mark assocAntennaId, which is an optional field, as non-existent.
Tag	getStationId ()
	Get stationId.
void	setStationId (Tag stationId)
	Set stationId with the specified Tag value.
boolean	isAssociatedAntennaExists ()
	The link to table Antenna is optional.
AntennaRow	getAssociatedAntenna () throws NoSuchRow
	Get the optional row in table Antenna by traversing the defined link to that table.
void	setAssociatedAntennaLink (Tag assocAntennaId)
	Set the values of the link attributes needed to link this row to a row in table Antenna.
StationRow	getStationUsingStationId ()
	Returns the pointer to the row in the Station table having Station.stationId == stationId.
boolean	compareNoAutoInc (Tag stationId, String name, AntennaMake antennaMake, AntennaType antennaType, Length xPosition, Length yPosition, Length zPosition, ArrayTime time, Length xOffset, Length yOffset, Length zOffset, Length dishDiameter, boolean flagRow)
	Compare each attribute except the autoincrementable one of this AntennaRow with the corresponding parameters and return true if there is a match and false otherwise.
boolean	equalByRequiredValue (AntennaRow x)
	Return true if all required attributes of the value part are equal to their homologues in x and false otherwise.
boolean	compareRequiredValue (Tag stationId, String name, AntennaMake antennaMake, AntennaType antennaType, Length xPosition, Length yPosition, Length zPosition, ArrayTime time, Length xOffset, Length yOffset, Length zOffset, Length dishDiameter, boolean flagRow)
Protected Member Functions
void	setAntennaId (Tag antennaId) throws IllegalAccessException
	Set antennaId with the specified Tag value.
Package Functions
	AntennaRow (AntennaTable table)
	Create a AntennaRow.
	AntennaRow (AntennaTable table, AntennaRow row)
	Creates a AntennaRow 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.AntennaRow.AntennaRow

(

AntennaTable

table

)

[package]

Create a AntennaRow.

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.AntennaRow.AntennaRow	(	AntennaTable	table,
		AntennaRow	row
	)			[package]

Creates a AntennaRow using a copy constructor mechanism.

Given a AntennaRow row and a AntennaTable table, the method creates a new AntennaRow 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

AntennaRowIDL alma.asdm.AntennaRow.toIDL

(

)

Return this row in the form of an IDL struct.

Returns:

The values of this row as a AntennaRowIDL struct.

void alma.asdm.AntennaRow.setFromIDL

(

AntennaRowIDL

x

)

throws ConversionException

Fill the values of this row from the IDL struct AntennaRowIDL.

Parameters:

x

The IDL struct containing the values used to fill this row.

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

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

Tag alma.asdm.AntennaRow.getAntennaId

(

)

Get antennaId.

Returns:

antennaId as Tag

void alma.asdm.AntennaRow.setAntennaId

(

Tag

antennaId

)

throws IllegalAccessException [protected]

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.

String alma.asdm.AntennaRow.getName

(

)

Get name.

Returns:

name as String

void alma.asdm.AntennaRow.setName

(

String

name

)

Set name with the specified String value.

Parameters:

name

The String value to which name is to be set.

AntennaMake alma.asdm.AntennaRow.getAntennaMake

(

)

Get antennaMake.

Returns:

antennaMake as AntennaMake

void alma.asdm.AntennaRow.setAntennaMake

(

AntennaMake

antennaMake

)

Set antennaMake with the specified AntennaMake value.

Parameters:

antennaMake

The AntennaMake value to which antennaMake is to be set.

AntennaType alma.asdm.AntennaRow.getAntennaType

(

)

Get antennaType.

Returns:

antennaType as AntennaType

void alma.asdm.AntennaRow.setAntennaType

(

AntennaType

antennaType

)

Set antennaType with the specified AntennaType value.

Parameters:

antennaType

The AntennaType value to which antennaType is to be set.

Length alma.asdm.AntennaRow.getXPosition

(

)

Get xPosition.

Returns:

xPosition as Length

void alma.asdm.AntennaRow.setXPosition

(

Length

xPosition

)

Set xPosition with the specified Length value.

Parameters:

xPosition

The Length value to which xPosition is to be set.

Length alma.asdm.AntennaRow.getYPosition

(

)

Get yPosition.

Returns:

yPosition as Length

void alma.asdm.AntennaRow.setYPosition

(

Length

yPosition

)

Set yPosition with the specified Length value.

Parameters:

yPosition

The Length value to which yPosition is to be set.

Length alma.asdm.AntennaRow.getZPosition

(

)

Get zPosition.

Returns:

zPosition as Length

void alma.asdm.AntennaRow.setZPosition

(

Length

zPosition

)

Set zPosition with the specified Length value.

Parameters:

zPosition

The Length value to which zPosition is to be set.

ArrayTime alma.asdm.AntennaRow.getTime

(

)

Get time.

Returns:

time as ArrayTime

void alma.asdm.AntennaRow.setTime

(

ArrayTime

time

)

Set time with the specified ArrayTime value.

Parameters:

time

The ArrayTime value to which time is to be set.

Length alma.asdm.AntennaRow.getXOffset

(

)

Get xOffset.

Returns:

xOffset as Length

void alma.asdm.AntennaRow.setXOffset

(

Length

xOffset

)

Set xOffset with the specified Length value.

Parameters:

xOffset

The Length value to which xOffset is to be set.

Length alma.asdm.AntennaRow.getYOffset

(

)

Get yOffset.

Returns:

yOffset as Length

void alma.asdm.AntennaRow.setYOffset

(

Length

yOffset

)

Set yOffset with the specified Length value.

Parameters:

yOffset

The Length value to which yOffset is to be set.

Length alma.asdm.AntennaRow.getZOffset

(

)

Get zOffset.

Returns:

zOffset as Length

void alma.asdm.AntennaRow.setZOffset

(

Length

zOffset

)

Set zOffset with the specified Length value.

Parameters:

zOffset

The Length value to which zOffset is to be set.

Length alma.asdm.AntennaRow.getDishDiameter

(

)

Get dishDiameter.

Returns:

dishDiameter as Length

void alma.asdm.AntennaRow.setDishDiameter

(

Length

dishDiameter

)

Set dishDiameter with the specified Length value.

Parameters:

dishDiameter

The Length value to which dishDiameter is to be set.

boolean alma.asdm.AntennaRow.getFlagRow

(

)

Get flagRow.

Returns:

flagRow as boolean

void alma.asdm.AntennaRow.setFlagRow

(

boolean

flagRow

)

Set flagRow with the specified boolean value.

Parameters:

flagRow

The boolean value to which flagRow is to be set.

boolean alma.asdm.AntennaRow.isAssocAntennaIdExists

(

)

The attribute assocAntennaId is optional.

Return true if this attribute exists.

Returns:

true if and only if the assocAntennaId attribute exists.

Tag alma.asdm.AntennaRow.getAssocAntennaId

(

)

throws IllegalAccessException

Get assocAntennaId, which is optional.

Returns:

assocAntennaId as Tag

Exceptions:

IllegalAccessException

If assocAntennaId does not exist.

void alma.asdm.AntennaRow.setAssocAntennaId

(

Tag

assocAntennaId

)

Set assocAntennaId with the specified Tag value.

Parameters:

assocAntennaId

The Tag value to which assocAntennaId is to be set.

Tag alma.asdm.AntennaRow.getStationId

(

)

Get stationId.

Returns:

stationId as Tag

void alma.asdm.AntennaRow.setStationId

(

Tag

stationId

)

Set stationId with the specified Tag value.

Parameters:

stationId

The Tag value to which stationId is to be set.

boolean alma.asdm.AntennaRow.isAssociatedAntennaExists

(

)

The link to table Antenna is optional.

Return true if this link exists.

Returns:

true if and only if the Antenna link exists.

AntennaRow alma.asdm.AntennaRow.getAssociatedAntenna

(

)

throws NoSuchRow

Get the optional row in table Antenna by traversing the defined link to that table.

Returns:

A row in Antenna table.

Exceptions:

NoSuchRow

if there is no such row in table Antenna or the link does not exist.

StationRow alma.asdm.AntennaRow.getStationUsingStationId

(

)

Returns the pointer to the row in the Station table having Station.stationId == stationId.

Returns:

a StationRow

boolean alma.asdm.AntennaRow.equalByRequiredValue

(

AntennaRow

x

)

Return true if all required attributes of the value part are equal to their homologues in x and false otherwise.

Parameters:

x

the AntennaRow whose required attributes of the value part will be compared with those of this.

Returns:

a boolean.

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

---

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

• AntennaRow.java

---