alma.asdm.FocusTable Class Reference

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

Detailed Description

The FocusTable class is an Alma table.

Generated from model's revision 1.46, branch HEAD

Attributes of Focus
Name Type Comment

Key

antennaId Tag

feedId int

timeInterval ArrayTimeInterval

Value
(Mandarory)

focusModelId Tag

xFocusPosition Length

yFocusPosition Length

zFocusPosition Length

focusTracking boolean

xFocusOffset Length

yFocusOffset Length

zFocusOffset Length

Attributes of Focus
Name	Type	Comment
Key
antennaId	Tag
feedId	int
timeInterval	ArrayTimeInterval
Value (Mandarory)
focusModelId	Tag
xFocusPosition	Length
yFocusPosition	Length
zFocusPosition	Length
focusTracking	boolean
xFocusOffset	Length
yFocusOffset	Length
zFocusOffset	Length

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

FocusRow newRow ()

Create a new row with default values .

FocusRow add (FocusRow x) throws DuplicateKey

Add a row.

FocusRow newRow (Tag antennaId, int feedId, ArrayTimeInterval timeInterval, Tag focusModelId, Length xFocusPosition, Length yFocusPosition, Length zFocusPosition, boolean focusTracking, Length xFocusOffset, Length yFocusOffset, Length zFocusOffset)

Create a new row initialized to the specified values.

FocusRow newRow (FocusRow row)

Create a new row using a copy constructor mechanism.

FocusRow[] get ()

Get all rows.

FocusRow[] getByContext (Tag antennaId, int feedId)

Returns all the rows sorted by ascending startTime for a given context.

FocusRow getRowByKey (Tag antennaId, int feedId, ArrayTimeInterval timeInterval)

Returns a FocusRow given a key.

ASDMRow[] getRows ()

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

FocusTableIDL toIDL ()

Convert this table into a FocusTableIDL CORBA structure.

void fromIDL (FocusTableIDL x) throws DuplicateKey,ConversionException

Populate this table from the content of a FocusTableIDL 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 Focus (FocusTable.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 Focus (FocusTable.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 FocusTable 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 antennaId, int feedId)

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

boolean inKey (String s)

FocusTable (ASDM container)

Create a FocusTable.

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

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

FocusRow alma.asdm.FocusTable.add ( FocusRow x ) throws DuplicateKey

Add a row.

Parameters:

x a pointer to the FocusRow to be added.

Returns:
a FocusRow. If the table contains a FocusRow whose attributes (key and mandatory values) are equal to x ones then returns a pointer on that FocusRow, otherwise returns x.

Exceptions:

DuplicateKey { thrown when the table contains a FocusRow with a key equal to the x one but having and a value section different from x one }

Note:
The row is inserted in the table in such a way that all the rows having the same value of ( antennaId, feedId ) are stored by ascending time.

void alma.asdm.FocusTable.fromIDL ( FocusTableIDL x ) throws DuplicateKey,ConversionException

Populate this table from the content of a FocusTableIDL 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.FocusTable.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 Focus (FocusTable.xsd).

Exceptions:

ConversionException

Implements alma.asdm.Representable.

FocusRow [] alma.asdm.FocusTable.get ( )

Get all rows.

Returns:
Alls rows as an array of FocusRow

String [] alma.asdm.FocusTable.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.

FocusRow [] alma.asdm.FocusTable.getByContext ( Tag antennaId,

int feedId

)

Returns all the rows sorted by ascending startTime for a given context.
The context is defined by a value of ( antennaId, feedId ).

Returns:
an array of FocusRow. A null returned value means that the table contains no FocusRow for the given ( antennaId, feedId ).

ASDM alma.asdm.FocusTable.getContainer ( )

Return the container to which this table belongs.

Returns:
a ASDM.

Entity alma.asdm.FocusTable.getEntity ( )

Returns the table's entity.

Implements alma.asdm.Representable.

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

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

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

Return the name of this table.

Implements alma.asdm.ASDMTable.

FocusRow alma.asdm.FocusTable.getRowByKey ( Tag antennaId,

int feedId,

ArrayTimeInterval timeInterval

)

Returns a FocusRow given a key.

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

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

int feedId

) [package]

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

FocusRow alma.asdm.FocusTable.newRow ( FocusRow row )

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

Parameters:

row the row which is to be copied.

FocusRow alma.asdm.FocusTable.newRow ( Tag antennaId,

int feedId,

ArrayTimeInterval timeInterval,

Tag focusModelId,

Length xFocusPosition,

Length yFocusPosition,

Length zFocusPosition,

boolean focusTracking,

Length xFocusOffset,

Length yFocusOffset,

Length zFocusOffset

)

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:

antennaId.

feedId.

timeInterval.

focusModelId.

xFocusPosition.

yFocusPosition.

zFocusPosition.

focusTracking.

xFocusOffset.

yFocusOffset.

zFocusOffset.

FocusRow alma.asdm.FocusTable.newRow ( )

Create a new row with default values .

Returns:
a FocusRow

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

Set the table's entity.

Parameters:

e An entity.

Implements alma.asdm.Representable.

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

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

Return the number of rows in the table.

Implements alma.asdm.ASDMTable.

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

FocusTableIDL alma.asdm.FocusTable.toIDL ( )

Convert this table into a FocusTableIDL CORBA structure.

Returns:
a FocusTableIDL

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

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

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

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

Returns:
a string containing the XML representation.

Implements alma.asdm.Representable.

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

FocusTable.java

Generated on Tue Nov 18 17:46:47 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 "FocusTable" followed by the current size of the table between parenthesis.
FocusRow	newRow ()
	Create a new row with default values .
FocusRow	add (FocusRow x) throws DuplicateKey
	Add a row.
FocusRow	newRow (Tag antennaId, int feedId, ArrayTimeInterval timeInterval, Tag focusModelId, Length xFocusPosition, Length yFocusPosition, Length zFocusPosition, boolean focusTracking, Length xFocusOffset, Length yFocusOffset, Length zFocusOffset)
	Create a new row initialized to the specified values.
FocusRow	newRow (FocusRow row)
	Create a new row using a copy constructor mechanism.
FocusRow[]	get ()
	Get all rows.
FocusRow[]	getByContext (Tag antennaId, int feedId)
	Returns all the rows sorted by ascending startTime for a given context.
FocusRow	getRowByKey (Tag antennaId, int feedId, ArrayTimeInterval timeInterval)
	Returns a FocusRow given a key.
ASDMRow[]	getRows ()
	Returns the rows of an ASDMTable as an array of ASDMRow.
FocusTableIDL	toIDL ()
	Convert this table into a FocusTableIDL CORBA structure.
void	fromIDL (FocusTableIDL x) throws DuplicateKey,ConversionException
	Populate this table from the content of a FocusTableIDL 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 Focus (FocusTable.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 Focus (FocusTable.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 FocusTable 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 antennaId, int feedId)
	Returns a string built by concatenating the ascii representation of the parameters values suffixed with a "_" character.
boolean	inKey (String s)
	FocusTable (ASDM container)
	Create a FocusTable.
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.