Package ome.xml.model
Class Experimenter
- java.lang.Object
-
- ome.xml.model.AbstractOMEModelObject
-
- ome.xml.model.Experimenter
-
- All Implemented Interfaces:
OMEModelObject
public class Experimenter extends AbstractOMEModelObject
-
-
Constructor Summary
Constructors Constructor Description Experimenter()
Default constructor.Experimenter(Experimenter orig)
Copy constructor.Experimenter(Element element, OMEModel model)
Constructs Experimenter recursively from an XML DOM tree.
-
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
-
Experimenter
public Experimenter()
Default constructor.
-
Experimenter
public Experimenter(Element element, OMEModel model) throws EnumerationException
Constructs Experimenter 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.
-
Experimenter
public Experimenter(Experimenter orig)
Copy constructor.
-
-
Method Detail
-
update
public void update(Element element, OMEModel model) throws EnumerationException
Updates Experimenter 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)
-
getFirstName
public String getFirstName()
-
setFirstName
public void setFirstName(String firstName)
-
getMiddleName
public String getMiddleName()
-
setMiddleName
public void setMiddleName(String middleName)
-
getLastName
public String getLastName()
-
setLastName
public void setLastName(String lastName)
-
getEmail
public String getEmail()
-
setEmail
public void setEmail(String email)
-
getInstitution
public String getInstitution()
-
setInstitution
public void setInstitution(String institution)
-
getUserName
public String getUserName()
-
setUserName
public void setUserName(String userName)
-
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)
-
sizeOfLinkedImageList
public int sizeOfLinkedImageList()
-
getLinkedImage
public Image getLinkedImage(int index)
-
linkImage
public boolean linkImage(Image o)
-
unlinkImage
public boolean unlinkImage(Image o)
-
sizeOfLinkedMicrobeamManipulationList
public int sizeOfLinkedMicrobeamManipulationList()
-
copyLinkedMicrobeamManipulationList
public List<MicrobeamManipulation> copyLinkedMicrobeamManipulationList()
-
getLinkedMicrobeamManipulation
public MicrobeamManipulation getLinkedMicrobeamManipulation(int index)
-
setLinkedMicrobeamManipulation
public MicrobeamManipulation setLinkedMicrobeamManipulation(int index, MicrobeamManipulation o)
-
linkMicrobeamManipulation
public boolean linkMicrobeamManipulation(MicrobeamManipulation o)
-
unlinkMicrobeamManipulation
public boolean unlinkMicrobeamManipulation(MicrobeamManipulation o)
-
sizeOfLinkedProjectList
public int sizeOfLinkedProjectList()
-
getLinkedProject
public Project getLinkedProject(int index)
-
linkProject
public boolean linkProject(Project o)
-
unlinkProject
public boolean unlinkProject(Project o)
-
sizeOfLinkedExperimenterGroupList
public int sizeOfLinkedExperimenterGroupList()
-
copyLinkedExperimenterGroupList
public List<ExperimenterGroup> copyLinkedExperimenterGroupList()
-
getLinkedExperimenterGroup
public ExperimenterGroup getLinkedExperimenterGroup(int index)
-
setLinkedExperimenterGroup
public ExperimenterGroup setLinkedExperimenterGroup(int index, ExperimenterGroup o)
-
linkExperimenterGroup
public boolean linkExperimenterGroup(ExperimenterGroup o)
-
unlinkExperimenterGroup
public boolean unlinkExperimenterGroup(ExperimenterGroup o)
-
sizeOfLinkedDatasetList
public int sizeOfLinkedDatasetList()
-
getLinkedDataset
public Dataset getLinkedDataset(int index)
-
linkDataset
public boolean linkDataset(Dataset o)
-
unlinkDataset
public boolean unlinkDataset(Dataset o)
-
sizeOfLinkedExperimentList
public int sizeOfLinkedExperimentList()
-
copyLinkedExperimentList
public List<Experiment> copyLinkedExperimentList()
-
getLinkedExperiment
public Experiment getLinkedExperiment(int index)
-
setLinkedExperiment
public Experiment setLinkedExperiment(int index, Experiment o)
-
linkExperiment
public boolean linkExperiment(Experiment o)
-
unlinkExperiment
public boolean unlinkExperiment(Experiment 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 Experimenter_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.Experimenter_element
- Element from the subclass. Ifnull
a new element will be created of this class.- Returns:
element
populated with properties from this class.
-
-