alma.asdm.PolarizationRow Class Reference

Inherits alma.asdm.ASDMRow.

List of all members.


Detailed Description

The PolarizationRow class is a row of a PolarizationTable.

Generated from model's revision 1.46, branch HEAD


Public Member Functions

PolarizationTable getTable ()
 Return the table to which this row belongs.
PolarizationRowIDL toIDL ()
 Return this row in the form of an IDL struct.
void setFromIDL (PolarizationRowIDL x) throws ConversionException
 Fill the values of this row from the IDL struct PolarizationRowIDL.
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 getPolarizationId ()
 Get polarizationId.
int getNumCorr ()
 Get numCorr.
void setNumCorr (int numCorr) throws IllegalAccessException
 Set numCorr with the specified int value.
StokesParameter[] getCorrType ()
 Get corrType.
void setCorrType (StokesParameter[] corrType) throws IllegalAccessException
 Set corrType with the specified StokesParameter[] value.
PolarizationType[][] getCorrProduct ()
 Get corrProduct.
void setCorrProduct (PolarizationType[][] corrProduct) throws IllegalAccessException
 Set corrProduct with the specified PolarizationType[][] value.
boolean isFlagRowExists ()
 The attribute flagRow is optional.
boolean getFlagRow () throws IllegalAccessException
 Get flagRow, which is optional.
void setFlagRow (boolean flagRow)
 Set flagRow with the specified boolean value.
void clearFlagRow ()
 Mark flagRow, which is an optional field, as non-existent.
boolean compareNoAutoInc (int numCorr, StokesParameter[] corrType, PolarizationType[][] corrProduct)
 Compare each attribute except the autoincrementable one of this PolarizationRow with the corresponding parameters and return true if there is a match and false otherwise.
boolean equalByRequiredValue (PolarizationRow x)
 Return true if all required attributes of the value part are equal to their homologues in x and false otherwise.
boolean compareRequiredValue (int numCorr, StokesParameter[] corrType, PolarizationType[][] corrProduct)

Protected Member Functions

void setPolarizationId (Tag polarizationId) throws IllegalAccessException
 Set polarizationId with the specified Tag value.

Package Functions

 PolarizationRow (PolarizationTable table)
 Create a PolarizationRow.
 PolarizationRow (PolarizationTable table, PolarizationRow row)
 Creates a PolarizationRow 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.PolarizationRow.PolarizationRow PolarizationTable  table  )  [package]
 

Create a PolarizationRow.

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.PolarizationRow.PolarizationRow PolarizationTable  table,
PolarizationRow  row
[package]
 

Creates a PolarizationRow using a copy constructor mechanism.

Given a PolarizationRow row and a PolarizationTable table, the method creates a new PolarizationRow 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.PolarizationRow.clearFlagRow  ) 
 

Mark flagRow, which is an optional field, as non-existent.

boolean alma.asdm.PolarizationRow.compareNoAutoInc int  numCorr,
StokesParameter[]  corrType,
PolarizationType  corrProduct[][]
 

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

boolean alma.asdm.PolarizationRow.equalByRequiredValue PolarizationRow  x  ) 
 

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

Parameters:
x the PolarizationRow whose required attributes of the value part will be compared with those of this.
Returns:
a boolean.

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

PolarizationType [][] alma.asdm.PolarizationRow.getCorrProduct  ) 
 

Get corrProduct.

Returns:
corrProduct as PolarizationType[][]

StokesParameter [] alma.asdm.PolarizationRow.getCorrType  ) 
 

Get corrType.

Returns:
corrType as StokesParameter[]

boolean alma.asdm.PolarizationRow.getFlagRow  )  throws IllegalAccessException
 

Get flagRow, which is optional.

Returns:
flagRow as boolean
Exceptions:
IllegalAccessException If flagRow does not exist.

int alma.asdm.PolarizationRow.getNumCorr  ) 
 

Get numCorr.

Returns:
numCorr as int

Tag alma.asdm.PolarizationRow.getPolarizationId  ) 
 

Get polarizationId.

Returns:
polarizationId as Tag

PolarizationTable alma.asdm.PolarizationRow.getTable  ) 
 

Return the table to which this row belongs.

boolean alma.asdm.PolarizationRow.isFlagRowExists  ) 
 

The attribute flagRow is optional.

Return true if this attribute exists.

Returns:
true if and only if the flagRow attribute exists.

void alma.asdm.PolarizationRow.setCorrProduct PolarizationType  corrProduct[][]  )  throws IllegalAccessException
 

Set corrProduct with the specified PolarizationType[][] value.

Parameters:
corrProduct The PolarizationType[][] value to which corrProduct 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.PolarizationRow.setCorrType StokesParameter[]  corrType  )  throws IllegalAccessException
 

Set corrType with the specified StokesParameter[] value.

Parameters:
corrType The StokesParameter[] value to which corrType 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.PolarizationRow.setFlagRow boolean  flagRow  ) 
 

Set flagRow with the specified boolean value.

Parameters:
flagRow The boolean value to which flagRow is to be set.

void alma.asdm.PolarizationRow.setFromIDL PolarizationRowIDL  x  )  throws ConversionException
 

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

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

void alma.asdm.PolarizationRow.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.PolarizationRow.setNumCorr int  numCorr  )  throws IllegalAccessException
 

Set numCorr with the specified int value.

Parameters:
numCorr The int value to which numCorr 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.PolarizationRow.setPolarizationId Tag  polarizationId  )  throws IllegalAccessException [protected]
 

Set polarizationId with the specified Tag value.

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

PolarizationRowIDL alma.asdm.PolarizationRow.toIDL  ) 
 

Return this row in the form of an IDL struct.

Returns:
The values of this row as a PolarizationRowIDL struct.

String alma.asdm.PolarizationRow.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:
Generated on Tue Nov 18 17:46:47 2008 for ASDM Java Implementation by doxygen 1.3.8