Package ome.xml.model
Class Reagent
- java.lang.Object
-
- ome.xml.model.AbstractOMEModelObject
-
- ome.xml.model.Reagent
-
- All Implemented Interfaces:
OMEModelObject
public class Reagent extends AbstractOMEModelObject
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Element
asXMLElement(Document document)
Takes the entire object hierarchy and produces an XML DOM tree.Element
asXMLElement(Document document, Element Reagent_element)
Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.List<Annotation>
copyLinkedAnnotationList()
List<Well>
copyLinkedWellList()
String
getDescription()
String
getID()
Annotation
getLinkedAnnotation(int index)
Well
getLinkedWell(int index)
String
getName()
String
getReagentIdentifier()
Screen
getScreen()
boolean
link(Reference reference, OMEModelObject o)
Link a given OME model object to this model object.boolean
linkAnnotation(Annotation o)
boolean
linkWell(Well o)
void
setDescription(String description)
void
setID(String id)
Annotation
setLinkedAnnotation(int index, Annotation o)
Well
setLinkedWell(int index, Well o)
void
setName(String name)
void
setReagentIdentifier(String reagentIdentifier)
void
setScreen(Screen screen_BackReference)
int
sizeOfLinkedAnnotationList()
int
sizeOfLinkedWellList()
boolean
unlinkAnnotation(Annotation o)
boolean
unlinkWell(Well o)
void
update(Element element, OMEModel model)
Updates Reagent recursively from an XML DOM tree.-
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
-
Reagent
public Reagent()
Default constructor.
-
Reagent
public Reagent(Element element, OMEModel model) throws EnumerationException
Constructs Reagent 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.
-
Reagent
public Reagent(Reagent orig)
Copy constructor.
-
-
Method Detail
-
update
public void update(Element element, OMEModel model) throws EnumerationException
Updates Reagent 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)
-
getReagentIdentifier
public String getReagentIdentifier()
-
setReagentIdentifier
public void setReagentIdentifier(String reagentIdentifier)
-
getDescription
public String getDescription()
-
setDescription
public void setDescription(String description)
-
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)
-
getScreen
public Screen getScreen()
-
setScreen
public void setScreen(Screen screen_BackReference)
-
sizeOfLinkedWellList
public int sizeOfLinkedWellList()
-
getLinkedWell
public Well getLinkedWell(int index)
-
linkWell
public boolean linkWell(Well o)
-
unlinkWell
public boolean unlinkWell(Well 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 Reagent_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.Reagent_element
- Element from the subclass. Ifnull
a new element will be created of this class.- Returns:
element
populated with properties from this class.
-
-