ome.xml.model

Class XMLAnnotation

java.lang.Object

ome.xml.model.AbstractOMEModelObject

ome.xml.model.Annotation

ome.xml.model.TextAnnotation

ome.xml.model.XMLAnnotation

All Implemented Interfaces:

OMEModelObject

Direct Known Subclasses:

ModuloAnnotation, OriginalMetadataAnnotation

public class XMLAnnotation
extends TextAnnotation

Field Summary

Fields

Modifier and Type	Field and Description
private static org.slf4j.Logger	LOGGER Logger for this class.
static String	NAMESPACE
private StructuredAnnotations	structuredAnnotations
private String	value

Constructor Summary

Constructors

Constructor and Description
XMLAnnotation() Default constructor.
XMLAnnotation(Element element, OMEModel model) Constructs XMLAnnotation recursively from an XML DOM tree.
XMLAnnotation(XMLAnnotation 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 XMLAnnotation_element) Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.
StructuredAnnotations	getStructuredAnnotations()
String	getValue()
boolean	link(Reference reference, OMEModelObject o) Link a given OME model object to this model object.
void	setStructuredAnnotations(StructuredAnnotations structuredAnnotations_BackReference)
void	setValue(String value)
void	update(Element element, OMEModel model) Updates XMLAnnotation recursively from an XML DOM tree.

Methods inherited from class ome.xml.model.Annotation

copyLinkedAnnotationList, copyLinkedChannelList, copyLinkedDatasetList, copyLinkedDetectorList, copyLinkedDichroicList, copyLinkedExperimenterGroupList, copyLinkedExperimenterList, copyLinkedFilterList, copyLinkedFolderList, copyLinkedImageList, copyLinkedInstrumentList, copyLinkedLightPathList, copyLinkedLightSourceList, copyLinkedObjectiveList, copyLinkedPlaneList, copyLinkedPlateAcquisitionList, copyLinkedPlateList, copyLinkedProjectList, copyLinkedReagentList, copyLinkedROIList, copyLinkedScreenList, copyLinkedShapeList, copyLinkedWellList, getAnnotator, getDescription, getID, getLinkedAnnotation, getLinkedChannel, getLinkedDataset, getLinkedDetector, getLinkedDichroic, getLinkedExperimenter, getLinkedExperimenterGroup, getLinkedFilter, getLinkedFolder, getLinkedImage, getLinkedInstrument, getLinkedLightPath, getLinkedLightSource, getLinkedObjective, getLinkedPlane, getLinkedPlate, getLinkedPlateAcquisition, getLinkedProject, getLinkedReagent, getLinkedROI, getLinkedScreen, getLinkedShape, getLinkedWell, getNamespace, linkAnnotation, linkChannel, linkDataset, linkDetector, linkDichroic, linkExperimenter, linkExperimenterGroup, linkFilter, linkFolder, linkImage, linkInstrument, linkLightPath, linkLightSource, linkObjective, linkPlane, linkPlate, linkPlateAcquisition, linkProject, linkReagent, linkROI, linkScreen, linkShape, linkWell, setAnnotator, setDescription, setID, setLinkedAnnotation, setLinkedChannel, setLinkedDataset, setLinkedDetector, setLinkedDichroic, setLinkedExperimenter, setLinkedExperimenterGroup, setLinkedFilter, setLinkedFolder, setLinkedImage, setLinkedInstrument, setLinkedLightPath, setLinkedLightSource, setLinkedObjective, setLinkedPlane, setLinkedPlate, setLinkedPlateAcquisition, setLinkedProject, setLinkedReagent, setLinkedROI, setLinkedScreen, setLinkedShape, setLinkedWell, setNamespace, sizeOfLinkedAnnotationList, sizeOfLinkedChannelList, sizeOfLinkedDatasetList, sizeOfLinkedDetectorList, sizeOfLinkedDichroicList, sizeOfLinkedExperimenterGroupList, sizeOfLinkedExperimenterList, sizeOfLinkedFilterList, sizeOfLinkedFolderList, sizeOfLinkedImageList, sizeOfLinkedInstrumentList, sizeOfLinkedLightPathList, sizeOfLinkedLightSourceList, sizeOfLinkedObjectiveList, sizeOfLinkedPlaneList, sizeOfLinkedPlateAcquisitionList, sizeOfLinkedPlateList, sizeOfLinkedProjectList, sizeOfLinkedReagentList, sizeOfLinkedROIList, sizeOfLinkedScreenList, sizeOfLinkedShapeList, sizeOfLinkedWellList, unlinkAnnotation, unlinkChannel, unlinkDataset, unlinkDetector, unlinkDichroic, unlinkExperimenter, unlinkExperimenterGroup, unlinkFilter, unlinkFolder, unlinkImage, unlinkInstrument, unlinkLightPath, unlinkLightSource, unlinkObjective, unlinkPlane, unlinkPlate, unlinkPlateAcquisition, unlinkProject, unlinkReagent, unlinkROI, unlinkScreen, unlinkShape, unlinkWell

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.

value

private String value

structuredAnnotations

private StructuredAnnotations structuredAnnotations

Constructor Detail

XMLAnnotation

public XMLAnnotation()

Default constructor.

XMLAnnotation

public XMLAnnotation(Element element,
             OMEModel model)
              throws EnumerationException

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

XMLAnnotation

public XMLAnnotation(XMLAnnotation orig)

Copy constructor.

Method Detail

update

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

Updates XMLAnnotation 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 TextAnnotation

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 TextAnnotation

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.

getValue

public String getValue()

setValue

public void setValue(String value)

getStructuredAnnotations

public StructuredAnnotations getStructuredAnnotations()

setStructuredAnnotations

public void setStructuredAnnotations(StructuredAnnotations structuredAnnotations_BackReference)

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

Overrides:

asXMLElement in class TextAnnotation

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

Parameters:

document - Destination document for element creation, etc.

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

Returns:

element populated with properties from this class.