org.apache.streams.data

Interface ActivityConverter<T>

All Superinterfaces:

Serializable

public interface ActivityConverter<T>
extends Serializable

Converts non-Activity documents to Activities and back.

Each converter may one, several, or zero activities.

The recommended approach for deriving multiple activities from a source document is:

1) Return one activity for each occurance of a verb, from the same ActivityConverter, if the activities are of like type.

For example, BlogShareConverter would convert a blog containing two shares into two Activities with verb: share

2) Create multiple ActivityConverters, if the activities are not of like type.

For example, a blog post that is both a post and a share should be transformed by two seperate Converters, individually or simultaneously applied.

Method Summary

Modifier and Type	Method and Description
T	fromActivity(Activity deserialized) Converts the activity to a POJO representation.
List<T>	fromActivityList(List<Activity> list) Converts multiple Activities into a list of source documents.
Class	requiredClass() What class does this ActivityConverter require?
String	serializationFormat() Gets the supported content type that can be deserialized/serialized
List<Activity>	toActivityList(List<T> list) Converts multiple documents into a list of Activity objects.
List<Activity>	toActivityList(T serialized) Converts a POJO into one or more Activities.

Method Detail

requiredClass

Class requiredClass()

What class does this ActivityConverter require?

Returns:

The class the ActivityConverter requires. Should always return the templated class.

serializationFormat

String serializationFormat()

Gets the supported content type that can be deserialized/serialized

Returns:

A string representing the format name. Can be an IETF MIME type or other

fromActivity

T fromActivity(Activity deserialized)
        throws ActivityConversionException

Converts the activity to a POJO representation.

Parameters:

deserialized - the string

Returns:

a fully populated Activity object

Throws:

ActivityConversionException

fromActivityList

List<T> fromActivityList(List<Activity> list)
                  throws ActivityConversionException

Converts multiple Activities into a list of source documents.

Parameters:

list - a typed List of documents

Returns:

a list of source documents

Throws:

ActivityConversionException

toActivityList

List<Activity> toActivityList(T serialized)
                       throws ActivityConversionException

Converts a POJO into one or more Activities.

Parameters:

serialized - the string representation

Returns:

a fully populated Activity object

Throws:

ActivityConversionException

toActivityList

List<Activity> toActivityList(List<T> list)
                       throws ActivityConversionException

Converts multiple documents into a list of Activity objects.

Parameters:

list - a typed List of documents

Returns:

a list of fully populated activities

Throws:

ActivityConversionException