com.inscoper.nbo.Annotation_Type¶

Represents the XML complex type Annotation. More...

Inherits from com.inscoper.nbo.NBOBaseClass

Inherited by com.inscoper.nbo.BasicAnnotation_Type, com.inscoper.nbo.ListAnnotation, com.inscoper.nbo.MapAnnotation, com.inscoper.nbo.TextAnnotation_Type, com.inscoper.nbo.TypeAnnotation_Type

Public Functions¶

	Name
synchronized void	delete()
	Annotation_Type()
String	getTypeName() Returns the class type name.
String	getXMLName() Returns the XML element name corresponding to this class.
ENBOType	getNBOType() Returns the NBO Type corresponding to this class.
NBOBaseClassVector	getChildren() Returns a list of all classes derived from this class.
NBOBaseClassVector	getSubElements() Returns a list of all child elements contained in this class.
void	fromJsonFile(String path, boolean validate) Populates this object from a JSON file.
void	fromJsonFile(String path) Populates this object from a JSON file.
void	fromJsonString(String json_string, boolean validate) Populates this object from a JSON string.
void	fromJsonString(String json_string) Populates this object from a JSON string.
void	fromXmlFile(String path, boolean validate) Populates this object from a XML file.
void	fromXmlFile(String path) Populates this object from a XML file.
void	fromXmlString(String xml_string, boolean validate) Populates this object from a XML string.
void	fromXmlString(String xml_string) Populates this object from a XML string.
void	toXmlFile(String filename, boolean validate) Serializes this object to an XML file.
void	toXmlFile(String filename) Serializes this object to an XML file.
String	toXmlString(boolean validate) Serializes this object to an XML string.
String	toXmlString() Serializes this object to an XML string.
void	setID(AnnotationID_Type value, boolean validate) Sets the value of the ID attribute.
void	setID(AnnotationID_Type value) Sets the value of the ID attribute.
AnnotationID_Type	getID() Returns the value of the ID attribute.
void	resetID() Resets the ID attribute to an unset state.
boolean	hasID() Checks whether the optional ID attribute is present.
void	setNamespace(String value, boolean validate) Sets the value of the Namespace attribute.
void	setNamespace(String value) Sets the value of the Namespace attribute.
String	getNamespace() Returns the value of the Namespace attribute.
void	resetNamespace() Resets the Namespace attribute to an unset state.
boolean	hasNamespace() Checks whether the Namespace attribute is present.
void	setAnnotator(ExperimenterID_Type value, boolean validate) Sets the value of the Annotator attribute.
void	setAnnotator(ExperimenterID_Type value) Sets the value of the Annotator attribute.
ExperimenterID_Type	getAnnotator() Returns the value of the Annotator attribute.
void	resetAnnotator() Resets the Annotator attribute to an unset state.
boolean	hasAnnotator() Checks whether the optional Annotator attribute is present.
void	setDescription(Annotation_Type_InlineDescription value, boolean validate) Sets the value of the Description element.
void	setDescription(Annotation_Type_InlineDescription value) Sets the value of the Description element.
Annotation_Type_InlineDescription	getDescription() Returns the value of the Description element.
void	resetDescription() Resets the Description element to an unset state.
boolean	hasDescription() Checks whether the optional Description element is present.
Annotation_Type	__internal_create(long cPtr, boolean own)
Annotation_Type	fromBase(NBOBaseClass base) Cast a NBOBaseClass to a Annotation_Type.
StringSet	getNamespaceAllowedValues() Returns the allowed values for this attribut.

Protected Functions¶

	Name
	Annotation_Type(long cPtr, boolean cMemoryOwn)
void	swigSetCMemOwn(boolean own)
void	finalize()
long	getCPtr(Annotation_Type obj)

Additional inherited members¶

Protected Functions inherited from com.inscoper.nbo.NBOBaseClass

	Name
	NBOBaseClass(long cPtr, boolean cMemoryOwn)

Detailed Description¶

public class com.inscoper.nbo.Annotation_Type;

Represents the XML complex type Annotation.

This element contains a description for the annotation.[plain-text multi-line string]

Public Functions Documentation¶

function delete¶

public synchronized void delete()

Reimplements: com.inscoper.nbo.NBOBaseClass.delete

function Annotation_Type¶

function getTypeName¶

public String getTypeName()

Returns the class type name.

Return: The class type name

Reimplements: com.inscoper.nbo.NBOBaseClass.getTypeName

function getXMLName¶

public String getXMLName()

Returns the XML element name corresponding to this class.

Return: The XML element name

Reimplements: com.inscoper.nbo.NBOBaseClass.getXMLName

function getNBOType¶

public ENBOType getNBOType()

Returns the NBO Type corresponding to this class.

Return: The NBO Type value

Reimplements: com.inscoper.nbo.NBOBaseClass.getNBOType

function getChildren¶

public NBOBaseClassVector getChildren()

Returns a list of all classes derived from this class.

Return: The list of derived classes

Reimplements: com.inscoper.nbo.NBOBaseClass.getChildren

function getSubElements¶

public NBOBaseClassVector getSubElements()

Returns a list of all child elements contained in this class.

Return: The list of child classes

Reimplements: com.inscoper.nbo.NBOBaseClass.getSubElements

function fromJsonFile¶

public void fromJsonFile(
    String path,
    boolean validate
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file
validate If true, validates constraints on value. Default is true.

function fromJsonFile¶

public void fromJsonFile(
    String path
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file

function fromJsonString¶

public void fromJsonString(
    String json_string,
    boolean validate
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string
validate If true, validates constraints on value. Default is true.

function fromJsonString¶

public void fromJsonString(
    String json_string
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string

function fromXmlFile¶

public void fromXmlFile(
    String path,
    boolean validate
)

Populates this object from a XML file.

Parameters:

path The path to the XML file
validate If true, validates constraints on value. Default is true.

function fromXmlFile¶

public void fromXmlFile(
    String path
)

Populates this object from a XML file.

Parameters:

path The path to the XML file

function fromXmlString¶

public void fromXmlString(
    String xml_string,
    boolean validate
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string
validate If true, validates constraints on value. Default is true.

function fromXmlString¶

public void fromXmlString(
    String xml_string
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string

function toXmlFile¶

public void toXmlFile(
    String filename,
    boolean validate
)

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file
validate If true, validates constraints on value. Default is true.

function toXmlFile¶

public void toXmlFile(
    String filename
)

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file

function toXmlString¶

public String toXmlString(
    boolean validate
)

Serializes this object to an XML string.

Parameters:

validate If true, validates constraints on value. Default is true.

Return: A string containing the XML representation of this object

function toXmlString¶

public String toXmlString()

Serializes this object to an XML string.

Return: A string containing the XML representation of this object

function setID¶

public void setID(
    AnnotationID_Type value,
    boolean validate
)

Sets the value of the ID attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

A Unique Identifier for this element.

function setID¶

function getID¶

function resetID¶

function hasID¶

function setNamespace¶

public void setNamespace(
    String value,
    boolean validate
)

Sets the value of the Namespace attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

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.

function setNamespace¶

public void setNamespace(
    String value
)

Sets the value of the Namespace attribute.

Parameters:

value The value to set

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.

function getNamespace¶

public String getNamespace()

Returns the value of the Namespace attribute.

Return: The value of the 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.

function resetNamespace¶

public void resetNamespace()

Resets the Namespace attribute to an unset state.

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.

function hasNamespace¶

public boolean hasNamespace()

Checks whether the Namespace attribute is present.

Return: true if the attribute has been set, false otherwise

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.

function setAnnotator¶

public void setAnnotator(
    ExperimenterID_Type value,
    boolean validate
)

Sets the value of the Annotator attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

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.

function setAnnotator¶

public void setAnnotator(
    ExperimenterID_Type value
)

Sets the value of the Annotator attribute.

Parameters:

value The value to set

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.

function getAnnotator¶

public ExperimenterID_Type getAnnotator()

Returns the value of the Annotator attribute.

Return: The value of the 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.

function resetAnnotator¶

public void 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.

function hasAnnotator¶

public boolean hasAnnotator()

Checks whether the optional Annotator attribute is present.

Return: true if the optional attribute has been set, false otherwise

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.

function setDescription¶

public void setDescription(
    Annotation_Type_InlineDescription value,
    boolean validate
)

Sets the value of the Description element.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This element contains a description for the annotation.[plain-text multi-line string]

function setDescription¶

public void setDescription(
    Annotation_Type_InlineDescription value
)

Sets the value of the Description element.

Parameters:

value The value to set

This element contains a description for the annotation.[plain-text multi-line string]

function getDescription¶

public Annotation_Type_InlineDescription getDescription()

Returns the value of the Description element.

Return: The value of the element

This element contains a description for the annotation.[plain-text multi-line string]

function resetDescription¶

function hasDescription¶

public boolean hasDescription()

Checks whether the optional Description element is present.

Return: true if the optional attribute has been set, false otherwise

This element contains a description for the annotation.[plain-text multi-line string]

function __internal_create¶

public static Annotation_Type __internal_create(
    long cPtr,
    boolean own
)

Reimplements: com.inscoper.nbo.NBOBaseClass.__internal_create

function fromBase¶

public static Annotation_Type fromBase(
    NBOBaseClass base
)

Cast a NBOBaseClass to a Annotation_Type.

Parameters:

base The base class to cast

Return: The casted element, or nullptr if the cast fails

function getNamespaceAllowedValues¶

public static StringSet getNamespaceAllowedValues()

Returns the allowed values for this attribut.

Return: The list of allowed values

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.

Protected Functions Documentation¶

function Annotation_Type¶

function swigSetCMemOwn¶

protected void swigSetCMemOwn(
    boolean own
)

Reimplements: com.inscoper.nbo.NBOBaseClass.swigSetCMemOwn

function finalize¶

protected void finalize()

Reimplements: com.inscoper.nbo.NBOBaseClass.finalize

com.inscoper.nbo.Annotation_Type¶

Public Functions¶

Protected Functions¶

Additional inherited members¶

Detailed Description¶

Public Functions Documentation¶

function delete¶

function Annotation_Type¶

function getTypeName¶

function getXMLName¶

function getNBOType¶

function getChildren¶

function getSubElements¶

function fromJsonFile¶

function fromJsonFile¶

function fromJsonString¶

function fromJsonString¶

function fromXmlFile¶

function fromXmlFile¶

function fromXmlString¶

function fromXmlString¶

function toXmlFile¶

function toXmlFile¶

function toXmlString¶

function toXmlString¶

function setID¶

function setID¶

function getID¶

function resetID¶

function hasID¶

function setNamespace¶

function setNamespace¶

function getNamespace¶

function resetNamespace¶

function hasNamespace¶

function setAnnotator¶

function setAnnotator¶

function getAnnotator¶

function resetAnnotator¶

function hasAnnotator¶

function setDescription¶

function setDescription¶

function getDescription¶

function resetDescription¶

function hasDescription¶

function __internal_create¶

function fromBase¶

function getNamespaceAllowedValues¶

Protected Functions Documentation¶

function Annotation_Type¶

function swigSetCMemOwn¶

function finalize¶

function getCPtr¶