com.inscoper.nbo.Reagent¶

Represents the XML element Reagent. More...

Inherits from com.inscoper.nbo.NBOBaseClass

Public Functions¶

	Name
synchronized void	delete()
	Reagent()
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(ReagentID_Type value, boolean validate) Sets the value of the ID attribute.
void	setID(ReagentID_Type value) Sets the value of the ID attribute.
ReagentID_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	setName(String value, boolean validate) Sets the value of the Name attribute.
void	setName(String value) Sets the value of the Name attribute.
String	getName() Returns the value of the Name attribute.
void	resetName() Resets the Name attribute to an unset state.
boolean	hasName() Checks whether the Name attribute is present.
void	setReagentIdentifier(String value, boolean validate) Sets the value of the ReagentIdentifier attribute.
void	setReagentIdentifier(String value) Sets the value of the ReagentIdentifier attribute.
String	getReagentIdentifier() Returns the value of the ReagentIdentifier attribute.
void	resetReagentIdentifier() Resets the ReagentIdentifier attribute to an unset state.
boolean	hasReagentIdentifier() Checks whether the ReagentIdentifier attribute is present.
void	setDescription(Reagent_InlineDescription value, boolean validate) Sets the value of the Description element.
void	setDescription(Reagent_InlineDescription value) Sets the value of the Description element.
Reagent_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.
void	setAnnotationRef_List(AnnotationRefVector value, boolean validate) Sets the list of AnnotationRef elements.
void	setAnnotationRef_List(AnnotationRefVector value) Sets the list of AnnotationRef elements.
AnnotationRefVector	getAnnotationRef_List() Returns the list of AnnotationRef elements.
void	addToAnnotationRef_List(AnnotationRef value, boolean validate) Adds a new AnnotationRef element to this object.
void	addToAnnotationRef_List(AnnotationRef value) Adds a new AnnotationRef element to this object.
void	clearAnnotationRef_List() Clear the list of AnnotationRef.
Reagent	__internal_create(long cPtr, boolean own)
Reagent	fromBase(NBOBaseClass base) Cast a NBOBaseClass to a Reagent.
StringSet	getNameAllowedValues() Returns the allowed values for this attribut.
StringSet	getReagentIdentifierAllowedValues() Returns the allowed values for this attribut.

Protected Functions¶

	Name
	Reagent(long cPtr, boolean cMemoryOwn)
void	swigSetCMemOwn(boolean own)
void	finalize()
long	getCPtr(Reagent 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.Reagent;

Represents the XML element Reagent.

Reagent is used to describe a chemical or some other physical experimental parameter.

Public Functions Documentation¶

function delete¶

function Reagent¶

function getTypeName¶

function getXMLName¶

function getNBOType¶

function 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¶

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¶

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¶

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¶

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¶

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¶

function setID¶

public void setID(
    ReagentID_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.

No description available in the XSD standard.

function setID¶

function getID¶

function resetID¶

function hasID¶

function setName¶

public void setName(
    String value,
    boolean validate
)

Sets the value of the Name attribute.

Parameters:

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

A short name for the reagent.

function setName¶

function getName¶

function resetName¶

function hasName¶

function setReagentIdentifier¶

public void setReagentIdentifier(
    String value,
    boolean validate
)

Sets the value of the ReagentIdentifier attribute.

Parameters:

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

This is a reference to an external (to OME) representation of the Reagent. It serves as a foreign key into an external database. - It is sometimes referred to as ExternalIdentifier.

function setReagentIdentifier¶

public void setReagentIdentifier(
    String value
)

Sets the value of the ReagentIdentifier attribute.

Parameters:

value The value to set

This is a reference to an external (to OME) representation of the Reagent. It serves as a foreign key into an external database. - It is sometimes referred to as ExternalIdentifier.

function getReagentIdentifier¶

public String getReagentIdentifier()

Returns the value of the ReagentIdentifier attribute.

Return: The value of the attribute

This is a reference to an external (to OME) representation of the Reagent. It serves as a foreign key into an external database. - It is sometimes referred to as ExternalIdentifier.

function resetReagentIdentifier¶

public void resetReagentIdentifier()

Resets the ReagentIdentifier attribute to an unset state.

This is a reference to an external (to OME) representation of the Reagent. It serves as a foreign key into an external database. - It is sometimes referred to as ExternalIdentifier.

function hasReagentIdentifier¶

public boolean hasReagentIdentifier()

Checks whether the ReagentIdentifier attribute is present.

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

This is a reference to an external (to OME) representation of the Reagent. It serves as a foreign key into an external database. - It is sometimes referred to as ExternalIdentifier.

function setDescription¶

public void setDescription(
    Reagent_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.

A long description for the reagent.

function setDescription¶

function getDescription¶

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

A long description for the reagent.

function setAnnotationRef_List¶

public void setAnnotationRef_List(
    AnnotationRefVector value,
    boolean validate
)

Sets the list of AnnotationRef elements.

Parameters:

value The new list of AnnotationRef elements
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setAnnotationRef_List¶

public void setAnnotationRef_List(
    AnnotationRefVector value
)

Sets the list of AnnotationRef elements.

Parameters:

value The new list of AnnotationRef elements

No description available in the XSD standard.

function getAnnotationRef_List¶

function addToAnnotationRef_List¶

public void addToAnnotationRef_List(
    AnnotationRef value,
    boolean validate
)

Adds a new AnnotationRef element to this object.

Parameters:

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

No description available in the XSD standard.

function addToAnnotationRef_List¶

public void addToAnnotationRef_List(
    AnnotationRef value
)

Adds a new AnnotationRef element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearAnnotationRef_List¶

function __internal_create¶

function fromBase¶

function getNameAllowedValues¶

function getReagentIdentifierAllowedValues¶

public static StringSet getReagentIdentifierAllowedValues()

Returns the allowed values for this attribut.

Return: The list of allowed values

This is a reference to an external (to OME) representation of the Reagent. It serves as a foreign key into an external database. - It is sometimes referred to as ExternalIdentifier.

com.inscoper.nbo.Reagent¶

Public Functions¶

Protected Functions¶

Additional inherited members¶

Detailed Description¶

Public Functions Documentation¶

function delete¶

function Reagent¶

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 setName¶

function setName¶

function getName¶

function resetName¶

function hasName¶

function setReagentIdentifier¶

function setReagentIdentifier¶

function getReagentIdentifier¶

function resetReagentIdentifier¶

function hasReagentIdentifier¶

function setDescription¶

function setDescription¶

function getDescription¶

function resetDescription¶

function hasDescription¶

function setAnnotationRef_List¶

function setAnnotationRef_List¶

function getAnnotationRef_List¶

function addToAnnotationRef_List¶

function addToAnnotationRef_List¶

function clearAnnotationRef_List¶

function __internal_create¶

function fromBase¶

function getNameAllowedValues¶

function getReagentIdentifierAllowedValues¶

Protected Functions Documentation¶

function Reagent¶

function swigSetCMemOwn¶

function finalize¶

function getCPtr¶