Package org.javarosa.xform.util

Class XFormAnswerDataSerializer

java.lang.Object

org.javarosa.xform.util.XFormAnswerDataSerializer

All Implemented Interfaces:

IAnswerDataSerializer

public class XFormAnswerDataSerializer
extends Object
implements IAnswerDataSerializer

The XFormAnswerDataSerializer takes in AnswerData objects, and provides an XForms compliant (String or Element) representation of that AnswerData. By default, this serializer can properly operate on StringData, DateData MultipleItemsData, and SelectOneData AnswerData objects. This list can be extended by registering appropriate XForm serializing AnswerDataSerializers with this class.

Author:

Clayton Sims

Field Summary

Fields

Modifier and Type	Field	Description
static String	DELIMITER

Constructor Summary

Constructors

Constructor	Description
XFormAnswerDataSerializer()

Method Summary

Modifier and Type	Method	Description
boolean	canSerialize(IAnswerData data)	Identifies whether this serializer can turn the AnswerData object inside of the given element into an external format.
Boolean	containsExternalData(IAnswerData data)	Identifies whether an answer data object contains data that needs to be extracted to be handled differently than the serialized answer data.
void	registerAnswerSerializer(IAnswerDataSerializer ads)	Extends the serializing capabilities of this serializer by registering another, and allowing this serializer to operate on all of the data types that the argument can.
IDataPointer[]	retrieveExternalDataPointer(IAnswerData data)	Retrieves a pointer to external data contained in the provided answer data, if one exists.
Object	serializeAnswerData(BooleanData data)
Object	serializeAnswerData(DateData data)
Object	serializeAnswerData(DateTimeData data)
Object	serializeAnswerData(DecimalData data)
Object	serializeAnswerData(GeoPointData data)
Object	serializeAnswerData(GeoShapeData data)
Object	serializeAnswerData(GeoTraceData data)
Object	serializeAnswerData(IAnswerData data)	Serializes the given data object into a format that can be stored externally.
Object	serializeAnswerData(IAnswerData data, int dataType)	Serializes the given data object into a format that can be stored externally using the defined schemas
Object	serializeAnswerData(IntegerData data)
Object	serializeAnswerData(LongData data)
Object	serializeAnswerData(MultipleItemsData data)
Object	serializeAnswerData(MultiPointerAnswerData data)
Object	serializeAnswerData(PointerAnswerData data)
Object	serializeAnswerData(SelectOneData data)
Object	serializeAnswerData(StringData data)
Object	serializeAnswerData(TimeData data)
Object	serializeAnswerData(UncastData data)

Methods inherited from class java.lang.Object

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

Field Details

DELIMITER

public static final String DELIMITER

See Also:

Constant Field Values

Constructor Details

XFormAnswerDataSerializer

public XFormAnswerDataSerializer()

Method Details

registerAnswerSerializer

public void registerAnswerSerializer(IAnswerDataSerializer ads)

Description copied from interface: IAnswerDataSerializer

Extends the serializing capabilities of this serializer by registering another, and allowing this serializer to operate on all of the data types that the argument can.

Specified by:

registerAnswerSerializer in interface IAnswerDataSerializer

Parameters:

ads - An IAnswerDataSerializer

canSerialize

public boolean canSerialize(IAnswerData data)

Description copied from interface: IAnswerDataSerializer

Identifies whether this serializer can turn the AnswerData object inside of the given element into an external format.

Specified by:

canSerialize in interface IAnswerDataSerializer

Parameters:

data - The element whose data is to be serialzed

Returns:

true if this can meaningfully serialze the provided object. false otherwise

serializeAnswerData

public Object serializeAnswerData(UncastData data)

Parameters:

data - The AnswerDataObject to be serialized

Returns:

A String which contains the given answer

serializeAnswerData

public Object serializeAnswerData(StringData data)

Parameters:

data - The AnswerDataObject to be serialized

Returns:

A String which contains the given answer

serializeAnswerData

public Object serializeAnswerData(DateData data)

Parameters:

data - The AnswerDataObject to be serialized

Returns:

A String which contains a date in xsd:date formatting

serializeAnswerData

public Object serializeAnswerData(DateTimeData data)

Parameters:

data - The AnswerDataObject to be serialized

Returns:

A String which contains a date in xsd:date formatting

serializeAnswerData

public Object serializeAnswerData(TimeData data)

Parameters:

data - The AnswerDataObject to be serialized

Returns:

A String which contains a date in xsd:time formatting

serializeAnswerData

public Object serializeAnswerData(PointerAnswerData data)

Parameters:

data - The AnswerDataObject to be serialized

Returns:

A String which contains a reference to the data

serializeAnswerData

public Object serializeAnswerData(MultiPointerAnswerData data)

Parameters:

data - The AnswerDataObject to be serialized

Returns:

A String which contains a reference to the data

serializeAnswerData

public Object serializeAnswerData(MultipleItemsData data)

Parameters:

data - The AnswerDataObject to be serialized

Returns:

A string containing the xforms compliant format for a tag, a string containing a list of answers separated by space characters.

serializeAnswerData

public Object serializeAnswerData(SelectOneData data)

Parameters:

data - The AnswerDataObject to be serialized

Returns:

A String which contains the value of a selection

serializeAnswerData

public Object serializeAnswerData(IntegerData data)

serializeAnswerData

public Object serializeAnswerData(LongData data)

serializeAnswerData

public Object serializeAnswerData(DecimalData data)

serializeAnswerData

public Object serializeAnswerData(GeoPointData data)

serializeAnswerData

public Object serializeAnswerData(GeoTraceData data)

serializeAnswerData

public Object serializeAnswerData(GeoShapeData data)

serializeAnswerData

public Object serializeAnswerData(BooleanData data)

serializeAnswerData

public Object serializeAnswerData(IAnswerData data, int dataType)

Description copied from interface: IAnswerDataSerializer

Serializes the given data object into a format that can be stored externally using the defined schemas

Specified by:

serializeAnswerData in interface IAnswerDataSerializer

Returns:

An implementation-specific representation of the given object if canSerialize() would return true for that object. False otherwise.

serializeAnswerData

public Object serializeAnswerData(IAnswerData data)

Description copied from interface: IAnswerDataSerializer

Serializes the given data object into a format that can be stored externally.

Specified by:

serializeAnswerData in interface IAnswerDataSerializer

Parameters:

data - The element whose data is to be serialzed

Returns:

An implementation-specific representation of the given object if canSerialize() would return true for that object. False otherwise.

containsExternalData

public Boolean containsExternalData(IAnswerData data)

Description copied from interface: IAnswerDataSerializer

Identifies whether an answer data object contains data that needs to be extracted to be handled differently than the serialized answer data.

Specified by:

containsExternalData in interface IAnswerDataSerializer

Parameters:

data - The answer data that should be checked.

Returns:

True if this data contains information that can be extracted. False if it does not. Null if this serializer cannot process the data type.

retrieveExternalDataPointer

public IDataPointer[] retrieveExternalDataPointer(IAnswerData data)

Description copied from interface: IAnswerDataSerializer

Retrieves a pointer to external data contained in the provided answer data, if one exists.

Specified by:

retrieveExternalDataPointer in interface IAnswerDataSerializer

Parameters:

data - The answer data that contains the pointer. containsExternalData should return true for this data.

Returns:

An IDataPointer to an external piece of data that couldn't (or shouldn't) be serialized directly. Null if containsExternalData() does not return true for this answer data.