com.inscoper.nbo.Dataset

Represents the XML element Dataset. More...

Inherits from com.inscoper.nbo.NBOBaseClass

Public Functions

	Name
synchronized void	delete()
	Dataset()
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) Populates this object from a JSON file.
void	fromJsonString(String json_string) Populates this object from a JSON string.
void	fromXmlFile(String path) Populates this object from a XML file.
void	fromXmlString(String xml_string) Populates this object from a XML string.
void	toXmlFile(String filename) Serializes this object to an XML file.
String	toXmlString() Serializes this object to an XML string.
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 optional Name attribute is present.
void	setID(DatasetID_Type value) Sets the value of the ID attribute.
DatasetID_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	setDescription(Dataset_InlineDescription value) Sets the value of the Description element.
Dataset_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	setExperimenterRef(ExperimenterRef value) Sets the value of the ExperimenterRef element.
ExperimenterRef	getExperimenterRef() Returns the value of the ExperimenterRef element.
void	resetExperimenterRef() Resets the ExperimenterRef element to an unset state.
boolean	hasExperimenterRef() Checks whether the optional ExperimenterRef element is present.
void	setExperimenterGroupRef(ExperimenterGroupRef value) Sets the value of the ExperimenterGroupRef element.
ExperimenterGroupRef	getExperimenterGroupRef() Returns the value of the ExperimenterGroupRef element.
void	resetExperimenterGroupRef() Resets the ExperimenterGroupRef element to an unset state.
boolean	hasExperimenterGroupRef() Checks whether the optional ExperimenterGroupRef element is present.
void	setImageRef_List(ImageRefVector value) Sets the list of ImageRef elements.
ImageRefVector	getImageRef_List() Returns the list of ImageRef elements.
void	addToImageRef_List(ImageRef value) Adds a new ImageRef element to this object.
void	clearImageRef_List() Clear the list of ImageRef.
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) Adds a new AnnotationRef element to this object.
void	clearAnnotationRef_List() Clear the list of AnnotationRef.
Dataset	__internal_create(long cPtr, boolean own)

Protected Functions

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

Represents the XML element Dataset.

An element specifying a collection of images that are always processed together. Images can belong to more than one Dataset, and a Dataset may contain more than one Image. Images contain one or more DatasetRef elements to specify what datasets they belong to. Once a Dataset has been processed in any way, its collection of images cannot be altered. The ExperimenterRef and ExperimenterGroupRef elements specify the person and group this Dataset belongs to. Projects may contain one or more Datasets, and Datasets may belong to one or more Projects. This relationship is specified by listing DatasetRef elements within the Project element.

Public Functions Documentation

function delete

public synchronized void delete()

Reimplements: com.inscoper.nbo.NBOBaseClass.delete

function Dataset

public Dataset()

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
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file

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
)

Populates this object from a XML file.

Parameters:

path The path to the XML file

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
)

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file

function toXmlString

public String toXmlString()

Serializes this object to an XML string.

Return: A string containing the XML representation of this object

function setName

public void setName(
    String value
)

Sets the value of the Name attribute.

Parameters:

value The value to set

A name for the dataset that is suitable for presentation to the user.

function getName

public String getName()

Returns the value of the Name attribute.

Return: The value of the attribute

A name for the dataset that is suitable for presentation to the user.

function resetName

public void resetName()

Resets the Name attribute to an unset state.

A name for the dataset that is suitable for presentation to the user.

function hasName

public boolean hasName()

Checks whether the optional Name attribute is present.

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

A name for the dataset that is suitable for presentation to the user.

function setID

public void setID(
    DatasetID_Type value
)

Sets the value of the ID attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getID

public DatasetID_Type getID()

Returns the value of the ID attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetID

public void resetID()

Resets the ID attribute to an unset state.

No description available in the XSD standard.

function hasID

public boolean hasID()

Checks whether the optional ID attribute is present.

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

No description available in the XSD standard.

function setDescription

public void setDescription(
    Dataset_InlineDescription value
)

Sets the value of the Description element.

Parameters:

value The value to set

A description for the dataset. [plain-text multi-line string]

function getDescription

public Dataset_InlineDescription getDescription()

Returns the value of the Description element.

Return: The value of the element

A description for the dataset. [plain-text multi-line string]

function resetDescription

public void resetDescription()

Resets the Description element to an unset state.

A description for the dataset. [plain-text multi-line string]

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 description for the dataset. [plain-text multi-line string]

function setExperimenterRef

public void setExperimenterRef(
    ExperimenterRef value
)

Sets the value of the ExperimenterRef element.

Parameters:

value The value to set

No description available in the XSD standard.

function getExperimenterRef

public ExperimenterRef getExperimenterRef()

Returns the value of the ExperimenterRef element.

Return: The value of the element

No description available in the XSD standard.

function resetExperimenterRef

public void resetExperimenterRef()

Resets the ExperimenterRef element to an unset state.

No description available in the XSD standard.

function hasExperimenterRef

public boolean hasExperimenterRef()

Checks whether the optional ExperimenterRef element is present.

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

No description available in the XSD standard.

function setExperimenterGroupRef

public void setExperimenterGroupRef(
    ExperimenterGroupRef value
)

Sets the value of the ExperimenterGroupRef element.

Parameters:

value The value to set

No description available in the XSD standard.

function getExperimenterGroupRef

public ExperimenterGroupRef getExperimenterGroupRef()

Returns the value of the ExperimenterGroupRef element.

Return: The value of the element

No description available in the XSD standard.

function resetExperimenterGroupRef

public void resetExperimenterGroupRef()

Resets the ExperimenterGroupRef element to an unset state.

No description available in the XSD standard.

function hasExperimenterGroupRef

public boolean hasExperimenterGroupRef()

Checks whether the optional ExperimenterGroupRef element is present.

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

No description available in the XSD standard.

function setImageRef_List

public void setImageRef_List(
    ImageRefVector value
)

Sets the list of ImageRef elements.

Parameters:

value The new list of ImageRef elements

No description available in the XSD standard.

function getImageRef_List

public ImageRefVector getImageRef_List()

Returns the list of ImageRef elements.

Return: The list of ImageRef elements

No description available in the XSD standard.

function addToImageRef_List

public void addToImageRef_List(
    ImageRef value
)

Adds a new ImageRef element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearImageRef_List

public void clearImageRef_List()

Clear the list of ImageRef.

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

public AnnotationRefVector getAnnotationRef_List()

Returns the list of AnnotationRef elements.

Return: The list of AnnotationRef elements

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

public void clearAnnotationRef_List()

Clear the list of AnnotationRef.

No description available in the XSD standard.

function __internal_create

public static Dataset __internal_create(
    long cPtr,
    boolean own
)

Reimplements: com.inscoper.nbo.NBOBaseClass.__internal_create

Protected Functions Documentation

function Dataset

protected Dataset(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn

protected void swigSetCMemOwn(
    boolean own
)

Reimplements: com.inscoper.nbo.NBOBaseClass.swigSetCMemOwn

function finalize

protected void finalize()

Reimplements: com.inscoper.nbo.NBOBaseClass.finalize

function getCPtr

protected static long getCPtr(
    Dataset obj
)

Updated on 2026-02-13 at 16:10:56 +0100