mpicbg.spim.data.generic

Class XmlIoAbstractSpimData<S extends AbstractSequenceDescription<?,?,?>,T extends AbstractSpimData<S>>

java.lang.Object

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

mpicbg.spim.data.generic.XmlIoAbstractSpimData<S,T>

Direct Known Subclasses:

XmlIoSpimData

public class XmlIoAbstractSpimData<S extends AbstractSequenceDescription<?,?,?>,T extends AbstractSpimData<S>>
extends XmlIoSingleton<T>

Field Summary

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

handledTags

Constructor Summary

Constructors

Constructor and Description
XmlIoAbstractSpimData(Class<T> klass, XmlIoAbstractSequenceDescription<?,S> xmlIoSequenceDescription, XmlIoViewRegistrations xmlIoViewRegistrations)

Method Summary

Modifier and Type	Method and Description
T	fromXml(org.jdom2.Element root, File xmlFile)
T	fromXml(org.jdom2.Element root, URI xmlURI)
String	getVersion(org.jdom2.Element root)
T	load(Reader xmlReader, URI xmlURI) Load SpimData from the given Reader (that can read from a local file, or S3 for example).
T	load(String xmlFilename)
protected URI	loadBasePathURI(org.jdom2.Element root, URI xmlURI)
void	save(T spimData, String xmlFilename)
void	save(T spimData, Writer xmlWriter, URI xmlURI) Write spimData to the given Writer (that can write to a local file, or S3 for example).
org.jdom2.Element	toXml(T spimData, File xmlFileDirectory)
org.jdom2.Element	toXml(T spimData, URI xmlParentURI)

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

fromXml, getTag, toXml

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlIoAbstractSpimData

public XmlIoAbstractSpimData(Class<T> klass,
                             XmlIoAbstractSequenceDescription<?,S> xmlIoSequenceDescription,
                             XmlIoViewRegistrations xmlIoViewRegistrations)

Method Detail

load

public T load(String xmlFilename)
       throws SpimDataException

Throws:

SpimDataException

load

public T load(Reader xmlReader,
              URI xmlURI)
       throws SpimDataException

Load SpimData from the given Reader (that can read from a local file, or S3 for example). The xmlURI is the URI that the xmlReader reads from, and it is used to construct the base path URI.

Throws:

SpimDataException

save

public void save(T spimData,
                 String xmlFilename)
          throws SpimDataException

Throws:

SpimDataException

save

public void save(T spimData,
                 Writer xmlWriter,
                 URI xmlURI)
          throws SpimDataException

Write spimData to the given Writer (that can write to a local file, or S3 for example). The xmlURI is the URI that the xmlWriter writes to, and it is used to construct the base path URI.

Throws:

SpimDataException

getVersion

public String getVersion(org.jdom2.Element root)

fromXml

public T fromXml(org.jdom2.Element root,
                 File xmlFile)
          throws SpimDataException

Throws:

SpimDataException

fromXml

public T fromXml(org.jdom2.Element root,
                 URI xmlURI)
          throws SpimDataException

Throws:

SpimDataException

loadBasePathURI

protected URI loadBasePathURI(org.jdom2.Element root,
                              URI xmlURI)
                       throws SpimDataIOException

Throws:

SpimDataIOException

toXml

public org.jdom2.Element toXml(T spimData,
                               File xmlFileDirectory)
                        throws SpimDataException

Throws:

SpimDataException

toXml

public org.jdom2.Element toXml(T spimData,
                               URI xmlParentURI)
                        throws SpimDataException

Throws:

SpimDataException