alma.asdm.SourceTable Class Reference

Inherits alma.asdm.ASDMTable, and alma.asdm.Representable.

List of all members.

---

Detailed Description

The SourceTable class is an Alma table.

Generated from model's revision 1.46, branch HEAD

Attributes of Source

Name	Type	Comment
Key
sourceId	int
spectralWindowId	Tag
timeInterval	ArrayTimeInterval
Value (Mandarory)
numLines	int
sourceName	String
code	String
direction	Angle[]	2
properMotion	AngularRate[]	2
Value (Optional)
sourceParameterId	int
catalog	String
calibrationGroup	int
position	Length[]	3
transition	String[]	numLines
restFrequency	Frequency[]	numLines
sysVel	Speed[]	numLines
sourceModel	SourceModel
deltaVel	Speed
rangeVel	Speed[]	2

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 "SourceTable" followed by the current size of the table between parenthesis.
SourceRow	newRow ()
	Create a new row with default values .
SourceRow	add (SourceRow x)
	Append a row to a SourceTable which has simply 1) an autoincrementable attribute (sourceId) 2) a temporal attribute (timeInterval) in its key section.
SourceRow	newRow (Tag spectralWindowId, ArrayTimeInterval timeInterval, int numLines, String sourceName, String code, Angle[] direction, AngularRate[] properMotion)
	Create a new row initialized to the specified values.
SourceRow	newRow (SourceRow row)
	Create a new row using a copy constructor mechanism.
SourceRow[]	get ()
	Get all rows.
SourceRow	getRowByKey (int sourceId, Tag spectralWindowId, ArrayTimeInterval timeInterval)
	Returns a SourceRow given a key.
SourceRow[]	getRowBySourceId (int sourceId)
	Returns an array rows whose key element sourceId is equal to the parameter sourceId.
SourceRow	lookup (Tag spectralWindowId, ArrayTimeInterval timeInterval, int numLines, String sourceName, String code, Angle[] direction, AngularRate[] properMotion)
	Look up the table for a row whose all attributes except the autoincrementable one are equal to the corresponding parameters of the method.
ASDMRow[]	getRows ()
	Returns the rows of an ASDMTable as an array of ASDMRow.
SourceTableIDL	toIDL ()
	Convert this table into a SourceTableIDL CORBA structure.
void	fromIDL (SourceTableIDL x) throws DuplicateKey,ConversionException, UniquenessViolationException
	Populate this table from the content of a SourceTableIDL 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 Source (SourceTable.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 Source (SourceTable.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 SourceTable 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
String[]	getKeyName ()
	Return the list of field names that make up key key as an array of strings.
Package Functions
String	Key (Tag spectralWindowId)
	Returns a string built by concatenating the ascii representation of the parameters values suffixed with a "_" character.
boolean	inKey (String s)
	SourceTable (ASDM container)
	Create a SourceTable.
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.SourceTable.SourceTable (  ASDM  container  )  [package]

Create a SourceTable. 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

SourceRow alma.asdm.SourceTable.add (  SourceRow  x  )

Append a row to a SourceTable which has simply 1) an autoincrementable attribute (sourceId) 2) a temporal attribute (timeInterval) in its key section. 3) other attributes in the key section (defining a so called context). If there is already a row in the table whose key section non including is equal to x's one and whose value section is equal to x's one then return this row, otherwise add x to the collection of rows.

void alma.asdm.SourceTable.fromIDL (  SourceTableIDL  x  )  throws DuplicateKey,ConversionException, UniquenessViolationException

Populate this table from the content of a SourceTableIDL Corba structure. Exceptions: DuplicateKey  Thrown if the method tries to add a row having a key that is already in the table. ConversionException

void alma.asdm.SourceTable.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 Source (SourceTable.xsd). Exceptions: ConversionException  Implements alma.asdm.Representable.

SourceRow [] alma.asdm.SourceTable.get (   )

Get all rows. Returns: Alls rows as an array of SourceRow

String [] alma.asdm.SourceTable.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.SourceTable.getContainer (   )

Return the container to which this table belongs. Returns: a ASDM.

Entity alma.asdm.SourceTable.getEntity (   )

Returns the table's entity. Implements alma.asdm.Representable.

String [] alma.asdm.SourceTable.getKeyName (   )  [static]

Return the list of field names that make up key key as an array of strings.

String alma.asdm.SourceTable.getName (   )  [virtual]

Return the name of this table. Implements alma.asdm.ASDMTable.

SourceRow alma.asdm.SourceTable.getRowByKey (  int  sourceId, Tag  spectralWindowId, ArrayTimeInterval  timeInterval )

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

SourceRow [] alma.asdm.SourceTable.getRowBySourceId (  int  sourceId  )

Returns an array rows whose key element sourceId is equal to the parameter sourceId. Returns: an array of SourceRow. A returned array of size 0 means that no row has been found. Parameters: sourceId  int contains the value of the autoincrementable attribute that is looked up in the table.

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

Returns the rows of an ASDMTable as an array of ASDMRow. Returns: an array of ASDMRow. Implements alma.asdm.ASDMTable.

String alma.asdm.SourceTable.Key (  Tag  spectralWindowId  )  [package]

Returns a string built by concatenating the ascii representation of the parameters values suffixed with a "_" character.

SourceRow alma.asdm.SourceTable.lookup (  Tag  spectralWindowId, ArrayTimeInterval  timeInterval, int  numLines, String  sourceName, String  code, Angle[]  direction, AngularRate[]  properMotion )

Look up the table for a row whose all attributes except the autoincrementable one are equal to the corresponding parameters of the method. Returns: this row if any, 0 otherwise. Parameters: spectralWindowId.  timeInterval.  numLines.  sourceName.  code.  direction.  properMotion.

SourceRow alma.asdm.SourceTable.newRow (  SourceRow  row  )

Create a new row using a copy constructor mechanism. The method creates a new SourceRow 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 SourceRow with default values for its attributes. Parameters: row  the row which is to be copied.

SourceRow alma.asdm.SourceTable.newRow (  Tag  spectralWindowId, ArrayTimeInterval  timeInterval, int  numLines, String  sourceName, String  code, Angle[]  direction, AngularRate[]  properMotion )

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: spectralWindowId.  timeInterval.  numLines.  sourceName.  code.  direction.  properMotion.

SourceRow alma.asdm.SourceTable.newRow (   )

Create a new row with default values . Returns: a SourceRow

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

Set the table's entity. Parameters: e  An entity. Implements alma.asdm.Representable.

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

Reads and parses a file containing a representation of a SourceTable 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.SourceTable.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

int alma.asdm.SourceTable.size (   )  [virtual]

Return the number of rows in the table. Implements alma.asdm.ASDMTable.

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

Store this table into the archive. Parameters: ar  the archiver in charge of the archiving. Returns: the UID assigned to the archived table.

void alma.asdm.SourceTable.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 "Source.bin" or an XML representation (fileAsBin==false) will be saved in a file "Source.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

SourceTableIDL alma.asdm.SourceTable.toIDL (   )

Convert this table into a SourceTableIDL CORBA structure. Returns: a SourceTableIDL

byte [] alma.asdm.SourceTable.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.

String alma.asdm.SourceTable.toString (   )

Returns "SourceTable" followed by the current size of the table between parenthesis. Example : SpectralWindowTable(12) Returns: a String.

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

Translate this table to an XML representation conform to the schema defined for Source (SourceTable.xsd). Returns: a string containing the XML representation. Implements alma.asdm.Representable.

---

The documentation for this class was generated from the following file:

• SourceTable.java

---