alma.asdm.CalDataRow Class Reference

Inherits alma.asdm.ASDMRow.

List of all members.

---

Detailed Description

The CalDataRow class is a row of a CalDataTable.

Generated from model's revision 1.41, branch HEAD

Public Member Functions
CalDataTable	getTable ()
	Return the table to which this row belongs.
CalDataRowIDL	toIDL ()
	Return this row in the form of an IDL struct.
void	setFromIDL (CalDataRowIDL x) throws ConversionException
	Fill the values of this row from the IDL struct CalDataRowIDL.
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	getCalDataId ()
	Get calDataId.
int	getNumScan ()
	Get numScan.
void	setNumScan (int numScan)
	Set numScan with the specified int value.
boolean	isFrequencyGroupExists ()
	The attribute frequencyGroup is optional.
int	getFrequencyGroup () throws IllegalAccessException
	Get frequencyGroup, which is optional.
void	setFrequencyGroup (int frequencyGroup)
	Set frequencyGroup with the specified int value.
void	clearFrequencyGroup ()
	Mark frequencyGroup, which is an optional field, as non-existent.
int[]	getScanSet ()
	Get scanSet.
void	setScanSet (int[] scanSet)
	Set scanSet with the specified int[] value.
CalType	getCalType ()
	Get calType.
void	setCalType (CalType calType)
	Set calType with the specified CalType value.
boolean	isFreqGroupNameExists ()
	The attribute freqGroupName is optional.
String	getFreqGroupName () throws IllegalAccessException
	Get freqGroupName, which is optional.
void	setFreqGroupName (String freqGroupName)
	Set freqGroupName with the specified String value.
void	clearFreqGroupName ()
	Mark freqGroupName, which is an optional field, as non-existent.
boolean	isFieldNameExists ()
	The attribute fieldName is optional.
String	getFieldName () throws IllegalAccessException
	Get fieldName, which is optional.
void	setFieldName (String fieldName)
	Set fieldName with the specified String value.
void	clearFieldName ()
	Mark fieldName, which is an optional field, as non-existent.
boolean	isFieldCodeExists ()
	The attribute fieldCode is optional.
String[]	getFieldCode () throws IllegalAccessException
	Get fieldCode, which is optional.
void	setFieldCode (String[] fieldCode)
	Set fieldCode with the specified String[] value.
void	clearFieldCode ()
	Mark fieldCode, which is an optional field, as non-existent.
ArrayTime	getStartTimeObserved ()
	Get startTimeObserved.
void	setStartTimeObserved (ArrayTime startTimeObserved)
	Set startTimeObserved with the specified ArrayTime value.
ArrayTime	getEndTimeObserved ()
	Get endTimeObserved.
void	setEndTimeObserved (ArrayTime endTimeObserved)
	Set endTimeObserved with the specified ArrayTime value.
boolean	isSourceNameExists ()
	The attribute sourceName is optional.
String[]	getSourceName () throws IllegalAccessException
	Get sourceName, which is optional.
void	setSourceName (String[] sourceName)
	Set sourceName with the specified String[] value.
void	clearSourceName ()
	Mark sourceName, which is an optional field, as non-existent.
boolean	isSourceCodeExists ()
	The attribute sourceCode is optional.
String[]	getSourceCode () throws IllegalAccessException
	Get sourceCode, which is optional.
void	setSourceCode (String[] sourceCode)
	Set sourceCode with the specified String[] value.
void	clearSourceCode ()
	Mark sourceCode, which is an optional field, as non-existent.
boolean	isScanIntentExists ()
	The attribute scanIntent is optional.
ScanIntent[]	getScanIntent () throws IllegalAccessException
	Get scanIntent, which is optional.
void	setScanIntent (ScanIntent[] scanIntent)
	Set scanIntent with the specified ScanIntent[] value.
void	clearScanIntent ()
	Mark scanIntent, which is an optional field, as non-existent.
boolean	isAssocCalDataIdExists ()
	The attribute assocCalDataId is optional.
Tag	getAssocCalDataId () throws IllegalAccessException
	Get assocCalDataId, which is optional.
void	setAssocCalDataId (Tag assocCalDataId)
	Set assocCalDataId with the specified Tag value.
void	clearAssocCalDataId ()
	Mark assocCalDataId, which is an optional field, as non-existent.
boolean	isAssocCalNatureExists ()
	The attribute assocCalNature is optional.
AssociatedCalNature	getAssocCalNature () throws IllegalAccessException
	Get assocCalNature, which is optional.
void	setAssocCalNature (AssociatedCalNature assocCalNature)
	Set assocCalNature with the specified AssociatedCalNature value.
void	clearAssocCalNature ()
	Mark assocCalNature, which is an optional field, as non-existent.
CalDataOrigin	getCalDataType ()
	Get calDataType.
void	setCalDataType (CalDataOrigin calDataType)
	Set calDataType with the specified CalDataOrigin value.
boolean	compareNoAutoInc (int numScan, int[] scanSet, CalType calType, ArrayTime startTimeObserved, ArrayTime endTimeObserved, CalDataOrigin calDataType)
	Compare each attribute except the autoincrementable one of this CalDataRow with the corresponding parameters and return true if there is a match and false otherwise.
boolean	equalByRequiredValue (CalDataRow x)
	Return true if all required attributes of the value part are equal to their homologues in x and false otherwise.
boolean	compareRequiredValue (int numScan, int[] scanSet, CalType calType, ArrayTime startTimeObserved, ArrayTime endTimeObserved, CalDataOrigin calDataType)
Protected Member Functions
void	setCalDataId (Tag calDataId) throws IllegalAccessException
	Set calDataId with the specified Tag value.
Package Functions
	CalDataRow (CalDataTable table)
	Create a CalDataRow.
	CalDataRow (CalDataTable table, CalDataRow row)
	Creates a CalDataRow 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.CalDataRow.CalDataRow

(

CalDataTable

table

)

[package]

Create a CalDataRow.

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

Creates a CalDataRow using a copy constructor mechanism.

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

CalDataRowIDL alma.asdm.CalDataRow.toIDL

(

)

Return this row in the form of an IDL struct.

Returns:

The values of this row as a CalDataRowIDL struct.

void alma.asdm.CalDataRow.setFromIDL

(

CalDataRowIDL

x

)

throws ConversionException

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

Parameters:

x

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

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

(

)

Get calDataId.

Returns:

calDataId as Tag

void alma.asdm.CalDataRow.setCalDataId

(

Tag

calDataId

)

throws IllegalAccessException [protected]

Set calDataId with the specified Tag value.

Parameters:

calDataId

The Tag value to which calDataId 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.CalDataRow.getNumScan

(

)

Get numScan.

Returns:

numScan as int

void alma.asdm.CalDataRow.setNumScan

(

int

numScan

)

Set numScan with the specified int value.

Parameters:

numScan

The int value to which numScan is to be set.

boolean alma.asdm.CalDataRow.isFrequencyGroupExists

(

)

The attribute frequencyGroup is optional.

Return true if this attribute exists.

Returns:

true if and only if the frequencyGroup attribute exists.

int alma.asdm.CalDataRow.getFrequencyGroup

(

)

throws IllegalAccessException

Get frequencyGroup, which is optional.

Returns:

frequencyGroup as int

Exceptions:

IllegalAccessException

If frequencyGroup does not exist.

void alma.asdm.CalDataRow.setFrequencyGroup

(

int

frequencyGroup

)

Set frequencyGroup with the specified int value.

Parameters:

frequencyGroup

The int value to which frequencyGroup is to be set.

int [] alma.asdm.CalDataRow.getScanSet

(

)

Get scanSet.

Returns:

scanSet as int[]

void alma.asdm.CalDataRow.setScanSet

(

int[]

scanSet

)

Set scanSet with the specified int[] value.

Parameters:

scanSet

The int[] value to which scanSet is to be set.

CalType alma.asdm.CalDataRow.getCalType

(

)

Get calType.

Returns:

calType as CalType

void alma.asdm.CalDataRow.setCalType

(

CalType

calType

)

Set calType with the specified CalType value.

Parameters:

calType

The CalType value to which calType is to be set.

boolean alma.asdm.CalDataRow.isFreqGroupNameExists

(

)

The attribute freqGroupName is optional.

Return true if this attribute exists.

Returns:

true if and only if the freqGroupName attribute exists.

String alma.asdm.CalDataRow.getFreqGroupName

(

)

throws IllegalAccessException

Get freqGroupName, which is optional.

Returns:

freqGroupName as String

Exceptions:

IllegalAccessException

If freqGroupName does not exist.

void alma.asdm.CalDataRow.setFreqGroupName

(

String

freqGroupName

)

Set freqGroupName with the specified String value.

Parameters:

freqGroupName

The String value to which freqGroupName is to be set.

boolean alma.asdm.CalDataRow.isFieldNameExists

(

)

The attribute fieldName is optional.

Return true if this attribute exists.

Returns:

true if and only if the fieldName attribute exists.

String alma.asdm.CalDataRow.getFieldName

(

)

throws IllegalAccessException

Get fieldName, which is optional.

Returns:

fieldName as String

Exceptions:

IllegalAccessException

If fieldName does not exist.

void alma.asdm.CalDataRow.setFieldName

(

String

fieldName

)

Set fieldName with the specified String value.

Parameters:

fieldName

The String value to which fieldName is to be set.

boolean alma.asdm.CalDataRow.isFieldCodeExists

(

)

The attribute fieldCode is optional.

Return true if this attribute exists.

Returns:

true if and only if the fieldCode attribute exists.

String [] alma.asdm.CalDataRow.getFieldCode

(

)

throws IllegalAccessException

Get fieldCode, which is optional.

Returns:

fieldCode as String[]

Exceptions:

IllegalAccessException

If fieldCode does not exist.

void alma.asdm.CalDataRow.setFieldCode

(

String[]

fieldCode

)

Set fieldCode with the specified String[] value.

Parameters:

fieldCode

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

ArrayTime alma.asdm.CalDataRow.getStartTimeObserved

(

)

Get startTimeObserved.

Returns:

startTimeObserved as ArrayTime

void alma.asdm.CalDataRow.setStartTimeObserved

(

ArrayTime

startTimeObserved

)

Set startTimeObserved with the specified ArrayTime value.

Parameters:

startTimeObserved

The ArrayTime value to which startTimeObserved is to be set.

ArrayTime alma.asdm.CalDataRow.getEndTimeObserved

(

)

Get endTimeObserved.

Returns:

endTimeObserved as ArrayTime

void alma.asdm.CalDataRow.setEndTimeObserved

(

ArrayTime

endTimeObserved

)

Set endTimeObserved with the specified ArrayTime value.

Parameters:

endTimeObserved

The ArrayTime value to which endTimeObserved is to be set.

boolean alma.asdm.CalDataRow.isSourceNameExists

(

)

The attribute sourceName is optional.

Return true if this attribute exists.

Returns:

true if and only if the sourceName attribute exists.

String [] alma.asdm.CalDataRow.getSourceName

(

)

throws IllegalAccessException

Get sourceName, which is optional.

Returns:

sourceName as String[]

Exceptions:

IllegalAccessException

If sourceName does not exist.

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

(

)

The attribute sourceCode is optional.

Return true if this attribute exists.

Returns:

true if and only if the sourceCode attribute exists.

String [] alma.asdm.CalDataRow.getSourceCode

(

)

throws IllegalAccessException

Get sourceCode, which is optional.

Returns:

sourceCode as String[]

Exceptions:

IllegalAccessException

If sourceCode does not exist.

void alma.asdm.CalDataRow.setSourceCode

(

String[]

sourceCode

)

Set sourceCode with the specified String[] value.

Parameters:

sourceCode

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

boolean alma.asdm.CalDataRow.isScanIntentExists

(

)

The attribute scanIntent is optional.

Return true if this attribute exists.

Returns:

true if and only if the scanIntent attribute exists.

ScanIntent [] alma.asdm.CalDataRow.getScanIntent

(

)

throws IllegalAccessException

Get scanIntent, which is optional.

Returns:

scanIntent as ScanIntent[]

Exceptions:

IllegalAccessException

If scanIntent does not exist.

void alma.asdm.CalDataRow.setScanIntent

(

ScanIntent[]

scanIntent

)

Set scanIntent with the specified ScanIntent[] value.

Parameters:

scanIntent

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

boolean alma.asdm.CalDataRow.isAssocCalDataIdExists

(

)

The attribute assocCalDataId is optional.

Return true if this attribute exists.

Returns:

true if and only if the assocCalDataId attribute exists.

Tag alma.asdm.CalDataRow.getAssocCalDataId

(

)

throws IllegalAccessException

Get assocCalDataId, which is optional.

Returns:

assocCalDataId as Tag

Exceptions:

IllegalAccessException

If assocCalDataId does not exist.

void alma.asdm.CalDataRow.setAssocCalDataId

(

Tag

assocCalDataId

)

Set assocCalDataId with the specified Tag value.

Parameters:

assocCalDataId

The Tag value to which assocCalDataId is to be set.

boolean alma.asdm.CalDataRow.isAssocCalNatureExists

(

)

The attribute assocCalNature is optional.

Return true if this attribute exists.

Returns:

true if and only if the assocCalNature attribute exists.

AssociatedCalNature alma.asdm.CalDataRow.getAssocCalNature

(

)

throws IllegalAccessException

Get assocCalNature, which is optional.

Returns:

assocCalNature as AssociatedCalNature

Exceptions:

IllegalAccessException

If assocCalNature does not exist.

void alma.asdm.CalDataRow.setAssocCalNature

(

AssociatedCalNature

assocCalNature

)

Set assocCalNature with the specified AssociatedCalNature value.

Parameters:

assocCalNature

The AssociatedCalNature value to which assocCalNature is to be set.

CalDataOrigin alma.asdm.CalDataRow.getCalDataType

(

)

Get calDataType.

Returns:

calDataType as CalDataOrigin

void alma.asdm.CalDataRow.setCalDataType

(

CalDataOrigin

calDataType

)

Set calDataType with the specified CalDataOrigin value.

Parameters:

calDataType

The CalDataOrigin value to which calDataType is to be set.

boolean alma.asdm.CalDataRow.equalByRequiredValue

(

CalDataRow

x

)

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

Parameters:

x

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

Returns:

a boolean.

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

• CalDataRow.java

---