ome.xml.model

Class MapPairs

java.lang.Object

ome.xml.model.MapPairs

All Implemented Interfaces:

OMEModelObject

Direct Known Subclasses:

Map

public class MapPairs
extends Object
implements OMEModelObject

Author:

rleigh

Field Summary

Fields

Modifier and Type	Field and Description
private static org.slf4j.Logger	LOGGER Logger for this class.
static String	MAPNAMESPACE
private List<MapPair>	pairs
static String	PAIRSNAMESPACE
static String	PROPERTY_FILE
static String	VERSION Version number of this schema release.
static Properties	VERSION_PROPERTIES

Constructor Summary

Constructors

Constructor and Description
MapPairs() Default constructor.
MapPairs(Element element, OMEModel model) Constructs MapPairs recursively from an XML DOM tree.
MapPairs(List<MapPair> pairs) Copies List argument
MapPairs(MapPairs 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 pairs)
List<MapPair>	getPairs()
boolean	link(Reference reference, OMEModelObject o) Link a given OME model object to this model object.
(package private) static Properties	loadProperties()
void	update(Element element, OMEModel model) Updates the object hierarchy recursively from an XML DOM tree.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOGGER

private static final org.slf4j.Logger LOGGER

Logger for this class.

PROPERTY_FILE

public static final String PROPERTY_FILE

See Also:

Constant Field Values

VERSION_PROPERTIES

public static final Properties VERSION_PROPERTIES

VERSION

public static final String VERSION

Version number of this schema release.

MAPNAMESPACE

public static final String MAPNAMESPACE

PAIRSNAMESPACE

public static final String PAIRSNAMESPACE

pairs

private List<MapPair> pairs

Constructor Detail

MapPairs

public MapPairs()

Default constructor.

MapPairs

public MapPairs(List<MapPair> pairs)

Copies List argument

MapPairs

public MapPairs(MapPairs orig)

Copy constructor.

MapPairs

public MapPairs(Element element,
        OMEModel model)
         throws EnumerationException

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

Method Detail

loadProperties

static Properties loadProperties()

getPairs

public List<MapPair> getPairs()

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

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 pairs)

update

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

Description copied from interface: OMEModelObject

Updates the object hierarchy recursively from an XML DOM tree. NOTE: No properties are removed, only added or updated.

Specified by:

update in interface OMEModelObject

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

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.