alma.asdm.ScanTable Class Reference

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

Detailed Description

The ScanTable class is an Alma table.

Generated from model's revision 1.46, branch HEAD

Attributes of Scan
Name Type Comment

Key

execBlockId Tag

scanNumber int

Value
(Mandarory)

startTime ArrayTime

endTime ArrayTime

numSubScan int

numIntent int

scanIntent ScanIntent[] numIntent

flagRow boolean

Value
(Optional)

numField int

sourceName String

fieldName String[] numField

Attributes of Scan
Name	Type	Comment
Key
execBlockId	Tag
scanNumber	int
Value (Mandarory)
startTime	ArrayTime
endTime	ArrayTime
numSubScan	int
numIntent	int
scanIntent	ScanIntent[]	numIntent
flagRow	boolean
Value (Optional)
numField	int
sourceName	String
fieldName	String[]	numField

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 "ScanTable" followed by the current size of the table between parenthesis.

ScanRow newRow ()

Create a new row with default values .

ScanRow add (ScanRow x) throws DuplicateKey

Add a row.

void add (ScanRow[] x) throws DuplicateKey

Add an array of rows.

ScanRow newRow (Tag execBlockId, int scanNumber, ArrayTime startTime, ArrayTime endTime, int numSubScan, int numIntent, ScanIntent[] scanIntent, boolean flagRow)

Create a new row initialized to the specified values.

ScanRow newRow (ScanRow row)

Create a new row using a copy constructor mechanism.

ScanRow[] get ()

Get all rows.

ScanRow getRowByKey (Tag execBlockId, int scanNumber)

Returns a ScanRow given a key.

ScanRow lookup (Tag execBlockId, int scanNumber, ArrayTime startTime, ArrayTime endTime, int numSubScan, int numIntent, ScanIntent[] scanIntent, boolean flagRow)

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.

ScanTableIDL toIDL ()

Convert this table into a ScanTableIDL CORBA structure.

void fromIDL (ScanTableIDL x) throws DuplicateKey,ConversionException

Populate this table from the content of a ScanTableIDL 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 Scan (ScanTable.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 Scan (ScanTable.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 ScanTable 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 execBlockId, int scanNumber)

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

boolean inKey (String s)

ScanTable (ASDM container)

Create a ScanTable.

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.ScanTable.ScanTable ( ASDM container ) [package]

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

void alma.asdm.ScanTable.add ( ScanRow[] 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:

x The array of rows to be added.

ScanRow alma.asdm.ScanTable.add ( ScanRow x ) throws DuplicateKey

Add a row.

Exceptions:

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

Parameters:

x The row to be added.

Returns:
x

void alma.asdm.ScanTable.fromIDL ( ScanTableIDL x ) throws DuplicateKey,ConversionException

Populate this table from the content of a ScanTableIDL 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.ScanTable.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 Scan (ScanTable.xsd).

Exceptions:

ConversionException

Implements alma.asdm.Representable.

ScanRow [] alma.asdm.ScanTable.get ( )

Get all rows.

Returns:
Alls rows as an array of ScanRow

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

Return the container to which this table belongs.

Returns:
a ASDM.

Entity alma.asdm.ScanTable.getEntity ( )

Returns the table's entity.

Implements alma.asdm.Representable.

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

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

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

Return the name of this table.

Implements alma.asdm.ASDMTable.

ScanRow alma.asdm.ScanTable.getRowByKey ( Tag execBlockId,

int scanNumber

)

Returns a ScanRow 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:

execBlockId.

scanNumber.

ASDMRow [] alma.asdm.ScanTable.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.ScanTable.Key ( Tag execBlockId,

int scanNumber

) [package]

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

ScanRow alma.asdm.ScanTable.lookup ( Tag execBlockId,

int scanNumber,

ArrayTime startTime,

ArrayTime endTime,

int numSubScan,

int numIntent,

ScanIntent[] scanIntent,

boolean flagRow

)

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:

execBlockId.

scanNumber.

startTime.

endTime.

numSubScan.

numIntent.

scanIntent.

flagRow.

ScanRow alma.asdm.ScanTable.newRow ( ScanRow row )

Create a new row using a copy constructor mechanism.
The method creates a new ScanRow 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 ScanRow with default values for its attributes.

Parameters:

row the row which is to be copied.

ScanRow alma.asdm.ScanTable.newRow ( Tag execBlockId,

int scanNumber,

ArrayTime startTime,

ArrayTime endTime,

int numSubScan,

int numIntent,

ScanIntent[] scanIntent,

boolean flagRow

)

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:

execBlockId.

scanNumber.

startTime.

endTime.

numSubScan.

numIntent.

scanIntent.

flagRow.

ScanRow alma.asdm.ScanTable.newRow ( )

Create a new row with default values .

Returns:
a ScanRow

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

Set the table's entity.

Parameters:

e An entity.

Implements alma.asdm.Representable.

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

Reads and parses a file containing a representation of a ScanTable 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.ScanTable.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.ScanTable.size ( ) [virtual]

Return the number of rows in the table.

Implements alma.asdm.ASDMTable.

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

ScanTableIDL alma.asdm.ScanTable.toIDL ( )

Convert this table into a ScanTableIDL CORBA structure.

Returns:
a ScanTableIDL

byte [] alma.asdm.ScanTable.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.ScanTable.toString ( )

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

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

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

Returns:
a string containing the XML representation.

Implements alma.asdm.Representable.

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

ScanTable.java

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

1.3.8


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 "ScanTable" followed by the current size of the table between parenthesis.
ScanRow	newRow ()
	Create a new row with default values .
ScanRow	add (ScanRow x) throws DuplicateKey
	Add a row.
void	add (ScanRow[] x) throws DuplicateKey
	Add an array of rows.
ScanRow	newRow (Tag execBlockId, int scanNumber, ArrayTime startTime, ArrayTime endTime, int numSubScan, int numIntent, ScanIntent[] scanIntent, boolean flagRow)
	Create a new row initialized to the specified values.
ScanRow	newRow (ScanRow row)
	Create a new row using a copy constructor mechanism.
ScanRow[]	get ()
	Get all rows.
ScanRow	getRowByKey (Tag execBlockId, int scanNumber)
	Returns a ScanRow given a key.
ScanRow	lookup (Tag execBlockId, int scanNumber, ArrayTime startTime, ArrayTime endTime, int numSubScan, int numIntent, ScanIntent[] scanIntent, boolean flagRow)
	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.
ScanTableIDL	toIDL ()
	Convert this table into a ScanTableIDL CORBA structure.
void	fromIDL (ScanTableIDL x) throws DuplicateKey,ConversionException
	Populate this table from the content of a ScanTableIDL 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 Scan (ScanTable.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 Scan (ScanTable.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 ScanTable 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 execBlockId, int scanNumber)
	Returns a string built by concatenating the ascii representation of the parameters values suffixed with a "_" character.
boolean	inKey (String s)
	ScanTable (ASDM container)
	Create a ScanTable.
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.