alma.asdm.HolographyRow Class Reference

Inherits alma.asdm.ASDMRow.

List of all members.


Detailed Description

The HolographyRow class is a row of a HolographyTable.

Generated from model's revision 1.41, branch HEAD


Public Member Functions

HolographyTable getTable ()
 Return the table to which this row belongs.
HolographyRowIDL toIDL ()
 Return this row in the form of an IDL struct.
void setFromIDL (HolographyRowIDL x) throws ConversionException
 Fill the values of this row from the IDL struct HolographyRowIDL.
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 getHolographyId ()
 Get holographyId.
int getNumCorr ()
 Get numCorr.
void setNumCorr (int numCorr)
 Set numCorr with the specified int value.
HolographyChannelType[] getType ()
 Get type.
void setType (HolographyChannelType[] type)
 Set type with the specified HolographyChannelType[] value.
Length getDistance ()
 Get distance.
void setDistance (Length distance)
 Set distance with the specified Length value.
Length getFocus ()
 Get focus.
void setFocus (Length focus)
 Set focus with the specified Length value.
boolean getFlagRow ()
 Get flagRow.
void setFlagRow (boolean flagRow)
 Set flagRow with the specified boolean value.
boolean compareNoAutoInc (int numCorr, HolographyChannelType[] type, Length distance, Length focus, boolean flagRow)
 Compare each attribute except the autoincrementable one of this HolographyRow with the corresponding parameters and return true if there is a match and false otherwise.
boolean equalByRequiredValue (HolographyRow 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, HolographyChannelType[] type, Length distance, Length focus, boolean flagRow)

Protected Member Functions

void setHolographyId (Tag holographyId) throws IllegalAccessException
 Set holographyId with the specified Tag value.

Package Functions

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

Create a HolographyRow.

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

Creates a HolographyRow using a copy constructor mechanism.

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

HolographyRowIDL alma.asdm.HolographyRow.toIDL (  ) 

Return this row in the form of an IDL struct.

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

void alma.asdm.HolographyRow.setFromIDL ( HolographyRowIDL  x  )  throws ConversionException

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

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

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

Tag alma.asdm.HolographyRow.getHolographyId (  ) 

Get holographyId.

Returns:
holographyId as Tag

void alma.asdm.HolographyRow.setHolographyId ( Tag  holographyId  )  throws IllegalAccessException [protected]

Set holographyId with the specified Tag value.

Parameters:
holographyId The Tag value to which holographyId 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.HolographyRow.getNumCorr (  ) 

Get numCorr.

Returns:
numCorr as int

void alma.asdm.HolographyRow.setNumCorr ( int  numCorr  ) 

Set numCorr with the specified int value.

Parameters:
numCorr The int value to which numCorr is to be set.

HolographyChannelType [] alma.asdm.HolographyRow.getType (  ) 

Get type.

Returns:
type as HolographyChannelType[]

void alma.asdm.HolographyRow.setType ( HolographyChannelType[]  type  ) 

Set type with the specified HolographyChannelType[] value.

Parameters:
type The HolographyChannelType[] value to which type is to be set.

Length alma.asdm.HolographyRow.getDistance (  ) 

Get distance.

Returns:
distance as Length

void alma.asdm.HolographyRow.setDistance ( Length  distance  ) 

Set distance with the specified Length value.

Parameters:
distance The Length value to which distance is to be set.

Length alma.asdm.HolographyRow.getFocus (  ) 

Get focus.

Returns:
focus as Length

void alma.asdm.HolographyRow.setFocus ( Length  focus  ) 

Set focus with the specified Length value.

Parameters:
focus The Length value to which focus is to be set.

boolean alma.asdm.HolographyRow.getFlagRow (  ) 

Get flagRow.

Returns:
flagRow as boolean

void alma.asdm.HolographyRow.setFlagRow ( boolean  flagRow  ) 

Set flagRow with the specified boolean value.

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

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

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

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

Object [] alma.asdm.HolographyRow.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:
Generated on Thu Nov 29 16:47:24 2007 for ASDM Java Implementation by  doxygen 1.5.1