Package ome.xml.model
Class Project
java.lang.Object
ome.xml.model.AbstractOMEModelObject
ome.xml.model.Project
- All Implemented Interfaces:
OMEModelObject
public class Project extends AbstractOMEModelObject
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
NAMESPACE
-
Constructor Summary
-
Method Summary
Modifier and Type Method Description org.w3c.dom.Element
asXMLElement(org.w3c.dom.Document document)
Takes the entire object hierarchy and produces an XML DOM tree.org.w3c.dom.Element
asXMLElement(org.w3c.dom.Document document, org.w3c.dom.Element Project_element)
Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.java.util.List<Annotation>
copyLinkedAnnotationList()
java.util.List<Dataset>
copyLinkedDatasetList()
java.lang.String
getDescription()
java.lang.String
getID()
Annotation
getLinkedAnnotation(int index)
Dataset
getLinkedDataset(int index)
Experimenter
getLinkedExperimenter()
ExperimenterGroup
getLinkedExperimenterGroup()
java.lang.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)
void
linkExperimenter(Experimenter o)
void
linkExperimenterGroup(ExperimenterGroup o)
void
setDescription(java.lang.String description)
void
setID(java.lang.String id)
Annotation
setLinkedAnnotation(int index, Annotation o)
Dataset
setLinkedDataset(int index, Dataset o)
void
setName(java.lang.String name)
int
sizeOfLinkedAnnotationList()
int
sizeOfLinkedDatasetList()
boolean
unlinkAnnotation(Annotation o)
boolean
unlinkDataset(Dataset o)
void
unlinkExperimenter(Experimenter o)
void
unlinkExperimenterGroup(ExperimenterGroup o)
void
update(org.w3c.dom.Element element, OMEModel model)
Updates Project recursively from an XML DOM tree.Methods inherited from class ome.xml.model.AbstractOMEModelObject
getChildrenByTagName, stripNamespacePrefix
-
Field Details
-
NAMESPACE
public static final java.lang.String NAMESPACE- See Also:
- Constant Field Values
-
-
Constructor Details
-
Project
public Project()Default constructor. -
Project
Constructs Project 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.
-
Project
Copy constructor.
-
-
Method Details
-
update
Updates Project 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
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.
-
getName
public java.lang.String getName() -
setName
public void setName(java.lang.String name) -
getID
public java.lang.String getID() -
setID
public void setID(java.lang.String id) -
getDescription
public java.lang.String getDescription() -
setDescription
public void setDescription(java.lang.String description) -
getLinkedExperimenter
-
linkExperimenter
-
unlinkExperimenter
-
getLinkedExperimenterGroup
-
linkExperimenterGroup
-
unlinkExperimenterGroup
-
sizeOfLinkedDatasetList
public int sizeOfLinkedDatasetList() -
copyLinkedDatasetList
-
getLinkedDataset
-
setLinkedDataset
-
linkDataset
-
unlinkDataset
-
sizeOfLinkedAnnotationList
public int sizeOfLinkedAnnotationList() -
copyLinkedAnnotationList
-
getLinkedAnnotation
-
setLinkedAnnotation
-
linkAnnotation
-
unlinkAnnotation
-
asXMLElement
public org.w3c.dom.Element asXMLElement(org.w3c.dom.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 org.w3c.dom.Element asXMLElement(org.w3c.dom.Document document, org.w3c.dom.Element Project_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.Project_element
- Element from the subclass. Ifnull
a new element will be created of this class.- Returns:
element
populated with properties from this class.
-