Package ome.xml.model
Class Annotation
java.lang.Object
ome.xml.model.AbstractOMEModelObject
ome.xml.model.Annotation
- All Implemented Interfaces:
OMEModelObject
- Direct Known Subclasses:
BasicAnnotation,ListAnnotation,MapAnnotation,TextAnnotation,TypeAnnotation
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor.Annotation(Annotation orig) Copy constructor.Annotation(Element element, OMEModel model) Constructs Annotation recursively from an XML DOM tree. -
Method Summary
Modifier and TypeMethodDescriptionasXMLElement(Document document) Takes the entire object hierarchy and produces an XML DOM tree.asXMLElement(Document document, Element Annotation_element) Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.getID()getLinkedAnnotation(int index) getLinkedChannel(int index) getLinkedDataset(int index) getLinkedDetector(int index) getLinkedDichroic(int index) getLinkedExperimenter(int index) getLinkedExperimenterGroup(int index) getLinkedFilter(int index) getLinkedFolder(int index) getLinkedImage(int index) getLinkedInstrument(int index) getLinkedLightPath(int index) getLinkedLightSource(int index) getLinkedObjective(int index) getLinkedPlane(int index) getLinkedPlate(int index) getLinkedPlateAcquisition(int index) getLinkedProject(int index) getLinkedReagent(int index) getLinkedROI(int index) getLinkedScreen(int index) getLinkedShape(int index) getLinkedWell(int index) booleanlink(Reference reference, OMEModelObject o) Link a given OME model object to this model object.booleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanlinkFilter(Filter o) booleanlinkFolder(Folder o) booleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanlinkScreen(Screen o) booleanbooleanvoidsetAnnotator(String annotator) voidsetDescription(String description) voidsetLinkedAnnotation(int index, Annotation o) setLinkedChannel(int index, Channel o) setLinkedDataset(int index, Dataset o) setLinkedDetector(int index, Detector o) setLinkedDichroic(int index, Dichroic o) setLinkedExperimenter(int index, Experimenter o) setLinkedExperimenterGroup(int index, ExperimenterGroup o) setLinkedFilter(int index, Filter o) setLinkedFolder(int index, Folder o) setLinkedImage(int index, Image o) setLinkedInstrument(int index, Instrument o) setLinkedLightPath(int index, LightPath o) setLinkedLightSource(int index, LightSource o) setLinkedObjective(int index, Objective o) setLinkedPlane(int index, Plane o) setLinkedPlate(int index, Plate o) setLinkedPlateAcquisition(int index, PlateAcquisition o) setLinkedProject(int index, Project o) setLinkedReagent(int index, Reagent o) setLinkedROI(int index, ROI o) setLinkedScreen(int index, Screen o) setLinkedShape(int index, Shape o) setLinkedWell(int index, Well o) voidsetNamespace(String namespace) intintintintintintintintintintintintintintintintintintintintintintintbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanunlinkImage(Image o) booleanbooleanbooleanbooleanbooleanunlinkPlane(Plane o) booleanunlinkPlate(Plate o) booleanbooleanbooleanbooleanbooleanbooleanunlinkShape(Shape o) booleanunlinkWell(Well o) voidUpdates Annotation recursively from an XML DOM tree.Methods inherited from class ome.xml.model.AbstractOMEModelObject
getChildrenByTagName, stripNamespacePrefix
-
Field Details
-
NAMESPACE
- See Also:
-
-
Constructor Details
-
Annotation
public Annotation()Default constructor. -
Annotation
Constructs Annotation 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.
-
Annotation
Copy constructor.
-
-
Method Details
-
update
Updates Annotation recursively from an XML DOM tree. NOTE: No properties are removed, only added or updated.- Specified by:
updatein interfaceOMEModelObject- Overrides:
updatein 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:OMEModelObjectLink a given OME model object to this model object.- Specified by:
linkin interfaceOMEModelObject- Overrides:
linkin classAbstractOMEModelObject- Parameters:
reference- The type qualifier for the reference. This should be the corresponding reference type foro. If, for example,ois of typeImage,referenceMUST be of typeImageRef.o- Model object to link to.- Returns:
trueif this model object was able to handle the reference,falseotherwise.
-
getID
-
setID
-
getNamespace
-
setNamespace
-
getAnnotator
-
setAnnotator
-
getDescription
-
setDescription
-
sizeOfLinkedAnnotationList
public int sizeOfLinkedAnnotationList() -
copyLinkedAnnotationList
-
getLinkedAnnotation
-
setLinkedAnnotation
-
linkAnnotation
-
unlinkAnnotation
-
sizeOfLinkedImageList
public int sizeOfLinkedImageList() -
copyLinkedImageList
-
getLinkedImage
-
setLinkedImage
-
linkImage
-
unlinkImage
-
sizeOfLinkedPlaneList
public int sizeOfLinkedPlaneList() -
copyLinkedPlaneList
-
getLinkedPlane
-
setLinkedPlane
-
linkPlane
-
unlinkPlane
-
sizeOfLinkedChannelList
public int sizeOfLinkedChannelList() -
copyLinkedChannelList
-
getLinkedChannel
-
setLinkedChannel
-
linkChannel
-
unlinkChannel
-
sizeOfLinkedInstrumentList
public int sizeOfLinkedInstrumentList() -
copyLinkedInstrumentList
-
getLinkedInstrument
-
setLinkedInstrument
-
linkInstrument
-
unlinkInstrument
-
sizeOfLinkedLightSourceList
public int sizeOfLinkedLightSourceList() -
copyLinkedLightSourceList
-
getLinkedLightSource
-
setLinkedLightSource
-
linkLightSource
-
unlinkLightSource
-
sizeOfLinkedProjectList
public int sizeOfLinkedProjectList() -
copyLinkedProjectList
-
getLinkedProject
-
setLinkedProject
-
linkProject
-
unlinkProject
-
sizeOfLinkedExperimenterGroupList
public int sizeOfLinkedExperimenterGroupList() -
copyLinkedExperimenterGroupList
-
getLinkedExperimenterGroup
-
setLinkedExperimenterGroup
-
linkExperimenterGroup
-
unlinkExperimenterGroup
-
sizeOfLinkedDatasetList
public int sizeOfLinkedDatasetList() -
copyLinkedDatasetList
-
getLinkedDataset
-
setLinkedDataset
-
linkDataset
-
unlinkDataset
-
sizeOfLinkedExperimenterList
public int sizeOfLinkedExperimenterList() -
copyLinkedExperimenterList
-
getLinkedExperimenter
-
setLinkedExperimenter
-
linkExperimenter
-
unlinkExperimenter
-
sizeOfLinkedFolderList
public int sizeOfLinkedFolderList() -
copyLinkedFolderList
-
getLinkedFolder
-
setLinkedFolder
-
linkFolder
-
unlinkFolder
-
sizeOfLinkedObjectiveList
public int sizeOfLinkedObjectiveList() -
copyLinkedObjectiveList
-
getLinkedObjective
-
setLinkedObjective
-
linkObjective
-
unlinkObjective
-
sizeOfLinkedDetectorList
public int sizeOfLinkedDetectorList() -
copyLinkedDetectorList
-
getLinkedDetector
-
setLinkedDetector
-
linkDetector
-
unlinkDetector
-
sizeOfLinkedFilterList
public int sizeOfLinkedFilterList() -
copyLinkedFilterList
-
getLinkedFilter
-
setLinkedFilter
-
linkFilter
-
unlinkFilter
-
sizeOfLinkedDichroicList
public int sizeOfLinkedDichroicList() -
copyLinkedDichroicList
-
getLinkedDichroic
-
setLinkedDichroic
-
linkDichroic
-
unlinkDichroic
-
sizeOfLinkedLightPathList
public int sizeOfLinkedLightPathList() -
copyLinkedLightPathList
-
getLinkedLightPath
-
setLinkedLightPath
-
linkLightPath
-
unlinkLightPath
-
sizeOfLinkedROIList
public int sizeOfLinkedROIList() -
copyLinkedROIList
-
getLinkedROI
-
setLinkedROI
-
linkROI
-
unlinkROI
-
sizeOfLinkedShapeList
public int sizeOfLinkedShapeList() -
copyLinkedShapeList
-
getLinkedShape
-
setLinkedShape
-
linkShape
-
unlinkShape
-
sizeOfLinkedPlateList
public int sizeOfLinkedPlateList() -
copyLinkedPlateList
-
getLinkedPlate
-
setLinkedPlate
-
linkPlate
-
unlinkPlate
-
sizeOfLinkedReagentList
public int sizeOfLinkedReagentList() -
copyLinkedReagentList
-
getLinkedReagent
-
setLinkedReagent
-
linkReagent
-
unlinkReagent
-
sizeOfLinkedScreenList
public int sizeOfLinkedScreenList() -
copyLinkedScreenList
-
getLinkedScreen
-
setLinkedScreen
-
linkScreen
-
unlinkScreen
-
sizeOfLinkedPlateAcquisitionList
public int sizeOfLinkedPlateAcquisitionList() -
copyLinkedPlateAcquisitionList
-
getLinkedPlateAcquisition
-
setLinkedPlateAcquisition
-
linkPlateAcquisition
-
unlinkPlateAcquisition
-
sizeOfLinkedWellList
public int sizeOfLinkedWellList() -
copyLinkedWellList
-
getLinkedWell
-
setLinkedWell
-
linkWell
-
unlinkWell
-
asXMLElement
Description copied from interface:OMEModelObjectTakes the entire object hierarchy and produces an XML DOM tree.- Specified by:
asXMLElementin interfaceOMEModelObject- Specified by:
asXMLElementin classAbstractOMEModelObject- Parameters:
document- Destination document for element creation, etc.- Returns:
- XML DOM tree root element for this model object.
-
asXMLElement
Description copied from class:AbstractOMEModelObjectTakes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.- Overrides:
asXMLElementin classAbstractOMEModelObject- Parameters:
document- Destination document for element creation, etc.Annotation_element- Element from the subclass. Ifnulla new element will be created of this class.- Returns:
elementpopulated with properties from this class.
-