org.freehep.xml.io
Interface XMLIO

All Known Implementing Classes:

XMLIOFile

public interface XMLIO

Interface to for objects that can be save/restore to/from xml.

Version:

1.0

Author:

turri

Source Code:

XMLIO.java

Method Summary

void	restore(XMLIOManager xmlioManager, org.jdom.Element nodeEl) Restore the object configuration.
void	save(XMLIOManager xmlioManager, org.jdom.Element nodeEl) Save the current configuration of an object.

Method Detail

save

public void save(XMLIOManager xmlioManager,
                 org.jdom.Element nodeEl)

Save the current configuration of an object.

Parameters:

xmlioManager - The objects ID manager.

nodeEl - The jdom node containing the object's configuration info. This node is created by the XMLIOManager. Its name is, by default, the final part of the object's class. The node contains the attribute "objId", i.e. the unique id assigned to this object by the XMLIOManager. This id is used internally by the XMLIOManager for cross references to this object. The user has to append to this node all the attributes and other Elements required to save the object's configuration. Any other object, either XMLIO or Proxy-XMLIO, that needs to be saved has to be passed to the XMLIOManager through its save(Object) method.

See Also:

XMLIOManager.save(Object obj).

restore

public void restore(XMLIOManager xmlioManager,
                    org.jdom.Element nodeEl)

Restore the object configuration.

Parameters:

xmlioManager - The objects ID manager.

nodeEl - The jdom node containing the object's configuration info.