de.unihalle.informatik.Alida.dataio

Class ALDDataIOManagerXmlbeans

java.lang.Object

de.unihalle.informatik.Alida.dataio.ALDDataIOManager

de.unihalle.informatik.Alida.dataio.ALDDataIOManagerXmlbeans

public class ALDDataIOManagerXmlbeans
extends ALDDataIOManager

This class implements a DataIO manager for reading/writing from xml using xmlbeans. For reading and writing, it essentially looks up the correct provider for xml using the method of its super class and invokes its method.

It does its work in collaboration with ALDDataIOXmlbeans.

Author:

posch

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	allowAdditionalFields If true additional fields/variables and so on should be tolerated by providers
private boolean	doHistory If true writeData should try to write the history to file if the object itself is written to a file
(package private) static ALDDataIOManagerXmlbeans	instance The singleton instance of this class

Fields inherited from class de.unihalle.informatik.Alida.dataio.ALDDataIOManager

debug, mapTable

Constructor Summary

Constructors

Modifier	Constructor and Description
private	ALDDataIOManagerXmlbeans() private constructor

Method Summary

Modifier and Type	Method and Description
static ALDDataIOManagerXmlbeans	getInstance() Return the single instance of this class
boolean	isAllowAdditionalFields()
boolean	isDoHistory()
static de.unihalle.informatik.Alida_xml.ALDXMLObjectType	parseXml(File file, Class<?> clazz) Parse a ALDXMLObjectType from a file using xmlbeans
Object	readData(Field field, Class<?> cl, de.unihalle.informatik.Alida_xml.ALDXMLObjectType aldXmlObject) Reads data of given class from a specified source.
static Object	readXml(File file, Class<?> clazz) Read Object from a file using xmlbeans providers
static Object	readXml(String filename, Class<?> clazz) Read Object from a file using xmlbeans providers
void	setAllowAdditionalFields(boolean allowAdditionalFields)
void	setDoHistory(boolean doHistory)
de.unihalle.informatik.Alida_xml.ALDXMLObjectType	writeData(Object obj) Writes data to the specified location.
static void	writeXml(File file, Object obj) Write the object to a file using xmlbeans providers
static void	writeXml(String filename, Object obj) Write to object to a file using xmlbeans providers

Methods inherited from class de.unihalle.informatik.Alida.dataio.ALDDataIOManager

getProvider, getProviderMap, initMapTable

Methods inherited from class java.lang.Object

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

Field Detail

doHistory

private boolean doHistory

If true writeData should try to write the history to file if the object itself is written to a file

allowAdditionalFields

private boolean allowAdditionalFields

If true additional fields/variables and so on should be tolerated by providers

instance

static final ALDDataIOManagerXmlbeans instance

The singleton instance of this class

Constructor Detail

ALDDataIOManagerXmlbeans

private ALDDataIOManagerXmlbeans()

private constructor

Method Detail

getInstance

public static ALDDataIOManagerXmlbeans getInstance()

Return the single instance of this class

Returns:

single instance

readData

public Object readData(Field field,
                       Class<?> cl,
                       de.unihalle.informatik.Alida_xml.ALDXMLObjectType aldXmlObject)
                throws ALDDataIOManagerException,
                       ALDDataIOProviderException

Reads data of given class from a specified source. If both field and cl are non-null, the class defined in field is used and cl ignored. If one of field or cl is null, the other non null argument will be used. Some objects can only be read if field is supplied, e.g. Collections.

The aldXmlObject is used to actually read the data. The interpretation is specific to the class to be read and defined by the corresponding provider class. As a minimum this xml object contains the class name of the object represented.

Parameters:

field - field of object to be returned.

cl - Class of data to be read.

aldXmlObject - xml object to read data from.

Returns:

Read data object

Throws:

ALDDataIOManagerException

ALDDataIOProviderException

writeData

public de.unihalle.informatik.Alida_xml.ALDXMLObjectType writeData(Object obj)
                                                            throws ALDDataIOManagerException,
                                                                   ALDDataIOProviderException

Writes data to the specified location. This method returns a xml object with a representation of parameters value.

Parameters:

obj - Object to write.

Returns:

ALDXMLObjectType representing the obj

Throws:

ALDDataIOManagerException

ALDDataIOProviderException

isDoHistory

public boolean isDoHistory()

Returns:

the writeHistory

setDoHistory

public void setDoHistory(boolean doHistory)

Parameters:

doHistory - the writeHistory to set

isAllowAdditionalFields

public boolean isAllowAdditionalFields()

Returns:

the allowAdditionalFields

setAllowAdditionalFields

public void setAllowAdditionalFields(boolean allowAdditionalFields)

Parameters:

allowAdditionalFields - the allowAdditionalFields to set

writeXml

public static void writeXml(String filename,
                            Object obj)
                     throws ALDDataIOProviderException,
                            ALDDataIOManagerException

Write to object to a file using xmlbeans providers

Parameters:

filename -

obj -

Throws:

ALDDataIOProviderException

ALDDataIOManagerException

writeXml

public static void writeXml(File file,
                            Object obj)
                     throws ALDDataIOProviderException,
                            ALDDataIOManagerException

Write the object to a file using xmlbeans providers

Parameters:

file -

obj -

Throws:

ALDDataIOProviderException

ALDDataIOManagerException

readXml

public static Object readXml(String filename,
                             Class<?> clazz)
                      throws org.apache.xmlbeans.XmlException,
                             ALDDataIOManagerException,
                             ALDDataIOProviderException

Read Object from a file using xmlbeans providers

Parameters:

filename -

clazz -

Returns:

Object read from XML file.

Throws:

org.apache.xmlbeans.XmlException

IOException

ALDDataIOManagerException

ALDDataIOProviderException

readXml

public static Object readXml(File file,
                             Class<?> clazz)
                      throws org.apache.xmlbeans.XmlException,
                             ALDDataIOManagerException,
                             ALDDataIOProviderException

Read Object from a file using xmlbeans providers

Parameters:

file -

clazz -

Returns:

Object read from XML file.

Throws:

org.apache.xmlbeans.XmlException

IOException

ALDDataIOManagerException

ALDDataIOProviderException

parseXml

public static de.unihalle.informatik.Alida_xml.ALDXMLObjectType parseXml(File file,
                                                                         Class<?> clazz)
                                                                  throws org.apache.xmlbeans.XmlException,
                                                                         ALDDataIOProviderException

Parse a ALDXMLObjectType from a file using xmlbeans

Parameters:

file -

clazz -

Returns:

ALDXMLObjectType read from XML file.

Throws:

org.apache.xmlbeans.XmlException

IOException

ALDDataIOManagerException

ALDDataIOProviderException