com.inscoper.nbo.Well¶

Represents the XML element Well. More...

Inherits from com.inscoper.nbo.NBOBaseClass

Public Functions¶

	Name
synchronized void	delete()
	Well()
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(WellID_Type value, boolean validate) Sets the value of the ID attribute.
void	setID(WellID_Type value) Sets the value of the ID attribute.
WellID_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	setColumn(NonNegativeInt_Type value, boolean validate) Sets the value of the Column attribute.
void	setColumn(NonNegativeInt_Type value) Sets the value of the Column attribute.
NonNegativeInt_Type	getColumn() Returns the value of the Column attribute.
void	resetColumn() Resets the Column attribute to an unset state.
boolean	hasColumn() Checks whether the optional Column attribute is present.
void	setRow(NonNegativeInt_Type value, boolean validate) Sets the value of the Row attribute.
void	setRow(NonNegativeInt_Type value) Sets the value of the Row attribute.
NonNegativeInt_Type	getRow() Returns the value of the Row attribute.
void	resetRow() Resets the Row attribute to an unset state.
boolean	hasRow() Checks whether the optional Row attribute is present.
void	setExternalDescription(String value, boolean validate) Sets the value of the ExternalDescription attribute.
void	setExternalDescription(String value) Sets the value of the ExternalDescription attribute.
String	getExternalDescription() Returns the value of the ExternalDescription attribute.
void	resetExternalDescription() Resets the ExternalDescription attribute to an unset state.
boolean	hasExternalDescription() Checks whether the ExternalDescription attribute is present.
void	setExternalIdentifier(String value, boolean validate) Sets the value of the ExternalIdentifier attribute.
void	setExternalIdentifier(String value) Sets the value of the ExternalIdentifier attribute.
String	getExternalIdentifier() Returns the value of the ExternalIdentifier attribute.
void	resetExternalIdentifier() Resets the ExternalIdentifier attribute to an unset state.
boolean	hasExternalIdentifier() Checks whether the ExternalIdentifier 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	setColor(Color_Type value, boolean validate) Sets the value of the Color attribute.
void	setColor(Color_Type value) Sets the value of the Color attribute.
Color_Type	getColor() Returns the value of the Color attribute.
void	resetColor() Resets the Color attribute to an unset state.
boolean	hasColor() Checks whether the optional Color attribute is present.
void	setWellSample_List(WellSampleVector value, boolean validate) Sets the list of WellSample elements.
void	setWellSample_List(WellSampleVector value) Sets the list of WellSample elements.
WellSampleVector	getWellSample_List() Returns the list of WellSample elements.
void	addToWellSample_List(WellSample value, boolean validate) Adds a new WellSample element to this object.
void	addToWellSample_List(WellSample value) Adds a new WellSample element to this object.
void	clearWellSample_List() Clear the list of WellSample.
void	setReagentRef(ReagentRef value, boolean validate) Sets the value of the ReagentRef element.
void	setReagentRef(ReagentRef value) Sets the value of the ReagentRef element.
ReagentRef	getReagentRef() Returns the value of the ReagentRef element.
void	resetReagentRef() Resets the ReagentRef element to an unset state.
boolean	hasReagentRef() Checks whether the optional ReagentRef element is present.
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.
Well	__internal_create(long cPtr, boolean own)
Well	fromBase(NBOBaseClass base) Cast a NBOBaseClass to a Well.
StringSet	getExternalDescriptionAllowedValues() Returns the allowed values for this attribut.
StringSet	getExternalIdentifierAllowedValues() Returns the allowed values for this attribut.
StringSet	getTypeAllowedValues() Returns the allowed values for this attribut.

Protected Functions¶

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

Represents the XML element Well.

A Well is a component of the Well/Plate/Screen construct to describe screening applications. A Well has a number of WellSample elements that link to the Images collected in this well. The ReagentRef links any Reagents that were used in this Well. A well is part of only one Plate. The origin for the row and column identifiers is the top left corner of the plate starting at zero. i.e The top left well of a plate is index (0,0)

Public Functions Documentation¶

function delete¶

function Well¶

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(
    WellID_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 setColumn¶

public void setColumn(
    NonNegativeInt_Type value,
    boolean validate
)

Sets the value of the Column attribute.

Parameters:

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

This is the column index of the well, the origin is the top left corner of the plate with the first column of cells being column zero. i.e top left is (0,0) The combination of Row, Column has to be unique for each well in a plate.

function setColumn¶

public void setColumn(
    NonNegativeInt_Type value
)

Sets the value of the Column attribute.

Parameters:

value The value to set

This is the column index of the well, the origin is the top left corner of the plate with the first column of cells being column zero. i.e top left is (0,0) The combination of Row, Column has to be unique for each well in a plate.

function getColumn¶

public NonNegativeInt_Type getColumn()

Returns the value of the Column attribute.

Return: The value of the attribute

This is the column index of the well, the origin is the top left corner of the plate with the first column of cells being column zero. i.e top left is (0,0) The combination of Row, Column has to be unique for each well in a plate.

function resetColumn¶

public void resetColumn()

Resets the Column attribute to an unset state.

This is the column index of the well, the origin is the top left corner of the plate with the first column of cells being column zero. i.e top left is (0,0) The combination of Row, Column has to be unique for each well in a plate.

function hasColumn¶

public boolean hasColumn()

Checks whether the optional Column attribute is present.

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

This is the column index of the well, the origin is the top left corner of the plate with the first column of cells being column zero. i.e top left is (0,0) The combination of Row, Column has to be unique for each well in a plate.

function setRow¶

public void setRow(
    NonNegativeInt_Type value,
    boolean validate
)

Sets the value of the Row attribute.

Parameters:

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

This is the row index of the well, the origin is the top left corner of the plate with the first row of wells being row zero. i.e top left is (0,0) The combination of Row, Column has to be unique for each well in a plate.

function setRow¶

public void setRow(
    NonNegativeInt_Type value
)

Sets the value of the Row attribute.

Parameters:

value The value to set

This is the row index of the well, the origin is the top left corner of the plate with the first row of wells being row zero. i.e top left is (0,0) The combination of Row, Column has to be unique for each well in a plate.

function getRow¶

public NonNegativeInt_Type getRow()

Returns the value of the Row attribute.

Return: The value of the attribute

This is the row index of the well, the origin is the top left corner of the plate with the first row of wells being row zero. i.e top left is (0,0) The combination of Row, Column has to be unique for each well in a plate.

function resetRow¶

public void resetRow()

Resets the Row attribute to an unset state.

This is the row index of the well, the origin is the top left corner of the plate with the first row of wells being row zero. i.e top left is (0,0) The combination of Row, Column has to be unique for each well in a plate.

function hasRow¶

public boolean hasRow()

Checks whether the optional Row attribute is present.

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

This is the row index of the well, the origin is the top left corner of the plate with the first row of wells being row zero. i.e top left is (0,0) The combination of Row, Column has to be unique for each well in a plate.

function setExternalDescription¶

public void setExternalDescription(
    String value,
    boolean validate
)

Sets the value of the ExternalDescription attribute.

Parameters:

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

A description of the externally defined identifier for this plate.

function setExternalDescription¶

public void setExternalDescription(
    String value
)

Sets the value of the ExternalDescription attribute.

Parameters:

value The value to set

A description of the externally defined identifier for this plate.

function getExternalDescription¶

public String getExternalDescription()

Returns the value of the ExternalDescription attribute.

Return: The value of the attribute

A description of the externally defined identifier for this plate.

function resetExternalDescription¶

function hasExternalDescription¶

public boolean hasExternalDescription()

Checks whether the ExternalDescription attribute is present.

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

A description of the externally defined identifier for this plate.

function setExternalIdentifier¶

public void setExternalIdentifier(
    String value,
    boolean validate
)

Sets the value of the ExternalIdentifier attribute.

Parameters:

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

The ExternalIdentifier attribute may contain a reference to an external database.

function setExternalIdentifier¶

public void setExternalIdentifier(
    String value
)

Sets the value of the ExternalIdentifier attribute.

Parameters:

value The value to set

The ExternalIdentifier attribute may contain a reference to an external database.

function getExternalIdentifier¶

public String getExternalIdentifier()

Returns the value of the ExternalIdentifier attribute.

Return: The value of the attribute

The ExternalIdentifier attribute may contain a reference to an external database.

function resetExternalIdentifier¶

function hasExternalIdentifier¶

public boolean hasExternalIdentifier()

Checks whether the ExternalIdentifier attribute is present.

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

The ExternalIdentifier attribute may contain a reference to an external database.

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

public void setColor(
    Color_Type value,
    boolean validate
)

Sets the value of the Color 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 setColor¶

function getColor¶

function resetColor¶

function hasColor¶

public boolean hasColor()

Checks whether the optional Color attribute is present.

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

No description available in the XSD standard.

function setWellSample_List¶

public void setWellSample_List(
    WellSampleVector value,
    boolean validate
)

Sets the list of WellSample elements.

Parameters:

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

No description available in the XSD standard.

function setWellSample_List¶

public void setWellSample_List(
    WellSampleVector value
)

Sets the list of WellSample elements.

Parameters:

value The new list of WellSample elements

No description available in the XSD standard.

function getWellSample_List¶

function addToWellSample_List¶

public void addToWellSample_List(
    WellSample value,
    boolean validate
)

Adds a new WellSample 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 addToWellSample_List¶

function clearWellSample_List¶

function setReagentRef¶

public void setReagentRef(
    ReagentRef value,
    boolean validate
)

Sets the value of the ReagentRef 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 setReagentRef¶

function getReagentRef¶

function resetReagentRef¶

function hasReagentRef¶

public boolean hasReagentRef()

Checks whether the optional ReagentRef element is present.

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

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¶

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

public static StringSet getExternalDescriptionAllowedValues()

Returns the allowed values for this attribut.

Return: The list of allowed values

A description of the externally defined identifier for this plate.

function getExternalIdentifierAllowedValues¶

public static StringSet getExternalIdentifierAllowedValues()

Returns the allowed values for this attribut.

Return: The list of allowed values

The ExternalIdentifier attribute may contain a reference to an external database.