org.opencastproject.metadata.dublincore

Interface MetadataCollection

public interface MetadataCollection

Method Summary

Modifier and Type	Method and Description
void	addField(MetadataField<?> metadata) Add the given MetadataField field to the metadata list
MetadataCollection	fromJSON(String json) Parse the given JSON string to extract the metadata.
List<MetadataField<?>>	getFields()
Map<String,MetadataField<?>>	getInputFields()
Map<String,MetadataField<?>>	getOutputFields()
boolean	isUpdated()
void	removeField(MetadataField<?> metadata)
com.entwinemedia.fn.data.json.JValue	toJSON() Format the metadata as JSON array
void	updateStringField(MetadataField<?> current, String value)

Method Detail

toJSON

com.entwinemedia.fn.data.json.JValue toJSON()

Format the metadata as JSON array

Returns:

a JSON array representation of the metadata

fromJSON

MetadataCollection fromJSON(String json)
                     throws MetadataParsingException

Parse the given JSON string to extract the metadata. The JSON structure must look like this:

 [
  {
     "id"        : "field id",
     "value"     : "field value",

     // The following properties should not be present as they are useless,
     // but they do not hurt for the parsing.

     "label"     : "EVENTS.SERIES.DETAILS.METADATA.LABEL",
     "type"      : "",
     // The collection can be a json object like below...
     "collection": { "id1": "value1", "id2": "value2" },
     // Or a the id of the collection available through the resource endpoint
     "collection": "USERS",
     "readOnly": false
   },

   // Additionally fields
   ...
 ]
 

Parameters:

json - A JSON array of metadata as String

Throws:

MetadataParsingException - if the JSON structure is not correct

IllegalArgumentException - if the JSON string is null or empty

getInputFields

Map<String,MetadataField<?>> getInputFields()

getOutputFields

Map<String,MetadataField<?>> getOutputFields()

addField

void addField(MetadataField<?> metadata)

Add the given MetadataField field to the metadata list

Parameters:

metadata - The MetadataField field to add

Throws:

IllegalArgumentException - if the MetadataField is null

removeField

void removeField(MetadataField<?> metadata)

getFields

List<MetadataField<?>> getFields()

updateStringField

void updateStringField(MetadataField<?> current,
                       String value)

isUpdated

boolean isUpdated()