alma.asdm.SBSummaryRow Class Reference

Inherits alma.asdm.ASDMRow.

List of all members.


Detailed Description

The SBSummaryRow class is a row of a SBSummaryTable.

Generated from model's revision 1.46, branch HEAD


Public Member Functions

SBSummaryTable getTable ()
 Return the table to which this row belongs.
SBSummaryRowIDL toIDL ()
 Return this row in the form of an IDL struct.
void setFromIDL (SBSummaryRowIDL x) throws ConversionException
 Fill the values of this row from the IDL struct SBSummaryRowIDL.
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.
EntityRef getSbId ()
 Get sbId.
void setSbId (EntityRef sbId) throws IllegalAccessException
 Set sbId with the specified EntityRef value.
EntityRef getProjectId ()
 Get projectId.
void setProjectId (EntityRef projectId) throws IllegalAccessException
 Set projectId with the specified EntityRef value.
EntityRef getObsUnitSetId ()
 Get obsUnitSetId.
void setObsUnitSetId (EntityRef obsUnitSetId) throws IllegalAccessException
 Set obsUnitSetId with the specified EntityRef value.
String getSbIntent ()
 Get sbIntent.
void setSbIntent (String sbIntent) throws IllegalAccessException
 Set sbIntent with the specified String value.
SBType getSbType ()
 Get sbType.
void setSbType (SBType sbType) throws IllegalAccessException
 Set sbType with the specified SBType value.
Interval getSbDuration ()
 Get sbDuration.
void setSbDuration (Interval sbDuration) throws IllegalAccessException
 Set sbDuration with the specified Interval value.
int getNumScan ()
 Get numScan.
void setNumScan (int numScan) throws IllegalAccessException
 Set numScan with the specified int value.
String[] getScanIntent ()
 Get scanIntent.
void setScanIntent (String[] scanIntent) throws IllegalAccessException
 Set scanIntent with the specified String[] value.
int getNumberRepeats ()
 Get numberRepeats.
void setNumberRepeats (int numberRepeats) throws IllegalAccessException
 Set numberRepeats with the specified int value.
String[] getWeatherConstraint ()
 Get weatherConstraint.
void setWeatherConstraint (String[] weatherConstraint) throws IllegalAccessException
 Set weatherConstraint with the specified String[] value.
String[] getScienceGoal ()
 Get scienceGoal.
void setScienceGoal (String[] scienceGoal) throws IllegalAccessException
 Set scienceGoal with the specified String[] value.
double getRaCenter ()
 Get raCenter.
void setRaCenter (double raCenter) throws IllegalAccessException
 Set raCenter with the specified double value.
double getDecCenter ()
 Get decCenter.
void setDecCenter (double decCenter) throws IllegalAccessException
 Set decCenter with the specified double value.
double getFrequency ()
 Get frequency.
void setFrequency (double frequency) throws IllegalAccessException
 Set frequency with the specified double value.
String getFrequencyBand ()
 Get frequencyBand.
void setFrequencyBand (String frequencyBand) throws IllegalAccessException
 Set frequencyBand with the specified String value.
String[] getObservingMode ()
 Get observingMode.
void setObservingMode (String[] observingMode) throws IllegalAccessException
 Set observingMode with the specified String[] value.
boolean compareNoAutoInc (EntityRef sbId, EntityRef projectId, EntityRef obsUnitSetId, String sbIntent, SBType sbType, Interval sbDuration, int numScan, String[] scanIntent, int numberRepeats, String[] weatherConstraint, String[] scienceGoal, double raCenter, double decCenter, double frequency, String frequencyBand, String[] observingMode)
 Compare each attribute except the autoincrementable one of this SBSummaryRow with the corresponding parameters and return true if there is a match and false otherwise.
boolean equalByRequiredValue (SBSummaryRow x)
 Return true if all required attributes of the value part are equal to their homologues in x and false otherwise.
boolean compareRequiredValue (EntityRef projectId, EntityRef obsUnitSetId, String sbIntent, SBType sbType, Interval sbDuration, int numScan, String[] scanIntent, int numberRepeats, String[] weatherConstraint, String[] scienceGoal, double raCenter, double decCenter, double frequency, String frequencyBand, String[] observingMode)

Package Functions

 SBSummaryRow (SBSummaryTable table)
 Create a SBSummaryRow.
 SBSummaryRow (SBSummaryTable table, SBSummaryRow row)
 Creates a SBSummaryRow 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.SBSummaryRow.SBSummaryRow SBSummaryTable  table  )  [package]
 

Create a SBSummaryRow.

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.SBSummaryRow.SBSummaryRow SBSummaryTable  table,
SBSummaryRow  row
[package]
 

Creates a SBSummaryRow using a copy constructor mechanism.

Given a SBSummaryRow row and a SBSummaryTable table, the method creates a new SBSummaryRow 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.SBSummaryRow.compareNoAutoInc EntityRef  sbId,
EntityRef  projectId,
EntityRef  obsUnitSetId,
String  sbIntent,
SBType  sbType,
Interval  sbDuration,
int  numScan,
String[]  scanIntent,
int  numberRepeats,
String[]  weatherConstraint,
String[]  scienceGoal,
double  raCenter,
double  decCenter,
double  frequency,
String  frequencyBand,
String[]  observingMode
 

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

boolean alma.asdm.SBSummaryRow.equalByRequiredValue SBSummaryRow  x  ) 
 

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

Parameters:
x the SBSummaryRow whose required attributes of the value part will be compared with those of this.
Returns:
a boolean.

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

double alma.asdm.SBSummaryRow.getDecCenter  ) 
 

Get decCenter.

Returns:
decCenter as double

double alma.asdm.SBSummaryRow.getFrequency  ) 
 

Get frequency.

Returns:
frequency as double

String alma.asdm.SBSummaryRow.getFrequencyBand  ) 
 

Get frequencyBand.

Returns:
frequencyBand as String

int alma.asdm.SBSummaryRow.getNumberRepeats  ) 
 

Get numberRepeats.

Returns:
numberRepeats as int

int alma.asdm.SBSummaryRow.getNumScan  ) 
 

Get numScan.

Returns:
numScan as int

String [] alma.asdm.SBSummaryRow.getObservingMode  ) 
 

Get observingMode.

Returns:
observingMode as String[]

EntityRef alma.asdm.SBSummaryRow.getObsUnitSetId  ) 
 

Get obsUnitSetId.

Returns:
obsUnitSetId as EntityRef

EntityRef alma.asdm.SBSummaryRow.getProjectId  ) 
 

Get projectId.

Returns:
projectId as EntityRef

double alma.asdm.SBSummaryRow.getRaCenter  ) 
 

Get raCenter.

Returns:
raCenter as double

Interval alma.asdm.SBSummaryRow.getSbDuration  ) 
 

Get sbDuration.

Returns:
sbDuration as Interval

EntityRef alma.asdm.SBSummaryRow.getSbId  ) 
 

Get sbId.

Returns:
sbId as EntityRef

String alma.asdm.SBSummaryRow.getSbIntent  ) 
 

Get sbIntent.

Returns:
sbIntent as String

SBType alma.asdm.SBSummaryRow.getSbType  ) 
 

Get sbType.

Returns:
sbType as SBType

String [] alma.asdm.SBSummaryRow.getScanIntent  ) 
 

Get scanIntent.

Returns:
scanIntent as String[]

String [] alma.asdm.SBSummaryRow.getScienceGoal  ) 
 

Get scienceGoal.

Returns:
scienceGoal as String[]

SBSummaryTable alma.asdm.SBSummaryRow.getTable  ) 
 

Return the table to which this row belongs.

String [] alma.asdm.SBSummaryRow.getWeatherConstraint  ) 
 

Get weatherConstraint.

Returns:
weatherConstraint as String[]

void alma.asdm.SBSummaryRow.setDecCenter double  decCenter  )  throws IllegalAccessException
 

Set decCenter with the specified double value.

Parameters:
decCenter The double value to which decCenter 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.SBSummaryRow.setFrequency double  frequency  )  throws IllegalAccessException
 

Set frequency with the specified double value.

Parameters:
frequency The double value to which frequency 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.SBSummaryRow.setFrequencyBand String  frequencyBand  )  throws IllegalAccessException
 

Set frequencyBand with the specified String value.

Parameters:
frequencyBand The String value to which frequencyBand 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.SBSummaryRow.setFromIDL SBSummaryRowIDL  x  )  throws ConversionException
 

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

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

void alma.asdm.SBSummaryRow.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.SBSummaryRow.setNumberRepeats int  numberRepeats  )  throws IllegalAccessException
 

Set numberRepeats with the specified int value.

Parameters:
numberRepeats The int value to which numberRepeats 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.SBSummaryRow.setNumScan int  numScan  )  throws IllegalAccessException
 

Set numScan with the specified int value.

Parameters:
numScan The int value to which numScan 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.SBSummaryRow.setObservingMode String[]  observingMode  )  throws IllegalAccessException
 

Set observingMode with the specified String[] value.

Parameters:
observingMode The String[] value to which observingMode 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.SBSummaryRow.setObsUnitSetId EntityRef  obsUnitSetId  )  throws IllegalAccessException
 

Set obsUnitSetId with the specified EntityRef value.

Parameters:
obsUnitSetId The EntityRef value to which obsUnitSetId 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.SBSummaryRow.setProjectId EntityRef  projectId  )  throws IllegalAccessException
 

Set projectId with the specified EntityRef value.

Parameters:
projectId The EntityRef value to which projectId 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.SBSummaryRow.setRaCenter double  raCenter  )  throws IllegalAccessException
 

Set raCenter with the specified double value.

Parameters:
raCenter The double value to which raCenter 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.SBSummaryRow.setSbDuration Interval  sbDuration  )  throws IllegalAccessException
 

Set sbDuration with the specified Interval value.

Parameters:
sbDuration The Interval value to which sbDuration 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.SBSummaryRow.setSbId EntityRef  sbId  )  throws IllegalAccessException
 

Set sbId with the specified EntityRef value.

Parameters:
sbId The EntityRef value to which sbId 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.SBSummaryRow.setSbIntent String  sbIntent  )  throws IllegalAccessException
 

Set sbIntent with the specified String value.

Parameters:
sbIntent The String value to which sbIntent 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.SBSummaryRow.setSbType SBType  sbType  )  throws IllegalAccessException
 

Set sbType with the specified SBType value.

Parameters:
sbType The SBType value to which sbType 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.SBSummaryRow.setScanIntent String[]  scanIntent  )  throws IllegalAccessException
 

Set scanIntent with the specified String[] value.

Parameters:
scanIntent The String[] value to which scanIntent 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.SBSummaryRow.setScienceGoal String[]  scienceGoal  )  throws IllegalAccessException
 

Set scienceGoal with the specified String[] value.

Parameters:
scienceGoal The String[] value to which scienceGoal 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.SBSummaryRow.setWeatherConstraint String[]  weatherConstraint  )  throws IllegalAccessException
 

Set weatherConstraint with the specified String[] value.

Parameters:
weatherConstraint The String[] value to which weatherConstraint is to be set.
Exceptions:
IllegalAccessException If an attempt is made to change this field after is has been added to the table.

SBSummaryRowIDL alma.asdm.SBSummaryRow.toIDL  ) 
 

Return this row in the form of an IDL struct.

Returns:
The values of this row as a SBSummaryRowIDL struct.

String alma.asdm.SBSummaryRow.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:
Generated on Tue Nov 18 17:46:47 2008 for ASDM Java Implementation by doxygen 1.3.8