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

Field Summary

Fields

Modifier and Type	Field and Description
private List<Annotation>	annotationLinks
private List<Dataset>	datasets
private String	email
private List<ExperimenterGroup>	experimenterGroupLinks
private List<Experiment>	experiments
private String	firstName
private String	id
private List<Image>	images
private String	institution
private String	lastName
private static org.slf4j.Logger	LOGGER Logger for this class.
private List<MicrobeamManipulation>	microbeamManipulations
private String	middleName
static String	NAMESPACE
private List<Project>	projects
private String	userName

Constructor Summary

Constructors

Constructor and Description
Experimenter() Default constructor.
Experimenter(Element element, OMEModel model) Constructs Experimenter recursively from an XML DOM tree.
Experimenter(Experimenter orig) Copy constructor.

Method Summary

Methods

Modifier and Type	Method and Description
Element	asXMLElement(Document document) Takes the entire object hierarchy and produces an XML DOM tree.
protected Element	asXMLElement(Document document, Element Experimenter_element) Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.
List<Annotation>	copyLinkedAnnotationList()
List<Dataset>	copyLinkedDatasetList()
List<ExperimenterGroup>	copyLinkedExperimenterGroupList()
List<Experiment>	copyLinkedExperimentList()
List<Image>	copyLinkedImageList()
List<MicrobeamManipulation>	copyLinkedMicrobeamManipulationList()
List<Project>	copyLinkedProjectList()
String	getEmail()
String	getFirstName()
String	getID()
String	getInstitution()
String	getLastName()
Annotation	getLinkedAnnotation(int index)
Dataset	getLinkedDataset(int index)
Experiment	getLinkedExperiment(int index)
ExperimenterGroup	getLinkedExperimenterGroup(int index)
Image	getLinkedImage(int index)
MicrobeamManipulation	getLinkedMicrobeamManipulation(int index)
Project	getLinkedProject(int index)
String	getMiddleName()
String	getUserName()
boolean	link(Reference reference, OMEModelObject o) Link a given OME model object to this model object.
boolean	linkAnnotation(Annotation o)
boolean	linkDataset(Dataset o)
boolean	linkExperiment(Experiment o)
boolean	linkExperimenterGroup(ExperimenterGroup o)
boolean	linkImage(Image o)
boolean	linkMicrobeamManipulation(MicrobeamManipulation o)
boolean	linkProject(Project o)
void	setEmail(String email)
void	setFirstName(String firstName)
void	setID(String id)
void	setInstitution(String institution)
void	setLastName(String lastName)
Annotation	setLinkedAnnotation(int index, Annotation o)
Dataset	setLinkedDataset(int index, Dataset o)
Experiment	setLinkedExperiment(int index, Experiment o)
ExperimenterGroup	setLinkedExperimenterGroup(int index, ExperimenterGroup o)
Image	setLinkedImage(int index, Image o)
MicrobeamManipulation	setLinkedMicrobeamManipulation(int index, MicrobeamManipulation o)
Project	setLinkedProject(int index, Project o)
void	setMiddleName(String middleName)
void	setUserName(String userName)
int	sizeOfLinkedAnnotationList()
int	sizeOfLinkedDatasetList()
int	sizeOfLinkedExperimenterGroupList()
int	sizeOfLinkedExperimentList()
int	sizeOfLinkedImageList()
int	sizeOfLinkedMicrobeamManipulationList()
int	sizeOfLinkedProjectList()
boolean	unlinkAnnotation(Annotation o)
boolean	unlinkDataset(Dataset o)
boolean	unlinkExperiment(Experiment o)
boolean	unlinkExperimenterGroup(ExperimenterGroup o)
boolean	unlinkImage(Image o)
boolean	unlinkMicrobeamManipulation(MicrobeamManipulation o)
boolean	unlinkProject(Project o)
void	update(Element element, OMEModel model) Updates Experimenter 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 Detail

NAMESPACE

public static final String NAMESPACE

See Also:

Constant Field Values

LOGGER

private static final org.slf4j.Logger LOGGER

Logger for this class.

email

private String email

userName

private String userName

firstName

private String firstName

middleName

private String middleName

lastName

private String lastName

id

private String id

institution

private String institution

annotationLinks

private List<Annotation> annotationLinks

images

private List<Image> images

microbeamManipulations

private List<MicrobeamManipulation> microbeamManipulations

projects

private List<Project> projects

experimenterGroupLinks

private List<ExperimenterGroup> experimenterGroupLinks

datasets

private List<Dataset> datasets

experiments

private List<Experiment> experiments

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 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.

getEmail

public String getEmail()

setEmail

public void setEmail(String email)

getUserName

public String getUserName()

setUserName

public void setUserName(String userName)

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)

getID

public String getID()

setID

public void setID(String id)

getInstitution

public String getInstitution()

setInstitution

public void setInstitution(String institution)

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()

copyLinkedImageList

public List<Image> copyLinkedImageList()

getLinkedImage

public Image getLinkedImage(int index)

setLinkedImage

public Image setLinkedImage(int index,
                   Image o)

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()

copyLinkedProjectList

public List<Project> copyLinkedProjectList()

getLinkedProject

public Project getLinkedProject(int index)

setLinkedProject

public Project setLinkedProject(int index,
                       Project o)

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()

copyLinkedDatasetList

public List<Dataset> copyLinkedDatasetList()

getLinkedDataset

public Dataset getLinkedDataset(int index)

setLinkedDataset

public Dataset setLinkedDataset(int index,
                       Dataset o)

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 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

protected 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 class AbstractOMEModelObject

Parameters:

document - Destination document for element creation, etc.

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

Returns:

element populated with properties from this class.