org.sakaiproject.content.metadata.model

Interface MetadataConverter<T>

public interface MetadataConverter<T>

Allows values associated to a certain kind of metadata to be converted in the application

Author:

Colin Hebert

Method Summary

Modifier and Type	Method and Description
T	fromHttpForm(Map<String,?> parameters, String parameterSuffix) Fetches relevant information in a map (usually the parameters from a HttpServletRequest) to build an Object.
T	fromProperties(Map<String,?> properties)
T	fromString(String stringValue) Converts a String into an object of the appropriate type.
Map<String,?>	toProperties(T metaValue) Transforms the object into a properties map.
String	toString(T metaValue) Transforms the object in parameter into a simple String.

Method Detail

toString

String toString(T metaValue)

Transforms the object in parameter into a simple String. The string can be later parsed with fromString(String)

Parameters:

metaValue - Object to convert as a String

Returns:

String value of the parameter

fromString

T fromString(String stringValue)

Converts a String into an object of the appropriate type. The given String should be generated with toString(Object)

Parameters:

stringValue - String to convert into an Object

Returns:

The converted result

toProperties

Map<String,?> toProperties(T metaValue)

Transforms the object into a properties map. The map should only contain String and List<String> elements.

Parameters:

metaValue - Object to convert

Returns:

a Map containing every relevant values

fromProperties

T fromProperties(Map<String,?> properties)

fromHttpForm

T fromHttpForm(Map<String,?> parameters,
               String parameterSuffix)

Fetches relevant information in a map (usually the parameters from a HttpServletRequest) to build an Object.

Parameters:

parameters - Map containing the information

parameterSuffix - Optional suffix which can be used in HTML forms

Returns:

The converted result