XmlIoSingleton (Fiji Javadocs 0-SNAPSHOT API)

Skip navigation links

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- mpicbg.spim.data.generic.base.XmlIoSingleton<T>

Type Parameters:

T - the entity type

Direct Known Subclasses:

XmlIoAbstractSequenceDescription, XmlIoAbstractSpimData, XmlIoBoundingBoxes, XmlIoEntityMap, XmlIoMissingViews, XmlIoTimePoints, XmlIoViewInterestPoints, XmlIoViewRegistrations
```
public class XmlIoSingleton<T>
extends Object
```
Writes and reads objects of a specific class as XML elements. This is for sections in the XML that only occur once, i.e., <ViewSetups> or <ViewRegistrations>. Derived classes should add the tag names of children that they handle to the set handledTags. When reading an (the) object from an XML element, unhandled children of the element are stored. When writing an object 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
`XmlIoSingleton(String tag, Class<T> klass)` Construct a `XmlIoSingleton` that writes and reads objects of the specified `Class` as XML elements with the specified tag name.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected T`	`fromXml(org.jdom2.Element elem)` Create an object from the given element.
`String`	`getTag()` Get the tag name of the XML element that is written by this `XmlIoSingleton`.
`protected org.jdom2.Element`	`toXml()` 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
  - XmlIoSingleton
```
public XmlIoSingleton(String tag,
                      Class<T> klass)
```
    Construct a XmlIoSingleton that writes and reads objects of the specified Class as XML elements with the specified tag name. This takes care of unhandled tags.
    
    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 XmlIoSingleton.
    
    Returns:
    
    the tag name of the XML elements that is written.
  - toXml
```
protected org.jdom2.Element toXml()
```
    Create an XML element from the given object.
  - fromXml
```
protected T fromXml(org.jdom2.Element elem)
             throws SpimDataException
```
    Create an object from the given element. Unhandled children of the element are stored and added to any XML element that is created. Calling this method clears all unhandled content from previous invocations.
    
    Throws:
    
    SpimDataException

Skip navigation links

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2015–2021 Fiji. All rights reserved.