com.inscoper.nbo.Screen

Represents the XML element Screen. More...

Inherits from com.inscoper.nbo.NBOBaseClass

Public Functions

	Name
synchronized void	delete()
	Screen()
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	setID(ScreenID_Type value) Sets the value of the ID attribute.
ScreenID_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) 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	setProtocolIdentifier(String value) Sets the value of the ProtocolIdentifier attribute.
String	getProtocolIdentifier() Returns the value of the ProtocolIdentifier attribute.
void	resetProtocolIdentifier() Resets the ProtocolIdentifier attribute to an unset state.
boolean	hasProtocolIdentifier() Checks whether the optional ProtocolIdentifier attribute is present.
void	setProtocolDescription(String value) Sets the value of the ProtocolDescription attribute.
String	getProtocolDescription() Returns the value of the ProtocolDescription attribute.
void	resetProtocolDescription() Resets the ProtocolDescription attribute to an unset state.
boolean	hasProtocolDescription() Checks whether the optional ProtocolDescription attribute is present.
void	setReagentSetDescription(String value) Sets the value of the ReagentSetDescription attribute.
String	getReagentSetDescription() Returns the value of the ReagentSetDescription attribute.
void	resetReagentSetDescription() Resets the ReagentSetDescription attribute to an unset state.
boolean	hasReagentSetDescription() Checks whether the optional ReagentSetDescription attribute is present.
void	setReagentSetIdentifier(String value) Sets the value of the ReagentSetIdentifier attribute.
String	getReagentSetIdentifier() Returns the value of the ReagentSetIdentifier attribute.
void	resetReagentSetIdentifier() Resets the ReagentSetIdentifier attribute to an unset state.
boolean	hasReagentSetIdentifier() Checks whether the optional ReagentSetIdentifier attribute is present.
void	setType(String value) Sets the value of the Type attribute.
String	getType() Returns the value of the Type attribute.
void	resetType() Resets the Type attribute to an unset state.
boolean	hasType() Checks whether the optional Type attribute is present.
void	setDescription(Screen_InlineDescription value) Sets the value of the Description element.
Screen_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	setReagent_List(ReagentVector value) Sets the list of Reagent elements.
ReagentVector	getReagent_List() Returns the list of Reagent elements.
void	addToReagent_List(Reagent value) Adds a new Reagent element to this object.
void	clearReagent_List() Clear the list of Reagent.
void	setPlateRef_List(Screen_InlinePlateRefVector value) Sets the list of PlateRef elements.
Screen_InlinePlateRefVector	getPlateRef_List() Returns the list of PlateRef elements.
void	addToPlateRef_List(Screen_InlinePlateRef value) Adds a new PlateRef element to this object.
void	clearPlateRef_List() Clear the list of PlateRef.
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.
Screen	__internal_create(long cPtr, boolean own)

Protected Functions

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

Represents the XML element Screen.

The Screen element is a grouping for Plates. The required attribute is the Screen's Name and ID - both must be unique within the document. The Screen element may contain an ExternalRef attribute that refers to an external database. A description of the screen may be specified in the Description element. Screens may contain overlapping sets of Plates i.e. Screens and Plates have a many-to-many relationship. Plates contain one or more ScreenRef elements to specify what screens they belong to.

Public Functions Documentation

function delete

public synchronized void delete()

Reimplements: com.inscoper.nbo.NBOBaseClass.delete

function Screen

public Screen()

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 setID

public void setID(
    ScreenID_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 ScreenID_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
)

Sets the value of the Name attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getName

public String getName()

Returns the value of the Name attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetName

public void resetName()

Resets the Name attribute to an unset state.

No description available in the XSD standard.

function hasName

public boolean hasName()

Checks whether the optional Name attribute is present.

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

No description available in the XSD standard.

function setProtocolIdentifier

public void setProtocolIdentifier(
    String value
)

Sets the value of the ProtocolIdentifier attribute.

Parameters:

value The value to set

A pointer to an externally defined protocol, usually in a screening database.

function getProtocolIdentifier

public String getProtocolIdentifier()

Returns the value of the ProtocolIdentifier attribute.

Return: The value of the attribute

A pointer to an externally defined protocol, usually in a screening database.

function resetProtocolIdentifier

public void resetProtocolIdentifier()

Resets the ProtocolIdentifier attribute to an unset state.

A pointer to an externally defined protocol, usually in a screening database.

function hasProtocolIdentifier

public boolean hasProtocolIdentifier()

Checks whether the optional ProtocolIdentifier attribute is present.

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

A pointer to an externally defined protocol, usually in a screening database.

function setProtocolDescription

public void setProtocolDescription(
    String value
)

Sets the value of the ProtocolDescription attribute.

Parameters:

value The value to set

A description of the screen protocol; may contain very detailed information to reproduce some of that found in a screening database.

function getProtocolDescription

public String getProtocolDescription()

Returns the value of the ProtocolDescription attribute.

Return: The value of the attribute

A description of the screen protocol; may contain very detailed information to reproduce some of that found in a screening database.

function resetProtocolDescription

public void resetProtocolDescription()

Resets the ProtocolDescription attribute to an unset state.

A description of the screen protocol; may contain very detailed information to reproduce some of that found in a screening database.

function hasProtocolDescription

public boolean hasProtocolDescription()

Checks whether the optional ProtocolDescription attribute is present.

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

A description of the screen protocol; may contain very detailed information to reproduce some of that found in a screening database.

function setReagentSetDescription

public void setReagentSetDescription(
    String value
)

Sets the value of the ReagentSetDescription attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getReagentSetDescription

public String getReagentSetDescription()

Returns the value of the ReagentSetDescription attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetReagentSetDescription

public void resetReagentSetDescription()

Resets the ReagentSetDescription attribute to an unset state.

No description available in the XSD standard.

function hasReagentSetDescription

public boolean hasReagentSetDescription()

Checks whether the optional ReagentSetDescription attribute is present.

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

No description available in the XSD standard.

function setReagentSetIdentifier

public void setReagentSetIdentifier(
    String value
)

Sets the value of the ReagentSetIdentifier attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getReagentSetIdentifier

public String getReagentSetIdentifier()

Returns the value of the ReagentSetIdentifier attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetReagentSetIdentifier

public void resetReagentSetIdentifier()

Resets the ReagentSetIdentifier attribute to an unset state.

No description available in the XSD standard.

function hasReagentSetIdentifier

public boolean hasReagentSetIdentifier()

Checks whether the optional ReagentSetIdentifier attribute is present.

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

No description available in the XSD standard.

function setType

public void setType(
    String value
)

Sets the value of the Type attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getType

public String getType()

Returns the value of the Type attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetType

public void resetType()

Resets the Type attribute to an unset state.

No description available in the XSD standard.

function hasType

public boolean hasType()

Checks whether the optional Type 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(
    Screen_InlineDescription value
)

Sets the value of the Description element.

Parameters:

value The value to set

A description for the screen.

function getDescription

public Screen_InlineDescription getDescription()

Returns the value of the Description element.

Return: The value of the element

A description for the screen.

function resetDescription

public void resetDescription()

Resets the Description element to an unset state.

A description for the screen.

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 screen.

function setReagent_List

public void setReagent_List(
    ReagentVector value
)

Sets the list of Reagent elements.

Parameters:

value The new list of Reagent elements

No description available in the XSD standard.

function getReagent_List

public ReagentVector getReagent_List()

Returns the list of Reagent elements.

Return: The list of Reagent elements

No description available in the XSD standard.

function addToReagent_List

public void addToReagent_List(
    Reagent value
)

Adds a new Reagent element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearReagent_List

public void clearReagent_List()

Clear the list of Reagent.

No description available in the XSD standard.

function setPlateRef_List

public void setPlateRef_List(
    Screen_InlinePlateRefVector value
)

Sets the list of PlateRef elements.

Parameters:

value The new list of PlateRef elements

The PlateRef element is a reference to a Plate element. Screen elements may have one or more PlateRef elements to define the plates that are part of the screen. Plates may belong to more than one screen.

function getPlateRef_List

public Screen_InlinePlateRefVector getPlateRef_List()

Returns the list of PlateRef elements.

Return: The list of PlateRef elements

The PlateRef element is a reference to a Plate element. Screen elements may have one or more PlateRef elements to define the plates that are part of the screen. Plates may belong to more than one screen.

function addToPlateRef_List

public void addToPlateRef_List(
    Screen_InlinePlateRef value
)

Adds a new PlateRef element to this object.

Parameters:

value The element to add

The PlateRef element is a reference to a Plate element. Screen elements may have one or more PlateRef elements to define the plates that are part of the screen. Plates may belong to more than one screen.

function clearPlateRef_List

public void clearPlateRef_List()

Clear the list of PlateRef.

The PlateRef element is a reference to a Plate element. Screen elements may have one or more PlateRef elements to define the plates that are part of the screen. Plates may belong to more than one screen.

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 Screen __internal_create(
    long cPtr,
    boolean own
)

Reimplements: com.inscoper.nbo.NBOBaseClass.__internal_create

Protected Functions Documentation

function Screen

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

Updated on 2026-02-13 at 16:11:06 +0100