alma.asdm.StateRow Class Reference

Detailed Description

The StateRow class is a row of a StateTable.

Generated from model's revision 1.46, branch HEAD

Public Member Functions

StateTable getTable ()

Return the table to which this row belongs.

StateRowIDL toIDL ()

Return this row in the form of an IDL struct.

void setFromIDL (StateRowIDL x) throws ConversionException

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

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 getStateId ()

Get stateId.

boolean getSig ()

Get sig.

void setSig (boolean sig) throws IllegalAccessException

Set sig with the specified boolean value.

boolean getRef ()

Get ref.

void setRef (boolean ref) throws IllegalAccessException

Set ref with the specified boolean value.

boolean isWeightExists ()

The attribute weight is optional.

float getWeight () throws IllegalAccessException

Get weight, which is optional.

void setWeight (float weight)

Set weight with the specified float value.

void clearWeight ()

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

boolean getOnSky ()

Get onSky.

void setOnSky (boolean onSky) throws IllegalAccessException

Set onSky with the specified boolean value.

CalibrationDevice getCalDeviceName ()

Get calDeviceName.

void setCalDeviceName (CalibrationDevice calDeviceName) throws IllegalAccessException

Set calDeviceName with the specified CalibrationDevice value.

boolean getFlagRow ()

Get flagRow.

void setFlagRow (boolean flagRow) throws IllegalAccessException

Set flagRow with the specified boolean value.

boolean compareNoAutoInc (boolean sig, boolean ref, boolean onSky, CalibrationDevice calDeviceName, boolean flagRow)

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

boolean equalByRequiredValue (StateRow x)

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

boolean compareRequiredValue (boolean sig, boolean ref, boolean onSky, CalibrationDevice calDeviceName, boolean flagRow)

Protected Member Functions

void setStateId (Tag stateId) throws IllegalAccessException

Set stateId with the specified Tag value.

Package Functions

StateRow (StateTable table)

Create a StateRow.

StateRow (StateTable table, StateRow row)

Creates a StateRow 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.StateRow.StateRow ( StateTable table ) [package]

Create a StateRow.
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.StateRow.StateRow ( StateTable table,

StateRow row

) [package]

Creates a StateRow using a copy constructor mechanism.
Given a StateRow row and a StateTable table, the method creates a new StateRow 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.StateRow.clearWeight ( )

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

boolean alma.asdm.StateRow.compareNoAutoInc ( boolean sig,

boolean ref,

boolean onSky,

CalibrationDevice calDeviceName,

boolean flagRow

)

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

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

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

Parameters:

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

Returns:
a boolean.

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

CalibrationDevice alma.asdm.StateRow.getCalDeviceName ( )

Get calDeviceName.

Returns:
calDeviceName as CalibrationDevice

boolean alma.asdm.StateRow.getFlagRow ( )

Get flagRow.

Returns:
flagRow as boolean

boolean alma.asdm.StateRow.getOnSky ( )

Get onSky.

Returns:
onSky as boolean

boolean alma.asdm.StateRow.getRef ( )

Get ref.

Returns:
ref as boolean

boolean alma.asdm.StateRow.getSig ( )

Get sig.

Returns:
sig as boolean

Tag alma.asdm.StateRow.getStateId ( )

Get stateId.

Returns:
stateId as Tag

StateTable alma.asdm.StateRow.getTable ( )

Return the table to which this row belongs.

float alma.asdm.StateRow.getWeight ( ) throws IllegalAccessException

Get weight, which is optional.

Returns:
weight as float

Exceptions:

IllegalAccessException If weight does not exist.

boolean alma.asdm.StateRow.isWeightExists ( )

The attribute weight is optional.
Return true if this attribute exists.
Returns:
true if and only if the weight attribute exists.

void alma.asdm.StateRow.setCalDeviceName ( CalibrationDevice calDeviceName ) throws IllegalAccessException

Set calDeviceName with the specified CalibrationDevice value.

Parameters:

calDeviceName The CalibrationDevice value to which calDeviceName 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.StateRow.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.StateRow.setFromIDL ( StateRowIDL x ) throws ConversionException

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

Parameters:

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

void alma.asdm.StateRow.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.StateRow.setOnSky ( boolean onSky ) throws IllegalAccessException

Set onSky with the specified boolean value.

Parameters:

onSky The boolean value to which onSky 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.StateRow.setRef ( boolean ref ) throws IllegalAccessException

Set ref with the specified boolean value.

Parameters:

ref The boolean value to which ref 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.StateRow.setSig ( boolean sig ) throws IllegalAccessException

Set sig with the specified boolean value.

Parameters:

sig The boolean value to which sig 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.StateRow.setStateId ( Tag stateId ) throws IllegalAccessException [protected]

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.StateRow.setWeight ( float weight )

Set weight with the specified float value.

Parameters:

weight The float value to which weight is to be set.

StateRowIDL alma.asdm.StateRow.toIDL ( )

Return this row in the form of an IDL struct.

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

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

StateRow.java

Generated on Tue Nov 18 17:46:48 2008 for ASDM Java Implementation by

1.3.8


Public Member Functions
StateTable	getTable ()
	Return the table to which this row belongs.
StateRowIDL	toIDL ()
	Return this row in the form of an IDL struct.
void	setFromIDL (StateRowIDL x) throws ConversionException
	Fill the values of this row from the IDL struct StateRowIDL.
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	getStateId ()
	Get stateId.
boolean	getSig ()
	Get sig.
void	setSig (boolean sig) throws IllegalAccessException
	Set sig with the specified boolean value.
boolean	getRef ()
	Get ref.
void	setRef (boolean ref) throws IllegalAccessException
	Set ref with the specified boolean value.
boolean	isWeightExists ()
	The attribute weight is optional.
float	getWeight () throws IllegalAccessException
	Get weight, which is optional.
void	setWeight (float weight)
	Set weight with the specified float value.
void	clearWeight ()
	Mark weight, which is an optional field, as non-existent.
boolean	getOnSky ()
	Get onSky.
void	setOnSky (boolean onSky) throws IllegalAccessException
	Set onSky with the specified boolean value.
CalibrationDevice	getCalDeviceName ()
	Get calDeviceName.
void	setCalDeviceName (CalibrationDevice calDeviceName) throws IllegalAccessException
	Set calDeviceName with the specified CalibrationDevice value.
boolean	getFlagRow ()
	Get flagRow.
void	setFlagRow (boolean flagRow) throws IllegalAccessException
	Set flagRow with the specified boolean value.
boolean	compareNoAutoInc (boolean sig, boolean ref, boolean onSky, CalibrationDevice calDeviceName, boolean flagRow)
	Compare each attribute except the autoincrementable one of this StateRow with the corresponding parameters and return true if there is a match and false otherwise.
boolean	equalByRequiredValue (StateRow x)
	Return true if all required attributes of the value part are equal to their homologues in x and false otherwise.
boolean	compareRequiredValue (boolean sig, boolean ref, boolean onSky, CalibrationDevice calDeviceName, boolean flagRow)
Protected Member Functions
void	setStateId (Tag stateId) throws IllegalAccessException
	Set stateId with the specified Tag value.
Package Functions
	StateRow (StateTable table)
	Create a StateRow.
	StateRow (StateTable table, StateRow row)
	Creates a StateRow 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.