ome.xml.model

Class Reference

java.lang.Object

ome.xml.model.AbstractOMEModelObject

ome.xml.model.Reference

All Implemented Interfaces:

OMEModelObject

Direct Known Subclasses:

AnnotationRef, ChannelRef, DatasetRef, DichroicRef, ExperimenterGroupRef, ExperimenterRef, ExperimentRef, FilterRef, FilterSetRef, ImageRef, InstrumentRef, Leader, MicrobeamManipulationRef, PlateRef, ProjectRef, Pump, ReagentRef, ROIRef, Settings, WellSampleRef

public abstract class Reference
extends AbstractOMEModelObject

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAMESPACE

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
org.w3c.dom.Element	asXMLElement(org.w3c.dom.Document document) Takes the entire object hierarchy and produces an XML DOM tree.
protected org.w3c.dom.Element	asXMLElement(org.w3c.dom.Document document, org.w3c.dom.Element Reference_element) Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.
abstract java.lang.String	getID() Retrieves the reference's target object ID.
boolean	link(Reference reference, OMEModelObject o) Link a given OME model object to this model object.
abstract void	setID(java.lang.String id) Sets the reference's target object ID.
void	update(org.w3c.dom.Element element, OMEModel model) Updates Reference 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 java.lang.String NAMESPACE

See Also:

Constant Field Values

Constructor Detail

Reference

public Reference()

Default constructor.

Reference

public Reference(org.w3c.dom.Element element,
         OMEModel model)
          throws EnumerationException

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

Reference

public Reference(Reference orig)

Copy constructor.

Method Detail

getID

public abstract java.lang.String getID()

Retrieves the reference's target object ID.

Returns:

See above.

setID

public abstract void setID(java.lang.String id)

Sets the reference's target object ID.

Parameters:

id - The object ID to set.

update

public void update(org.w3c.dom.Element element,
          OMEModel model)
            throws EnumerationException

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

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 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 org.w3c.dom.Element asXMLElement(org.w3c.dom.Document document,
                               org.w3c.dom.Element Reference_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.

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

Returns:

element populated with properties from this class.