alma.asdm.AnnotationRow Class Reference

Inherits alma.asdm.ASDMRow.

List of all members.

---

Detailed Description

The AnnotationRow class is a row of a AnnotationTable.

Generated from model's revision 1.46, branch HEAD

Public Member Functions
AnnotationTable	getTable ()
	Return the table to which this row belongs.
AnnotationRowIDL	toIDL ()
	Return this row in the form of an IDL struct.
void	setFromIDL (AnnotationRowIDL x) throws ConversionException
	Fill the values of this row from the IDL struct AnnotationRowIDL.
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.
ArrayTime	getTime ()
	Get time.
void	setTime (ArrayTime time) throws IllegalAccessException
	Set time with the specified ArrayTime value.
String	getIssue ()
	Get issue.
void	setIssue (String issue) throws IllegalAccessException
	Set issue with the specified String value.
String	getDetails ()
	Get details.
void	setDetails (String details) throws IllegalAccessException
	Set details with the specified String value.
boolean	isIntervalExists ()
	The attribute interval is optional.
Interval	getInterval () throws IllegalAccessException
	Get interval, which is optional.
void	setInterval (Interval interval)
	Set interval with the specified Interval value.
void	clearInterval ()
	Mark interval, which is an optional field, as non-existent.
boolean	isNumAntennaExists ()
	The attribute numAntenna is optional.
int	getNumAntenna () throws IllegalAccessException
	Get numAntenna, which is optional.
void	setNumAntenna (int numAntenna)
	Set numAntenna with the specified int value.
void	clearNumAntenna ()
	Mark numAntenna, which is an optional field, as non-existent.
boolean	isNumBasebandExists ()
	The attribute numBaseband is optional.
int	getNumBaseband () throws IllegalAccessException
	Get numBaseband, which is optional.
void	setNumBaseband (int numBaseband)
	Set numBaseband with the specified int value.
void	clearNumBaseband ()
	Mark numBaseband, which is an optional field, as non-existent.
boolean	isBasebandNameExists ()
	The attribute basebandName is optional.
BasebandName[]	getBasebandName () throws IllegalAccessException
	Get basebandName, which is optional.
void	setBasebandName (BasebandName[] basebandName)
	Set basebandName with the specified BasebandName[] value.
void	clearBasebandName ()
	Mark basebandName, which is an optional field, as non-existent.
boolean	isDValueExists ()
	The attribute dValue is optional.
double	getDValue () throws IllegalAccessException
	Get dValue, which is optional.
void	setDValue (double dValue)
	Set dValue with the specified double value.
void	clearDValue ()
	Mark dValue, which is an optional field, as non-existent.
boolean	isVdValueExists ()
	The attribute vdValue is optional.
double[]	getVdValue () throws IllegalAccessException
	Get vdValue, which is optional.
void	setVdValue (double[] vdValue)
	Set vdValue with the specified double[] value.
void	clearVdValue ()
	Mark vdValue, which is an optional field, as non-existent.
boolean	isVvdValuesExists ()
	The attribute vvdValues is optional.
double[][]	getVvdValues () throws IllegalAccessException
	Get vvdValues, which is optional.
void	setVvdValues (double[][] vvdValues)
	Set vvdValues with the specified double[][] value.
void	clearVvdValues ()
	Mark vvdValues, which is an optional field, as non-existent.
boolean	isLlValueExists ()
	The attribute llValue is optional.
long	getLlValue () throws IllegalAccessException
	Get llValue, which is optional.
void	setLlValue (long llValue)
	Set llValue with the specified long value.
void	clearLlValue ()
	Mark llValue, which is an optional field, as non-existent.
boolean	isVllValueExists ()
	The attribute vllValue is optional.
long[]	getVllValue () throws IllegalAccessException
	Get vllValue, which is optional.
void	setVllValue (long[] vllValue)
	Set vllValue with the specified long[] value.
void	clearVllValue ()
	Mark vllValue, which is an optional field, as non-existent.
boolean	isVvllValueExists ()
	The attribute vvllValue is optional.
long[][]	getVvllValue () throws IllegalAccessException
	Get vvllValue, which is optional.
void	setVvllValue (long[][] vvllValue)
	Set vvllValue with the specified long[][] value.
void	clearVvllValue ()
	Mark vvllValue, which is an optional field, as non-existent.
Tag	getAnnotationId ()
	Get annotationId.
boolean	isAntennaIdExists ()
	The attribute antennaId is optional.
Tag[]	getAntennaId () throws IllegalAccessException
	Get antennaId, which is optional.
void	setAntennaId (Tag[] antennaId)
	Set antennaId with the specified Tag[] value.
void	clearAntennaId ()
	Mark antennaId, which is an optional field, as non-existent.
void	setAntennaId (int i, Tag antennaId) throws IndexOutOfBoundsException
	Set antennaId[i] with the specified Tag value.
boolean	compareNoAutoInc (ArrayTime time, String issue, String details)
	Compare each attribute except the autoincrementable one of this AnnotationRow with the corresponding parameters and return true if there is a match and false otherwise.
boolean	equalByRequiredValue (AnnotationRow x)
	Return true if all required attributes of the value part are equal to their homologues in x and false otherwise.
boolean	compareRequiredValue (ArrayTime time, String issue, String details)
Protected Member Functions
void	setAnnotationId (Tag annotationId) throws IllegalAccessException
	Set annotationId with the specified Tag value.
Package Functions
	AnnotationRow (AnnotationTable table)
	Create a AnnotationRow.
	AnnotationRow (AnnotationTable table, AnnotationRow row)
	Creates a AnnotationRow using a copy constructor mechanism.
void	isAdded ()
void	addAntennaId (Tag id)
	Append a Tag to antennaId.
void	addAntennaId (Tag[] id)
	Append an array of Tag to antennaId.
Tag	getAntennaId (int i) throws IndexOutOfBoundsException
	Returns the Tag stored in antennaId at position i.
AntennaRow	getAntenna (int i) throws IndexOutOfBoundsException, NoSuchRow
	Returns the AntennaRow linked to this row via the Tag stored in antennaId at position i.
AntennaRow[]	getAntennas () throws NoSuchRow
	Returns the array of AntennaRow linked to this row via the Tags stored in antennaId.
Object[]	getAttributesValues ()
	Returns all the attributes of an attribute of an ASDM table as an array of Object.

---

Constructor & Destructor Documentation

alma.asdm.AnnotationRow.AnnotationRow (  AnnotationTable  table  )  [package]

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

Creates a AnnotationRow using a copy constructor mechanism. Given a AnnotationRow row and a AnnotationTable table, the method creates a new AnnotationRow 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

void alma.asdm.AnnotationRow.addAntennaId (  Tag[]  id  )  [package]

Append an array of Tag to antennaId. Parameters: id  an array of Tag to be appended to antennaId

void alma.asdm.AnnotationRow.addAntennaId (  Tag  id  )  [package]

Append a Tag to antennaId. Parameters: id  the Tag to be appended to antennaId

void alma.asdm.AnnotationRow.clearAntennaId (   )

Mark antennaId, which is an optional field, as non-existent.

void alma.asdm.AnnotationRow.clearBasebandName (   )

Mark basebandName, which is an optional field, as non-existent.

void alma.asdm.AnnotationRow.clearDValue (   )

Mark dValue, which is an optional field, as non-existent.

void alma.asdm.AnnotationRow.clearInterval (   )

Mark interval, which is an optional field, as non-existent.

void alma.asdm.AnnotationRow.clearLlValue (   )

Mark llValue, which is an optional field, as non-existent.

void alma.asdm.AnnotationRow.clearNumAntenna (   )

Mark numAntenna, which is an optional field, as non-existent.

void alma.asdm.AnnotationRow.clearNumBaseband (   )

Mark numBaseband, which is an optional field, as non-existent.

void alma.asdm.AnnotationRow.clearVdValue (   )

Mark vdValue, which is an optional field, as non-existent.

void alma.asdm.AnnotationRow.clearVllValue (   )

Mark vllValue, which is an optional field, as non-existent.

void alma.asdm.AnnotationRow.clearVvdValues (   )

Mark vvdValues, which is an optional field, as non-existent.

void alma.asdm.AnnotationRow.clearVvllValue (   )

Mark vvllValue, which is an optional field, as non-existent.

boolean alma.asdm.AnnotationRow.compareNoAutoInc (  ArrayTime  time, String  issue, String  details )

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

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

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

Tag alma.asdm.AnnotationRow.getAnnotationId (   )

Get annotationId. Returns: annotationId as Tag

Tag [] alma.asdm.AnnotationRow.getAntennaId (   )  throws IllegalAccessException

Get antennaId, which is optional. Returns: antennaId as Tag[] Exceptions: IllegalAccessException  If antennaId does not exist.

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

BasebandName [] alma.asdm.AnnotationRow.getBasebandName (   )  throws IllegalAccessException

Get basebandName, which is optional. Returns: basebandName as BasebandName[] Exceptions: IllegalAccessException  If basebandName does not exist.

String alma.asdm.AnnotationRow.getDetails (   )

Get details. Returns: details as String

double alma.asdm.AnnotationRow.getDValue (   )  throws IllegalAccessException

Get dValue, which is optional. Returns: dValue as double Exceptions: IllegalAccessException  If dValue does not exist.

Interval alma.asdm.AnnotationRow.getInterval (   )  throws IllegalAccessException

Get interval, which is optional. Returns: interval as Interval Exceptions: IllegalAccessException  If interval does not exist.

String alma.asdm.AnnotationRow.getIssue (   )

Get issue. Returns: issue as String

long alma.asdm.AnnotationRow.getLlValue (   )  throws IllegalAccessException

Get llValue, which is optional. Returns: llValue as long Exceptions: IllegalAccessException  If llValue does not exist.

int alma.asdm.AnnotationRow.getNumAntenna (   )  throws IllegalAccessException

Get numAntenna, which is optional. Returns: numAntenna as int Exceptions: IllegalAccessException  If numAntenna does not exist.

int alma.asdm.AnnotationRow.getNumBaseband (   )  throws IllegalAccessException

Get numBaseband, which is optional. Returns: numBaseband as int Exceptions: IllegalAccessException  If numBaseband does not exist.

AnnotationTable alma.asdm.AnnotationRow.getTable (   )

Return the table to which this row belongs.

ArrayTime alma.asdm.AnnotationRow.getTime (   )

Get time. Returns: time as ArrayTime

double [] alma.asdm.AnnotationRow.getVdValue (   )  throws IllegalAccessException

Get vdValue, which is optional. Returns: vdValue as double[] Exceptions: IllegalAccessException  If vdValue does not exist.

long [] alma.asdm.AnnotationRow.getVllValue (   )  throws IllegalAccessException

Get vllValue, which is optional. Returns: vllValue as long[] Exceptions: IllegalAccessException  If vllValue does not exist.

double [][] alma.asdm.AnnotationRow.getVvdValues (   )  throws IllegalAccessException

Get vvdValues, which is optional. Returns: vvdValues as double[][] Exceptions: IllegalAccessException  If vvdValues does not exist.

long [][] alma.asdm.AnnotationRow.getVvllValue (   )  throws IllegalAccessException

Get vvllValue, which is optional. Returns: vvllValue as long[][] Exceptions: IllegalAccessException  If vvllValue does not exist.

boolean alma.asdm.AnnotationRow.isAntennaIdExists (   )

The attribute antennaId is optional. Return true if this attribute exists. Returns: true if and only if the antennaId attribute exists.

boolean alma.asdm.AnnotationRow.isBasebandNameExists (   )

The attribute basebandName is optional. Return true if this attribute exists. Returns: true if and only if the basebandName attribute exists.

boolean alma.asdm.AnnotationRow.isDValueExists (   )

The attribute dValue is optional. Return true if this attribute exists. Returns: true if and only if the dValue attribute exists.

boolean alma.asdm.AnnotationRow.isIntervalExists (   )

The attribute interval is optional. Return true if this attribute exists. Returns: true if and only if the interval attribute exists.

boolean alma.asdm.AnnotationRow.isLlValueExists (   )

The attribute llValue is optional. Return true if this attribute exists. Returns: true if and only if the llValue attribute exists.

boolean alma.asdm.AnnotationRow.isNumAntennaExists (   )

The attribute numAntenna is optional. Return true if this attribute exists. Returns: true if and only if the numAntenna attribute exists.

boolean alma.asdm.AnnotationRow.isNumBasebandExists (   )

The attribute numBaseband is optional. Return true if this attribute exists. Returns: true if and only if the numBaseband attribute exists.

boolean alma.asdm.AnnotationRow.isVdValueExists (   )

The attribute vdValue is optional. Return true if this attribute exists. Returns: true if and only if the vdValue attribute exists.

boolean alma.asdm.AnnotationRow.isVllValueExists (   )

The attribute vllValue is optional. Return true if this attribute exists. Returns: true if and only if the vllValue attribute exists.

boolean alma.asdm.AnnotationRow.isVvdValuesExists (   )

The attribute vvdValues is optional. Return true if this attribute exists. Returns: true if and only if the vvdValues attribute exists.

boolean alma.asdm.AnnotationRow.isVvllValueExists (   )

The attribute vvllValue is optional. Return true if this attribute exists. Returns: true if and only if the vvllValue attribute exists.

void alma.asdm.AnnotationRow.setAnnotationId (  Tag  annotationId  )  throws IllegalAccessException [protected]

Set annotationId with the specified Tag value. Parameters: annotationId  The Tag value to which annotationId 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.AnnotationRow.setAntennaId (  int  i, Tag  antennaId )  throws IndexOutOfBoundsException

Set antennaId[i] with the specified Tag value. Parameters: i  The index in antennaId where to set the Tag value. antennaId  The Tag value to which antennaId[i] is to be set. Exceptions: IndexOutOfBoundsException

void alma.asdm.AnnotationRow.setAntennaId (  Tag[]  antennaId  )

Set antennaId with the specified Tag[] value. Parameters: antennaId  The Tag[] value to which antennaId is to be set.

void alma.asdm.AnnotationRow.setBasebandName (  BasebandName[]  basebandName  )

Set basebandName with the specified BasebandName[] value. Parameters: basebandName  The BasebandName[] value to which basebandName is to be set.

void alma.asdm.AnnotationRow.setDetails (  String  details  )  throws IllegalAccessException

Set details with the specified String value. Parameters: details  The String value to which details 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.AnnotationRow.setDValue (  double  dValue  )

Set dValue with the specified double value. Parameters: dValue  The double value to which dValue is to be set.

void alma.asdm.AnnotationRow.setFromIDL (  AnnotationRowIDL  x  )  throws ConversionException

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

void alma.asdm.AnnotationRow.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.AnnotationRow.setInterval (  Interval  interval  )

Set interval with the specified Interval value. Parameters: interval  The Interval value to which interval is to be set.

void alma.asdm.AnnotationRow.setIssue (  String  issue  )  throws IllegalAccessException

Set issue with the specified String value. Parameters: issue  The String value to which issue 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.AnnotationRow.setLlValue (  long  llValue  )

Set llValue with the specified long value. Parameters: llValue  The long value to which llValue is to be set.

void alma.asdm.AnnotationRow.setNumAntenna (  int  numAntenna  )

Set numAntenna with the specified int value. Parameters: numAntenna  The int value to which numAntenna is to be set.

void alma.asdm.AnnotationRow.setNumBaseband (  int  numBaseband  )

Set numBaseband with the specified int value. Parameters: numBaseband  The int value to which numBaseband is to be set.

void alma.asdm.AnnotationRow.setTime (  ArrayTime  time  )  throws IllegalAccessException

Set time with the specified ArrayTime value. Parameters: time  The ArrayTime value to which time 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.AnnotationRow.setVdValue (  double[]  vdValue  )

Set vdValue with the specified double[] value. Parameters: vdValue  The double[] value to which vdValue is to be set.

void alma.asdm.AnnotationRow.setVllValue (  long[]  vllValue  )

Set vllValue with the specified long[] value. Parameters: vllValue  The long[] value to which vllValue is to be set.

void alma.asdm.AnnotationRow.setVvdValues (  double  vvdValues[][]  )

Set vvdValues with the specified double[][] value. Parameters: vvdValues  The double[][] value to which vvdValues is to be set.

void alma.asdm.AnnotationRow.setVvllValue (  long  vvllValue[][]  )

Set vvllValue with the specified long[][] value. Parameters: vvllValue  The long[][] value to which vvllValue is to be set.

AnnotationRowIDL alma.asdm.AnnotationRow.toIDL (   )

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

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

• AnnotationRow.java

---