alma.asdm.SubscanRow Class Reference

Inherits alma.asdm.ASDMRow.

List of all members.

---

Detailed Description

The SubscanRow class is a row of a SubscanTable.

Generated from model's revision 1.41, branch HEAD

Public Member Functions
SubscanTable	getTable ()
	Return the table to which this row belongs.
SubscanRowIDL	toIDL ()
	Return this row in the form of an IDL struct.
void	setFromIDL (SubscanRowIDL x) throws ConversionException
	Fill the values of this row from the IDL struct SubscanRowIDL.
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	getSubscanNumber ()
	Get subscanNumber.
void	setSubscanNumber (int subscanNumber) throws IllegalAccessException
	Set subscanNumber with the specified int value.
ArrayTime	getStartTime ()
	Get startTime.
void	setStartTime (ArrayTime startTime)
	Set startTime with the specified ArrayTime value.
ArrayTime	getEndTime ()
	Get endTime.
void	setEndTime (ArrayTime endTime)
	Set endTime with the specified ArrayTime value.
SubscanIntent	getSubscanIntent ()
	Get subscanIntent.
void	setSubscanIntent (SubscanIntent subscanIntent)
	Set subscanIntent with the specified SubscanIntent value.
boolean	isSubscanModeExists ()
	The attribute subscanMode is optional.
SwitchingMode	getSubscanMode () throws IllegalAccessException
	Get subscanMode, which is optional.
void	setSubscanMode (SwitchingMode subscanMode)
	Set subscanMode with the specified SwitchingMode value.
void	clearSubscanMode ()
	Mark subscanMode, which is an optional field, as non-existent.
int	getNumberIntegration ()
	Get numberIntegration.
void	setNumberIntegration (int numberIntegration)
	Set numberIntegration with the specified int value.
int[]	getNumberSubintegration ()
	Get numberSubintegration.
void	setNumberSubintegration (int[] numberSubintegration)
	Set numberSubintegration with the specified int[] value.
boolean	getFlagRow ()
	Get flagRow.
void	setFlagRow (boolean flagRow)
	Set flagRow with the specified boolean value.
String	getFieldName ()
	Get fieldName.
void	setFieldName (String fieldName)
	Set fieldName with the specified String value.
boolean	isCorrelatorCalibrationExists ()
	The attribute correlatorCalibration is optional.
CorrelatorCalibration	getCorrelatorCalibration () throws IllegalAccessException
	Get correlatorCalibration, which is optional.
void	setCorrelatorCalibration (CorrelatorCalibration correlatorCalibration)
	Set correlatorCalibration with the specified CorrelatorCalibration value.
void	clearCorrelatorCalibration ()
	Mark correlatorCalibration, which is an optional field, as non-existent.
Tag	getExecBlockId ()
	Get execBlockId.
void	setExecBlockId (Tag execBlockId) throws IllegalAccessException
	Set execBlockId with the specified Tag value.
int	getScanNumber ()
	Get scanNumber.
void	setScanNumber (int scanNumber) throws IllegalAccessException
	Set scanNumber with the specified int value.
ExecBlockRow	getExecBlockUsingExecBlockId ()
	Returns the pointer to the row in the ExecBlock table having ExecBlock.execBlockId == execBlockId.
boolean	compareNoAutoInc (Tag execBlockId, int scanNumber, int subscanNumber, ArrayTime startTime, ArrayTime endTime, SubscanIntent subscanIntent, int numberIntegration, int[] numberSubintegration, boolean flagRow, String fieldName)
	Compare each attribute except the autoincrementable one of this SubscanRow with the corresponding parameters and return true if there is a match and false otherwise.
boolean	equalByRequiredValue (SubscanRow x)
	Return true if all required attributes of the value part are equal to their homologues in x and false otherwise.
boolean	compareRequiredValue (ArrayTime startTime, ArrayTime endTime, SubscanIntent subscanIntent, int numberIntegration, int[] numberSubintegration, boolean flagRow, String fieldName)
Package Functions
	SubscanRow (SubscanTable table)
	Create a SubscanRow.
	SubscanRow (SubscanTable table, SubscanRow row)
	Creates a SubscanRow 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.SubscanRow.SubscanRow

(

SubscanTable

table

)

[package]

Create a SubscanRow.

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

Creates a SubscanRow using a copy constructor mechanism.

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

SubscanRowIDL alma.asdm.SubscanRow.toIDL

(

)

Return this row in the form of an IDL struct.

Returns:

The values of this row as a SubscanRowIDL struct.

void alma.asdm.SubscanRow.setFromIDL

(

SubscanRowIDL

x

)

throws ConversionException

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

Parameters:

x

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

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

(

)

Get subscanNumber.

Returns:

subscanNumber as int

void alma.asdm.SubscanRow.setSubscanNumber

(

int

subscanNumber

)

throws IllegalAccessException

Set subscanNumber with the specified int value.

Parameters:

subscanNumber

The int value to which subscanNumber is to be set.

Exceptions:

IllegalAccessException

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

ArrayTime alma.asdm.SubscanRow.getStartTime

(

)

Get startTime.

Returns:

startTime as ArrayTime

void alma.asdm.SubscanRow.setStartTime

(

ArrayTime

startTime

)

Set startTime with the specified ArrayTime value.

Parameters:

startTime

The ArrayTime value to which startTime is to be set.

ArrayTime alma.asdm.SubscanRow.getEndTime

(

)

Get endTime.

Returns:

endTime as ArrayTime

void alma.asdm.SubscanRow.setEndTime

(

ArrayTime

endTime

)

Set endTime with the specified ArrayTime value.

Parameters:

endTime

The ArrayTime value to which endTime is to be set.

SubscanIntent alma.asdm.SubscanRow.getSubscanIntent

(

)

Get subscanIntent.

Returns:

subscanIntent as SubscanIntent

void alma.asdm.SubscanRow.setSubscanIntent

(

SubscanIntent

subscanIntent

)

Set subscanIntent with the specified SubscanIntent value.

Parameters:

subscanIntent

The SubscanIntent value to which subscanIntent is to be set.

boolean alma.asdm.SubscanRow.isSubscanModeExists

(

)

The attribute subscanMode is optional.

Return true if this attribute exists.

Returns:

true if and only if the subscanMode attribute exists.

SwitchingMode alma.asdm.SubscanRow.getSubscanMode

(

)

throws IllegalAccessException

Get subscanMode, which is optional.

Returns:

subscanMode as SwitchingMode

Exceptions:

IllegalAccessException

If subscanMode does not exist.

void alma.asdm.SubscanRow.setSubscanMode

(

SwitchingMode

subscanMode

)

Set subscanMode with the specified SwitchingMode value.

Parameters:

subscanMode

The SwitchingMode value to which subscanMode is to be set.

int alma.asdm.SubscanRow.getNumberIntegration

(

)

Get numberIntegration.

Returns:

numberIntegration as int

void alma.asdm.SubscanRow.setNumberIntegration

(

int

numberIntegration

)

Set numberIntegration with the specified int value.

Parameters:

numberIntegration

The int value to which numberIntegration is to be set.

int [] alma.asdm.SubscanRow.getNumberSubintegration

(

)

Get numberSubintegration.

Returns:

numberSubintegration as int[]

void alma.asdm.SubscanRow.setNumberSubintegration

(

int[]

numberSubintegration

)

Set numberSubintegration with the specified int[] value.

Parameters:

numberSubintegration

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

boolean alma.asdm.SubscanRow.getFlagRow

(

)

Get flagRow.

Returns:

flagRow as boolean

void alma.asdm.SubscanRow.setFlagRow

(

boolean

flagRow

)

Set flagRow with the specified boolean value.

Parameters:

flagRow

The boolean value to which flagRow is to be set.

String alma.asdm.SubscanRow.getFieldName

(

)

Get fieldName.

Returns:

fieldName as String

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

(

)

The attribute correlatorCalibration is optional.

Return true if this attribute exists.

Returns:

true if and only if the correlatorCalibration attribute exists.

CorrelatorCalibration alma.asdm.SubscanRow.getCorrelatorCalibration

(

)

throws IllegalAccessException

Get correlatorCalibration, which is optional.

Returns:

correlatorCalibration as CorrelatorCalibration

Exceptions:

IllegalAccessException

If correlatorCalibration does not exist.

void alma.asdm.SubscanRow.setCorrelatorCalibration

(

CorrelatorCalibration

correlatorCalibration

)

Set correlatorCalibration with the specified CorrelatorCalibration value.

Parameters:

correlatorCalibration

The CorrelatorCalibration value to which correlatorCalibration is to be set.

Tag alma.asdm.SubscanRow.getExecBlockId

(

)

Get execBlockId.

Returns:

execBlockId as Tag

void alma.asdm.SubscanRow.setExecBlockId

(

Tag

execBlockId

)

throws IllegalAccessException

Set execBlockId with the specified Tag value.

Parameters:

execBlockId

The Tag value to which execBlockId 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.SubscanRow.getScanNumber

(

)

Get scanNumber.

Returns:

scanNumber as int

void alma.asdm.SubscanRow.setScanNumber

(

int

scanNumber

)

throws IllegalAccessException

Set scanNumber with the specified int value.

Parameters:

scanNumber

The int value to which scanNumber is to be set.

Exceptions:

IllegalAccessException

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

ExecBlockRow alma.asdm.SubscanRow.getExecBlockUsingExecBlockId

(

)

Returns the pointer to the row in the ExecBlock table having ExecBlock.execBlockId == execBlockId.

Returns:

a ExecBlockRow

boolean alma.asdm.SubscanRow.equalByRequiredValue

(

SubscanRow

x

)

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

Parameters:

x

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

Returns:

a boolean.

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

• SubscanRow.java

---