com.inscoper.nbo.OME¶

Represents the XML element OME. More...

Inherits from com.inscoper.nbo.NBOBaseClass

Public Functions¶

	Name
synchronized void	delete()
	OME()
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	setUUID(UniversallyUniqueIdentifier_Type value, boolean validate) Sets the value of the UUID attribute.
void	setUUID(UniversallyUniqueIdentifier_Type value) Sets the value of the UUID attribute.
UniversallyUniqueIdentifier_Type	getUUID() Returns the value of the UUID attribute.
void	resetUUID() Resets the UUID attribute to an unset state.
boolean	hasUUID() Checks whether the optional UUID attribute is present.
void	setCreator(String value, boolean validate) Sets the value of the Creator attribute.
void	setCreator(String value) Sets the value of the Creator attribute.
String	getCreator() Returns the value of the Creator attribute.
void	resetCreator() Resets the Creator attribute to an unset state.
boolean	hasCreator() Checks whether the Creator attribute is present.
void	setRights(Rights value, boolean validate) Sets the value of the Rights element.
void	setRights(Rights value) Sets the value of the Rights element.
Rights	getRights() Returns the value of the Rights element.
void	resetRights() Resets the Rights element to an unset state.
boolean	hasRights() Checks whether the optional Rights element is present.
void	setome_choice(OME_Choice value, boolean validate) Sets the value of the ome_choice element.
void	setome_choice(OME_Choice value) Sets the value of the ome_choice element.
OME_Choice	getome_choice() Returns the value of the ome_choice element.
void	resetome_choice() Resets the ome_choice element to an unset state.
boolean	hasome_choice() Checks whether the optional ome_choice element is present.
OME	__internal_create(long cPtr, boolean own)
OME	fromBase(NBOBaseClass base) Cast a NBOBaseClass to a OME.
StringSet	getCreatorAllowedValues() Returns the allowed values for this attribut.

Protected Functions¶

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

Represents the XML element OME.

The OME element is a container for all information objects accessible by OME. These information objects include descriptions of the imaging experiments and the people who perform them, descriptions of the microscope, the resulting images and how they were acquired, the analyses performed on those images, and the analysis results themselves. An OME file may contain any or all of this information. With the creation of the Metadata Only Companion OME-XML and Binary Only OME-TIFF files the top level OME node has changed slightly. It can EITHER: Contain all the previously expected elements OR: Contain a single BinaryOnly element that points at its Metadata Only Companion OME-XML file.

Public Functions Documentation¶

function delete¶

function OME¶

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

public void setUUID(
    UniversallyUniqueIdentifier_Type value,
    boolean validate
)

Sets the value of the UUID attribute.

Parameters:

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

This unique identifier is used to keep track of multi part files. It allows the links between files to survive renaming. While OPTIONAL in the general case this is REQUIRED in a MetadataOnly Companion to a collection of BinaryOnly files.

function setUUID¶

public void setUUID(
    UniversallyUniqueIdentifier_Type value
)

Sets the value of the UUID attribute.

Parameters:

value The value to set

This unique identifier is used to keep track of multi part files. It allows the links between files to survive renaming. While OPTIONAL in the general case this is REQUIRED in a MetadataOnly Companion to a collection of BinaryOnly files.

function getUUID¶

public UniversallyUniqueIdentifier_Type getUUID()

Returns the value of the UUID attribute.

Return: The value of the attribute

This unique identifier is used to keep track of multi part files. It allows the links between files to survive renaming. While OPTIONAL in the general case this is REQUIRED in a MetadataOnly Companion to a collection of BinaryOnly files.

function resetUUID¶

public void resetUUID()

Resets the UUID attribute to an unset state.

This unique identifier is used to keep track of multi part files. It allows the links between files to survive renaming. While OPTIONAL in the general case this is REQUIRED in a MetadataOnly Companion to a collection of BinaryOnly files.

function hasUUID¶

public boolean hasUUID()

Checks whether the optional UUID attribute is present.

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

This unique identifier is used to keep track of multi part files. It allows the links between files to survive renaming. While OPTIONAL in the general case this is REQUIRED in a MetadataOnly Companion to a collection of BinaryOnly files.

function setCreator¶

public void setCreator(
    String value,
    boolean validate
)

Sets the value of the Creator attribute.

Parameters:

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

This is the name of the creating application of the OME-XML and preferably its full version. e.g "CompanyName, SoftwareName, V2.6.3456" This is optional but we hope it will be set by applications writing out OME-XML from scratch.

function setCreator¶

public void setCreator(
    String value
)

Sets the value of the Creator attribute.

Parameters:

value The value to set

This is the name of the creating application of the OME-XML and preferably its full version. e.g "CompanyName, SoftwareName, V2.6.3456" This is optional but we hope it will be set by applications writing out OME-XML from scratch.

function getCreator¶

public String getCreator()

Returns the value of the Creator attribute.

Return: The value of the attribute

This is the name of the creating application of the OME-XML and preferably its full version. e.g "CompanyName, SoftwareName, V2.6.3456" This is optional but we hope it will be set by applications writing out OME-XML from scratch.

function resetCreator¶

public void resetCreator()

Resets the Creator attribute to an unset state.

This is the name of the creating application of the OME-XML and preferably its full version. e.g "CompanyName, SoftwareName, V2.6.3456" This is optional but we hope it will be set by applications writing out OME-XML from scratch.

function hasCreator¶

public boolean hasCreator()

Checks whether the Creator attribute is present.

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

This is the name of the creating application of the OME-XML and preferably its full version. e.g "CompanyName, SoftwareName, V2.6.3456" This is optional but we hope it will be set by applications writing out OME-XML from scratch.

function setRights¶

public void setRights(
    Rights value,
    boolean validate
)

Sets the value of the Rights element.

Parameters:

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

No description available in the XSD standard.

function setRights¶

function getRights¶

function resetRights¶

function hasRights¶

public boolean hasRights()

Checks whether the optional Rights element is present.

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

No description available in the XSD standard.

function setome_choice¶

public void setome_choice(
    OME_Choice value,
    boolean validate
)

Sets the value of the ome_choice element.

Parameters:

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

No description available in the XSD standard.

function setome_choice¶

function getome_choice¶

function resetome_choice¶

function hasome_choice¶

public boolean hasome_choice()

Checks whether the optional ome_choice element is present.

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

No description available in the XSD standard.

function __internal_create¶

function fromBase¶

function getCreatorAllowedValues¶

public static StringSet getCreatorAllowedValues()

Returns the allowed values for this attribut.

Return: The list of allowed values

This is the name of the creating application of the OME-XML and preferably its full version. e.g "CompanyName, SoftwareName, V2.6.3456" This is optional but we hope it will be set by applications writing out OME-XML from scratch.

com.inscoper.nbo.OME¶

Public Functions¶

Protected Functions¶

Additional inherited members¶

Detailed Description¶

Public Functions Documentation¶

function delete¶

function OME¶

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

function setUUID¶

function getUUID¶

function resetUUID¶

function hasUUID¶

function setCreator¶

function setCreator¶

function getCreator¶

function resetCreator¶

function hasCreator¶

function setRights¶

function setRights¶

function getRights¶

function resetRights¶

function hasRights¶

function setome_choice¶

function setome_choice¶

function getome_choice¶

function resetome_choice¶

function hasome_choice¶

function __internal_create¶

function fromBase¶

function getCreatorAllowedValues¶

Protected Functions Documentation¶

function OME¶

function swigSetCMemOwn¶

function finalize¶

function getCPtr¶