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.41, 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)
	Set projectId with the specified EntityRef value.
EntityRef	getObsUnitSetId ()
	Get obsUnitSetId.
void	setObsUnitSetId (EntityRef obsUnitSetId)
	Set obsUnitSetId with the specified EntityRef value.
String	getSbIntent ()
	Get sbIntent.
void	setSbIntent (String sbIntent)
	Set sbIntent with the specified String value.
SBType	getSbType ()
	Get sbType.
void	setSbType (SBType sbType)
	Set sbType with the specified SBType value.
Interval	getSbDuration ()
	Get sbDuration.
void	setSbDuration (Interval sbDuration)
	Set sbDuration with the specified Interval value.
int	getNumScan ()
	Get numScan.
void	setNumScan (int numScan)
	Set numScan with the specified int value.
String[]	getScanIntent ()
	Get scanIntent.
void	setScanIntent (String[] scanIntent)
	Set scanIntent with the specified String[] value.
int	getNumberRepeats ()
	Get numberRepeats.
void	setNumberRepeats (int numberRepeats)
	Set numberRepeats with the specified int value.
String[]	getWeatherConstraint ()
	Get weatherConstraint.
void	setWeatherConstraint (String[] weatherConstraint)
	Set weatherConstraint with the specified String[] value.
String[]	getScienceGoal ()
	Get scienceGoal.
void	setScienceGoal (String[] scienceGoal)
	Set scienceGoal with the specified String[] value.
double	getRaCenter ()
	Get raCenter.
void	setRaCenter (double raCenter)
	Set raCenter with the specified double value.
double	getDecCenter ()
	Get decCenter.
void	setDecCenter (double decCenter)
	Set decCenter with the specified double value.
double	getFrequency ()
	Get frequency.
void	setFrequency (double frequency)
	Set frequency with the specified double value.
String	getFrequencyBand ()
	Get frequencyBand.
void	setFrequencyBand (String frequencyBand)
	Set frequencyBand with the specified String value.
String[]	getObservingMode ()
	Get observingMode.
void	setObservingMode (String[] observingMode)
	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

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.

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.

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.

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.

EntityRef alma.asdm.SBSummaryRow.getSbId

(

)

Get sbId.

Returns:

sbId as EntityRef

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.

EntityRef alma.asdm.SBSummaryRow.getProjectId

(

)

Get projectId.

Returns:

projectId as EntityRef

void alma.asdm.SBSummaryRow.setProjectId

(

EntityRef

projectId

)

Set projectId with the specified EntityRef value.

Parameters:

projectId

The EntityRef value to which projectId is to be set.

EntityRef alma.asdm.SBSummaryRow.getObsUnitSetId

(

)

Get obsUnitSetId.

Returns:

obsUnitSetId as EntityRef

void alma.asdm.SBSummaryRow.setObsUnitSetId

(

EntityRef

obsUnitSetId

)

Set obsUnitSetId with the specified EntityRef value.

Parameters:

obsUnitSetId

The EntityRef value to which obsUnitSetId is to be set.

String alma.asdm.SBSummaryRow.getSbIntent

(

)

Get sbIntent.

Returns:

sbIntent as String

void alma.asdm.SBSummaryRow.setSbIntent

(

String

sbIntent

)

Set sbIntent with the specified String value.

Parameters:

sbIntent

The String value to which sbIntent is to be set.

SBType alma.asdm.SBSummaryRow.getSbType

(

)

Get sbType.

Returns:

sbType as SBType

void alma.asdm.SBSummaryRow.setSbType

(

SBType

sbType

)

Set sbType with the specified SBType value.

Parameters:

sbType

The SBType value to which sbType is to be set.

Interval alma.asdm.SBSummaryRow.getSbDuration

(

)

Get sbDuration.

Returns:

sbDuration as Interval

void alma.asdm.SBSummaryRow.setSbDuration

(

Interval

sbDuration

)

Set sbDuration with the specified Interval value.

Parameters:

sbDuration

The Interval value to which sbDuration is to be set.

int alma.asdm.SBSummaryRow.getNumScan

(

)

Get numScan.

Returns:

numScan as int

void alma.asdm.SBSummaryRow.setNumScan

(

int

numScan

)

Set numScan with the specified int value.

Parameters:

numScan

The int value to which numScan is to be set.

String [] alma.asdm.SBSummaryRow.getScanIntent

(

)

Get scanIntent.

Returns:

scanIntent as String[]

void alma.asdm.SBSummaryRow.setScanIntent

(

String[]

scanIntent

)

Set scanIntent with the specified String[] value.

Parameters:

scanIntent

The String[] value to which scanIntent is to be set.

int alma.asdm.SBSummaryRow.getNumberRepeats

(

)

Get numberRepeats.

Returns:

numberRepeats as int

void alma.asdm.SBSummaryRow.setNumberRepeats

(

int

numberRepeats

)

Set numberRepeats with the specified int value.

Parameters:

numberRepeats

The int value to which numberRepeats is to be set.

String [] alma.asdm.SBSummaryRow.getWeatherConstraint

(

)

Get weatherConstraint.

Returns:

weatherConstraint as String[]

void alma.asdm.SBSummaryRow.setWeatherConstraint

(

String[]

weatherConstraint

)

Set weatherConstraint with the specified String[] value.

Parameters:

weatherConstraint

The String[] value to which weatherConstraint is to be set.

String [] alma.asdm.SBSummaryRow.getScienceGoal

(

)

Get scienceGoal.

Returns:

scienceGoal as String[]

void alma.asdm.SBSummaryRow.setScienceGoal

(

String[]

scienceGoal

)

Set scienceGoal with the specified String[] value.

Parameters:

scienceGoal

The String[] value to which scienceGoal is to be set.

double alma.asdm.SBSummaryRow.getRaCenter

(

)

Get raCenter.

Returns:

raCenter as double

void alma.asdm.SBSummaryRow.setRaCenter

(

double

raCenter

)

Set raCenter with the specified double value.

Parameters:

raCenter

The double value to which raCenter is to be set.

double alma.asdm.SBSummaryRow.getDecCenter

(

)

Get decCenter.

Returns:

decCenter as double

void alma.asdm.SBSummaryRow.setDecCenter

(

double

decCenter

)

Set decCenter with the specified double value.

Parameters:

decCenter

The double value to which decCenter is to be set.

double alma.asdm.SBSummaryRow.getFrequency

(

)

Get frequency.

Returns:

frequency as double

void alma.asdm.SBSummaryRow.setFrequency

(

double

frequency

)

Set frequency with the specified double value.

Parameters:

frequency

The double value to which frequency is to be set.

String alma.asdm.SBSummaryRow.getFrequencyBand

(

)

Get frequencyBand.

Returns:

frequencyBand as String

void alma.asdm.SBSummaryRow.setFrequencyBand

(

String

frequencyBand

)

Set frequencyBand with the specified String value.

Parameters:

frequencyBand

The String value to which frequencyBand is to be set.

String [] alma.asdm.SBSummaryRow.getObservingMode

(

)

Get observingMode.

Returns:

observingMode as String[]

void alma.asdm.SBSummaryRow.setObservingMode

(

String[]

observingMode

)

Set observingMode with the specified String[] value.

Parameters:

observingMode

The String[] value to which observingMode is to be set.

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.

---

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

• SBSummaryRow.java

---