XmlIoEntityMap (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- mpicbg.spim.data.generic.base.XmlIoSingleton<HashMap<Integer,T>>
- - mpicbg.spim.data.generic.base.XmlIoEntityMap<T>

Type Parameters:

T - the entity type

Direct Known Subclasses:

XmlIoBasicViewSetups
```
public class XmlIoEntityMap<T extends Entity>
extends XmlIoSingleton<HashMap<Integer,T>>
```
Writes and reads collections of a specific Entity subclass as an XML section.

Author:

Tobias Pietzsch <tobias.pietzsch@gmail.com>

Field Summary
- Fields inherited from class mpicbg.spim.data.generic.base.XmlIoSingleton
  handledTags

Constructor Summary

Constructors
Constructor and Description

XmlIoEntityMap(String tag, Class<T> klass, XmlIoEntity<T> entityIo)

Constructors
Constructor and Description
`XmlIoEntityMap(String tag, Class<T> klass, XmlIoEntity<T> entityIo)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HashMap<Integer,T>`	`fromXml(org.jdom2.Element elem)` Create an object from the given element.
`org.jdom2.Element`	`toXml(Collection<T> values)` Add the values to a new `XmlIoSingleton.getTag()` element (in the iteration order of the collection).
`org.jdom2.Element`	`toXml(Map<Integer,? extends T> map)` Sort the `values` in the entity map by id and add them to a new `XmlIoSingleton.getTag()` element.

Methods inherited from class mpicbg.spim.data.generic.base.XmlIoSingleton
getTag, toXml

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - XmlIoEntityMap
```
public XmlIoEntityMap(String tag,
                      Class<T> klass,
                      XmlIoEntity<T> entityIo)
```
    Parameters:
    
    tag - the tag-name of the element written (this is the tag-name of the collection, not the entries, e.g., <ViewSetups> not <ViewSetup>
    
    klass - the class of the concrete Entity type.
    
    entityIo - a reader/writer for the concrete Entity type.
- Method Detail
  - toXml
```
public org.jdom2.Element toXml(Map<Integer,? extends T> map)
                        throws SpimDataException
```
    Sort the values in the entity map by id and add them to a new XmlIoSingleton.getTag() element.
    
    Parameters:
    
    map - maps id to entity.
    
    Throws:
    
    SpimDataException
  - toXml
```
public org.jdom2.Element toXml(Collection<T> values)
                        throws SpimDataException
```
    Add the values to a new XmlIoSingleton.getTag() element (in the iteration order of the collection).
    
    Throws:
    
    SpimDataException
  - fromXml
```
public HashMap<Integer,T> fromXml(org.jdom2.Element elem)
                           throws SpimDataException
```
    Description copied from class: XmlIoSingleton
    
    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.
    
    Overrides:
    
    fromXml in class XmlIoSingleton<HashMap<Integer,T extends Entity>>
    
    Throws:
    
    SpimDataException

Class XmlIoEntityMap<T extends Entity>

Field Summary

Fields inherited from class mpicbg.spim.data.generic.base.XmlIoSingleton

Constructor Summary

Method Summary

Methods inherited from class mpicbg.spim.data.generic.base.XmlIoSingleton

Methods inherited from class java.lang.Object

Constructor Detail

XmlIoEntityMap

Method Detail

toXml

toXml

fromXml