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, 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(ScreenID_Type value, boolean validate) Sets the value of the ID attribute.
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, 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	setProtocolIdentifier(String value, boolean validate) Sets the value of the ProtocolIdentifier attribute.
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 ProtocolIdentifier attribute is present.
void	setProtocolDescription(String value, boolean validate) Sets the value of the ProtocolDescription attribute.
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 ProtocolDescription attribute is present.
void	setReagentSetDescription(String value, boolean validate) Sets the value of the ReagentSetDescription attribute.
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 ReagentSetDescription attribute is present.
void	setReagentSetIdentifier(String value, boolean validate) Sets the value of the ReagentSetIdentifier attribute.
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 ReagentSetIdentifier attribute is present.
void	setType(String value, boolean validate) Sets the value of the Type attribute.
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 Type attribute is present.
void	setDescription(Screen_InlineDescription value, boolean validate) Sets the value of the Description element.
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, boolean validate) Sets the list of Reagent elements.
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, boolean validate) Adds a new Reagent element to this object.
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, boolean validate) Sets the list of PlateRef elements.
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, boolean validate) Adds a new PlateRef element to this object.
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, 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.
Screen	__internal_create(long cPtr, boolean own)
Screen	fromBase(NBOBaseClass base) Cast a NBOBaseClass to a Screen.
StringSet	getNameAllowedValues() Returns the allowed values for this attribut.
StringSet	getProtocolIdentifierAllowedValues() Returns the allowed values for this attribut.
StringSet	getProtocolDescriptionAllowedValues() Returns the allowed values for this attribut.
StringSet	getReagentSetDescriptionAllowedValues() Returns the allowed values for this attribut.
StringSet	getReagentSetIdentifierAllowedValues() Returns the allowed values for this attribut.
StringSet	getTypeAllowedValues() Returns the allowed values for this attribut.

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¶

function Screen¶

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(
    ScreenID_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.

No description available in the XSD standard.

function setName¶

function getName¶

function resetName¶

function hasName¶

function setProtocolIdentifier¶

public void setProtocolIdentifier(
    String value,
    boolean validate
)

Sets the value of the ProtocolIdentifier attribute.

Parameters:

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

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

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¶

function hasProtocolIdentifier¶

public boolean hasProtocolIdentifier()

Checks whether the ProtocolIdentifier attribute is present.

Return: true if the 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,
    boolean validate
)

Sets the value of the ProtocolDescription attribute.

Parameters:

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

A description of the screen protocol; may contain very detailed information to reproduce some of that found 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 ProtocolDescription attribute is present.

Return: true if the 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,
    boolean validate
)

Sets the value of the ReagentSetDescription 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 setReagentSetDescription¶

function getReagentSetDescription¶

function resetReagentSetDescription¶

function hasReagentSetDescription¶

public boolean hasReagentSetDescription()

Checks whether the ReagentSetDescription attribute is present.

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

No description available in the XSD standard.

function setReagentSetIdentifier¶

public void setReagentSetIdentifier(
    String value,
    boolean validate
)

Sets the value of the ReagentSetIdentifier 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 setReagentSetIdentifier¶

function getReagentSetIdentifier¶

function resetReagentSetIdentifier¶

function hasReagentSetIdentifier¶

public boolean hasReagentSetIdentifier()

Checks whether the ReagentSetIdentifier attribute is present.

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

No description available in the XSD standard.

function setType¶

public void setType(
    String value,
    boolean validate
)

Sets the value of the Type 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 setType¶

function getType¶

function resetType¶

function hasType¶

function setDescription¶

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

function setDescription¶

function getDescription¶

function resetDescription¶

function hasDescription¶

function setReagent_List¶

public void setReagent_List(
    ReagentVector value,
    boolean validate
)

Sets the list of Reagent elements.

Parameters:

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

No description available in the XSD standard.

function setReagent_List¶

function getReagent_List¶

function addToReagent_List¶

public void addToReagent_List(
    Reagent value,
    boolean validate
)

Adds a new Reagent 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 addToReagent_List¶

function clearReagent_List¶

function setPlateRef_List¶

public void setPlateRef_List(
    Screen_InlinePlateRefVector value,
    boolean validate
)

Sets the list of PlateRef elements.

Parameters:

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

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

Adds a new PlateRef element to this object.

Parameters:

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

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

public static StringSet getProtocolIdentifierAllowedValues()

Returns the allowed values for this attribut.

Return: The list of allowed values

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

function getProtocolDescriptionAllowedValues¶

public static StringSet getProtocolDescriptionAllowedValues()

Returns the allowed values for this attribut.

Return: The list of allowed values

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