ASDM Java Implementation: alma.asdm.CalGainTable Class Reference

Attributes of CalGain
Name	Type	Comment
Key
calDataId	Tag
calReductionId	Tag
Value (Mandarory)
startValidTime	ArrayTime
endValidTime	ArrayTime
gain	float[][]
gainValid	boolean[]
fit	float[][]
fitWeight	float[]
totalGainValid	boolean
totalFit	float
totalFitWeight	float


Public Member Functions
String[]	getAttributesNames ()
	Returns the names of the attributes of the rows stored in that table.
ASDM	getContainer ()
	Return the container to which this table belongs.
int	size ()
	Return the number of rows in the table.
String	getName ()
	Return the name of this table.
String	toString ()
	Returns "CalGainTable" followed by the current size of the table between parenthesis.
CalGainRow	newRow ()
	Create a new row with default values .
CalGainRow	add (CalGainRow x) throws DuplicateKey
	Add a row.
void	add (CalGainRow[] x) throws DuplicateKey
	Add an array of rows.
CalGainRow	newRow (Tag calDataId, Tag calReductionId, ArrayTime startValidTime, ArrayTime endValidTime, float[][] gain, boolean[] gainValid, float[][] fit, float[] fitWeight, boolean totalGainValid, float totalFit, float totalFitWeight)
	Create a new row initialized to the specified values.
CalGainRow	newRow (CalGainRow row)
	Create a new row using a copy constructor mechanism.
CalGainRow[]	get ()
	Get all rows.
CalGainRow	getRowByKey (Tag calDataId, Tag calReductionId)
	Returns a CalGainRow given a key.
CalGainRow	lookup (Tag calDataId, Tag calReductionId, ArrayTime startValidTime, ArrayTime endValidTime, float[][] gain, boolean[] gainValid, float[][] fit, float[] fitWeight, boolean totalGainValid, float totalFit, float totalFitWeight)
	Look up the table for a row whose all attributes are equal to the corresponding parameters of the method.
ASDMRow[]	getRows ()
	Returns the rows of an ASDMTable as an array of ASDMRow.
CalGainTableIDL	toIDL ()
	Convert this table into a CalGainTableIDL CORBA structure.
void	fromIDL (CalGainTableIDL x) throws DuplicateKey,ConversionException
	Populate this table from the content of a CalGainTableIDL Corba structure.
byte[]	toFITS () throws ConversionException
	To be implemented.
void	fromFITS (byte[] fits) throws ConversionException
	To be implemented.
String	toVOTable () throws ConversionException
	To be implemented.
void	fromVOTable (String vo) throws ConversionException
	To be implemented.
String	toXML () throws ConversionException
	Translate this table to an XML representation conform to the schema defined for CalGain (CalGainTable.xsd).
void	fromXML (String xmlDoc) throws ConversionException
	Populate this table from the content of a XML document that is required to be conform to the XML schema defined for a CalGain (CalGainTable.xsd).
byte[]	toMIME () throws ConversionException
	Serialize this into a stream of bytes and encapsulates that stream into a MIME message.
void	toFile (String directory) throws ConversionException
	Stores a representation (binary or XML) of this table into a file.
void	setFromFile (String directory) throws ConversionException
	Reads and parses a file containing a representation of a CalGainTable as those produced by the toFile method.
Entity	getEntity ()
	Returns the table's entity.
void	setEntity (Entity e)
	Set the table's entity.
void	fromArchive (Archiver ar, String UID) throws ConversionException, ArchiverException
Static Public Member Functions
static String[]	getKeyName ()
	Return the list of field names that make up key key as an array of strings.
Package Functions
String	Key (Tag calDataId, Tag calReductionId)
	Returns a string built by concatenating the ascii representation of the parameters values suffixed with a "_" character.
boolean	inKey (String s)
	CalGainTable (ASDM container)
	Create a CalGainTable.
void	setFromMIME (byte[] mimeMsg) throws ConversionException
	Extracts the binary part of a MIME message and deserialize its content to fill this with the result of the deserialization.
String	toArchive (Archiver ar) throws ConversionException, ArchiverException
	Store this table into the archive.

Constructor & Destructor Documentation

alma.asdm.CalGainTable.CalGainTable ( ASDM container ) [package]

Create a CalGainTable.

This constructor has package access because only the container can create tables. All tables must know the container to which they belong.

Parameters:

container

The container to which this table belongs.

Member Function Documentation

String [] alma.asdm.CalGainTable.getAttributesNames ( ) [virtual]

Returns the names of the attributes of the rows stored in that table.

Returns:: the attributes names as an array of String.

Implements alma.asdm.ASDMTable.

ASDM alma.asdm.CalGainTable.getContainer ( )

Return the container to which this table belongs.

Returns:: a ASDM.

String alma.asdm.CalGainTable.toString ( )

Returns "CalGainTable" followed by the current size of the table between parenthesis.

Example : SpectralWindowTable(12)

Returns:: a String.

CalGainRow alma.asdm.CalGainTable.newRow ( )

Create a new row with default values .

Returns:: a CalGainRow

CalGainRow alma.asdm.CalGainTable.add ( CalGainRow x ) throws DuplicateKey

Add a row.

Exceptions:

DuplicateKey

Thrown if the new row has a key that is already in the table.

Parameters:

The row to be added.

Returns:: x

void alma.asdm.CalGainTable.add ( CalGainRow[] x ) throws DuplicateKey

Add an array of rows.

Exceptions:

DuplicateKey

Thrown if any new row has a key that is already in the table.

Parameters:

The array of rows to be added.

CalGainRow alma.asdm.CalGainTable.newRow	(	Tag	calDataId,
		Tag	calReductionId,
		ArrayTime	startValidTime,
		ArrayTime	endValidTime,
		float	gain[][],
		boolean[]	gainValid,
		float	fit[][],
		float[]	fitWeight,
		boolean	totalGainValid,
		float	totalFit,
		float	totalFitWeight
	)

Create a new row initialized to the specified values.

(the autoincrementable attribute if any is not in the parameter list)

Returns:: the new initialized row.

Parameters:

	calDataId.
	calReductionId.
	startValidTime.
	endValidTime.
	gain.
	gainValid.
	fit.
	fitWeight.
	totalGainValid.
	totalFit.
	totalFitWeight.

CalGainRow alma.asdm.CalGainTable.newRow ( CalGainRow row )

Create a new row using a copy constructor mechanism.

The method creates a new CalGainRow owned by this. Each attribute of the created row is a (deep) copy of the corresponding attribute of row. The method does not add the created row to this, its simply parents it to this, 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 new CalGainRow with default values for its attributes.

Parameters:

row

the row which is to be copied.

CalGainRow [] alma.asdm.CalGainTable.get ( )

Get all rows.

Returns:: Alls rows as an array of CalGainRow

CalGainRow alma.asdm.CalGainTable.getRowByKey	(	Tag	calDataId,
		Tag	calReductionId
	)

Returns a CalGainRow given a key.

Returns:: the row having the key whose values are passed as parameters, or null if no row exists for that key.

Parameters:

	calDataId.
	calReductionId.

CalGainRow alma.asdm.CalGainTable.lookup	(	Tag	calDataId,
		Tag	calReductionId,
		ArrayTime	startValidTime,
		ArrayTime	endValidTime,
		float	gain[][],
		boolean[]	gainValid,
		float	fit[][],
		float[]	fitWeight,
		boolean	totalGainValid,
		float	totalFit,
		float	totalFitWeight
	)

Look up the table for a row whose all attributes are equal to the corresponding parameters of the method.

Returns:: this row if any, null otherwise.

Parameters:

	calDataId.
	calReductionId.
	startValidTime.
	endValidTime.
	gain.
	gainValid.
	fit.
	fitWeight.
	totalGainValid.
	totalFit.
	totalFitWeight.

ASDMRow [] alma.asdm.CalGainTable.getRows ( ) [virtual]

Returns the rows of an ASDMTable as an array of ASDMRow.

Returns:: an array of ASDMRow.

Implements alma.asdm.ASDMTable.

CalGainTableIDL alma.asdm.CalGainTable.toIDL ( )

Convert this table into a CalGainTableIDL CORBA structure.

Returns:: a CalGainTableIDL

void alma.asdm.CalGainTable.fromIDL ( CalGainTableIDL x ) throws DuplicateKey,ConversionException

Populate this table from the content of a CalGainTableIDL Corba structure.

Exceptions:

	DuplicateKey	Thrown if the method tries to add a row having a key that is already in the table.
	ConversionException

String alma.asdm.CalGainTable.toXML ( ) throws ConversionException

Translate this table to an XML representation conform to the schema defined for CalGain (CalGainTable.xsd).

Returns:: a string containing the XML representation.

Implements alma.asdm.Representable.

void alma.asdm.CalGainTable.fromXML ( String xmlDoc ) throws ConversionException

Populate this table from the content of a XML document that is required to be conform to the XML schema defined for a CalGain (CalGainTable.xsd).

Exceptions:

ConversionException

Implements alma.asdm.Representable.

byte [] alma.asdm.CalGainTable.toMIME ( ) throws ConversionException

Serialize this into a stream of bytes and encapsulates that stream into a MIME message.

Returns:: a string containing the MIME message.

void alma.asdm.CalGainTable.setFromMIME ( byte[] mimeMsg ) throws ConversionException [package]

Extracts the binary part of a MIME message and deserialize its content to fill this with the result of the deserialization.

Parameters:

mimeMsg

the string containing the MIME message.

Exceptions:

ConversionException

void alma.asdm.CalGainTable.toFile ( String directory ) throws ConversionException

Stores a representation (binary or XML) of this table into a file.

Depending on the boolean value of its private field fileAsBin a binary serialization of this (fileAsBin==true) will be saved in a file "CalGain.bin" or an XML representation (fileAsBin==false) will be saved in a file "CalGain.xml". The file is always written in a directory whose name is passed as a parameter.

Parameters:

directory

The name of directory where the file containing the table's representation will be saved.

Exceptions:

ConversionException

void alma.asdm.CalGainTable.setFromFile ( String directory ) throws ConversionException

Reads and parses a file containing a representation of a CalGainTable as those produced by the toFile method.

This table is populated with the result of the parsing.

Parameters:

directory

The name of the directory containing the file te be read and parsed.

Exceptions:

ConversionException

If any error occurs while reading the files in the directory or parsing them.

void alma.asdm.CalGainTable.setEntity ( Entity e )

Set the table's entity.

Parameters:

An entity.

Implements alma.asdm.Representable.

String alma.asdm.CalGainTable.toArchive ( Archiver ar ) throws ConversionException, ArchiverException [package]

Store this table into the archive.

Parameters:

the archiver in charge of the archiving.

Returns:: the UID assigned to the archived table.

alma.asdm.CalGainTable Class Reference

Detailed Description

Public Member Functions

Static Public Member Functions

Package Functions

Constructor & Destructor Documentation

Member Function Documentation