org.javarosa.core.model.instance.utils

Class ModelReferencePayload

java.lang.Object

org.javarosa.core.model.instance.utils.ModelReferencePayload

All Implemented Interfaces:

IDataPayload, Externalizable

public class ModelReferencePayload
extends Object
implements IDataPayload

The ModelReferencePayload essentially provides a wrapper functionality around a ModelTree to allow it to be used as a payload, but only to actually perform the various computationally expensive functions of serialization when required.

Author:

Clayton Sims

Field Summary

Fields inherited from interface org.javarosa.core.services.transport.payload.IDataPayload

PAYLOAD_TYPE_HEADER, PAYLOAD_TYPE_JPG, PAYLOAD_TYPE_MULTI, PAYLOAD_TYPE_SMS, PAYLOAD_TYPE_TEXT, PAYLOAD_TYPE_XML

Constructor Summary

Constructors

Constructor and Description
ModelReferencePayload()
ModelReferencePayload(int modelRecordId)

Method Summary

Modifier and Type	Method and Description
<T> T	accept(IDataPayloadVisitor<T> visitor) Visitor pattern accept method.
String	getDestination()
long	getLength()
String	getPayloadId()
InputStream	getPayloadStream() Gets the stream for this payload.
int	getPayloadType()
int	getTransportId()
void	readExternal(DataInputStream in, PrototypeFactory pf)
void	setDestination(String destination)
void	setSerializer(IInstanceSerializingVisitor serializer)
void	writeExternal(DataOutputStream out)

Methods inherited from class java.lang.Object

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

Constructor Detail

ModelReferencePayload

public ModelReferencePayload()

ModelReferencePayload

public ModelReferencePayload(int modelRecordId)

Method Detail

setSerializer

public void setSerializer(IInstanceSerializingVisitor serializer)

Parameters:

serializer - the serializer to set

accept

public <T> T accept(IDataPayloadVisitor<T> visitor)

Description copied from interface: IDataPayload

Visitor pattern accept method.

Specified by:

accept in interface IDataPayload

Parameters:

visitor - The visitor to visit this payload.

getLength

public long getLength()

Specified by:

getLength in interface IDataPayload

getPayloadId

public String getPayloadId()

Specified by:

getPayloadId in interface IDataPayload

Returns:

A string identifying the contents of the payload

getPayloadStream

public InputStream getPayloadStream()
                             throws IOException

Description copied from interface: IDataPayload

Gets the stream for this payload.

Specified by:

getPayloadStream in interface IDataPayload

Returns:

A stream for the data in this payload.

Throws:

IOException

getPayloadType

public int getPayloadType()

Specified by:

getPayloadType in interface IDataPayload

Returns:

The type of the data encapsulated by this payload.

readExternal

public void readExternal(DataInputStream in,
                         PrototypeFactory pf)
                  throws IOException,
                         DeserializationException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

DeserializationException

writeExternal

public void writeExternal(DataOutputStream out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

getTransportId

public int getTransportId()

Specified by:

getTransportId in interface IDataPayload

Returns:

A unique Id for the transport manager to use to be able to identify the status of transmissions related to this payload

setDestination

public void setDestination(String destination)

getDestination

public String getDestination()