ome.xml.model

Class ExperimenterGroup

java.lang.Object

ome.xml.model.AbstractOMEModelObject

ome.xml.model.ExperimenterGroup

All Implemented Interfaces:

OMEModelObject

public class ExperimenterGroup
extends AbstractOMEModelObject

Field Summary

Fields

Modifier and Type	Field and Description
private List<Annotation>	annotationLinks
private List<Dataset>	datasets
private String	description
private List<Experimenter>	experimenterLinks
private String	id
private List<Image>	images
private List<Experimenter>	leaders
private static org.slf4j.Logger	LOGGER Logger for this class.
private String	name
static String	NAMESPACE
private List<Project>	projects

Constructor Summary

Constructors

Constructor and Description
ExperimenterGroup() Default constructor.
ExperimenterGroup(Element element, OMEModel model) Constructs ExperimenterGroup recursively from an XML DOM tree.
ExperimenterGroup(ExperimenterGroup 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 ExperimenterGroup_element) Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.
List<Annotation>	copyLinkedAnnotationList()
List<Dataset>	copyLinkedDatasetList()
List<Experimenter>	copyLinkedExperimenterList()
List<Image>	copyLinkedImageList()
List<Experimenter>	copyLinkedLeaderList()
List<Project>	copyLinkedProjectList()
String	getDescription()
String	getID()
Annotation	getLinkedAnnotation(int index)
Dataset	getLinkedDataset(int index)
Experimenter	getLinkedExperimenter(int index)
Image	getLinkedImage(int index)
Experimenter	getLinkedLeader(int index)
Project	getLinkedProject(int index)
String	getName()
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	linkExperimenter(Experimenter o)
boolean	linkImage(Image o)
boolean	linkLeader(Experimenter o)
boolean	linkProject(Project o)
void	setDescription(String description)
void	setID(String id)
Annotation	setLinkedAnnotation(int index, Annotation o)
Dataset	setLinkedDataset(int index, Dataset o)
Experimenter	setLinkedExperimenter(int index, Experimenter o)
Image	setLinkedImage(int index, Image o)
Experimenter	setLinkedLeader(int index, Experimenter o)
Project	setLinkedProject(int index, Project o)
void	setName(String name)
int	sizeOfLinkedAnnotationList()
int	sizeOfLinkedDatasetList()
int	sizeOfLinkedExperimenterList()
int	sizeOfLinkedImageList()
int	sizeOfLinkedLeaderList()
int	sizeOfLinkedProjectList()
boolean	unlinkAnnotation(Annotation o)
boolean	unlinkDataset(Dataset o)
boolean	unlinkExperimenter(Experimenter o)
boolean	unlinkImage(Image o)
boolean	unlinkLeader(Experimenter o)
boolean	unlinkProject(Project o)
void	update(Element element, OMEModel model) Updates ExperimenterGroup 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.

name

private String name

id

private String id

description

private String description

experimenterLinks

private List<Experimenter> experimenterLinks

leaders

private List<Experimenter> leaders

annotationLinks

private List<Annotation> annotationLinks

images

private List<Image> images

projects

private List<Project> projects

datasets

private List<Dataset> datasets

Constructor Detail

ExperimenterGroup

public ExperimenterGroup()

Default constructor.

ExperimenterGroup

public ExperimenterGroup(Element element,
                 OMEModel model)
                  throws EnumerationException

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

ExperimenterGroup

public ExperimenterGroup(ExperimenterGroup orig)

Copy constructor.

Method Detail

update

public void update(Element element,
          OMEModel model)
            throws EnumerationException

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

getName

public String getName()

setName

public void setName(String name)

getID

public String getID()

setID

public void setID(String id)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

sizeOfLinkedExperimenterList

public int sizeOfLinkedExperimenterList()

copyLinkedExperimenterList

public List<Experimenter> copyLinkedExperimenterList()

getLinkedExperimenter

public Experimenter getLinkedExperimenter(int index)

setLinkedExperimenter

public Experimenter setLinkedExperimenter(int index,
                                 Experimenter o)

linkExperimenter

public boolean linkExperimenter(Experimenter o)

unlinkExperimenter

public boolean unlinkExperimenter(Experimenter o)

sizeOfLinkedLeaderList

public int sizeOfLinkedLeaderList()

copyLinkedLeaderList

public List<Experimenter> copyLinkedLeaderList()

getLinkedLeader

public Experimenter getLinkedLeader(int index)

setLinkedLeader

public Experimenter setLinkedLeader(int index,
                           Experimenter o)

linkLeader

public boolean linkLeader(Experimenter o)

unlinkLeader

public boolean unlinkLeader(Experimenter 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)

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)

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)

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)

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

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

Returns:

element populated with properties from this class.