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
-
-
Method Summary
-
Methods inherited from class ome.xml.model.AbstractOMEModelObject
getChildrenByTagName, stripNamespacePrefix
-
-
-
-
Field Detail
-
NAMESPACE
public static final String NAMESPACE
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
Screen
public Screen()
Default constructor.
-
Screen
public Screen(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 Detail
-
update
public void update(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 interfaceOMEModelObject
- Overrides:
update
in classAbstractOMEModelObject
- 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 interfaceOMEModelObject
- Overrides:
link
in classAbstractOMEModelObject
- Parameters:
reference
- The type qualifier for the reference. This should be the corresponding reference type foro
. If, for example,o
is of typeImage
,reference
MUST be of typeImageRef
.o
- Model object to link to.- Returns:
true
if this model object was able to handle the reference,false
otherwise.
-
getID
public String getID()
-
setID
public void setID(String id)
-
getName
public String getName()
-
setName
public void setName(String name)
-
getProtocolIdentifier
public String getProtocolIdentifier()
-
setProtocolIdentifier
public void setProtocolIdentifier(String protocolIdentifier)
-
getProtocolDescription
public String getProtocolDescription()
-
setProtocolDescription
public void setProtocolDescription(String protocolDescription)
-
getReagentSetDescription
public String getReagentSetDescription()
-
setReagentSetDescription
public void setReagentSetDescription(String reagentSetDescription)
-
getReagentSetIdentifier
public String getReagentSetIdentifier()
-
setReagentSetIdentifier
public void setReagentSetIdentifier(String reagentSetIdentifier)
-
getType
public String getType()
-
setType
public void setType(String type)
-
getDescription
public String getDescription()
-
setDescription
public void setDescription(String description)
-
sizeOfReagentList
public int sizeOfReagentList()
-
clearReagentList
public void clearReagentList()
-
getReagent
public Reagent getReagent(int index)
-
addReagent
public void addReagent(Reagent reagent)
-
removeReagent
public void removeReagent(Reagent reagent)
-
sizeOfLinkedPlateList
public int sizeOfLinkedPlateList()
-
getLinkedPlate
public Plate getLinkedPlate(int index)
-
linkPlate
public boolean linkPlate(Plate o)
-
unlinkPlate
public boolean unlinkPlate(Plate o)
-
sizeOfLinkedAnnotationList
public int sizeOfLinkedAnnotationList()
-
copyLinkedAnnotationList
public 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 Element asXMLElement(Document document)
Description copied from interface:OMEModelObject
Takes the entire object hierarchy and produces an XML DOM tree.- Specified by:
asXMLElement
in interfaceOMEModelObject
- Specified by:
asXMLElement
in classAbstractOMEModelObject
- Parameters:
document
- Destination document for element creation, etc.- Returns:
- XML DOM tree root element for this model object.
-
asXMLElement
public Element asXMLElement(Document document, 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 classAbstractOMEModelObject
- Parameters:
document
- Destination document for element creation, etc.Screen_element
- Element from the subclass. Ifnull
a new element will be created of this class.- Returns:
element
populated with properties from this class.
-
-