com.inscoper.nbo.Folder¶

Represents the XML element Folder. More...

Inherits from com.inscoper.nbo.NBOBaseClass

Public Functions¶

	Name
synchronized void	delete()
	Folder()
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(FolderID_Type value, boolean validate) Sets the value of the ID attribute.
void	setID(FolderID_Type value) Sets the value of the ID attribute.
FolderID_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	setDescription(Folder_InlineDescription value, boolean validate) Sets the value of the Description element.
void	setDescription(Folder_InlineDescription value) Sets the value of the Description element.
Folder_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	setFolderRef_List(FolderRefVector value, boolean validate) Sets the list of FolderRef elements.
void	setFolderRef_List(FolderRefVector value) Sets the list of FolderRef elements.
FolderRefVector	getFolderRef_List() Returns the list of FolderRef elements.
void	addToFolderRef_List(FolderRef value, boolean validate) Adds a new FolderRef element to this object.
void	addToFolderRef_List(FolderRef value) Adds a new FolderRef element to this object.
void	clearFolderRef_List() Clear the list of FolderRef.
void	setImageRef_List(ImageRefVector value, boolean validate) Sets the list of ImageRef elements.
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, boolean validate) Adds a new ImageRef element to this object.
void	addToImageRef_List(ImageRef value) Adds a new ImageRef element to this object.
void	clearImageRef_List() Clear the list of ImageRef.
void	setROIRef_List(ROIRefVector value, boolean validate) Sets the list of ROIRef elements.
void	setROIRef_List(ROIRefVector value) Sets the list of ROIRef elements.
ROIRefVector	getROIRef_List() Returns the list of ROIRef elements.
void	addToROIRef_List(ROIRef value, boolean validate) Adds a new ROIRef element to this object.
void	addToROIRef_List(ROIRef value) Adds a new ROIRef element to this object.
void	clearROIRef_List() Clear the list of ROIRef.
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.
Folder	__internal_create(long cPtr, boolean own)
Folder	fromBase(NBOBaseClass base) Cast a NBOBaseClass to a CMOS.
StringSet	getNameAllowedValues() Returns the allowed values for this attribut.

Protected Functions¶

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

Represents the XML element Folder.

An element specifying a possibly heterogeneous collection of data. Folders may contain Folders so that data may be organized within a tree of Folders. Data may be in multiple Folders but a Folder may not be in more than one other Folder.

Public Functions Documentation¶

function delete¶

public synchronized void delete()

Reimplements: com.inscoper.nbo.NBOBaseClass.delete

function Folder¶

public Folder()

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(
    FolderID_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¶

public void setID(
    FolderID_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 FolderID_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 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 name for the folder that is suitable for presentation to the user.

function setName¶

public void setName(
    String value
)

Sets the value of the Name attribute.

Parameters:

value The value to set

A name for the folder 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 folder 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 folder that is suitable for presentation to the user.

function hasName¶

public boolean hasName()

Checks whether the Name attribute is present.

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

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

function setDescription¶

public void setDescription(
    Folder_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 description for the folder. [plain-text multi-line string]

function setDescription¶

public void setDescription(
    Folder_InlineDescription value
)

Sets the value of the Description element.

Parameters:

value The value to set

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

function getDescription¶

public Folder_InlineDescription getDescription()

Returns the value of the Description element.

Return: The value of the element

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

function resetDescription¶

public void resetDescription()

Resets the Description element to an unset state.

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

function setFolderRef_List¶

public void setFolderRef_List(
    FolderRefVector value,
    boolean validate
)

Sets the list of FolderRef elements.

Parameters:

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

No description available in the XSD standard.

function setFolderRef_List¶

public void setFolderRef_List(
    FolderRefVector value
)

Sets the list of FolderRef elements.

Parameters:

value The new list of FolderRef elements

No description available in the XSD standard.

function getFolderRef_List¶

public FolderRefVector getFolderRef_List()

Returns the list of FolderRef elements.

Return: The list of FolderRef elements

No description available in the XSD standard.

function addToFolderRef_List¶

public void addToFolderRef_List(
    FolderRef value,
    boolean validate
)

Adds a new FolderRef 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 addToFolderRef_List¶

public void addToFolderRef_List(
    FolderRef value
)

Adds a new FolderRef element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearFolderRef_List¶

public void clearFolderRef_List()

Clear the list of FolderRef.

No description available in the XSD standard.

function setImageRef_List¶

public void setImageRef_List(
    ImageRefVector value,
    boolean validate
)

Sets the list of ImageRef elements.

Parameters:

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

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,
    boolean validate
)

Adds a new ImageRef 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 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 setROIRef_List¶

public void setROIRef_List(
    ROIRefVector value,
    boolean validate
)

Sets the list of ROIRef elements.

Parameters:

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

No description available in the XSD standard.

function setROIRef_List¶

public void setROIRef_List(
    ROIRefVector value
)

Sets the list of ROIRef elements.

Parameters:

value The new list of ROIRef elements

No description available in the XSD standard.

function getROIRef_List¶

public ROIRefVector getROIRef_List()

Returns the list of ROIRef elements.

Return: The list of ROIRef elements

No description available in the XSD standard.

function addToROIRef_List¶

public void addToROIRef_List(
    ROIRef value,
    boolean validate
)

Adds a new ROIRef 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 addToROIRef_List¶

public void addToROIRef_List(
    ROIRef value
)

Adds a new ROIRef element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearROIRef_List¶

public void clearROIRef_List()

Clear the list of ROIRef.

No description available in the XSD standard.

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¶

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

public void clearAnnotationRef_List()

Clear the list of AnnotationRef.

No description available in the XSD standard.

function __internal_create¶

public static Folder __internal_create(
    long cPtr,
    boolean own
)

Reimplements: com.inscoper.nbo.NBOBaseClass.__internal_create

function fromBase¶

public static Folder fromBase(
    NBOBaseClass base
)

Cast a NBOBaseClass to a CMOS.

Parameters:

base The base class to cast

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

function getNameAllowedValues¶

public static StringSet getNameAllowedValues()

Returns the allowed values for this attribut.

Return: The list of allowed values

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

Protected Functions Documentation¶

function Folder¶

protected Folder(
    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(
    Folder obj
)

Updated on 2026-06-22 at 17:06:25 +0200