alma.asdm.ScanRow Class Reference

Inherits alma.asdm.ASDMRow.

List of all members.

---

Detailed Description

The ScanRow class is a row of a ScanTable.

Generated from model's revision 1.41, branch HEAD

Public Member Functions
ScanTable	getTable ()
	Return the table to which this row belongs.
ScanRowIDL	toIDL ()
	Return this row in the form of an IDL struct.
void	setFromIDL (ScanRowIDL x) throws ConversionException
	Fill the values of this row from the IDL struct ScanRowIDL.
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	getScanNumber ()
	Get scanNumber.
void	setScanNumber (int scanNumber) throws IllegalAccessException
	Set scanNumber 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.
int	getNumSubScan ()
	Get numSubScan.
void	setNumSubScan (int numSubScan)
	Set numSubScan with the specified int value.
int	getNumIntent ()
	Get numIntent.
void	setNumIntent (int numIntent)
	Set numIntent with the specified int value.
boolean	isNumFieldExists ()
	The attribute numField is optional.
int	getNumField () throws IllegalAccessException
	Get numField, which is optional.
void	setNumField (int numField)
	Set numField with the specified int value.
void	clearNumField ()
	Mark numField, which is an optional field, as non-existent.
ScanIntent[]	getScanIntent ()
	Get scanIntent.
void	setScanIntent (ScanIntent[] scanIntent)
	Set scanIntent with the specified ScanIntent[] 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	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	getFlagRow ()
	Get flagRow.
void	setFlagRow (boolean flagRow)
	Set flagRow with the specified boolean value.
Tag	getExecBlockId ()
	Get execBlockId.
void	setExecBlockId (Tag execBlockId) throws IllegalAccessException
	Set execBlockId with the specified Tag value.
ExecBlockRow	getExecBlockUsingExecBlockId ()
	Returns the pointer to the row in the ExecBlock table having ExecBlock.execBlockId == execBlockId.
boolean	compareNoAutoInc (Tag execBlockId, int scanNumber, ArrayTime startTime, ArrayTime endTime, int numSubScan, int numIntent, ScanIntent[] scanIntent, boolean flagRow)
	Compare each attribute except the autoincrementable one of this ScanRow with the corresponding parameters and return true if there is a match and false otherwise.
boolean	equalByRequiredValue (ScanRow 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, int numSubScan, int numIntent, ScanIntent[] scanIntent, boolean flagRow)
Package Functions
	ScanRow (ScanTable table)
	Create a ScanRow.
	ScanRow (ScanTable table, ScanRow row)
	Creates a ScanRow 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.ScanRow.ScanRow

(

ScanTable

table

)

[package]

Create a ScanRow.

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

Creates a ScanRow using a copy constructor mechanism.

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

ScanRowIDL alma.asdm.ScanRow.toIDL

(

)

Return this row in the form of an IDL struct.

Returns:

The values of this row as a ScanRowIDL struct.

void alma.asdm.ScanRow.setFromIDL

(

ScanRowIDL

x

)

throws ConversionException

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

Parameters:

x

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

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

(

)

Get scanNumber.

Returns:

scanNumber as int

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

ArrayTime alma.asdm.ScanRow.getStartTime

(

)

Get startTime.

Returns:

startTime as ArrayTime

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

(

)

Get endTime.

Returns:

endTime as ArrayTime

void alma.asdm.ScanRow.setEndTime

(

ArrayTime

endTime

)

Set endTime with the specified ArrayTime value.

Parameters:

endTime

The ArrayTime value to which endTime is to be set.

int alma.asdm.ScanRow.getNumSubScan

(

)

Get numSubScan.

Returns:

numSubScan as int

void alma.asdm.ScanRow.setNumSubScan

(

int

numSubScan

)

Set numSubScan with the specified int value.

Parameters:

numSubScan

The int value to which numSubScan is to be set.

int alma.asdm.ScanRow.getNumIntent

(

)

Get numIntent.

Returns:

numIntent as int

void alma.asdm.ScanRow.setNumIntent

(

int

numIntent

)

Set numIntent with the specified int value.

Parameters:

numIntent

The int value to which numIntent is to be set.

boolean alma.asdm.ScanRow.isNumFieldExists

(

)

The attribute numField is optional.

Return true if this attribute exists.

Returns:

true if and only if the numField attribute exists.

int alma.asdm.ScanRow.getNumField

(

)

throws IllegalAccessException

Get numField, which is optional.

Returns:

numField as int

Exceptions:

IllegalAccessException

If numField does not exist.

void alma.asdm.ScanRow.setNumField

(

int

numField

)

Set numField with the specified int value.

Parameters:

numField

The int value to which numField is to be set.

ScanIntent [] alma.asdm.ScanRow.getScanIntent

(

)

Get scanIntent.

Returns:

scanIntent as ScanIntent[]

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

(

)

throws IllegalAccessException

Get sourceName, which is optional.

Returns:

sourceName as String

Exceptions:

IllegalAccessException

If sourceName does not exist.

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

(

)

throws IllegalAccessException

Get fieldName, which is optional.

Returns:

fieldName as String[]

Exceptions:

IllegalAccessException

If fieldName does not exist.

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

(

)

Get flagRow.

Returns:

flagRow as boolean

void alma.asdm.ScanRow.setFlagRow

(

boolean

flagRow

)

Set flagRow with the specified boolean value.

Parameters:

flagRow

The boolean value to which flagRow is to be set.

Tag alma.asdm.ScanRow.getExecBlockId

(

)

Get execBlockId.

Returns:

execBlockId as Tag

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

ExecBlockRow alma.asdm.ScanRow.getExecBlockUsingExecBlockId

(

)

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

Returns:

a ExecBlockRow

boolean alma.asdm.ScanRow.equalByRequiredValue

(

ScanRow

x

)

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

Parameters:

x

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

Returns:

a boolean.

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

• ScanRow.java

---