alma.asdm.ASDM Class Reference

Inherits alma.asdm.Representable.

List of all members.

---

Detailed Description

The ASDM class is the container for all tables.

Its instantation create a complete set of tables.

Generated from model's revision 1.46, branch HEAD

Public Member Functions
Object[]	getTables ()
	Returns its tables as an array of Object.
	ASDM ()
	Create an instance of the tables that belong to this model.
MainTable	getMain ()
	Get the table Main.
AlmaRadiometerTable	getAlmaRadiometer ()
	Get the table AlmaRadiometer.
AnnotationTable	getAnnotation ()
	Get the table Annotation.
AntennaTable	getAntenna ()
	Get the table Antenna.
BeamTable	getBeam ()
	Get the table Beam.
CalAmpliTable	getCalAmpli ()
	Get the table CalAmpli.
CalAtmosphereTable	getCalAtmosphere ()
	Get the table CalAtmosphere.
CalBandpassTable	getCalBandpass ()
	Get the table CalBandpass.
CalCurveTable	getCalCurve ()
	Get the table CalCurve.
CalDataTable	getCalData ()
	Get the table CalData.
CalDelayTable	getCalDelay ()
	Get the table CalDelay.
CalDeviceTable	getCalDevice ()
	Get the table CalDevice.
CalFluxTable	getCalFlux ()
	Get the table CalFlux.
CalFocusTable	getCalFocus ()
	Get the table CalFocus.
CalFocusModelTable	getCalFocusModel ()
	Get the table CalFocusModel.
CalGainTable	getCalGain ()
	Get the table CalGain.
CalHolographyTable	getCalHolography ()
	Get the table CalHolography.
CalPhaseTable	getCalPhase ()
	Get the table CalPhase.
CalPointingTable	getCalPointing ()
	Get the table CalPointing.
CalPointingModelTable	getCalPointingModel ()
	Get the table CalPointingModel.
CalPositionTable	getCalPosition ()
	Get the table CalPosition.
CalPrimaryBeamTable	getCalPrimaryBeam ()
	Get the table CalPrimaryBeam.
CalReductionTable	getCalReduction ()
	Get the table CalReduction.
CalSeeingTable	getCalSeeing ()
	Get the table CalSeeing.
CalWVRTable	getCalWVR ()
	Get the table CalWVR.
ConfigDescriptionTable	getConfigDescription ()
	Get the table ConfigDescription.
CorrelatorModeTable	getCorrelatorMode ()
	Get the table CorrelatorMode.
DataDescriptionTable	getDataDescription ()
	Get the table DataDescription.
DopplerTable	getDoppler ()
	Get the table Doppler.
EphemerisTable	getEphemeris ()
	Get the table Ephemeris.
ExecBlockTable	getExecBlock ()
	Get the table ExecBlock.
FeedTable	getFeed ()
	Get the table Feed.
FieldTable	getField ()
	Get the table Field.
FlagCmdTable	getFlagCmd ()
	Get the table FlagCmd.
FocusTable	getFocus ()
	Get the table Focus.
FocusModelTable	getFocusModel ()
	Get the table FocusModel.
FreqOffsetTable	getFreqOffset ()
	Get the table FreqOffset.
GainTrackingTable	getGainTracking ()
	Get the table GainTracking.
HistoryTable	getHistory ()
	Get the table History.
HolographyTable	getHolography ()
	Get the table Holography.
ObservationTable	getObservation ()
	Get the table Observation.
PointingTable	getPointing ()
	Get the table Pointing.
PointingModelTable	getPointingModel ()
	Get the table PointingModel.
PolarizationTable	getPolarization ()
	Get the table Polarization.
ProcessorTable	getProcessor ()
	Get the table Processor.
ReceiverTable	getReceiver ()
	Get the table Receiver.
SBSummaryTable	getSBSummary ()
	Get the table SBSummary.
ScanTable	getScan ()
	Get the table Scan.
SeeingTable	getSeeing ()
	Get the table Seeing.
SourceTable	getSource ()
	Get the table Source.
SourceParameterTable	getSourceParameter ()
	Get the table SourceParameter.
SpectralWindowTable	getSpectralWindow ()
	Get the table SpectralWindow.
SquareLawDetectorTable	getSquareLawDetector ()
	Get the table SquareLawDetector.
StateTable	getState ()
	Get the table State.
StationTable	getStation ()
	Get the table Station.
SubscanTable	getSubscan ()
	Get the table Subscan.
SwitchCycleTable	getSwitchCycle ()
	Get the table SwitchCycle.
SysCalTable	getSysCal ()
	Get the table SysCal.
TotalPowerTable	getTotalPower ()
	Get the table TotalPower.
WVMCalTable	getWVMCal ()
	Get the table WVMCal.
WeatherTable	getWeather ()
	Get the table Weather.
ArrayTime	getTimeOfCreation ()
	Get timeOfCreation.
void	setTimeOfCreation (ArrayTime timeOfCreation) throws IllegalAccessException
	Set timeOfCreation with the specified ArrayTime value.
byte[]	toFITS () throws ConversionException
void	fromFITS (byte[] fits) throws ConversionException
String	toVOTable () throws ConversionException
void	fromVOTable (String vo) throws ConversionException
EntityId	toArchive (Archiver ar) throws ConversionException, ArchiverException
	Stores an XML representation of the ASDM into the Archive.
void	toArchive (Archiver ar, EntityId entUID) throws ConversionException, ArchiverException
	Stores an XML representation of the ASDM into the Archive.
String	toXML () throws ConversionException
	Produces the XML representation of this.
void	toXML (String directory) throws ConversionException
	Write this ASDM dataset to the specified directory as a collection of XML documents.
void	fromXML (String xmlDoc) throws ConversionException
	Parses the XML representation of an ASDM stored in a string and fills this (supposedly empty) with the result of the parsing.
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
	Write this ASDM dataset to the specified directory as a collection of files.
void	setFromFile (String directory) throws ConversionException
	Reads and parses a collection of files as those produced by the toFile method.
Entity	getEntity ()
void	setEntity (Entity e)
String	getName ()
	Meaningless, but required for the Representable interface.
int	size ()
	Meaningless, but required for the Representable interface.
void	updateArchive () throws ConversionException
	Update an ASDM dataset that already exists in the ALMA archive.
Representable	getTable (String tableName)
	Return the table, as a Representable object, with the specified name.
ASDMDataSetIDL	toIDL ()
	Converts this ASDM into an ASDMDataSetIDL CORBA structure.
void	fromIDL (ASDMDataSetIDL x) throws DuplicateKey,ConversionException, UniquenessViolationException
	Builds an ASDM out of its IDL representation.
Static Public Member Functions
ASDM	fromArchive (Archiver ar, EntityId datasetUID) throws ArchiverException, ConversionException
	Create an ASDM dataset from the ALMA archive, given the entityId of its container.
ASDM	getFromXML (String xmlDirectory) throws ConversionException
	Get an ASDM dataset, given the full path name of the directory containing the XML version of the dataset.
Package Functions
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.

---

Constructor & Destructor Documentation

alma.asdm.ASDM.ASDM (   )

Create an instance of the tables that belong to this model.

---

Member Function Documentation

ASDM alma.asdm.ASDM.fromArchive (  Archiver  ar, EntityId  datasetUID )  throws ArchiverException, ConversionException [static]

Create an ASDM dataset from the ALMA archive, given the entityId of its container. Parameters: ar  the Archiver used to access the Archive. datasetUID  The entityId of the container of the dataset.

void alma.asdm.ASDM.fromIDL (  ASDMDataSetIDL  x  )  throws DuplicateKey,ConversionException, UniquenessViolationException

Builds an ASDM out of its IDL representation. Parameters: x  the IDL representation of the ASDM Exceptions: DuplicateKey  ConversionException  UniquenessViolationException

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

Parses the XML representation of an ASDM stored in a string and fills this (supposedly empty) with the result of the parsing. Parameters: xmlDoc  The XML representation of the ASDM. Exceptions: ConversionException  If any error occurs reading the files in the directory or in converting the tables from XML. Implements alma.asdm.Representable.

AlmaRadiometerTable alma.asdm.ASDM.getAlmaRadiometer (   )

Get the table AlmaRadiometer. Returns: The table AlmaRadiometer as a AlmaRadiometerTable.

AnnotationTable alma.asdm.ASDM.getAnnotation (   )

Get the table Annotation. Returns: The table Annotation as a AnnotationTable.

AntennaTable alma.asdm.ASDM.getAntenna (   )

Get the table Antenna. Returns: The table Antenna as a AntennaTable.

BeamTable alma.asdm.ASDM.getBeam (   )

Get the table Beam. Returns: The table Beam as a BeamTable.

CalAmpliTable alma.asdm.ASDM.getCalAmpli (   )

Get the table CalAmpli. Returns: The table CalAmpli as a CalAmpliTable.

CalAtmosphereTable alma.asdm.ASDM.getCalAtmosphere (   )

Get the table CalAtmosphere. Returns: The table CalAtmosphere as a CalAtmosphereTable.

CalBandpassTable alma.asdm.ASDM.getCalBandpass (   )

Get the table CalBandpass. Returns: The table CalBandpass as a CalBandpassTable.

CalCurveTable alma.asdm.ASDM.getCalCurve (   )

Get the table CalCurve. Returns: The table CalCurve as a CalCurveTable.

CalDataTable alma.asdm.ASDM.getCalData (   )

Get the table CalData. Returns: The table CalData as a CalDataTable.

CalDelayTable alma.asdm.ASDM.getCalDelay (   )

Get the table CalDelay. Returns: The table CalDelay as a CalDelayTable.

CalDeviceTable alma.asdm.ASDM.getCalDevice (   )

Get the table CalDevice. Returns: The table CalDevice as a CalDeviceTable.

CalFluxTable alma.asdm.ASDM.getCalFlux (   )

Get the table CalFlux. Returns: The table CalFlux as a CalFluxTable.

CalFocusTable alma.asdm.ASDM.getCalFocus (   )

Get the table CalFocus. Returns: The table CalFocus as a CalFocusTable.

CalFocusModelTable alma.asdm.ASDM.getCalFocusModel (   )

Get the table CalFocusModel. Returns: The table CalFocusModel as a CalFocusModelTable.

CalGainTable alma.asdm.ASDM.getCalGain (   )

Get the table CalGain. Returns: The table CalGain as a CalGainTable.

CalHolographyTable alma.asdm.ASDM.getCalHolography (   )

Get the table CalHolography. Returns: The table CalHolography as a CalHolographyTable.

CalPhaseTable alma.asdm.ASDM.getCalPhase (   )

Get the table CalPhase. Returns: The table CalPhase as a CalPhaseTable.

CalPointingTable alma.asdm.ASDM.getCalPointing (   )

Get the table CalPointing. Returns: The table CalPointing as a CalPointingTable.

CalPointingModelTable alma.asdm.ASDM.getCalPointingModel (   )

Get the table CalPointingModel. Returns: The table CalPointingModel as a CalPointingModelTable.

CalPositionTable alma.asdm.ASDM.getCalPosition (   )

Get the table CalPosition. Returns: The table CalPosition as a CalPositionTable.

CalPrimaryBeamTable alma.asdm.ASDM.getCalPrimaryBeam (   )

Get the table CalPrimaryBeam. Returns: The table CalPrimaryBeam as a CalPrimaryBeamTable.

CalReductionTable alma.asdm.ASDM.getCalReduction (   )

Get the table CalReduction. Returns: The table CalReduction as a CalReductionTable.

CalSeeingTable alma.asdm.ASDM.getCalSeeing (   )

Get the table CalSeeing. Returns: The table CalSeeing as a CalSeeingTable.

CalWVRTable alma.asdm.ASDM.getCalWVR (   )

Get the table CalWVR. Returns: The table CalWVR as a CalWVRTable.

ConfigDescriptionTable alma.asdm.ASDM.getConfigDescription (   )

Get the table ConfigDescription. Returns: The table ConfigDescription as a ConfigDescriptionTable.

CorrelatorModeTable alma.asdm.ASDM.getCorrelatorMode (   )

Get the table CorrelatorMode. Returns: The table CorrelatorMode as a CorrelatorModeTable.

DataDescriptionTable alma.asdm.ASDM.getDataDescription (   )

Get the table DataDescription. Returns: The table DataDescription as a DataDescriptionTable.

DopplerTable alma.asdm.ASDM.getDoppler (   )

Get the table Doppler. Returns: The table Doppler as a DopplerTable.

EphemerisTable alma.asdm.ASDM.getEphemeris (   )

Get the table Ephemeris. Returns: The table Ephemeris as a EphemerisTable.

ExecBlockTable alma.asdm.ASDM.getExecBlock (   )

Get the table ExecBlock. Returns: The table ExecBlock as a ExecBlockTable.

FeedTable alma.asdm.ASDM.getFeed (   )

Get the table Feed. Returns: The table Feed as a FeedTable.

FieldTable alma.asdm.ASDM.getField (   )

Get the table Field. Returns: The table Field as a FieldTable.

FlagCmdTable alma.asdm.ASDM.getFlagCmd (   )

Get the table FlagCmd. Returns: The table FlagCmd as a FlagCmdTable.

FocusTable alma.asdm.ASDM.getFocus (   )

Get the table Focus. Returns: The table Focus as a FocusTable.

FocusModelTable alma.asdm.ASDM.getFocusModel (   )

Get the table FocusModel. Returns: The table FocusModel as a FocusModelTable.

FreqOffsetTable alma.asdm.ASDM.getFreqOffset (   )

Get the table FreqOffset. Returns: The table FreqOffset as a FreqOffsetTable.

ASDM alma.asdm.ASDM.getFromXML (  String  xmlDirectory  )  throws ConversionException [static]

Get an ASDM dataset, given the full path name of the directory containing the XML version of the dataset. Parameters: xmlDirectory  The full path name of the directory containing this dataset. Returns: The complete dataset that belongs to the container in this directory. Exceptions: ConversionException  If any error occurs reading the files in the directory or in converting the tables from XML.

GainTrackingTable alma.asdm.ASDM.getGainTracking (   )

Get the table GainTracking. Returns: The table GainTracking as a GainTrackingTable.

HistoryTable alma.asdm.ASDM.getHistory (   )

Get the table History. Returns: The table History as a HistoryTable.

HolographyTable alma.asdm.ASDM.getHolography (   )

Get the table Holography. Returns: The table Holography as a HolographyTable.

MainTable alma.asdm.ASDM.getMain (   )

Get the table Main. Returns: The table Main as a MainTable.

String alma.asdm.ASDM.getName (   )

Meaningless, but required for the Representable interface. Implements alma.asdm.Representable.

ObservationTable alma.asdm.ASDM.getObservation (   )

Get the table Observation. Returns: The table Observation as a ObservationTable.

PointingTable alma.asdm.ASDM.getPointing (   )

Get the table Pointing. Returns: The table Pointing as a PointingTable.

PointingModelTable alma.asdm.ASDM.getPointingModel (   )

Get the table PointingModel. Returns: The table PointingModel as a PointingModelTable.

PolarizationTable alma.asdm.ASDM.getPolarization (   )

Get the table Polarization. Returns: The table Polarization as a PolarizationTable.

ProcessorTable alma.asdm.ASDM.getProcessor (   )

Get the table Processor. Returns: The table Processor as a ProcessorTable.

ReceiverTable alma.asdm.ASDM.getReceiver (   )

Get the table Receiver. Returns: The table Receiver as a ReceiverTable.

SBSummaryTable alma.asdm.ASDM.getSBSummary (   )

Get the table SBSummary. Returns: The table SBSummary as a SBSummaryTable.

ScanTable alma.asdm.ASDM.getScan (   )

Get the table Scan. Returns: The table Scan as a ScanTable.

SeeingTable alma.asdm.ASDM.getSeeing (   )

Get the table Seeing. Returns: The table Seeing as a SeeingTable.

SourceTable alma.asdm.ASDM.getSource (   )

Get the table Source. Returns: The table Source as a SourceTable.

SourceParameterTable alma.asdm.ASDM.getSourceParameter (   )

Get the table SourceParameter. Returns: The table SourceParameter as a SourceParameterTable.

SpectralWindowTable alma.asdm.ASDM.getSpectralWindow (   )

Get the table SpectralWindow. Returns: The table SpectralWindow as a SpectralWindowTable.

SquareLawDetectorTable alma.asdm.ASDM.getSquareLawDetector (   )

Get the table SquareLawDetector. Returns: The table SquareLawDetector as a SquareLawDetectorTable.

StateTable alma.asdm.ASDM.getState (   )

Get the table State. Returns: The table State as a StateTable.

StationTable alma.asdm.ASDM.getStation (   )

Get the table Station. Returns: The table Station as a StationTable.

SubscanTable alma.asdm.ASDM.getSubscan (   )

Get the table Subscan. Returns: The table Subscan as a SubscanTable.

SwitchCycleTable alma.asdm.ASDM.getSwitchCycle (   )

Get the table SwitchCycle. Returns: The table SwitchCycle as a SwitchCycleTable.

SysCalTable alma.asdm.ASDM.getSysCal (   )

Get the table SysCal. Returns: The table SysCal as a SysCalTable.

Representable alma.asdm.ASDM.getTable (  String  tableName  )

Return the table, as a Representable object, with the specified name.

Object [] alma.asdm.ASDM.getTables (   )

Returns its tables as an array of Object. Returns: an array of Object.

ArrayTime alma.asdm.ASDM.getTimeOfCreation (   )

Get timeOfCreation. Returns: timeOfCreation as ArrayTime

TotalPowerTable alma.asdm.ASDM.getTotalPower (   )

Get the table TotalPower. Returns: The table TotalPower as a TotalPowerTable.

WeatherTable alma.asdm.ASDM.getWeather (   )

Get the table Weather. Returns: The table Weather as a WeatherTable.

WVMCalTable alma.asdm.ASDM.getWVMCal (   )

Get the table WVMCal. Returns: The table WVMCal as a WVMCalTable.

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

Reads and parses a collection of files as those produced by the toFile method. This dataset is populated with the result of the parsing. Parameters: directory  The name of the directory containing the files. Exceptions: ConversionException  If any error occurs while reading the files in the directory or parsing them.

void alma.asdm.ASDM.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 array of byte containing the MIME message. Exceptions: ConversionException

void alma.asdm.ASDM.setTimeOfCreation (  ArrayTime  timeOfCreation  )  throws IllegalAccessException

Set timeOfCreation with the specified ArrayTime value. Parameters: timeOfCreation  The ArrayTime value to which timeOfCreation is to be set. Exceptions: IllegalAccessException  If an attempt is made to change this field after is has been added to the table.

int alma.asdm.ASDM.size (   )

Meaningless, but required for the Representable interface. Implements alma.asdm.Representable.

void alma.asdm.ASDM.toArchive (  Archiver  ar, EntityId  entUID )  throws ConversionException, ArchiverException

Stores an XML representation of the ASDM into the Archive. This method behaves exactly like toArchive(Archiver ar) except that it expects the Archive UID of the ASDM's container to be provided by the caller (The Archive identifiers for the tables are provided internally as in toArchive(Archiver ar). Parameters: ar  an Archiver UID  an entityId constructed from an Archive UID. Note: As a side effect the ASDM and its archived tables have their entity private field updated with an entityId assigned to their XML representations.

EntityId alma.asdm.ASDM.toArchive (  Archiver  ar  )  throws ConversionException, ArchiverException

Stores an XML representation of the ASDM into the Archive. Each table of the ASDM with a non null number of rows is transformed into its XML representation and stored into the Archive as a separate document. Then the ASDM's container is converted into an XML document containing informations about the tables that it contains (Name, Number of rows, and Archive UIDs for the tables with a non null number of rows) and stored into the Archive.<br/> The Archive identifiers for the the container and the tables are provided internally. Parameters: ar  an Archiver Returns: the Archive UID assigned to the XML representation of the container. Note: As a side effect the ASDM and its archived tables have their entity private field updated with an entityId assigned to their XML representations.

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

Write this ASDM dataset to the specified directory as a collection of files. The container itself is written into an XML file. Each table of the container having at least one row is written into a binary or an XML file depending on the value of its "fileAsBin" private field. Parameters: directory  The directory to which this dataset is written. Exceptions: ConversionException  If any error occurs in converting the container or any of its table. This method will not overwrite any existing file; a ConversionException is also thrown in this case.

ASDMDataSetIDL alma.asdm.ASDM.toIDL (   )

Converts this ASDM into an ASDMDataSetIDL CORBA structure. Returns: a ASDMDataSetIDL.

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

Serialize this into a stream of bytes and encapsulates that stream into a MIME message. Returns: an array of bytes containing the MIME message. Exceptions: ConversionException.

void alma.asdm.ASDM.toXML (  String  directory  )  throws ConversionException

Write this ASDM dataset to the specified directory as a collection of XML documents. Parameters: directory  The directory to which this dataset is written. Exceptions: ConversionException  If any error occurs in converting the table to XML and writing it to the directory. This method will not overwrite any existing file; a ConversionException is also thrown in this case.

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

Produces the XML representation of this. Returns: a string containing the XML representation of this. Exceptions: ConversionException.  Implements alma.asdm.Representable.

void alma.asdm.ASDM.updateArchive (   )  throws ConversionException

Update an ASDM dataset that already exists in the ALMA archive.

---

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

• ASDM.java

---