public abstract class Reference extends AbstractOMEModelObject
Modifier and Type | Field and Description |
---|---|
private static org.slf4j.Logger |
LOGGER
Logger for this class.
|
static String |
NAMESPACE |
Constructor and Description |
---|
Reference()
Default constructor.
|
Reference(Element element,
OMEModel model)
Constructs Reference recursively from an XML DOM tree.
|
Reference(Reference orig)
Copy constructor.
|
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 Reference_element)
Takes the entire object hierarchy and produced an XML DOM tree taking
into account class hierarchy.
|
abstract 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(String id)
Sets the reference's target object ID.
|
void |
update(Element element,
OMEModel model)
Updates Reference recursively from an XML DOM tree.
|
getChildrenByTagName, stripNamespacePrefix
public static final String NAMESPACE
private static final org.slf4j.Logger LOGGER
public Reference()
public Reference(Element element, OMEModel model) throws EnumerationException
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.EnumerationException
- If there is an error instantiating an
enumeration during model object creation.public Reference(Reference orig)
public abstract String getID()
public abstract void setID(String id)
id
- The object ID to set.public void update(Element element, OMEModel model) throws EnumerationException
update
in interface OMEModelObject
update
in class AbstractOMEModelObject
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.EnumerationException
- If there is an error instantiating an
enumeration during model object creation.public boolean link(Reference reference, OMEModelObject o)
OMEModelObject
link
in interface OMEModelObject
link
in class AbstractOMEModelObject
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.true
if this model object was able to handle the
reference, false
otherwise.public Element asXMLElement(Document document)
OMEModelObject
asXMLElement
in interface OMEModelObject
asXMLElement
in class AbstractOMEModelObject
document
- Destination document for element creation, etc.protected Element asXMLElement(Document document, Element Reference_element)
AbstractOMEModelObject
asXMLElement
in class AbstractOMEModelObject
document
- Destination document for element creation, etc.Reference_element
- Element from the subclass. If null a new
element will be created of this class.element
populated with properties from this class.Copyright © 2016 Open Microscopy Environment