alma.asdm.DataDescriptionRow Class Reference

Inherits alma.asdm.ASDMRow.

List of all members.

Detailed Description

The DataDescriptionRow class is a row of a DataDescriptionTable.


Public Member Functions

DataDescriptionTable getTable ()
 Return the table to which this row belongs.
DataDescriptionRowIDL toIDL ()
 Return this row in the form of an IDL struct.
void setFromIDL (DataDescriptionRowIDL x) throws ConversionException
 Fill the values of this row from the IDL struct DataDescriptionRowIDL.
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 getDataDescriptionId ()
 Get dataDescriptionId.
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.
Tag getPolOrHoloId ()
 Get polOrHoloId.
void setPolOrHoloId (Tag polOrHoloId)
 Set polOrHoloId with the specified Tag value.
Tag getSpectralWindowId ()
 Get spectralWindowId.
void setSpectralWindowId (Tag spectralWindowId)
 Set spectralWindowId with the specified Tag value.
PolarizationRow getPolarizationUsingPolOrHoloId ()
 Returns the row in the Polarization table having Polarization.poIarizationId == polOrHoloId.
HolographyRow getHolographyUsingPolOrHoloId ()
 Returns the row in the Holography table having Holography.holographyId == polOrHoloId.
SpectralWindowRow getSpectralWindowUsingSpectralWindowId ()
 Returns the pointer to the row in the SpectralWindow table having SpectralWindow.spectralWindowId == spectralWindowId.
boolean compareNoAutoInc (Tag polOrHoloId, Tag spectralWindowId)
 Compare each attribute except the autoincrementable one of this DataDescriptionRow with the corresponding parameters and return true if there is a match and false otherwise.
boolean equalByRequiredValue (DataDescriptionRow x)
 Return true if all required attributes of the value part are equal to their homologues in x and false otherwise.
boolean compareRequiredValue (Tag polOrHoloId, Tag spectralWindowId)

Protected Member Functions

void setDataDescriptionId (Tag dataDescriptionId) throws IllegalAccessException
 Set dataDescriptionId with the specified Tag value.

Package Functions

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

Create a DataDescriptionRow.

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

Creates a DataDescriptionRow using a copy constructor mechanism.

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

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

boolean alma.asdm.DataDescriptionRow.compareNoAutoInc (  Tag  polOrHoloId,
Tag  spectralWindowId
) 
 

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

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

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

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

Object [] alma.asdm.DataDescriptionRow.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.DataDescriptionRow.getDataDescriptionId (   ) 
 

Get dataDescriptionId.

Returns:
dataDescriptionId as Tag

boolean alma.asdm.DataDescriptionRow.getFlagRow (   )  throws IllegalAccessException
 

Get flagRow, which is optional.

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

HolographyRow alma.asdm.DataDescriptionRow.getHolographyUsingPolOrHoloId (   ) 
 

Returns the row in the Holography table having Holography.holographyId == polOrHoloId.

Returns:
a PolarizationRow or null if polOrHoloId is an Polarization Tag.

PolarizationRow alma.asdm.DataDescriptionRow.getPolarizationUsingPolOrHoloId (   ) 
 

Returns the row in the Polarization table having Polarization.poIarizationId == polOrHoloId.

Returns:
a PolarizationRow or null if polOrHoloId is an Holography Tag.

Tag alma.asdm.DataDescriptionRow.getPolOrHoloId (   ) 
 

Get polOrHoloId.

Returns:
polOrHoloId as Tag

Tag alma.asdm.DataDescriptionRow.getSpectralWindowId (   ) 
 

Get spectralWindowId.

Returns:
spectralWindowId as Tag

SpectralWindowRow alma.asdm.DataDescriptionRow.getSpectralWindowUsingSpectralWindowId (   ) 
 

Returns the pointer to the row in the SpectralWindow table having SpectralWindow.spectralWindowId == spectralWindowId.

Returns:
a SpectralWindowRow

DataDescriptionTable alma.asdm.DataDescriptionRow.getTable (   ) 
 

Return the table to which this row belongs.

boolean alma.asdm.DataDescriptionRow.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.DataDescriptionRow.setDataDescriptionId (  Tag  dataDescriptionId  )  throws IllegalAccessException [protected]
 

Set dataDescriptionId with the specified Tag value.

Parameters:
dataDescriptionId The Tag value to which dataDescriptionId 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.DataDescriptionRow.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.DataDescriptionRow.setFromIDL (  DataDescriptionRowIDL  x  )  throws ConversionException
 

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

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

void alma.asdm.DataDescriptionRow.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.DataDescriptionRow.setPolOrHoloId (  Tag  polOrHoloId  ) 
 

Set polOrHoloId with the specified Tag value.

Parameters:
polOrHoloId The Tag value to which polOrHoloId is to be set.

void alma.asdm.DataDescriptionRow.setSpectralWindowId (  Tag  spectralWindowId  ) 
 

Set spectralWindowId with the specified Tag value.

Parameters:
spectralWindowId The Tag value to which spectralWindowId is to be set.

DataDescriptionRowIDL alma.asdm.DataDescriptionRow.toIDL (   ) 
 

Return this row in the form of an IDL struct.

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

String alma.asdm.DataDescriptionRow.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:46 2008 for ASDM Java Implementation by doxygen 1.3.8