alma.asdm.AnnotationTable Class Reference

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

Detailed Description

The AnnotationTable class is an Alma table.

Generated from model's revision 1.46, branch HEAD

Attributes of Annotation
Name Type Comment

Key

annotationId Tag

Value
(Mandarory)

time ArrayTime

issue String

details String

Value
(Optional)

antennaId Tag[]

interval Interval

numAntenna int

numBaseband int

basebandName BasebandName[] numBaseband

dValue double

vdValue double[]

vvdValues double[][] ,

llValue long

vllValue long[]

vvllValue long[][] ,

Attributes of Annotation
Name	Type	Comment
Key
annotationId	Tag
Value (Mandarory)
time	ArrayTime
issue	String
details	String
Value (Optional)
antennaId	Tag[]
interval	Interval
numAntenna	int
numBaseband	int
basebandName	BasebandName[]	numBaseband
dValue	double
vdValue	double[]
vvdValues	double[][]	,
llValue	long
vllValue	long[]
vvllValue	long[][]	,

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

AnnotationRow newRow ()

Create a new row with default values .

AnnotationRow add (AnnotationRow x)

Look up the table for a row whose noautoincrementable attributes are matching their homologues in x.

AnnotationRow newRow (ArrayTime time, String issue, String details)

Create a new row initialized to the specified values.

AnnotationRow newRow (AnnotationRow row)

Create a new row using a copy constructor mechanism.

AnnotationRow[] get ()

Get all rows.

AnnotationRow getRowByKey (Tag annotationId)

Returns a AnnotationRow given a key.

AnnotationRow lookup (ArrayTime time, String issue, String details)

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.

AnnotationTableIDL toIDL ()

Convert this table into a AnnotationTableIDL CORBA structure.

void fromIDL (AnnotationTableIDL x) throws DuplicateKey,ConversionException, UniquenessViolationException

Populate this table from the content of a AnnotationTableIDL 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 Annotation (AnnotationTable.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 Annotation (AnnotationTable.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 AnnotationTable 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

void autoIncrement (String key, AnnotationRow x)

boolean inKey (String s)

AnnotationTable (ASDM container)

Create a AnnotationTable.

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

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

AnnotationRow alma.asdm.AnnotationTable.add ( AnnotationRow x )

Look up the table for a row whose noautoincrementable attributes are matching their homologues in x.
If a row is found this row else autoincrement x.annotationId, add x to its table and returns x.

Returns:
a AnnotationRow.

Parameters:

x. A row to be added.

void alma.asdm.AnnotationTable.fromIDL ( AnnotationTableIDL x ) throws DuplicateKey,ConversionException, UniquenessViolationException

Populate this table from the content of a AnnotationTableIDL 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.AnnotationTable.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 Annotation (AnnotationTable.xsd).

Exceptions:

ConversionException

Implements alma.asdm.Representable.

AnnotationRow [] alma.asdm.AnnotationTable.get ( )

Get all rows.

Returns:
Alls rows as an array of AnnotationRow

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

Return the container to which this table belongs.

Returns:
a ASDM.

Entity alma.asdm.AnnotationTable.getEntity ( )

Returns the table's entity.

Implements alma.asdm.Representable.

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

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

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

Return the name of this table.

Implements alma.asdm.ASDMTable.

AnnotationRow alma.asdm.AnnotationTable.getRowByKey ( Tag annotationId )

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

annotationId.

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

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

Returns:
an array of ASDMRow.

Implements alma.asdm.ASDMTable.

AnnotationRow alma.asdm.AnnotationTable.lookup ( ArrayTime time,

String issue,

String details

)

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, null otherwise.

Parameters:

time.

issue.

details.

AnnotationRow alma.asdm.AnnotationTable.newRow ( AnnotationRow row )

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

Parameters:

row the row which is to be copied.

AnnotationRow alma.asdm.AnnotationTable.newRow ( ArrayTime time,

String issue,

String details

)

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:

time.

issue.

details.

AnnotationRow alma.asdm.AnnotationTable.newRow ( )

Create a new row with default values .

Returns:
a AnnotationRow

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

Set the table's entity.

Parameters:

e An entity.

Implements alma.asdm.Representable.

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

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

Return the number of rows in the table.

Implements alma.asdm.ASDMTable.

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

AnnotationTableIDL alma.asdm.AnnotationTable.toIDL ( )

Convert this table into a AnnotationTableIDL CORBA structure.

Returns:
a AnnotationTableIDL

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

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

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

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

Returns:
a string containing the XML representation.

Implements alma.asdm.Representable.

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

AnnotationTable.java

Generated on Tue Nov 18 17:46:43 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 "AnnotationTable" followed by the current size of the table between parenthesis.
AnnotationRow	newRow ()
	Create a new row with default values .
AnnotationRow	add (AnnotationRow x)
	Look up the table for a row whose noautoincrementable attributes are matching their homologues in x.
AnnotationRow	newRow (ArrayTime time, String issue, String details)
	Create a new row initialized to the specified values.
AnnotationRow	newRow (AnnotationRow row)
	Create a new row using a copy constructor mechanism.
AnnotationRow[]	get ()
	Get all rows.
AnnotationRow	getRowByKey (Tag annotationId)
	Returns a AnnotationRow given a key.
AnnotationRow	lookup (ArrayTime time, String issue, String details)
	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.
AnnotationTableIDL	toIDL ()
	Convert this table into a AnnotationTableIDL CORBA structure.
void	fromIDL (AnnotationTableIDL x) throws DuplicateKey,ConversionException, UniquenessViolationException
	Populate this table from the content of a AnnotationTableIDL 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 Annotation (AnnotationTable.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 Annotation (AnnotationTable.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 AnnotationTable 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
void	autoIncrement (String key, AnnotationRow x)
boolean	inKey (String s)
	AnnotationTable (ASDM container)
	Create a AnnotationTable.
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.