AnnotationTable¶
-
class
AnnotationTable(container)[source]¶ Bases:
objectThe AnnotationTable class is an Alma table.
The Annotation Table is intended to offer space for unexpected data to be added in the software development process at short notice, without redefining the data model.
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.
-
time¶ mid point of the interval of time on which the recorded information is pertinent.
- Type
-
issue¶ name of this annotation.
- Type
str
-
details¶ details of this annotation.
- Type
str
-
numAntenna¶ number of antennas. Optional.
- Type
int
-
basebandName¶ Array(numBaseband) an array of numBaseband baseband names. Optional.
- Type
BasebandName []
-
numBaseband¶ number of basebands. Optional.
- Type
int
-
dValue¶ scalar data. Optional.
- Type
float
-
vdValue¶ Array() useful to store an array of double values. Optional.
- Type
float []
-
vvdValues¶ Array(, ) useful to store an array of array(s) of double values. Optional.
- Type
float [] []
-
llValue¶ useful to record a long long data. Optional.
- Type
int
-
vllValue¶ Array() useful to store an array of array(s) of long long values. Optional.
- Type
int []
-
vvllValue¶ Array(, ) useful to store an array of array(s) long long values. Optional.
- Type
int [] []
-
sValue¶ details of this annotation. Optional.
- Type
str
-
antennaId¶ Array(numAntenna) refers to a collection of rows in the AntennaTable. Optional.
- Type
Tag []
Methods Summary
MIMEXMLPart(byteOrder)Used in both the small XML file as well as the bin file when writing out as binary.
add(x)Look up the table for a row whose noautoincrementable attributes are matching their homologues in x.
autoIncrement(key, x)For internal use.
checkAndAdd(x)A method to append a row to it’s table, used by input conversion methods.
checkPresenceInMemory()Check if the table is present in memory.
fromXML(xmlstr)Populate this table from the content of a XML document that is required to conform to the XML schema defined for a Annotation (AnnotationTable.xsd).
get()Get all rows.
getContainer()Return the container to which this table belongs.
getEntity()Returns the table’s entity.
getKeyName()Return the list of field names that make up key key as a list of strings.
getName()Return the name of this table.
getRowByKey(annotationId)Returns a AnnotationRow given a key.
getRows()get the rows, synonymous with the get method.
getVersion()lookup(time, issue, details)Look up the table for a row whose all attributes except the autoincrementable one are equal to the corresponding parameters of the method.
newRow(time, issue, details)Create a new AnnotationRow initialized to the specified values.
newRowCopy(row)Create a new row using a copy constructor mechanism.
newRowDefault()Create a new row with default values.
setEntity(e)Set the table’s entity The parameter, e, must be an Entity
setFromFile(directory)Reads and parses a file containing a representation of a AnnotationTable as those produced by the toFile method.
setFromMIME(byteStream)Extracts the binary part of a MIME message and deserialize its content to fill this with the result of the deserialization.
setFromMIMEFile(directory)Set this table from a MIME file.
setFromXMLFile(directory)This is the function used by setFromFile when the file is an XML file Not intended for external use.
setNotPresentInMemory()Set the state to indicate it is not present in memory and needs to be loaded before being used.
setVersion(version)size()Return the number of rows in the table.
toFile(directory)Stores a representation (binary or XML) of this table into a file.
toMIME(mimeFilePath, mimeXMLpart, byteOrder)Write this out to mimeFilePath as a serialized MIME file with a leading XML part and a following binary part.
toXML()Translate this table to an XML representation conforming to the schema defined for Annotation (AnnotationTable.xsd).
Methods Documentation
-
MIMEXMLPart(byteOrder)[source]¶ 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.
-
add(x)[source]¶ Look up the table for a row whose noautoincrementable attributes are matching their homologues in x. If a row is found that row else autoincrement x.annotationId, add x to its table and returns x.
returns a AnnotationRow. x. A row to be added.
-
checkAndAdd(x)[source]¶ A method to append a row to it’s 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 raise an exception if not.
Append x to its table. x is the row to be appended. returns x.
-
checkPresenceInMemory()[source]¶ Check if the table is present in memory. If not, load the table from the file using the directory of the container.
-
fromXML(xmlstr)[source]¶ Populate this table from the content of a XML document that is required to conform to the XML schema defined for a Annotation (AnnotationTable.xsd).
-
getRowByKey(annotationId)[source]¶ Returns a AnnotationRow given a key. return the row having the key whose values are passed as parameters, or None if no row exists for that key.
param annotationId.
-
lookup(time, issue, details)[source]¶ 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 time.
param issue.
param details.
-
newRow(time, issue, details)[source]¶ Create a new AnnotationRow 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)
-
newRowCopy(row)[source]¶ Create a new row using a copy constructor mechanism.
The method creates a new AnnotationRow 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 AnnotationRow with default values for its attributes.
-
newRowDefault()[source]¶ Create a new row with default values. The new row is not added to this table but it knows about it.
-
setFromFile(directory)[source]¶ 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. 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.
-
setFromMIME(byteStream)[source]¶ 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.
-
setFromMIMEFile(directory)[source]¶ Set this table from a MIME file. Used internally by setFromFile. Not intended for external use.
-
setFromXMLFile(directory)[source]¶ This is the function used by setFromFile when the file is an XML file Not intended for external use.
-
setNotPresentInMemory()[source]¶ 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.
-
toFile(directory)[source]¶ 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 “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. 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.
-
toMIME(mimeFilePath, mimeXMLpart, byteOrder)[source]¶ 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.
-