mpicbg.spim.data.generic.base

Class XmlIoEntity<T extends Entity>

java.lang.Object

mpicbg.spim.data.generic.base.XmlIoEntity<T>

Type Parameters:

T - the entity type

Direct Known Subclasses:

XmlIoBasicViewSetup, XmlIoNamedEntity

public class XmlIoEntity<T extends Entity>
extends Object

Writes and reads objects of a specific subclass of Entity as XML elements. When reading/writing an object, XmlIoEntity takes care of the id of the object. Other attributes are handled in derived classes. Derived classes should add the tag names of children that they handle to the set handledTags. When reading an object from an XML element, unhandled children of the element are stored as associated with the objects id. When writing an object with the same id to an XML element these children will be added. This provides a way to read / modify / write spimdata XML files without knowing the details of possible extensions.

Author:

Tobias Pietzsch <tobias.pietzsch@gmail.com>

Field Summary

Fields

Modifier and Type	Field and Description
protected HashSet<String>	handledTags

Constructor Summary

Constructors

Constructor and Description
XmlIoEntity(String tag, Class<T> klass) Construct a XmlIoEntity that writes and reads objects of the specified Class as XML elements with the specified tag name.

Method Summary

Modifier and Type	Method and Description
T	fromXml(org.jdom2.Element elem) Create an object from the given element.
Class<T>	getEntityClass()
String	getTag() Get the tag name of the XML element that is written by this XmlIoEntity.
org.jdom2.Element	toXml(T object) Create an XML element from the given object.

Methods inherited from class java.lang.Object

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

Field Detail

handledTags

protected final HashSet<String> handledTags

Constructor Detail

XmlIoEntity

public XmlIoEntity(String tag,
                   Class<T> klass)

Construct a XmlIoEntity that writes and reads objects of the specified Class as XML elements with the specified tag name. This reads/writes the id of the object. Other attributes are handled in derived classes.

Parameters:

tag - the tag name of the XML elements that are written by this XmlIoEntity.

klass - the class of the objects that are read by this XmlIoEntity.

Method Detail

getTag

public String getTag()

Get the tag name of the XML element that is written by this XmlIoEntity.

Returns:

the tag name of the XML elements that is written.

toXml

public org.jdom2.Element toXml(T object)

Create an XML element from the given object.

fromXml

public T fromXml(org.jdom2.Element elem)
          throws SpimDataException

Create an object from the given element. Unhandled children of the element are stored as associated with the objects id and added to any XML element created for that id.

Throws:

SpimDataException

getEntityClass

public Class<T> getEntityClass()