ome.xml.model.Experimenter Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ome-xml Show documentation
Show all versions of ome-xml Show documentation
OME XML model and metadata classes
/*
* #%L
* OME-XML Java library for working with OME-XML metadata structures.
* %%
* Copyright (C) 2006 - 2016 Open Microscopy Environment:
* - Massachusetts Institute of Technology
* - National Institutes of Health
* - University of Dundee
* - Board of Regents of the University of Wisconsin-Madison
* - Glencoe Software, Inc.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* The views and conclusions contained in the software and documentation are
* those of the authors and should not be interpreted as representing official
* policies, either expressed or implied, of any organization.
* #L%
*/
/*-----------------------------------------------------------------------------
*
* THIS IS AUTOMATICALLY GENERATED CODE. DO NOT MODIFY.
*
*-----------------------------------------------------------------------------
*/
package ome.xml.model;
import java.util.ArrayList;
import java.util.List;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import ome.units.quantity.Angle;
import ome.units.quantity.ElectricPotential;
import ome.units.quantity.Frequency;
import ome.units.quantity.Length;
import ome.units.quantity.Power;
import ome.units.quantity.Pressure;
import ome.units.quantity.Temperature;
import ome.units.quantity.Time;
import ome.units.unit.Unit;
import ome.xml.model.enums.*;
import ome.xml.model.enums.handlers.*;
import ome.xml.model.primitives.*;
public class Experimenter extends AbstractOMEModelObject
{
// Base: -- Name: Experimenter -- Type: Experimenter -- modelBaseType: AbstractOMEModelObject -- langBaseType: Object
// -- Constants --
public static final String NAMESPACE = "http://www.openmicroscopy.org/Schemas/OME/2016-06";
/** Logger for this class. */
private static final Logger LOGGER =
LoggerFactory.getLogger(Experimenter.class);
// -- Instance variables --
// ID property
private String id;
// FirstName property
private String firstName;
// MiddleName property
private String middleName;
// LastName property
private String lastName;
// Email property
private String email;
// Institution property
private String institution;
// UserName property
private String userName;
// AnnotationRef reference (occurs more than once)
private List annotationLinks = new ReferenceList();
// Image_BackReference back reference (occurs more than once)
private List images = new ReferenceList();
// MicrobeamManipulation_BackReference back reference (occurs more than once)
private List microbeamManipulations = new ReferenceList();
// Project_BackReference back reference (occurs more than once)
private List projects = new ReferenceList();
// ExperimenterGroup_BackReference back reference (occurs more than once)
private List experimenterGroupLinks = new ReferenceList();
// Dataset_BackReference back reference (occurs more than once)
private List datasets = new ReferenceList();
// Experiment_BackReference back reference (occurs more than once)
private List experiments = new ReferenceList();
// -- Constructors --
/** Default constructor. */
public Experimenter()
{
}
/**
* Constructs Experimenter recursively from an XML DOM tree.
* @param element Root of the XML DOM tree to construct a model object
* graph from.
* @param 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.
*/
public Experimenter(Element element, OMEModel model)
throws EnumerationException
{
update(element, model);
}
/** Copy constructor. */
public Experimenter(Experimenter orig)
{
id = orig.id;
firstName = orig.firstName;
middleName = orig.middleName;
lastName = orig.lastName;
email = orig.email;
institution = orig.institution;
userName = orig.userName;
annotationLinks = orig.annotationLinks;
images = orig.images;
microbeamManipulations = orig.microbeamManipulations;
projects = orig.projects;
experimenterGroupLinks = orig.experimenterGroupLinks;
datasets = orig.datasets;
experiments = orig.experiments;
}
// -- Custom content from Experimenter specific template --
// -- OMEModelObject API methods --
/**
* Updates Experimenter recursively from an XML DOM tree. NOTE: No
* properties are removed, only added or updated.
* @param element Root of the XML DOM tree to construct a model object
* graph from.
* @param 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.
*/
public void update(Element element, OMEModel model)
throws EnumerationException
{
super.update(element, model);
String tagName = element.getTagName();
if (!element.hasAttribute("ID") && getID() == null)
{
// TODO: Should be its own exception
throw new RuntimeException(String.format(
"Experimenter missing required ID property."));
}
if (element.hasAttribute("ID"))
{
// ID property
setID(String.valueOf(
element.getAttribute("ID")));
// Adding this model object to the model handler
model.addModelObject(getID(), this);
}
if (element.hasAttribute("FirstName"))
{
// Attribute property FirstName
setFirstName(String.valueOf(
element.getAttribute("FirstName")));
}
if (element.hasAttribute("MiddleName"))
{
// Attribute property MiddleName
setMiddleName(String.valueOf(
element.getAttribute("MiddleName")));
}
if (element.hasAttribute("LastName"))
{
// Attribute property LastName
setLastName(String.valueOf(
element.getAttribute("LastName")));
}
if (element.hasAttribute("Email"))
{
// Attribute property Email
setEmail(String.valueOf(
element.getAttribute("Email")));
}
if (element.hasAttribute("Institution"))
{
// Attribute property Institution
setInstitution(String.valueOf(
element.getAttribute("Institution")));
}
if (element.hasAttribute("UserName"))
{
// Attribute property UserName
setUserName(String.valueOf(
element.getAttribute("UserName")));
}
// Element reference AnnotationRef
List AnnotationRef_nodeList =
getChildrenByTagName(element, "AnnotationRef");
for (Element AnnotationRef_element : AnnotationRef_nodeList)
{
AnnotationRef annotationLinks_reference = new AnnotationRef();
annotationLinks_reference.setID(AnnotationRef_element.getAttribute("ID"));
model.addReference(this, annotationLinks_reference);
}
}
// -- Experimenter API methods --
public boolean link(Reference reference, OMEModelObject o)
{
if (reference instanceof AnnotationRef)
{
Annotation o_casted = (Annotation) o;
o_casted.linkExperimenter(this);
annotationLinks.add(o_casted);
return true;
}
return super.link(reference, o);
}
// Property ID
public String getID()
{
return id;
}
public void setID(String id)
{
this.id = id;
}
// Property FirstName
public String getFirstName()
{
return firstName;
}
public void setFirstName(String firstName)
{
this.firstName = firstName;
}
// Property MiddleName
public String getMiddleName()
{
return middleName;
}
public void setMiddleName(String middleName)
{
this.middleName = middleName;
}
// Property LastName
public String getLastName()
{
return lastName;
}
public void setLastName(String lastName)
{
this.lastName = lastName;
}
// Property Email
public String getEmail()
{
return email;
}
public void setEmail(String email)
{
this.email = email;
}
// Property Institution
public String getInstitution()
{
return institution;
}
public void setInstitution(String institution)
{
this.institution = institution;
}
// Property UserName
public String getUserName()
{
return userName;
}
public void setUserName(String userName)
{
this.userName = userName;
}
// Reference which occurs more than once
public int sizeOfLinkedAnnotationList()
{
return annotationLinks.size();
}
public List copyLinkedAnnotationList()
{
return new ArrayList(annotationLinks);
}
public Annotation getLinkedAnnotation(int index)
{
return annotationLinks.get(index);
}
public Annotation setLinkedAnnotation(int index, Annotation o)
{
return annotationLinks.set(index, o);
}
public boolean linkAnnotation(Annotation o)
{
o.linkExperimenter(this);
return annotationLinks.add(o);
}
public boolean unlinkAnnotation(Annotation o)
{
o.unlinkExperimenter(this);
return annotationLinks.remove(o);
}
// Reference which occurs more than once
public int sizeOfLinkedImageList()
{
return images.size();
}
public List copyLinkedImageList()
{
return new ArrayList(images);
}
public Image getLinkedImage(int index)
{
return images.get(index);
}
public Image setLinkedImage(int index, Image o)
{
return images.set(index, o);
}
public boolean linkImage(Image o)
{
return images.add(o);
}
public boolean unlinkImage(Image o)
{
return images.remove(o);
}
// Reference which occurs more than once
public int sizeOfLinkedMicrobeamManipulationList()
{
return microbeamManipulations.size();
}
public List copyLinkedMicrobeamManipulationList()
{
return new ArrayList(microbeamManipulations);
}
public MicrobeamManipulation getLinkedMicrobeamManipulation(int index)
{
return microbeamManipulations.get(index);
}
public MicrobeamManipulation setLinkedMicrobeamManipulation(int index, MicrobeamManipulation o)
{
return microbeamManipulations.set(index, o);
}
public boolean linkMicrobeamManipulation(MicrobeamManipulation o)
{
return microbeamManipulations.add(o);
}
public boolean unlinkMicrobeamManipulation(MicrobeamManipulation o)
{
return microbeamManipulations.remove(o);
}
// Reference which occurs more than once
public int sizeOfLinkedProjectList()
{
return projects.size();
}
public List copyLinkedProjectList()
{
return new ArrayList(projects);
}
public Project getLinkedProject(int index)
{
return projects.get(index);
}
public Project setLinkedProject(int index, Project o)
{
return projects.set(index, o);
}
public boolean linkProject(Project o)
{
return projects.add(o);
}
public boolean unlinkProject(Project o)
{
return projects.remove(o);
}
// Reference which occurs more than once
public int sizeOfLinkedExperimenterGroupList()
{
return experimenterGroupLinks.size();
}
public List copyLinkedExperimenterGroupList()
{
return new ArrayList(experimenterGroupLinks);
}
public ExperimenterGroup getLinkedExperimenterGroup(int index)
{
return experimenterGroupLinks.get(index);
}
public ExperimenterGroup setLinkedExperimenterGroup(int index, ExperimenterGroup o)
{
return experimenterGroupLinks.set(index, o);
}
public boolean linkExperimenterGroup(ExperimenterGroup o)
{
return experimenterGroupLinks.add(o);
}
public boolean unlinkExperimenterGroup(ExperimenterGroup o)
{
return experimenterGroupLinks.remove(o);
}
// Reference which occurs more than once
public int sizeOfLinkedDatasetList()
{
return datasets.size();
}
public List copyLinkedDatasetList()
{
return new ArrayList(datasets);
}
public Dataset getLinkedDataset(int index)
{
return datasets.get(index);
}
public Dataset setLinkedDataset(int index, Dataset o)
{
return datasets.set(index, o);
}
public boolean linkDataset(Dataset o)
{
return datasets.add(o);
}
public boolean unlinkDataset(Dataset o)
{
return datasets.remove(o);
}
// Reference which occurs more than once
public int sizeOfLinkedExperimentList()
{
return experiments.size();
}
public List copyLinkedExperimentList()
{
return new ArrayList(experiments);
}
public Experiment getLinkedExperiment(int index)
{
return experiments.get(index);
}
public Experiment setLinkedExperiment(int index, Experiment o)
{
return experiments.set(index, o);
}
public boolean linkExperiment(Experiment o)
{
return experiments.add(o);
}
public boolean unlinkExperiment(Experiment o)
{
return experiments.remove(o);
}
public Element asXMLElement(Document document)
{
return asXMLElement(document, null);
}
public Element asXMLElement(Document document, Element Experimenter_element)
{
// Creating XML block for Experimenter
if (Experimenter_element == null)
{
Experimenter_element =
document.createElementNS(NAMESPACE, "Experimenter");
}
// Ensure any base annotations add their Elements first
super.asXMLElement(document, Experimenter_element);
if (id != null)
{
// Attribute property ID
Experimenter_element.setAttribute("ID", id.toString());
}
if (firstName != null)
{
// Attribute property FirstName
Experimenter_element.setAttribute("FirstName", firstName.toString());
}
if (middleName != null)
{
// Attribute property MiddleName
Experimenter_element.setAttribute("MiddleName", middleName.toString());
}
if (lastName != null)
{
// Attribute property LastName
Experimenter_element.setAttribute("LastName", lastName.toString());
}
if (email != null)
{
// Attribute property Email
Experimenter_element.setAttribute("Email", email.toString());
}
if (institution != null)
{
// Attribute property Institution
Experimenter_element.setAttribute("Institution", institution.toString());
}
if (userName != null)
{
// Attribute property UserName
Experimenter_element.setAttribute("UserName", userName.toString());
}
if (annotationLinks != null)
{
// Reference property AnnotationRef which occurs more than once
for (Annotation annotationLinks_value : annotationLinks)
{
AnnotationRef o = new AnnotationRef();
o.setID(annotationLinks_value.getID());
Element child =
document.createElementNS(NAMESPACE, "AnnotationRef");
o.asXMLElement(document, child);
Experimenter_element.appendChild(child);
}
}
if (images != null)
{
// *** IGNORING *** Skipped back reference Image_BackReference
}
if (microbeamManipulations != null)
{
// *** IGNORING *** Skipped back reference MicrobeamManipulation_BackReference
}
if (projects != null)
{
// *** IGNORING *** Skipped back reference Project_BackReference
}
if (experimenterGroupLinks != null)
{
// *** IGNORING *** Skipped back reference ExperimenterGroup_BackReference
}
if (datasets != null)
{
// *** IGNORING *** Skipped back reference Dataset_BackReference
}
if (experiments != null)
{
// *** IGNORING *** Skipped back reference Experiment_BackReference
}
return Experimenter_element;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy