alma.asdm.MainRow Class Reference

Inherits alma.asdm.ASDMRow.

List of all members.

---

Detailed Description

The MainRow class is a row of a MainTable.

Generated from model's revision 1.46, branch HEAD

Public Member Functions
MainTable	getTable ()
	Return the table to which this row belongs.
MainRowIDL	toIDL ()
	Return this row in the form of an IDL struct.
void	setFromIDL (MainRowIDL x) throws ConversionException
	Fill the values of this row from the IDL struct MainRowIDL.
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.
ArrayTime	getTime ()
	Get time.
void	setTime (ArrayTime time) throws IllegalAccessException
	Set time with the specified ArrayTime value.
int	getScanNumber ()
	Get scanNumber.
void	setScanNumber (int scanNumber) throws IllegalAccessException
	Set scanNumber with the specified int value.
int	getSubscanNumber ()
	Get subscanNumber.
void	setSubscanNumber (int subscanNumber) throws IllegalAccessException
	Set subscanNumber with the specified int value.
TimeSampling	getTimeSampling ()
	Get timeSampling.
void	setTimeSampling (TimeSampling timeSampling) throws IllegalAccessException
	Set timeSampling with the specified TimeSampling value.
int	getNumIntegration ()
	Get numIntegration.
void	setNumIntegration (int numIntegration) throws IllegalAccessException
	Set numIntegration with the specified int value.
EntityRef	getDataOid ()
	Get dataOid.
void	setDataOid (EntityRef dataOid) throws IllegalAccessException
	Set dataOid with the specified EntityRef value.
boolean	getFlagRow ()
	Get flagRow.
void	setFlagRow (boolean flagRow) throws IllegalAccessException
	Set flagRow with the specified boolean value.
Interval	getInterval ()
	Get interval.
void	setInterval (Interval interval) throws IllegalAccessException
	Set interval with the specified Interval value.
Tag	getConfigDescriptionId ()
	Get configDescriptionId.
void	setConfigDescriptionId (Tag configDescriptionId) throws IllegalAccessException
	Set configDescriptionId with the specified Tag value.
Tag	getExecBlockId ()
	Get execBlockId.
void	setExecBlockId (Tag execBlockId) throws IllegalAccessException
	Set execBlockId with the specified Tag value.
Tag	getFieldId ()
	Get fieldId.
void	setFieldId (Tag fieldId) throws IllegalAccessException
	Set fieldId with the specified Tag value.
Tag[]	getStateId ()
	Get stateId.
void	setStateId (Tag[] stateId) throws IllegalAccessException
	Set stateId with the specified Tag[] value.
ConfigDescriptionRow	getConfigDescriptionUsingConfigDescriptionId ()
	Returns the pointer to the row in the ConfigDescription table having ConfigDescription.configDescriptionId == configDescriptionId.
FieldRow	getFieldUsingFieldId ()
	Returns the pointer to the row in the Field table having Field.fieldId == fieldId.
void	setStateId (int i, Tag stateId) throws IllegalAccessException, IndexOutOfBoundsException
	Set stateId[i] with the specified Tag value.
ExecBlockRow	getExecBlockUsingExecBlockId ()
	Returns the pointer to the row in the ExecBlock table having ExecBlock.execBlockId == execBlockId.
boolean	compareNoAutoInc (Tag configDescriptionId, Tag fieldId, ArrayTime time, Tag execBlockId, Tag[] stateId, int scanNumber, int subscanNumber, TimeSampling timeSampling, int numIntegration, EntityRef dataOid, boolean flagRow, Interval interval)
	Compare each attribute except the autoincrementable one of this MainRow with the corresponding parameters and return true if there is a match and false otherwise.
boolean	equalByRequiredValue (MainRow x)
	Return true if all required attributes of the value part are equal to their homologues in x and false otherwise.
boolean	compareRequiredValue (Tag execBlockId, Tag[] stateId, int scanNumber, int subscanNumber, TimeSampling timeSampling, int numIntegration, EntityRef dataOid, boolean flagRow, Interval interval)
Package Functions
	MainRow (MainTable table)
	Create a MainRow.
	MainRow (MainTable table, MainRow row)
	Creates a MainRow using a copy constructor mechanism.
void	isAdded ()
void	addStateId (Tag id)
	Append a Tag to stateId.
void	addStateId (Tag[] id)
	Append an array of Tag to stateId.
Tag	getStateId (int i) throws IndexOutOfBoundsException
	Returns the Tag stored in stateId at position i.
StateRow	getState (int i) throws IndexOutOfBoundsException, NoSuchRow
	Returns the StateRow linked to this row via the Tag stored in stateId at position i.
StateRow[]	getStates () throws NoSuchRow
	Returns the array of StateRow linked to this row via the Tags stored in stateId.
Object[]	getAttributesValues ()
	Returns all the attributes of an attribute of an ASDM table as an array of Object.

---

Constructor & Destructor Documentation

alma.asdm.MainRow.MainRow (  MainTable  table  )  [package]

Create a MainRow. 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.MainRow.MainRow (  MainTable  table, MainRow  row )  [package]

Creates a MainRow using a copy constructor mechanism. Given a MainRow row and a MainTable table, the method creates a new MainRow 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

void alma.asdm.MainRow.addStateId (  Tag[]  id  )  [package]

Append an array of Tag to stateId. Parameters: id  an array of Tag to be appended to stateId

void alma.asdm.MainRow.addStateId (  Tag  id  )  [package]

Append a Tag to stateId. Parameters: id  the Tag to be appended to stateId

boolean alma.asdm.MainRow.compareNoAutoInc (  Tag  configDescriptionId, Tag  fieldId, ArrayTime  time, Tag  execBlockId, Tag[]  stateId, int  scanNumber, int  subscanNumber, TimeSampling  timeSampling, int  numIntegration, EntityRef  dataOid, boolean  flagRow, Interval  interval )

Compare each attribute except the autoincrementable one of this MainRow with the corresponding parameters and return true if there is a match and false otherwise.

boolean alma.asdm.MainRow.equalByRequiredValue (  MainRow  x  )

Return true if all required attributes of the value part are equal to their homologues in x and false otherwise. Parameters: x  the MainRow whose required attributes of the value part will be compared with those of this. Returns: a boolean.

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

Tag alma.asdm.MainRow.getConfigDescriptionId (   )

Get configDescriptionId. Returns: configDescriptionId as Tag

ConfigDescriptionRow alma.asdm.MainRow.getConfigDescriptionUsingConfigDescriptionId (   )

Returns the pointer to the row in the ConfigDescription table having ConfigDescription.configDescriptionId == configDescriptionId. Returns: a ConfigDescriptionRow

EntityRef alma.asdm.MainRow.getDataOid (   )

Get dataOid. Returns: dataOid as EntityRef

Tag alma.asdm.MainRow.getExecBlockId (   )

Get execBlockId. Returns: execBlockId as Tag

ExecBlockRow alma.asdm.MainRow.getExecBlockUsingExecBlockId (   )

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

Tag alma.asdm.MainRow.getFieldId (   )

Get fieldId. Returns: fieldId as Tag

FieldRow alma.asdm.MainRow.getFieldUsingFieldId (   )

Returns the pointer to the row in the Field table having Field.fieldId == fieldId. Returns: a FieldRow

boolean alma.asdm.MainRow.getFlagRow (   )

Get flagRow. Returns: flagRow as boolean

Interval alma.asdm.MainRow.getInterval (   )

Get interval. Returns: interval as Interval

int alma.asdm.MainRow.getNumIntegration (   )

Get numIntegration. Returns: numIntegration as int

int alma.asdm.MainRow.getScanNumber (   )

Get scanNumber. Returns: scanNumber as int

Tag [] alma.asdm.MainRow.getStateId (   )

Get stateId. Returns: stateId as Tag[]

int alma.asdm.MainRow.getSubscanNumber (   )

Get subscanNumber. Returns: subscanNumber as int

MainTable alma.asdm.MainRow.getTable (   )

Return the table to which this row belongs.

ArrayTime alma.asdm.MainRow.getTime (   )

Get time. Returns: time as ArrayTime

TimeSampling alma.asdm.MainRow.getTimeSampling (   )

Get timeSampling. Returns: timeSampling as TimeSampling

void alma.asdm.MainRow.setConfigDescriptionId (  Tag  configDescriptionId  )  throws IllegalAccessException

Set configDescriptionId with the specified Tag value. Parameters: configDescriptionId  The Tag value to which configDescriptionId is to be set. Exceptions: IllegalAccessException  If an attempt is made to change this field after is has been added to the table.

void alma.asdm.MainRow.setDataOid (  EntityRef  dataOid  )  throws IllegalAccessException

Set dataOid with the specified EntityRef value. Parameters: dataOid  The EntityRef value to which dataOid is to be set. Exceptions: IllegalAccessException  If an attempt is made to change this field after is has been added to the table.

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

void alma.asdm.MainRow.setFieldId (  Tag  fieldId  )  throws IllegalAccessException

Set fieldId with the specified Tag value. Parameters: fieldId  The Tag value to which fieldId is to be set. Exceptions: IllegalAccessException  If an attempt is made to change this field after is has been added to the table.

void alma.asdm.MainRow.setFlagRow (  boolean  flagRow  )  throws IllegalAccessException

Set flagRow with the specified boolean value. Parameters: flagRow  The boolean value to which flagRow is to be set. Exceptions: IllegalAccessException  If an attempt is made to change this field after is has been added to the table.

void alma.asdm.MainRow.setFromIDL (  MainRowIDL  x  )  throws ConversionException

Fill the values of this row from the IDL struct MainRowIDL. Parameters: x  The IDL struct containing the values used to fill this row.

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

void alma.asdm.MainRow.setInterval (  Interval  interval  )  throws IllegalAccessException

Set interval with the specified Interval value. Parameters: interval  The Interval value to which interval is to be set. Exceptions: IllegalAccessException  If an attempt is made to change this field after is has been added to the table.

void alma.asdm.MainRow.setNumIntegration (  int  numIntegration  )  throws IllegalAccessException

Set numIntegration with the specified int value. Parameters: numIntegration  The int value to which numIntegration is to be set. Exceptions: IllegalAccessException  If an attempt is made to change this field after is has been added to the table.

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

void alma.asdm.MainRow.setStateId (  int  i, Tag  stateId )  throws IllegalAccessException, IndexOutOfBoundsException

Set stateId[i] with the specified Tag value. Parameters: i  The index in stateId where to set the Tag value. stateId  The Tag value to which stateId[i] is to be set. Exceptions: IllegalAccessException  IndexOutOfBoundsException

void alma.asdm.MainRow.setStateId (  Tag[]  stateId  )  throws IllegalAccessException

Set stateId with the specified Tag[] value. Parameters: stateId  The Tag[] value to which stateId is to be set. Exceptions: IllegalAccessException  If an attempt is made to change this field after is has been added to the table.

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

void alma.asdm.MainRow.setTime (  ArrayTime  time  )  throws IllegalAccessException

Set time with the specified ArrayTime value. Parameters: time  The ArrayTime value to which time is to be set. Exceptions: IllegalAccessException  If an attempt is made to change this field after is has been added to the table.

void alma.asdm.MainRow.setTimeSampling (  TimeSampling  timeSampling  )  throws IllegalAccessException

Set timeSampling with the specified TimeSampling value. Parameters: timeSampling  The TimeSampling value to which timeSampling is to be set. Exceptions: IllegalAccessException  If an attempt is made to change this field after is has been added to the table.

MainRowIDL alma.asdm.MainRow.toIDL (   )

Return this row in the form of an IDL struct. Returns: The values of this row as a MainRowIDL struct.

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

---

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

• MainRow.java

---