# ALMA - Atacama Large Millimeter Array
# (c) European Southern Observatory, 2002
# (c) Associated Universities Inc., 2002
# Copyright by ESO (in the framework of the ALMA collaboration),
# Copyright by AUI (in the framework of the ALMA collaboration),
# All rights reserved.
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY, without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston,
# MA 02111-1307 USA
#
# Warning!
# --------------------------------------------------------------------
# | This is generated code! Do not modify this file. |
# | If you do, all changes will be lost when the file is re-generated. |
# --------------------------------------------------------------------
#
# File FeedTable.py
#
import pyasdm.ASDM
from .FeedRow import FeedRow
# All of the extended types are imported
from pyasdm.types import *
# for BIN input and output
from pyasdm.ByteOrder import ByteOrder
from pyasdm.EndianInput import EndianInput
from pyasdm.EndianOutput import EndianOutput
from .exceptions.ConversionException import ConversionException
from .exceptions.DuplicateKey import DuplicateKey
from .exceptions.UniquenessViolationException import UniquenessViolationException
from xml.dom import minidom
import os
import io
[docs]class FeedTable:
"""
The FeedTable class is an Alma table.
Contains characteristics of the feeds.
Shown here are the fields found in each row.
The key fields are shown first and used (together) to index a unique row. Key fields
are all required and indicated by "Key." following the description.
Other fields are required unless "optional" is shown for that field.
The field description text here is as found in the model used to generate the code.
Types may be an enumeration or extended pyasdm type. Fields that are python lists
are indicated that by "[]" in the type and having the word "Array" at the start of
description followed by the expected number of elements in that list in parentheses.
Lists (arrays) may be multi-dimensional (lists of lists) and are indicated
by [][] ... etc as needed to indicate the expected number of
dimensions. Multi-dimenstional lists will show the expected number of elements
for each dimension also in the parenthese after "Array".
The use of "auto-incrementable" indicates that that field is auto-generated
when the table is created and that field is set, as necessary, to create a
unique key for the specific row being added, by incrementing that value from
the previous highest value needed for the rest of the elements of the key on
that row. Such a field can not be set independently, it is only set when
the row is added to the table by that auto-increment mechanism.
Attributes:
antennaId (Tag): refers to a unique row in AntennaTable. key.
spectralWindowId (Tag): refers to a unique row in SpectralWindowTable. key.
timeInterval (ArrayTimeInterval): the time interval of validity of the content of the row. key.
feedId (int): identifies a collection of rows in the table. auto-incrementable, key.
numReceptor (int): the number of receptors.
beamOffset (float [] [] ): Array(numReceptor, 2) the offsets of the beam (one pair per receptor).
focusReference (Length [] [] ): Array(numReceptor, 3) the references for the focus position (one triple per receptor).
polarizationTypes (PolarizationType [] ): Array(numReceptor) identifies the polarization types (one value per receptor).
polResponse (Complex [] [] ): Array(numReceptor, numReceptor) the polarization response (one value per pair of receptors).
receptorAngle (Angle [] ): Array(numReceptor) the receptors angles (one value per receptor).
receiverId (int [] ): Array(numReceptor) refers to one or more collections of rows in ReceiverTable.
feedNum (int): the feed number to be used for multi-feed receivers. Optional.
illumOffset (Length [] ): Array(2) the illumination offset. Optional.
position (Length [] ): Array(3) the position of the feed. Optional.
skyCoupling (float): the sky coupling is the coupling efficiency to the sky of the WVR radiometer's. Note that in general one expects to see whether \b no sky coupling efficiency recorded or \b only \b one of the two forms scalar (skyCoupling) or array (skyCouplingSpectrum, numChan). Optional.
numChan (int): the size of skyCouplingSpectrum. This attribute must be present when the (array) attribute skyCouplingSpectrum is present since it defines its number of elements. The value of this attribute must be equal to the value of numChan in the row of the SpectralWindow table refered to by spectralWindowId. Optional.
skyCouplingSpectrum (float [] ): Array(numChan) the sky coupling is the coupling efficiency to the sky of the WVR radiometer's. This column differs from the skyCoupling column because it contains one value for each of the individual channels of that spectralWindow. See the documentation of numChan for the size and the presence of this attribute. Note that in general one expects to see whether \b no sky coupling efficiency recorded or \b only \b one of the two forms scalar (skyCoupling) or array (skyCouplingSpectrum, numChan). Optional.
"""
# This is True if the file is considered present in memory (nothing to be loaded).
# The default state is True, ASDM will set this to False when it is loaded and this
# table has non-zero rows.
_presentInMemory = True
# set to True while the file is loading, just in case
_loadInProgress = False
# The name of this table.
_tableName = "Feed"
# The list of field names that make up key 'key'.
_key = ["antennaId", "spectralWindowId", "timeInterval", "feedId"]
# the ASDM container that this table belongs to (set by constructor)
_container = None
# archive as bin not used by python implementation
# _archiveAsBin = False # If True archive binary else archive XML
_fileAsBin = False # If True file binary else file XML
# A data structure to store the FeedRow s.
# In all cases we maintain a private list of FeedRow s.
_privateRows = []
# this table has a temporal key, an auto-incremetable key, and other key fields
# context is a dictionary where the key is the key without the temporal and auto
# incrementable fields.
# the value is a list of lists, where the outer list is index by the auto-incrementable
# key value and the inner list is the list of rows having that auto-incrementable
# value.
# Each list of rows is kept in temporal order
_context = {}
# the Entity of this table
_entity = None
# from the schemaVersion string found in the table, must be an integer
_version = 0
# The tolerance which will be used on focusReference during an add operation on the table
_focusReferenceEqTolerance = Length(0.0)
[docs] def setFocusReferenceEqTolerance(self, tolerance):
"""
A setter for the tolerance on focusReference
"""
if not isinstance(tolerance, Length):
print("tolerance must be a Length instance")
self._focusReferenceEqTolerance = Length(tolerance)
[docs] def getFocusReferenceEqTolerance(self):
"""
A getter for the tolerance on focusReference
Returns the tolerance as a Length
"""
return self._focusReferenceEqTolerance
# The tolerance which will be used on receptorAngle during an add operation on the table
_receptorAngleEqTolerance = Angle(0.0)
[docs] def setReceptorAngleEqTolerance(self, tolerance):
"""
A setter for the tolerance on receptorAngle
"""
if not isinstance(tolerance, Angle):
print("tolerance must be a Angle instance")
self._receptorAngleEqTolerance = Angle(tolerance)
[docs] def getReceptorAngleEqTolerance(self):
"""
A getter for the tolerance on receptorAngle
Returns the tolerance as a Angle
"""
return self._receptorAngleEqTolerance
# The tolerance which will be used on illumOffset during an add operation on the table
_illumOffsetEqTolerance = Length(0.0)
[docs] def setIllumOffsetEqTolerance(self, tolerance):
"""
A setter for the tolerance on illumOffset
"""
if not isinstance(tolerance, Length):
print("tolerance must be a Length instance")
self._illumOffsetEqTolerance = Length(tolerance)
[docs] def getIllumOffsetEqTolerance(self):
"""
A getter for the tolerance on illumOffset
Returns the tolerance as a Length
"""
return self._illumOffsetEqTolerance
# The tolerance which will be used on position during an add operation on the table
_positionEqTolerance = Length(0.0)
[docs] def setPositionEqTolerance(self, tolerance):
"""
A setter for the tolerance on position
"""
if not isinstance(tolerance, Length):
print("tolerance must be a Length instance")
self._positionEqTolerance = Length(tolerance)
[docs] def getPositionEqTolerance(self):
"""
A getter for the tolerance on position
Returns the tolerance as a Length
"""
return self._positionEqTolerance
[docs] def getKeyName(self):
"""
Return the list of field names that make up key key
as a list of strings.
"""
return self._key
[docs] def Key(self, antennaId, spectralWindowId):
"""
Returns a string built by concatenating the ascii representation of the
parameters values suffixed with a "_" character.
"""
result = ""
result += str(antennaId) + "_"
result += str(spectralWindowId) + "_"
return result
[docs] def insertByStartTime(self, x, rowlist):
"""
Insert a FeedRow in a list of FeedRow so that it's ordered by ascending start time.
x The FeedRow to be inserted.
rowlist The list where x is to be inserted.
The inserted row is returned. If x already exists in rowlist then it is not added and
the row in rowlist is returned.
If a row matching the value of the start time of timeInterval is
found in rowlist but the other required parameters do not have the same value
then a DuplicateKey exception is raised.
"""
# get the ArrayTime value at the start of the ArrayTimeInterval found in x
xTimeStart = x.getTimeInterval().getStart().get()
# work out where to add x to rowlist
if (len(rowlist) == 0) or (
xTimeStart > (rowlist[-1].getTimeInterval().getStart().get())
):
# it belongs at the end
if len(rowlist) > 0:
lastRow = rowlist[-1]
# Modify the duration of lastRow if and only if the start time of x
# is located strictly before the end time of last.
if xTimeStart < (
lastRow.getTimeInterval().getStart().get()
+ lastRow.getTimeInterval().getDuration().get()
):
lastRow.getTimeInterval().setDuration(
xTimeStart - lastRow.getTimeInterval().getStart().get()
)
rowlist.append(x)
elif xTimeStart < rowlist[0].getTimeInterval().getStart().get():
# it belongs at the start
firstRow = rowlist[0]
# Modify the duration of x if and only if the start time of firstRow
# is located strictly before the end time of x.
if firstRow.getTimeInterval().getStart().get() < (
xTimeStart + x.getTimeInterval().getDuration().get()
):
x.getTimeInterval().setDuration(
firstRow.getTimeInterval().getStart().get() - xTimeStart
)
rowlist.insert(0, x)
else:
# x is inserted somewhere inside rowlist; let's use a dichotomoy
# method to find the insertion index.
k0 = 0
k1 = len(rowlist) - 1
while k0 != (k1 - 1):
if xTimeStart == rowlist[k0].getTimeInterval().getStart().get():
if rowlist[k0].equalByRequiredValue(x):
# this row already exists at k0, nothing to insert or add, return that row
return rowlist[k0]
else:
# the start time matches, but the rest of the required parameters do not
raise DuplicateKey("DuplicateKey exception in ", "FeedTable")
elif xTimeStart == rowlist[k1].getTimeInterval().getStart().get():
if rowlist[k1].equalByRequiredValue(x):
# this row already exists at k1, nothing to insert or add, return that row
return rowlist[k1]
else:
# the start time matches, but the rest of the required parameters do not
raise DuplicateKey("DuplicateKey exception in ", "FeedTable")
else:
# make sure new index is an integer
newIndex = int((k0 + k1) / 2)
if (
xTimeStart
<= rowlist[newIndex].getTimeInterval().getStart().get()
):
k1 = newIndex
else:
k0 = newIndex
if xTimeStart == rowlist[k0].getTimeInterval().getStart().get():
if rowlist[k0].equalByRequiredValue(x):
# this row already exists at k0, nothing to insert or add, return that row
return rowlist[k0]
else:
# the start time matches, but the rest of the required paramters do not
raise DuplicateKey("DuplicateKey exception in ", "FeedTable")
elif xTimeStart == rowlist[k1].getTimeInterval().getStart().get():
if rowlist[k1].equalByRequiredValue(x):
# this row already exists at k1, nothing to insert or add, return that row
return rowlist[k1]
else:
# the start time matches, but the rest of the required parameters do not
raise DuplicateKey("DuplicateKey exception in ", "FeedTable")
# if it reaches here, it should be added, set the duration as appropriate for
# insertion at k1, after k0, adjust duration of k0 as appropriate
rowlist[k0].getTimeInterval().setDuration(
xTimeStart - rowlist[k0].getTimeInterval().getStart().get()
)
x.getTimeInterval().setDuration(
rowlist[k0 + 1].getTimeInterval().getStart().get() - xTimeStart
)
rowlist.insert(k1, x)
# if it reaches here then x has already been addded to rowlist and it needs to be
# appended to privateRows and marked as added internally before being returned
self._privateRows.append(x)
x.isAdded()
return x
def __init__(self, container):
"""
Create a FeedTable attached to container.
container must be a ASDM instance
All tables must know the container
"""
if not isinstance(container, pyasdm.ASDM):
raise (ValueError("FeedTable constructor must use a ASDM instance"))
self._container = container
self._entity = Entity()
self._entity.setEntityId(EntityId("uid://X0/X0/X0"))
self._entity.setEntityIdEncrypted("na")
self._entity.setEntityTypeName("FeedTable")
self._entity.setEntityVersion("1")
self._entity.setInstanceVersion("1")
# the default table has no rows and so is presentInMemory
self._presentInMemory = True
self._loadInProgress = False
self._privateRows = []
self._context = {}
self._version = 0
[docs] def setNotPresentInMemory(self):
"""
Set the state to indicate it is not present in memory and needs to be loaded before being used.
This is used by the container class when loaded from a file and this table is present with non-zero rows.
Tables are loaded on demand when the get function in the container for that table is used.
"""
self._presentInMemory = False
[docs] def checkPresenceInMemory(self):
"""
Check if the table is present in memory. If not, load the table from the file using the
directory of the container.
"""
# NOTE: if setFromFile raises an exception then presentInMemory will remain False
# and loadInProgress will remain True, preventing another attempt at loading.
# more complex solutions are then necessary to read that file and it's not worth
# complicating this code here to handle a need to eventually try again to reload that file
if not self._presentInMemory and not self._loadInProgress:
# print("Feed is not present in memory, setting from file")
self._loadInProgress = True
self.setFromFile(self.getContainer().getDirectory())
self._presentInMemory = True
self._loadInProgress = False
[docs] def getContainer(self):
"""
Return the container to which this table belongs.
return a ASDM.
"""
return self._container
[docs] def size(self):
"""
Return the number of rows in the table.
"""
return len(self._privateRows)
[docs] def getName(self):
"""
Return the name of this table.
"""
return self._tableName
def __str__(self):
"""
Returns "FeedTable" followed by the current size of the table
between parenthesis.
Example : FeedTable(12)
"""
return "FeedTable(" + size() + ")"
# ====> Row creation.
[docs] def newRowDefault(self):
"""
Create a new row with default values.
The new row is not added to this table but it knows about it.
"""
thisRow = FeedRow(self)
return thisRow
[docs] def add(self, x):
"""
Append a row to a FeedTable which has simply
1) an autoincrementable attribute (feedId)
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.
"""
if not isinstance(x, FeedRow):
raise ValueError("x must be a FeedRow instance.")
# Get the start time of the time interval of the row to be inserted (an ArrayTime)
startTime = x.getTimeInterval().getStart()
insertionId = 0
# the key from the appropriate attributes
keystr = self.Key(x.getAntennaId(), x.getSpectralWindowId())
# Determine the insertion index for the row x, possibly returning a pointer to a row identical to x.
if keystr in self._context:
contextRows = self._context[keystr]
# look through all of the auto-incrementable lists to see there is any
# row that matches this time and other required values
for autoIncList in range(len(contextRows)):
for thisRow in autoIncList:
if startTime.eq(thisRow.getTimeInterval().getStart()):
if thisRow.compareRequiredValue(
x.getNumReceptor(),
x.getBeamOffset(),
x.getFocusReference(),
x.getPolarizationTypes(),
x.getPolResponse(),
x.getReceptorAngle(),
x.getReceiverId(),
):
# We have found a FeedRow with the same value then return it.
return thisRow
# otherwise this has the same time but different other values so
# we must autoincrement feedId and
# insert a new FeedRow with this autoincremented value.
# System.out.println("A row has been found with the same start time but different value , increment id")
insertionId = i + 1
# And directly goto next id value
break
else:
# There is not yet a context...
# Create and initialize an entry in the context map for this combination....
self._context[keystr] = []
insertionId = 0
x.setFeedId(insertionId)
contextRows = self._context[keystr]
# make sure there are enough rows in contextRows to hold insertionId
# probably this just adds one list to contextRows
while len(contextRows) <= insertionId:
contetRows.append([])
# and insert this row into the list at insertionId so that list remains ordered in time
result = self.insertByStartTime(x, contextRows[insertionId])
return result
[docs] def newRow(
self,
antennaId,
spectralWindowId,
timeInterval,
numReceptor,
beamOffset,
focusReference,
polarizationTypes,
polResponse,
receptorAngle,
receiverId,
):
"""
Create a new FeedRow initialized to the specified values.
The new row is not added to this table, but it does know about it.
(the autoincrementable attribute, if any, is not in the parameter list)
"""
thisRow = FeedRow(self)
thisRow.setAntennaId(antennaId)
thisRow.setSpectralWindowId(spectralWindowId)
thisRow.setTimeInterval(timeInterval)
thisRow.setNumReceptor(numReceptor)
thisRow.setBeamOffset(beamOffset)
thisRow.setFocusReference(focusReference)
thisRow.setPolarizationTypes(polarizationTypes)
thisRow.setPolResponse(polResponse)
thisRow.setReceptorAngle(receptorAngle)
thisRow.setReceiverId(receiverId)
return thisRow
[docs] def newRowCopy(self, row):
"""
Create a new row using a copy constructor mechanism.
The method creates a new FeedRow which knows about this table.
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,
it 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 None then the method returns a new FeedRow with default values for its attributes.
"""
return FeedRow(self, row)
# ====> Append a row to its table.
[docs] def checkAndAdd(self, x):
"""
A method to append a row to its table, used by input conversion methods.
Not indended for external use.
If this table has an autoincrementable attribute then check if
x verifies the rule of uniqueness and throw exception if not.
This method is appropriate for an auto-incrementable attribute with a
temporal field either with or without additional keywords.
Append x to its table.
x The row to be appended.
returns x.
"""
# startTime is an ArrayTimeInterval
startTime = x.getTimeInterval().getStart()
if (
self.lookup(
x.getAntennaId(),
x.getSpectralWindowId(),
x.getTimeInterval(),
x.getNumReceptor(),
x.getBeamOffset(),
x.getFocusReference(),
x.getPolarizationTypes(),
x.getPolResponse(),
x.getReceptorAngle(),
x.getReceiverId(),
)
is not None
):
raise UniquenessViolationException(
"Uniqueness violation exception in table FeedTable"
)
if (
self.getRowByKey(
x.getAntennaId(),
x.getSpectralWindowId(),
x.getTimeInterval(),
x.getFeedId(),
)
is not None
):
raise DuplicateKey(
"Duplicate key exception . ("
+ "antennaId="
+ x.getAntennaId()
+ " "
+ "spectralWindowId="
+ x.getSpectralWindowId()
+ " "
+ "timeInterval="
+ x.getTimeInterval()
+ " "
+ "feedId="
+ x.getFeedId()
+ " "
+ ") in ",
"FeedTable.",
)
keystr = self.Key(x.getAntennaId(), x.getSpectralWindowId())
i = x.getFeedId()
# make sure keystr is known to context and that there enough elements to retrieve
# the list at element "i"
if keystr not in self._context:
self._context[keystr] = []
while len(self._context[keystr]) <= i:
self._context[keystr].append([])
return self.insertByStartTime(x, self._context[keystr][i])
# ====> methods returning rows.
[docs] def get(self):
"""
Get all rows.
return all rows as list of FeedRow
"""
return self._privateRows
[docs] def getRowByKey(self, antennaId, spectralWindowId, timeInterval, feedId):
"""
Returns a FeedRow given a key.
return the row having the key whose values are passed as parameters, or None if
no row exists for that key.
"""
# the ArrayTime at the start of the requested time interval
start = timeInterval.getStart()
keystr = self.Key(antennaId, spectralWindowId)
if keystr not in self._context:
return None
id = int(feedId)
contextRows = self._context[keystr]
# the first list is indexed by id so it must exist for this to find a row
if id < len(contextRows):
idRows = contextRows[id]
for aRow in idRows:
if aRow.getTimeInterval().equals(timeInterval):
return aRow
# never found
return None
[docs] def getRowByFeedId(self, feedId):
"""
Returns a list of rows whose key element feedId
is equal to the parameter feedId.
return a list of FeedRow. A returned list of size 0 means that no row has been found.
feedId is of type int and contains the value of
the autoincrementable attribute that is looked up in the table.
"""
result = []
# any of the context strings could contain a list appropriate for the requested value
for thisKeyValue in self._context.values():
# if this has the requested value, that value can be used to index into this list
if feedId < len(thisKeyValue):
# this value contains rows with the requested value
# append all of them to the result
result.extend(thisKeyValue[feedId])
return result
[docs] def lookup(
self,
antennaId,
spectralWindowId,
timeInterval,
numReceptor,
beamOffset,
focusReference,
polarizationTypes,
polResponse,
receptorAngle,
receiverId,
):
"""
Look up the table for a row whose all attributes except the autoincrementable one
are equal to the corresponding parameters of the method.
return this row if any, None otherwise.
param antennaId.
param spectralWindowId.
param timeInterval.
param numReceptor.
param beamOffset.
param focusReference.
param polarizationTypes.
param polResponse.
param receptorAngle.
param receiverId.
"""
keystr = self.Key(antennaId, spectralWindowId)
if keystr in self._context:
# it may be found in any of the list of lists
for thisKeyValueList in self._context.values():
for thisList in thisKeyValueList:
for thisRow in thisList:
if thisRow.getTimeInterval().contains(
timeInterval
) and thisRow.compareNoAutoInc(
antennaId,
spectralWindowId,
timeInterval,
numReceptor,
beamOffset,
focusReference,
polarizationTypes,
polResponse,
receptorAngle,
receiverId,
):
return thisRow
return None
[docs] def getRows(self):
"""
get the rows, synonymous with the get method.
"""
return self.get()
# ====> conversion Methods
[docs] def toXML(self):
"""
Translate this table to an XML representation conforming
to the schema defined for Feed (FeedTable.xsd).
returns a string containing the XML representation.
"""
result = ""
result += '<?xml version="1.0" encoding="ISO-8859-1"?> '
result += '<FeedTable xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:feed="http://Alma/XASDM/FeedTable" xsi:schemaLocation="http://Alma/XASDM/FeedTable http://almaobservatory.org/XML/XASDM/4/FeedTable.xsd" schemaVersion="4" schemaRevision="-1">\n'
result += self._entity.toXML()
s = self._container.getEntity().toXML()
# Change the "Entity" tag to "ContainerEntity".
result += "<Container" + s[1:]
for thisRow in self._privateRows:
result += thisRow.toXML()
result += " "
result += "</FeedTable>"
return result
[docs] def fromXML(self, xmlstr):
"""
Populate this table from the content of a XML document that is required to
conform to the XML schema defined for a Feed (FeedTable.xsd).
"""
if not isinstance(xmlstr, str):
raise ConversionException("xmlstr must be a string")
xmldom = minidom.parseString(xmlstr)
# this should have at least one child node with a name of "FeedTable".
if not xmldom.hasChildNodes() or xmldom.firstChild.nodeName != "FeedTable":
raise ConversionException("XML is not from the expected table", "FeedTable")
# ignore everything but the first child node
tabdom = xmldom.firstChild
# get the version from the schemaVersion attribute, which is not always there
versionStr = "-1"
if tabdom.hasAttributes() and (
tabdom.attributes.getNamedItem("schemaVersion") is not None
):
versionStr = tabdom.attributes.getNamedItem("schemaVersion").value
# raises a ValueError if not an integer
try:
self.setVersion(int(versionStr))
except Exception as ex:
# reraise it as a ConversionException
raise ConversionException(
"schemaVersion is not an integer", "FeedTable"
) from None
# go through the child nodes of tabdom
# get Entity and rows, require ContainerEntity but don't get anything from that
tabEntity = None
hasContainerEntity = False
if not tabdom.hasChildNodes():
raise ConversionException(
"XML is missing all of the expected elements", "FeedTable"
)
for thisNode in tabdom.childNodes:
nodeName = thisNode.nodeName
if nodeName == "Entity":
if tabEntity is not None:
raise ConversionException(
"More than one Entity found in XML", "FeedTable"
)
tabEntity = Entity(thisNode.toxml())
if not (tabEntity.getEntityTypeName() == "FeedTable"):
raise ConversionException(
"Entity type name in XML is not the expected value of the table name",
"FeedTable",
)
elif nodeName == "ContainerEntity":
# there must be one, but no more than one
if hasContainerEntity:
raise ConversionException(
"More than one ContainerEntity found in XML", "FeedTable"
)
hasContainerEntity = True
elif nodeName == "row":
try:
row = self.newRowDefault()
row.setFromXML(thisNode)
self.checkAndAdd(row)
except DuplicateKey as exc:
# reraise it as a ConversionException
raise ConversionException(str(exc), "FeedTable") from None
except UniquenessViolationException as exc:
msg = "UniquenessViolationException in row in FeedTable : %s" % str(
exc
)
if tabEntity is None:
raise ConversionException("No Entity seen in XML", "FeedTable")
if not hasContainerEntity:
raise ValueError("No Container Entity seen in XL", "FeedTable")
self.setEntity(tabEntity)
[docs] def MIMEXMLPart(self, byteOrder):
"""
Used in both the small XML file as well as the bin file when writing out as binary.
The byte order is set by byteOrder.
"""
uidStr = str(self.getEntity().getEntityId())
withoutUID = uidStr[6:]
containerUID = str(self.getContainer().getEntity().getEntityId())
result = ""
result += "<?xml version='1.0' encoding='ISO-8859-1'?>"
result += "\n"
result += '<FeedTable xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:feed="http://Alma/XASDM/FeedTable" xsi:schemaLocation="http://Alma/XASDM/FeedTable http://almaobservatory.org/XML/XASDM/4/FeedTable.xsd" schemaVersion="4" schemaRevision="-1">\n'
result += "<Entity entityId='"
result += uidStr
result += "' entityIdEncrypted='na' entityTypeName='FeedTable' schemaVersion='1' documentVersion='1'/>\n"
result += "<ContainerEntity entityId='"
result += containerUID
result += "' entityIdEncrypted='na' entityTypeName='ASDM' schemaVersion='1' documentVersion='1'/>\n"
result += "<BulkStoreRef file_id='"
result += withoutUID
result += "' byteOrder='" + str(byteOrder) + "' />\n"
result += "<Attributes>\n"
result += "<antennaId/>\n"
result += "<spectralWindowId/>\n"
result += "<timeInterval/>\n"
result += "<feedId/>\n"
result += "<numReceptor/>\n"
result += "<beamOffset/>\n"
result += "<focusReference/>\n"
result += "<polarizationTypes/>\n"
result += "<polResponse/>\n"
result += "<receptorAngle/>\n"
result += "<receiverId/>\n"
result += "<feedNum/>\n"
result += "<illumOffset/>\n"
result += "<position/>\n"
result += "<skyCoupling/>\n"
result += "<numChan/>\n"
result += "<skyCouplingSpectrum/>\n"
result += "</Attributes>\n"
result += "</FeedTable>\n"
return result
[docs] def toMIME(self, mimeFilePath, mimeXMLpart, byteOrder):
"""
Write this out to mimeFilePath as a serialized MIME file with
a leading XML part and a following binary part.
The mimeXMLpart is a string that should have already been written
to the corresponding small XML file (and is returned by the
MIMEXMLPart method here). The byteOrder is a ByteOrder instance
that gives the byte order to use when writing the binary data.
That instance should have also been used to generate mimeXMLpart.
"""
# mimeFilePath should have already been removed if it already existed.
with open(mimeFilePath, "wb") as outBuffer:
uidStr = str(self.getEntity().getEntityId())
# The XML Header part.
outBuffer.write(bytes("MIME-Version: 1.0", "utf-8"))
outBuffer.write(bytes("\n", "utf-8"))
outBuffer.write(
bytes(
"Content-Type: Multipart/Related; boundary='MIME_boundary'; type='text/xml'; start= '<header.xml>'",
"utf-8",
)
)
outBuffer.write(bytes("\n", "utf-8"))
outBuffer.write(bytes("Content-Description: Correlator", "utf-8"))
outBuffer.write(bytes("\n", "utf-8"))
outBuffer.write(bytes("alma-uid:" + uidStr, "utf-8"))
outBuffer.write(bytes("\n", "utf-8"))
outBuffer.write(bytes("\n", "utf-8"))
# The MIME XML part header.
outBuffer.write(bytes("--MIME_boundary", "utf-8"))
outBuffer.write(bytes("\n", "utf-8"))
outBuffer.write(
bytes("Content-Type: text/xml; charset='ISO-8859-1'", "utf-8")
)
outBuffer.write(bytes("\n", "utf-8"))
outBuffer.write(bytes("Content-Transfer-Encoding: 8bit", "utf-8"))
outBuffer.write(bytes("\n", "utf-8"))
outBuffer.write(bytes("Content-ID: <header.xml>", "utf-8"))
outBuffer.write(bytes("\n", "utf-8"))
outBuffer.write(bytes("\n", "utf-8"))
# The MIME XML part content.
outBuffer.write(bytes(mimeXMLpart, "utf-8"))
# The MIME binary part header
outBuffer.write(bytes("--MIME_boundary", "utf-8"))
outBuffer.write(bytes("\n", "utf-8"))
outBuffer.write(bytes("Content-Type: binary/octet-stream", "utf-8"))
outBuffer.write(bytes("\n", "utf-8"))
outBuffer.write(bytes("Content-ID: <content.bin>", "utf-8"))
outBuffer.write(bytes("\n", "utf-8"))
outBuffer.write(bytes("\n", "utf-8"))
# The binary part, needs an EndianOutput instance
eos = EndianOutput(outBuffer, byteOrder)
self.getEntity().toBin(eos)
self.getContainer().getEntity().toBin(eos)
eos.writeInt(len(self._privateRows))
# and all of the rows
for thisRow in self._privateRows:
thisRow.toBin(eos)
# The closing MIME boundary
outBuffer.write(bytes("\n--MIME_boundary--", "utf-8"))
outBuffer.write(bytes("\n", "utf-8"))
# close the eos, also closes outBuffer, no penalty for doing that more than once
eos.close()
[docs] def setFromMIME(self, byteStream):
"""
Extracts the binary part of a MIME message and deserialize its content
to fill this with the result of the deserialization.
param byteStream the previously opened io.BufferedReader instance
containing the data to be extracted.
It is the responsibility of this method to close byteStream.
"""
if not (isinstance(byteStream, io.BufferedReader) and byteStream.seekable()):
byteStream.close()
raise ConversionException(
"opened byteStream is not the expected io.BufferedReader or it is not seekable, this should never happen.",
"Feed",
)
xmlPartMIMEHeader = bytes(str("Content-ID: <header.xml>\n\n").encode())
binPartMIMEHeader = bytes(
str(
"--MIME_boundary\nContent-Type: binary/octet-stream\nContent-ID: <content.bin>\n\n"
).encode()
)
# follow the Java example and grab the first 10000 bytes, which will always contain the header
headerBytes = byteStream.read(10000)
# Detect the XML header.
loc0 = headerBytes.find(xmlPartMIMEHeader)
# c++ code also looks for a string with an additional CRLF after each newline if the above fails, but Java
# doesn't and even c++ doesn't follow that up when failing to find the binPartMIMEHeader, so go with the Java example
if loc0 < 0:
byteStream.close()
raise ConversionException(
"Failed to detect the begining of the XML header.", "Feed"
)
loc0 += len(xmlPartMIMEHeader)
# Look for the string announcing the binary part.
loc1 = headerBytes.find(binPartMIMEHeader, loc0)
if loc1 < 0:
byteStream.close()
raise ConversionException(
"Failed to detect the begining of the binary part.", "Feed"
)
# extract the XML header as a string
xmlHeader = headerBytes[loc0:loc1].decode()
xmldom = minidom.parseString(xmlHeader)
if not xmldom.hasChildNodes():
byteStream.close()
raise ConversionException("XML is not properly structured.", "Feed")
attributesSeq = []
byteOrderStr = None
versionStr = "-1"
hdrdom = xmldom.firstChild
if hdrdom.nodeName == "ASDMBinaryTable":
# old style of binary data
# assume Big_Endian and the default order of the elements
byteOrderStr = "Big_Endian"
attributesSeq.append("antennaId")
attributesSeq.append("spectralWindowId")
attributesSeq.append("timeInterval")
attributesSeq.append("feedId")
attributesSeq.append("numReceptor")
attributesSeq.append("beamOffset")
attributesSeq.append("focusReference")
attributesSeq.append("polarizationTypes")
attributesSeq.append("polResponse")
attributesSeq.append("receptorAngle")
attributesSeq.append("receiverId")
attributesSeq.append("feedNum")
attributesSeq.append("illumOffset")
attributesSeq.append("position")
attributesSeq.append("skyCoupling")
attributesSeq.append("numChan")
attributesSeq.append("skyCouplingSpectrum")
versionStr = "2"
else:
# c++ and Java just assume it then must be a Feed table
# this is more insistant, just in case
if hdrdom.nodeName != "FeedTable":
byteStream.close()
raise ConversionException(
"XML Header is not from the expected table.", "Feed"
)
# schemaVersion becomes versionStr
if (
hdrdom.hasAttributes()
and hdrdom.attributes.getNamedItem("schemaVersion") is not None
):
versionStr = hdrdom.attributes.getNamedItem("schemaVersion").value
if not hdrdom.hasChildNodes():
byteStream.close()
raise ConversionException(
"THe XML header is missing all of the expected elements.", "Feed"
)
# loop through the child nodes, looking for BulkStoreRef and Attributes
for hdrnode in hdrdom.childNodes:
if hdrnode.nodeName == "BulkStoreRef":
if byteOrderStr is not None:
byteStream.close()
raise ConversionException(
"More than one BulkStoreRef element seen. Invalid XML header.",
"Feed",
)
if not hdrnode.hasAttributes():
byteStream.close()
raise ConversionException(
"BulkStoreRef does not contain any attributes. Invalid XML header.",
"Feed",
)
byteOrderAttr = hdrnode.attributes.getNamedItem("byteOrder")
if byteOrderAttr is None:
byteStream.close()
raise ConversionException(
"byteOrder attribute not found in BulkStoreRef element. Invalid XML header.",
"Feed",
)
byteOrderStr = byteOrderAttr.value
elif hdrnode.nodeName == "Attributes":
if len(attributesSeq) > 0:
byteStream.close()
raise ConversionException(
"More than one Attributes node seen. Invalid XML header.",
"Feed",
)
if not hdrnode.hasChildNodes():
byteStream.close()
raise ConversionException(
"Attributes element has no child nodes. Invalid XML header.",
"Feed",
)
for attrnode in hdrnode.childNodes:
if attrnode.nodeType == attrnode.ELEMENT_NODE:
attributesSeq.append(str(attrnode.nodeName))
if byteOrderStr is None:
byteStream.close()
raise ConversionException(
"BulkStoreRef element not seen and this is not an older version 2 XML header. Invalid XML header.",
"Feed",
)
if len(attributesSeq) == 0:
byteStream.close()
raise ConversionException(
"Attributes element not seen and this is not an older version 2 XML header. Invalid XML header.",
"Feed",
)
byteOrder = ByteOrder(byteOrderStr)
# seek to the start of the binary part
byteStream.seek(loc1 + len(binPartMIMEHeader))
# and create the class that manages that stream and returns values as requested
eis = EndianInput(byteStream, byteOrder)
self._entity = Entity.fromBin(eis)
# containerEntity is not used, but it is next
containerEntity = Entity.fromBin(eis)
# the number of rows
numRows = eis.readInt()
# c++ checks numRows against what is reported in the ASDM for this table, this is what Java does
try:
for i in range(numRows):
self.checkAndAdd(FeedRow.fromBin(eis, self, attributesSeq))
# print("row %s added, loc = %s" % (i, eis.tell()))
except Exception as exc:
byteStream.close()
eis.close()
raise ConversionException(
"Error while reading binary data, the exception was " + str(exc), "Feed"
) from None
# there is no harm in closing both
# print("closing")
eis.close()
byteStream.close()
# print("checking")
# print("eis : %s" % eis.closed())
# print("byteStream : %s" % byteStream.closed)
[docs] def setFromFile(self, directory):
"""
Reads and parses a file containing a representation of a FeedTable as those produced by the toFile method.
This table is populated with the result of the parsing.
param directory The name of the directory containing the file te be read and parsed.
raises ConversionException If any error occurs while reading the
files in the directory or parsing them.
"""
if not isinstance(directory, str):
print("directory must be a string")
# directory must exist as a directory
if not os.path.isdir(directory):
raise ConversionException(
"Directory " + directory + " must be a path to an existing directory",
"FeedTable",
)
if os.path.exists(os.path.join(directory, "Feed.xml")):
self.setFromXMLFile(directory)
elif os.path.exists(os.path.join(directory, "Feed.bin")):
self.setFromMIMEFile(directory)
else:
raise ConversionException("No file found for the Feed table", "FeedTable")
[docs] def setFromMIMEFile(self, directory):
"""
Set this table from a MIME file.
Used internally by setFromFile. Not intended for external use.
"""
# The java and c++ versions read all of the contents into a byte array.
# This uses a buffered byte stream. Created here and then
# handed off to the setFromMIME method, which is responsible for closing it.
filename = os.path.join(directory, "Feed.bin")
byteStream = None
try:
byteStream = open(filename, "rb")
except Exception as exc:
raise ConversionException(
"Error while opening " + filename + ". The exception was " + str(exc),
"Feed",
)
self.setFromMIME(byteStream)
[docs] def setFromXMLFile(self, directory):
"""
This is the function used by setFromFile when the file is an XML file
Not intended for external use.
"""
# setFromFile has already established that this exists
# read the entire file into a string
xmlstr = None
try:
with open(os.path.join(directory, "Feed.xml")) as f:
xmlstr = f.read()
except Exception as exc:
# reraise it as a ConversionException
raise ConversionException(str(exc), "FeedTable") from None
# if the string contains '<BulkStoreRef' then this is stored in a bin file
if xmlstr.find("<BulkStoreRef") != -1:
self.setFromMIMEFile(directory)
else:
self.fromXML(xmlstr)
[docs] def toFile(self, directory):
"""
Stores a representation (binary or XML) of this table into a file.
Depending on the boolean value of its _fileAsBin data member a binary serialization
of this (_fileAsBin==True) will be saved in a file "Feed.bin" or
an XML representation (_fileAsBin==False) will be saved in a file "Feed.xml".
The file is always written in a directory whose name is passed as a parameter.
param directory The name of directory where the file containing the table's
representation will be saved.
raises ConversionException for any errors while writing that file.
"""
if not isinstance(directory, str):
raise ConversionException("directory must be a string")
if os.path.exists(directory) and not os.path.isdir(directory):
raise ConversionException(
"Cannot write into directory %s. This file already exists and is not a directory. (Feed)"
% directory,
"FeedTable",
)
# if not let's create it.
try:
if not os.path.exists(directory):
# if it can't be created a FileNotFound exception is the most likely result
os.mkdir(directory)
except Exception as exc:
# reraise any exception as a ConversionException
raise ConversionException(
"Could not create directory "
+ directory
+ " exception caught "
+ str(exc),
"FeedTable",
) from None
if self._fileAsBin:
# The table is exported in a binary format.
# (actually a short XML file + a possibly long MIME file)
# Java defaults to Big_Endian
# c++ defaults to Machine, go with c++
byteOrder = ByteOrder()
# first, just the short XML file
xmlFilePath = os.path.join(directory, "Feed.xml")
if os.path.exists(xmlFilePath):
try:
os.remove(xmlFilePath)
except Exception as exc:
raise ConversionException(
"Could not remove existing "
+ xmlFilePath
+ ", exception caught "
+ str(exc),
"Feed",
) from None
# used in both files
mimeXMLpart = self.MIMEXMLPart(byteOrder)
# this is all that is written to the XML file
with open(xmlFilePath, "w") as xmlfile:
xmlfile.write(mimeXMLpart)
# now open the possibly much longer MIME file
mimeFilePath = os.path.join(directory, "Feed.bin")
if os.path.exists(mimeFilePath):
try:
os.remove(mimeFilePath)
except Exception as exc:
raise ConversionException(
"Could not remove existing "
+ mimeFilePath
+ ", exception caught "
+ str(exc),
"Feed",
) from None
# the details are all handled in toMIME
self.toMIME(mimeFilePath, mimeXMLpart, byteOrder)
else:
# The table is totally exported in a XML file.
filePath = os.path.join(directory, "Feed.xml")
if os.path.exists(filePath):
try:
# try to delete it, this will raise an exception if the user does not have permission to do that
os.remove(filePath)
except Exception as exc:
# reraise it as a ConversionException
raise ConversionException(
"Could not remove existing "
+ filePath
+ " exception caught "
+ str(exc),
"FeedTable",
) from None
try:
with open(filePath, "w") as f:
f.write(self.toXML())
f.close()
# Java code uses a BufferedWriter to capture the output of toXML to the file
except Exception as exc:
# reraise it as a ConversionException
raise ConversionException(
"Problem while writing the XML representation, the message was : "
+ str(exc),
"Feed",
) from None
[docs] def getEntity(self):
"""
Returns the table's entity.
"""
return self._entity
[docs] def setEntity(self, e):
"""
Set the table's entity
The parameter, e, must be an Entity
"""
if not isinstance(e, Entity):
raise (ValueError("setEntity must use an Entity value"))
self._entity = Entity(e)
[docs] def getVersion(self):
return self._version
[docs] def setVersion(self, version):
if not isinstance(version, int):
raise ValueError("version must be an int")
self._version = version