Package ome.xml.model

Class Screen

java.lang.Object

ome.xml.model.AbstractOMEModelObject

ome.xml.model.Screen

All Implemented Interfaces:

OMEModelObject

public class Screen
extends AbstractOMEModelObject

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	NAMESPACE

Constructor Summary

Constructors

Constructor	Description
Screen()	Default constructor.
Screen(Screen orig)	Copy constructor.
Screen(org.w3c.dom.Element element, OMEModel model)	Constructs Screen recursively from an XML DOM tree.

Method Summary

Modifier and Type	Method	Description
void	addReagent(Reagent reagent)
org.w3c.dom.Element	asXMLElement(org.w3c.dom.Document document)	Takes the entire object hierarchy and produces an XML DOM tree.
org.w3c.dom.Element	asXMLElement(org.w3c.dom.Document document, org.w3c.dom.Element Screen_element)	Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.
java.util.List<Annotation>	copyLinkedAnnotationList()
java.util.List<Plate>	copyLinkedPlateList()
java.util.List<Reagent>	copyReagentList()
java.lang.String	getDescription()
java.lang.String	getID()
Annotation	getLinkedAnnotation(int index)
Plate	getLinkedPlate(int index)
java.lang.String	getName()
java.lang.String	getProtocolDescription()
java.lang.String	getProtocolIdentifier()
Reagent	getReagent(int index)
java.lang.String	getReagentSetDescription()
java.lang.String	getReagentSetIdentifier()
java.lang.String	getType()
boolean	link(Reference reference, OMEModelObject o)	Link a given OME model object to this model object.
boolean	linkAnnotation(Annotation o)
boolean	linkPlate(Plate o)
void	removeReagent(Reagent reagent)
void	setDescription(java.lang.String description)
void	setID(java.lang.String id)
Annotation	setLinkedAnnotation(int index, Annotation o)
Plate	setLinkedPlate(int index, Plate o)
void	setName(java.lang.String name)
void	setProtocolDescription(java.lang.String protocolDescription)
void	setProtocolIdentifier(java.lang.String protocolIdentifier)
Reagent	setReagent(int index, Reagent reagent)
void	setReagentSetDescription(java.lang.String reagentSetDescription)
void	setReagentSetIdentifier(java.lang.String reagentSetIdentifier)
void	setType(java.lang.String type)
int	sizeOfLinkedAnnotationList()
int	sizeOfLinkedPlateList()
int	sizeOfReagentList()
boolean	unlinkAnnotation(Annotation o)
boolean	unlinkPlate(Plate o)
void	update(org.w3c.dom.Element element, OMEModel model)	Updates Screen recursively from an XML DOM tree.

Methods inherited from class ome.xml.model.AbstractOMEModelObject

getChildrenByTagName, stripNamespacePrefix

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NAMESPACE

public static final java.lang.String NAMESPACE

See Also:

Constant Field Values

Constructor Details

Screen

public Screen()

Default constructor.

Screen

public Screen(org.w3c.dom.Element element, OMEModel model) throws EnumerationException

Constructs Screen recursively from an XML DOM tree.

Parameters:

element - Root of the XML DOM tree to construct a model object graph from.

model - Handler for the OME model which keeps track of instances and references seen during object population.

Throws:

EnumerationException - If there is an error instantiating an enumeration during model object creation.

Screen

public Screen(Screen orig)

Copy constructor.

Method Details

update

public void update(org.w3c.dom.Element element, OMEModel model) throws EnumerationException

Updates Screen recursively from an XML DOM tree. NOTE: No properties are removed, only added or updated.

Specified by:

update in interface OMEModelObject

Overrides:

update in class AbstractOMEModelObject

Parameters:

element - Root of the XML DOM tree to construct a model object graph from.

model - Handler for the OME model which keeps track of instances and references seen during object population.

Throws:

EnumerationException - If there is an error instantiating an enumeration during model object creation.

link

public boolean link(Reference reference, OMEModelObject o)

Description copied from interface: OMEModelObject

Link a given OME model object to this model object.

Specified by:

link in interface OMEModelObject

Overrides:

link in class AbstractOMEModelObject

Parameters:

reference - The type qualifier for the reference. This should be the corresponding reference type for o. If, for example, o is of type Image, reference MUST be of type ImageRef.

o - Model object to link to.

Returns:

true if this model object was able to handle the reference, false otherwise.

getID

public java.lang.String getID()

setID

public void setID(java.lang.String id)

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

getProtocolIdentifier

public java.lang.String getProtocolIdentifier()

setProtocolIdentifier

public void setProtocolIdentifier(java.lang.String protocolIdentifier)

getProtocolDescription

public java.lang.String getProtocolDescription()

setProtocolDescription

public void setProtocolDescription(java.lang.String protocolDescription)

getReagentSetDescription

public java.lang.String getReagentSetDescription()

setReagentSetDescription

public void setReagentSetDescription(java.lang.String reagentSetDescription)

getReagentSetIdentifier

public java.lang.String getReagentSetIdentifier()

setReagentSetIdentifier

public void setReagentSetIdentifier(java.lang.String reagentSetIdentifier)

getType

public java.lang.String getType()

setType

public void setType(java.lang.String type)

getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.lang.String description)

sizeOfReagentList

public int sizeOfReagentList()

copyReagentList

public java.util.List<Reagent> copyReagentList()

getReagent

public Reagent getReagent(int index)

setReagent

public Reagent setReagent(int index, Reagent reagent)

addReagent

public void addReagent(Reagent reagent)

removeReagent

public void removeReagent(Reagent reagent)

sizeOfLinkedPlateList

public int sizeOfLinkedPlateList()

copyLinkedPlateList

public java.util.List<Plate> copyLinkedPlateList()

getLinkedPlate

public Plate getLinkedPlate(int index)

setLinkedPlate

public Plate setLinkedPlate(int index, Plate o)

linkPlate

public boolean linkPlate(Plate o)

unlinkPlate

public boolean unlinkPlate(Plate o)

sizeOfLinkedAnnotationList

public int sizeOfLinkedAnnotationList()

copyLinkedAnnotationList

public java.util.List<Annotation> copyLinkedAnnotationList()

getLinkedAnnotation

public Annotation getLinkedAnnotation(int index)

setLinkedAnnotation

public Annotation setLinkedAnnotation(int index, Annotation o)

linkAnnotation

public boolean linkAnnotation(Annotation o)

unlinkAnnotation

public boolean unlinkAnnotation(Annotation o)

asXMLElement

public org.w3c.dom.Element asXMLElement(org.w3c.dom.Document document)

Description copied from interface: OMEModelObject

Takes the entire object hierarchy and produces an XML DOM tree.

Specified by:

asXMLElement in interface OMEModelObject

Specified by:

asXMLElement in class AbstractOMEModelObject

Parameters:

document - Destination document for element creation, etc.

Returns:

XML DOM tree root element for this model object.

asXMLElement

public org.w3c.dom.Element asXMLElement(org.w3c.dom.Document document, org.w3c.dom.Element Screen_element)

Description copied from class: AbstractOMEModelObject

Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.

Overrides:

asXMLElement in class AbstractOMEModelObject

Parameters:

document - Destination document for element creation, etc.

Screen_element - Element from the subclass. If null a new element will be created of this class.

Returns:

element populated with properties from this class.