Annotation_Type
Bases: NBOBaseClass
Represents the XML complex type Annotation.
This element contains a description for the annotation.[plain-text multi-line string]
getTypeName()
Returns the class type name.
Returns:
| Type | Description |
|---|---|
string
|
The class type name |
getXMLName()
Returns the XML element name corresponding to this class.
Returns:
| Type | Description |
|---|---|
string
|
The XML element name |
getNBOType()
Returns the NBO Type corresponding to this class.
Returns:
| Type | Description |
|---|---|
int
|
The NBO Type value |
getChildren()
Returns a list of all classes derived from this class.
Returns:
| Type | Description |
|---|---|
List[NBOBaseClass]
|
The list of derived classes |
getSubElements()
Returns a list of all child elements contained in this class.
Returns:
| Type | Description |
|---|---|
List[NBOBaseClass]
|
The list of child classes |
fromJsonFile(path)
Populates this object from a JSON file.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
path
|
string
|
The path to the JSON file |
required |
fromJsonString(json_string)
Populates this object from a JSON string.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
json_string
|
string
|
The JSON content as a string |
required |
fromXmlFile(path)
Populates this object from a XML file.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
path
|
string
|
The path to the XML file |
required |
fromXmlString(xml_string)
Populates this object from a XML string.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
xml_string
|
string
|
The XML content as a string |
required |
toXmlFile(filename)
Serializes this object to an XML file.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
filename
|
string
|
The path to the output XML file |
required |
toXmlString()
Serializes this object to an XML string.
Returns:
| Type | Description |
|---|---|
string
|
A string containing the XML representation of this object |
setID(value)
Sets the value of the ID attribute.
A Unique Identifier for this element.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
AnnotationID_Type
|
The value to set |
required |
getID()
Returns the value of the ID attribute.
A Unique Identifier for this element.
Returns:
| Type | Description |
|---|---|
AnnotationID_Type
|
The value of the attribute |
resetID()
Resets the ID attribute to an unset state.
A Unique Identifier for this element.
hasID()
Checks whether the optional ID attribute is present.
A Unique Identifier for this element.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setNamespace(value)
Sets the value of the Namespace attribute.
We recommend the inclusion of a namespace for annotations you define. If it is absent then we assume the annotation is to use our (OME's) default interpretation for this type.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
string
|
The value to set |
required |
getNamespace()
Returns the value of the Namespace attribute.
We recommend the inclusion of a namespace for annotations you define. If it is absent then we assume the annotation is to use our (OME's) default interpretation for this type.
Returns:
| Type | Description |
|---|---|
string
|
The value of the attribute |
setAnnotator(value)
Sets the value of the Annotator attribute.
The Annotator is the person who attached this annotation.e.g. If UserA annotates something with TagB, owned by UserB, UserA is still the Annotator.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
ExperimenterID_Type
|
The value to set |
required |
getAnnotator()
Returns the value of the Annotator attribute.
The Annotator is the person who attached this annotation.e.g. If UserA annotates something with TagB, owned by UserB, UserA is still the Annotator.
Returns:
| Type | Description |
|---|---|
ExperimenterID_Type
|
The value of the attribute |
resetAnnotator()
Resets the Annotator attribute to an unset state.
The Annotator is the person who attached this annotation.e.g. If UserA annotates something with TagB, owned by UserB, UserA is still the Annotator.
hasAnnotator()
Checks whether the optional Annotator attribute is present.
The Annotator is the person who attached this annotation.e.g. If UserA annotates something with TagB, owned by UserB, UserA is still the Annotator.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setDescription(value)
Sets the value of the Description element.
This element contains a description for the annotation.[plain-text multi-line string]
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
Annotation_Type_InlineDescription
|
The value to set |
required |
getDescription()
Returns the value of the Description element.
This element contains a description for the annotation.[plain-text multi-line string]
Returns:
| Type | Description |
|---|---|
Annotation_Type_InlineDescription
|
The value of the element |
resetDescription()
Resets the Description element to an unset state.
This element contains a description for the annotation.[plain-text multi-line string]
hasDescription()
Checks whether the optional Description element is present.
This element contains a description for the annotation.[plain-text multi-line string]
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |