alma.asdm.FieldRow Class Reference

Inherits alma.asdm.ASDMRow.

List of all members.

---

Detailed Description

The FieldRow class is a row of a FieldTable.

Generated from model's revision 1.41, branch HEAD

Public Member Functions
FieldTable	getTable ()
	Return the table to which this row belongs.
FieldRowIDL	toIDL ()
	Return this row in the form of an IDL struct.
void	setFromIDL (FieldRowIDL x) throws ConversionException
	Fill the values of this row from the IDL struct FieldRowIDL.
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	getFieldId ()
	Get fieldId.
String	getFieldName ()
	Get fieldName.
void	setFieldName (String fieldName)
	Set fieldName with the specified String value.
String	getCode ()
	Get code.
void	setCode (String code)
	Set code with the specified String value.
ArrayTime	getTime ()
	Get time.
void	setTime (ArrayTime time)
	Set time with the specified ArrayTime value.
int	getNumPoly ()
	Get numPoly.
void	setNumPoly (int numPoly)
	Set numPoly with the specified int value.
Angle[][]	getDelayDir ()
	Get delayDir.
void	setDelayDir (Angle[][] delayDir)
	Set delayDir with the specified Angle[][] value.
Angle[][]	getPhaseDir ()
	Get phaseDir.
void	setPhaseDir (Angle[][] phaseDir)
	Set phaseDir with the specified Angle[][] value.
Angle[][]	getReferenceDir ()
	Get referenceDir.
void	setReferenceDir (Angle[][] referenceDir)
	Set referenceDir with the specified Angle[][] value.
boolean	isAssocNatureExists ()
	The attribute assocNature is optional.
String	getAssocNature () throws IllegalAccessException
	Get assocNature, which is optional.
void	setAssocNature (String assocNature)
	Set assocNature with the specified String value.
void	clearAssocNature ()
	Mark assocNature, which is an optional field, as non-existent.
boolean	getFlagRow ()
	Get flagRow.
void	setFlagRow (boolean flagRow)
	Set flagRow with the specified boolean value.
boolean	isAssocFieldIdExists ()
	The attribute assocFieldId is optional.
Tag[]	getAssocFieldId () throws IllegalAccessException
	Get assocFieldId, which is optional.
void	setAssocFieldId (Tag[] assocFieldId)
	Set assocFieldId with the specified Tag[] value.
void	clearAssocFieldId ()
	Mark assocFieldId, which is an optional field, as non-existent.
boolean	isEphemerisIdExists ()
	The attribute ephemerisId is optional.
Tag	getEphemerisId () throws IllegalAccessException
	Get ephemerisId, which is optional.
void	setEphemerisId (Tag ephemerisId)
	Set ephemerisId with the specified Tag value.
void	clearEphemerisId ()
	Mark ephemerisId, which is an optional field, as non-existent.
boolean	isSourceIdExists ()
	The attribute sourceId is optional.
int	getSourceId () throws IllegalAccessException
	Get sourceId, which is optional.
void	setSourceId (int sourceId)
	Set sourceId with the specified int value.
void	clearSourceId ()
	Mark sourceId, which is an optional field, as non-existent.
void	setAssocFieldId (int i, Tag assocFieldId) throws IllegalAccessException, IndexOutOfBoundsException
	Set assocFieldId[i] with the specified Tag value.
EphemerisRow	getEphemerisUsingEphemerisId () throws IllegalAccessException
	Returns the pointer to the row in the Ephemeris table having Ephemeris.ephemerisId == ephemerisId.
SourceRow[]	getSources () throws InvalidAccessException, NoSuchRow
	Get the collection of rows in the Source table having sourceId == this.sourceId.
boolean	compareNoAutoInc (String fieldName, String code, ArrayTime time, int numPoly, Angle[][] delayDir, Angle[][] phaseDir, Angle[][] referenceDir, boolean flagRow)
	Compare each attribute except the autoincrementable one of this FieldRow with the corresponding parameters and return true if there is a match and false otherwise.
boolean	equalByRequiredValue (FieldRow x)
	Return true if all required attributes of the value part are equal to their homologues in x and false otherwise.
boolean	compareRequiredValue (String fieldName, String code, ArrayTime time, int numPoly, Angle[][] delayDir, Angle[][] phaseDir, Angle[][] referenceDir, boolean flagRow)
Protected Member Functions
void	setFieldId (Tag fieldId) throws IllegalAccessException
	Set fieldId with the specified Tag value.
Package Functions
	FieldRow (FieldTable table)
	Create a FieldRow.
	FieldRow (FieldTable table, FieldRow row)
	Creates a FieldRow using a copy constructor mechanism.
void	isAdded ()
void	addAssocFieldId (Tag id)
	Append a Tag to assocFieldId.
void	addAssocFieldId (Tag[] id)
	Append an array of Tag to assocFieldId.
Tag	getAssocFieldId (int i) throws IndexOutOfBoundsException
	Returns the Tag stored in assocFieldId at position i.
FieldRow	getField (int i) throws IndexOutOfBoundsException, NoSuchRow
	Returns the FieldRow linked to this row via the Tag stored in assocFieldId at position i.
FieldRow[]	getFields () throws NoSuchRow
	Returns the array of FieldRow linked to this row via the Tags stored in assocFieldId.
Object[]	getAttributesValues ()
	Returns all the attributes of an attribute of an ASDM table as an array of Object.

---

Constructor & Destructor Documentation

alma.asdm.FieldRow.FieldRow

(

FieldTable

table

)

[package]

Create a FieldRow.

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

Creates a FieldRow using a copy constructor mechanism.

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

FieldRowIDL alma.asdm.FieldRow.toIDL

(

)

Return this row in the form of an IDL struct.

Returns:

The values of this row as a FieldRowIDL struct.

void alma.asdm.FieldRow.setFromIDL

(

FieldRowIDL

x

)

throws ConversionException

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

Parameters:

x

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

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

(

)

Get fieldId.

Returns:

fieldId as Tag

void alma.asdm.FieldRow.setFieldId

(

Tag

fieldId

)

throws IllegalAccessException [protected]

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.

String alma.asdm.FieldRow.getFieldName

(

)

Get fieldName.

Returns:

fieldName as String

void alma.asdm.FieldRow.setFieldName

(

String

fieldName

)

Set fieldName with the specified String value.

Parameters:

fieldName

The String value to which fieldName is to be set.

String alma.asdm.FieldRow.getCode

(

)

Get code.

Returns:

code as String

void alma.asdm.FieldRow.setCode

(

String

code

)

Set code with the specified String value.

Parameters:

code

The String value to which code is to be set.

ArrayTime alma.asdm.FieldRow.getTime

(

)

Get time.

Returns:

time as ArrayTime

void alma.asdm.FieldRow.setTime

(

ArrayTime

time

)

Set time with the specified ArrayTime value.

Parameters:

time

The ArrayTime value to which time is to be set.

int alma.asdm.FieldRow.getNumPoly

(

)

Get numPoly.

Returns:

numPoly as int

void alma.asdm.FieldRow.setNumPoly

(

int

numPoly

)

Set numPoly with the specified int value.

Parameters:

numPoly

The int value to which numPoly is to be set.

Angle [][] alma.asdm.FieldRow.getDelayDir

(

)

Get delayDir.

Returns:

delayDir as Angle[][]

void alma.asdm.FieldRow.setDelayDir

(

Angle

delayDir[][]

)

Set delayDir with the specified Angle[][] value.

Parameters:

delayDir

The Angle[][] value to which delayDir is to be set.

Angle [][] alma.asdm.FieldRow.getPhaseDir

(

)

Get phaseDir.

Returns:

phaseDir as Angle[][]

void alma.asdm.FieldRow.setPhaseDir

(

Angle

phaseDir[][]

)

Set phaseDir with the specified Angle[][] value.

Parameters:

phaseDir

The Angle[][] value to which phaseDir is to be set.

Angle [][] alma.asdm.FieldRow.getReferenceDir

(

)

Get referenceDir.

Returns:

referenceDir as Angle[][]

void alma.asdm.FieldRow.setReferenceDir

(

Angle

referenceDir[][]

)

Set referenceDir with the specified Angle[][] value.

Parameters:

referenceDir

The Angle[][] value to which referenceDir is to be set.

boolean alma.asdm.FieldRow.isAssocNatureExists

(

)

The attribute assocNature is optional.

Return true if this attribute exists.

Returns:

true if and only if the assocNature attribute exists.

String alma.asdm.FieldRow.getAssocNature

(

)

throws IllegalAccessException

Get assocNature, which is optional.

Returns:

assocNature as String

Exceptions:

IllegalAccessException

If assocNature does not exist.

void alma.asdm.FieldRow.setAssocNature

(

String

assocNature

)

Set assocNature with the specified String value.

Parameters:

assocNature

The String value to which assocNature is to be set.

boolean alma.asdm.FieldRow.getFlagRow

(

)

Get flagRow.

Returns:

flagRow as boolean

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

(

)

The attribute assocFieldId is optional.

Return true if this attribute exists.

Returns:

true if and only if the assocFieldId attribute exists.

Tag [] alma.asdm.FieldRow.getAssocFieldId

(

)

throws IllegalAccessException

Get assocFieldId, which is optional.

Returns:

assocFieldId as Tag[]

Exceptions:

IllegalAccessException

If assocFieldId does not exist.

void alma.asdm.FieldRow.setAssocFieldId

(

Tag[]

assocFieldId

)

Set assocFieldId with the specified Tag[] value.

Parameters:

assocFieldId

The Tag[] value to which assocFieldId is to be set.

boolean alma.asdm.FieldRow.isEphemerisIdExists

(

)

The attribute ephemerisId is optional.

Return true if this attribute exists.

Returns:

true if and only if the ephemerisId attribute exists.

Tag alma.asdm.FieldRow.getEphemerisId

(

)

throws IllegalAccessException

Get ephemerisId, which is optional.

Returns:

ephemerisId as Tag

Exceptions:

IllegalAccessException

If ephemerisId does not exist.

void alma.asdm.FieldRow.setEphemerisId

(

Tag

ephemerisId

)

Set ephemerisId with the specified Tag value.

Parameters:

ephemerisId

The Tag value to which ephemerisId is to be set.

boolean alma.asdm.FieldRow.isSourceIdExists

(

)

The attribute sourceId is optional.

Return true if this attribute exists.

Returns:

true if and only if the sourceId attribute exists.

int alma.asdm.FieldRow.getSourceId

(

)

throws IllegalAccessException

Get sourceId, which is optional.

Returns:

sourceId as int

Exceptions:

IllegalAccessException

If sourceId does not exist.

void alma.asdm.FieldRow.setSourceId

(

int

sourceId

)

Set sourceId with the specified int value.

Parameters:

sourceId

The int value to which sourceId is to be set.

void alma.asdm.FieldRow.setAssocFieldId	(	int	i,
		Tag	assocFieldId
	)			throws IllegalAccessException, IndexOutOfBoundsException

Set assocFieldId[i] with the specified Tag value.

Parameters:

	i	The index in assocFieldId where to set the Tag value.
	assocFieldId	The Tag value to which assocFieldId[i] is to be set.

Exceptions:

	IllegalAccessException
	IndexOutOfBoundsException

void alma.asdm.FieldRow.addAssocFieldId

(

Tag

id

)

[package]

Append a Tag to assocFieldId.

Parameters:

id

the Tag to be appended to assocFieldId

void alma.asdm.FieldRow.addAssocFieldId

(

Tag[]

id

)

[package]

Append an array of Tag to assocFieldId.

Parameters:

id

an array of Tag to be appended to assocFieldId

EphemerisRow alma.asdm.FieldRow.getEphemerisUsingEphemerisId

(

)

throws IllegalAccessException

Returns the pointer to the row in the Ephemeris table having Ephemeris.ephemerisId == ephemerisId.

Returns:

a EphemerisRow

throws IllegalAccessException

boolean alma.asdm.FieldRow.equalByRequiredValue

(

FieldRow

x

)

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

Parameters:

x

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

Returns:

a boolean.

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

• FieldRow.java

---