ome.xml.model

Class ROIRef

java.lang.Object

ome.xml.model.AbstractOMEModelObject

ome.xml.model.Reference

ome.xml.model.ROIRef

All Implemented Interfaces:

OMEModelObject

public class ROIRef
extends Reference

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
ROIRef() Default constructor.
ROIRef(Element element, OMEModel model) Constructs ROIRef recursively from an XML DOM tree.
ROIRef(ROIRef 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 ROIRef_element) Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.
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.
void	setID(String id) Sets the reference's target object ID.
void	update(Element element, OMEModel model) Updates ROIRef 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.

id

private String id

Constructor Detail

ROIRef

public ROIRef()

Default constructor.

ROIRef

public ROIRef(Element element,
      OMEModel model)
       throws EnumerationException

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

ROIRef

public ROIRef(ROIRef orig)

Copy constructor.

Method Detail

update

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

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

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 Reference

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.

getID

public String getID()

Description copied from class: Reference

Retrieves the reference's target object ID.

Specified by:

getID in class Reference

Returns:

See above.

setID

public void setID(String id)

Description copied from class: Reference

Sets the reference's target object ID.

Specified by:

setID in class Reference

Parameters:

id - The object ID to set.

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 Reference

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 ROIRef_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 Reference

Parameters:

document - Destination document for element creation, etc.

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

Returns:

element populated with properties from this class.