alma.asdm.SourceRow Class Reference

Inherits alma.asdm.ASDMRow.

List of all members.

---

Detailed Description

The SourceRow class is a row of a SourceTable.

Generated from model's revision 1.41, branch HEAD

Public Member Functions
SourceTable	getTable ()
	Return the table to which this row belongs.
SourceRowIDL	toIDL ()
	Return this row in the form of an IDL struct.
void	setFromIDL (SourceRowIDL x) throws ConversionException
	Fill the values of this row from the IDL struct SourceRowIDL.
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.
int	getSourceId ()
	Get sourceId.
ArrayTimeInterval	getTimeInterval ()
	Get timeInterval.
void	setTimeInterval (ArrayTimeInterval timeInterval) throws IllegalAccessException
	Set timeInterval with the specified ArrayTimeInterval value.
int	getNumLines ()
	Get numLines.
void	setNumLines (int numLines)
	Set numLines with the specified int value.
String	getSourceName ()
	Get sourceName.
void	setSourceName (String sourceName)
	Set sourceName with the specified String value.
boolean	isCatalogExists ()
	The attribute catalog is optional.
String	getCatalog () throws IllegalAccessException
	Get catalog, which is optional.
void	setCatalog (String catalog)
	Set catalog with the specified String value.
void	clearCatalog ()
	Mark catalog, which is an optional field, as non-existent.
boolean	isCalibrationGroupExists ()
	The attribute calibrationGroup is optional.
int	getCalibrationGroup () throws IllegalAccessException
	Get calibrationGroup, which is optional.
void	setCalibrationGroup (int calibrationGroup)
	Set calibrationGroup with the specified int value.
void	clearCalibrationGroup ()
	Mark calibrationGroup, which is an optional field, as non-existent.
String	getCode ()
	Get code.
void	setCode (String code)
	Set code with the specified String value.
Angle[]	getDirection ()
	Get direction.
void	setDirection (Angle[] direction)
	Set direction with the specified Angle[] value.
boolean	isPositionExists ()
	The attribute position is optional.
Length[]	getPosition () throws IllegalAccessException
	Get position, which is optional.
void	setPosition (Length[] position)
	Set position with the specified Length[] value.
void	clearPosition ()
	Mark position, which is an optional field, as non-existent.
AngularRate[]	getProperMotion ()
	Get properMotion.
void	setProperMotion (AngularRate[] properMotion)
	Set properMotion with the specified AngularRate[] value.
boolean	isTransitionExists ()
	The attribute transition is optional.
String[]	getTransition () throws IllegalAccessException
	Get transition, which is optional.
void	setTransition (String[] transition)
	Set transition with the specified String[] value.
void	clearTransition ()
	Mark transition, which is an optional field, as non-existent.
boolean	isRestFrequencyExists ()
	The attribute restFrequency is optional.
Frequency[]	getRestFrequency () throws IllegalAccessException
	Get restFrequency, which is optional.
void	setRestFrequency (Frequency[] restFrequency)
	Set restFrequency with the specified Frequency[] value.
void	clearRestFrequency ()
	Mark restFrequency, which is an optional field, as non-existent.
boolean	isSysVelExists ()
	The attribute sysVel is optional.
Speed[]	getSysVel () throws IllegalAccessException
	Get sysVel, which is optional.
void	setSysVel (Speed[] sysVel)
	Set sysVel with the specified Speed[] value.
void	clearSysVel ()
	Mark sysVel, which is an optional field, as non-existent.
boolean	isSourceModelExists ()
	The attribute sourceModel is optional.
SourceModel	getSourceModel () throws IllegalAccessException
	Get sourceModel, which is optional.
void	setSourceModel (SourceModel sourceModel)
	Set sourceModel with the specified SourceModel value.
void	clearSourceModel ()
	Mark sourceModel, which is an optional field, as non-existent.
boolean	isDeltaVelExists ()
	The attribute deltaVel is optional.
Speed	getDeltaVel () throws IllegalAccessException
	Get deltaVel, which is optional.
void	setDeltaVel (Speed deltaVel)
	Set deltaVel with the specified Speed value.
void	clearDeltaVel ()
	Mark deltaVel, which is an optional field, as non-existent.
boolean	isRangeVelExists ()
	The attribute rangeVel is optional.
Speed[]	getRangeVel () throws IllegalAccessException
	Get rangeVel, which is optional.
void	setRangeVel (Speed[] rangeVel)
	Set rangeVel with the specified Speed[] value.
void	clearRangeVel ()
	Mark rangeVel, which is an optional field, as non-existent.
boolean	isSourceParameterIdExists ()
	The attribute sourceParameterId is optional.
int	getSourceParameterId () throws IllegalAccessException
	Get sourceParameterId, which is optional.
void	setSourceParameterId (int sourceParameterId)
	Set sourceParameterId with the specified int value.
void	clearSourceParameterId ()
	Mark sourceParameterId, which is an optional field, as non-existent.
Tag	getSpectralWindowId ()
	Get spectralWindowId.
void	setSpectralWindowId (Tag spectralWindowId) throws IllegalAccessException
	Set spectralWindowId with the specified Tag value.
SpectralWindowRow	getSpectralWindowUsingSpectralWindowId ()
	Returns the pointer to the row in the SpectralWindow table having SpectralWindow.spectralWindowId == spectralWindowId.
SourceParameterRow[]	getSourceParameters () throws InvalidAccessException, NoSuchRow
	Get the collection of rows in the SourceParameter table having sourceParameterId == this.sourceParameterId.
boolean	compareNoAutoInc (Tag spectralWindowId, ArrayTimeInterval timeInterval, int numLines, String sourceName, String code, Angle[] direction, AngularRate[] properMotion)
	Compare each attribute except the autoincrementable one of this SourceRow with the corresponding parameters and return true if there is a match and false otherwise.
boolean	equalByRequiredValue (SourceRow x)
	Return true if all required attributes of the value part are equal to their homologues in x and false otherwise.
boolean	compareRequiredValue (int numLines, String sourceName, String code, Angle[] direction, AngularRate[] properMotion)
Protected Member Functions
void	setSourceId (int sourceId) throws IllegalAccessException
	Set sourceId with the specified int value.
Package Functions
	SourceRow (SourceTable table)
	Create a SourceRow.
	SourceRow (SourceTable table, SourceRow row)
	Creates a SourceRow 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.SourceRow.SourceRow

(

SourceTable

table

)

[package]

Create a SourceRow.

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

Creates a SourceRow using a copy constructor mechanism.

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

SourceRowIDL alma.asdm.SourceRow.toIDL

(

)

Return this row in the form of an IDL struct.

Returns:

The values of this row as a SourceRowIDL struct.

void alma.asdm.SourceRow.setFromIDL

(

SourceRowIDL

x

)

throws ConversionException

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

Parameters:

x

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

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

int alma.asdm.SourceRow.getSourceId

(

)

Get sourceId.

Returns:

sourceId as int

void alma.asdm.SourceRow.setSourceId

(

int

sourceId

)

throws IllegalAccessException [protected]

Set sourceId with the specified int value.

Parameters:

sourceId

The int value to which sourceId is to be set.

Exceptions:

IllegalAccessException

If an attempt is made to change this field after is has been added to the table.

ArrayTimeInterval alma.asdm.SourceRow.getTimeInterval

(

)

Get timeInterval.

Returns:

timeInterval as ArrayTimeInterval

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

int alma.asdm.SourceRow.getNumLines

(

)

Get numLines.

Returns:

numLines as int

void alma.asdm.SourceRow.setNumLines

(

int

numLines

)

Set numLines with the specified int value.

Parameters:

numLines

The int value to which numLines is to be set.

String alma.asdm.SourceRow.getSourceName

(

)

Get sourceName.

Returns:

sourceName as String

void alma.asdm.SourceRow.setSourceName

(

String

sourceName

)

Set sourceName with the specified String value.

Parameters:

sourceName

The String value to which sourceName is to be set.

boolean alma.asdm.SourceRow.isCatalogExists

(

)

The attribute catalog is optional.

Return true if this attribute exists.

Returns:

true if and only if the catalog attribute exists.

String alma.asdm.SourceRow.getCatalog

(

)

throws IllegalAccessException

Get catalog, which is optional.

Returns:

catalog as String

Exceptions:

IllegalAccessException

If catalog does not exist.

void alma.asdm.SourceRow.setCatalog

(

String

catalog

)

Set catalog with the specified String value.

Parameters:

catalog

The String value to which catalog is to be set.

boolean alma.asdm.SourceRow.isCalibrationGroupExists

(

)

The attribute calibrationGroup is optional.

Return true if this attribute exists.

Returns:

true if and only if the calibrationGroup attribute exists.

int alma.asdm.SourceRow.getCalibrationGroup

(

)

throws IllegalAccessException

Get calibrationGroup, which is optional.

Returns:

calibrationGroup as int

Exceptions:

IllegalAccessException

If calibrationGroup does not exist.

void alma.asdm.SourceRow.setCalibrationGroup

(

int

calibrationGroup

)

Set calibrationGroup with the specified int value.

Parameters:

calibrationGroup

The int value to which calibrationGroup is to be set.

String alma.asdm.SourceRow.getCode

(

)

Get code.

Returns:

code as String

void alma.asdm.SourceRow.setCode

(

String

code

)

Set code with the specified String value.

Parameters:

code

The String value to which code is to be set.

Angle [] alma.asdm.SourceRow.getDirection

(

)

Get direction.

Returns:

direction as Angle[]

void alma.asdm.SourceRow.setDirection

(

Angle[]

direction

)

Set direction with the specified Angle[] value.

Parameters:

direction

The Angle[] value to which direction is to be set.

boolean alma.asdm.SourceRow.isPositionExists

(

)

The attribute position is optional.

Return true if this attribute exists.

Returns:

true if and only if the position attribute exists.

Length [] alma.asdm.SourceRow.getPosition

(

)

throws IllegalAccessException

Get position, which is optional.

Returns:

position as Length[]

Exceptions:

IllegalAccessException

If position does not exist.

void alma.asdm.SourceRow.setPosition

(

Length[]

position

)

Set position with the specified Length[] value.

Parameters:

position

The Length[] value to which position is to be set.

AngularRate [] alma.asdm.SourceRow.getProperMotion

(

)

Get properMotion.

Returns:

properMotion as AngularRate[]

void alma.asdm.SourceRow.setProperMotion

(

AngularRate[]

properMotion

)

Set properMotion with the specified AngularRate[] value.

Parameters:

properMotion

The AngularRate[] value to which properMotion is to be set.

boolean alma.asdm.SourceRow.isTransitionExists

(

)

The attribute transition is optional.

Return true if this attribute exists.

Returns:

true if and only if the transition attribute exists.

String [] alma.asdm.SourceRow.getTransition

(

)

throws IllegalAccessException

Get transition, which is optional.

Returns:

transition as String[]

Exceptions:

IllegalAccessException

If transition does not exist.

void alma.asdm.SourceRow.setTransition

(

String[]

transition

)

Set transition with the specified String[] value.

Parameters:

transition

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

boolean alma.asdm.SourceRow.isRestFrequencyExists

(

)

The attribute restFrequency is optional.

Return true if this attribute exists.

Returns:

true if and only if the restFrequency attribute exists.

Frequency [] alma.asdm.SourceRow.getRestFrequency

(

)

throws IllegalAccessException

Get restFrequency, which is optional.

Returns:

restFrequency as Frequency[]

Exceptions:

IllegalAccessException

If restFrequency does not exist.

void alma.asdm.SourceRow.setRestFrequency

(

Frequency[]

restFrequency

)

Set restFrequency with the specified Frequency[] value.

Parameters:

restFrequency

The Frequency[] value to which restFrequency is to be set.

boolean alma.asdm.SourceRow.isSysVelExists

(

)

The attribute sysVel is optional.

Return true if this attribute exists.

Returns:

true if and only if the sysVel attribute exists.

Speed [] alma.asdm.SourceRow.getSysVel

(

)

throws IllegalAccessException

Get sysVel, which is optional.

Returns:

sysVel as Speed[]

Exceptions:

IllegalAccessException

If sysVel does not exist.

void alma.asdm.SourceRow.setSysVel

(

Speed[]

sysVel

)

Set sysVel with the specified Speed[] value.

Parameters:

sysVel

The Speed[] value to which sysVel is to be set.

boolean alma.asdm.SourceRow.isSourceModelExists

(

)

The attribute sourceModel is optional.

Return true if this attribute exists.

Returns:

true if and only if the sourceModel attribute exists.

SourceModel alma.asdm.SourceRow.getSourceModel

(

)

throws IllegalAccessException

Get sourceModel, which is optional.

Returns:

sourceModel as SourceModel

Exceptions:

IllegalAccessException

If sourceModel does not exist.

void alma.asdm.SourceRow.setSourceModel

(

SourceModel

sourceModel

)

Set sourceModel with the specified SourceModel value.

Parameters:

sourceModel

The SourceModel value to which sourceModel is to be set.

boolean alma.asdm.SourceRow.isDeltaVelExists

(

)

The attribute deltaVel is optional.

Return true if this attribute exists.

Returns:

true if and only if the deltaVel attribute exists.

Speed alma.asdm.SourceRow.getDeltaVel

(

)

throws IllegalAccessException

Get deltaVel, which is optional.

Returns:

deltaVel as Speed

Exceptions:

IllegalAccessException

If deltaVel does not exist.

void alma.asdm.SourceRow.setDeltaVel

(

Speed

deltaVel

)

Set deltaVel with the specified Speed value.

Parameters:

deltaVel

The Speed value to which deltaVel is to be set.

boolean alma.asdm.SourceRow.isRangeVelExists

(

)

The attribute rangeVel is optional.

Return true if this attribute exists.

Returns:

true if and only if the rangeVel attribute exists.

Speed [] alma.asdm.SourceRow.getRangeVel

(

)

throws IllegalAccessException

Get rangeVel, which is optional.

Returns:

rangeVel as Speed[]

Exceptions:

IllegalAccessException

If rangeVel does not exist.

void alma.asdm.SourceRow.setRangeVel

(

Speed[]

rangeVel

)

Set rangeVel with the specified Speed[] value.

Parameters:

rangeVel

The Speed[] value to which rangeVel is to be set.

boolean alma.asdm.SourceRow.isSourceParameterIdExists

(

)

The attribute sourceParameterId is optional.

Return true if this attribute exists.

Returns:

true if and only if the sourceParameterId attribute exists.

int alma.asdm.SourceRow.getSourceParameterId

(

)

throws IllegalAccessException

Get sourceParameterId, which is optional.

Returns:

sourceParameterId as int

Exceptions:

IllegalAccessException

If sourceParameterId does not exist.

void alma.asdm.SourceRow.setSourceParameterId

(

int

sourceParameterId

)

Set sourceParameterId with the specified int value.

Parameters:

sourceParameterId

The int value to which sourceParameterId is to be set.

Tag alma.asdm.SourceRow.getSpectralWindowId

(

)

Get spectralWindowId.

Returns:

spectralWindowId as Tag

void alma.asdm.SourceRow.setSpectralWindowId

(

Tag

spectralWindowId

)

throws IllegalAccessException

Set spectralWindowId with the specified Tag value.

Parameters:

spectralWindowId

The Tag value to which spectralWindowId is to be set.

Exceptions:

IllegalAccessException

If an attempt is made to change this field after is has been added to the table.

SpectralWindowRow alma.asdm.SourceRow.getSpectralWindowUsingSpectralWindowId

(

)

Returns the pointer to the row in the SpectralWindow table having SpectralWindow.spectralWindowId == spectralWindowId.

Returns:

a SpectralWindowRow

boolean alma.asdm.SourceRow.equalByRequiredValue

(

SourceRow

x

)

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

Parameters:

x

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

Returns:

a boolean.

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

• SourceRow.java

---