metadataplayer: comparison src/js/serializers/JSONSerializer.js

Mercurial Mercurial > metadataplayer / comparison

summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | comparison | raw | help

src/js/serializers/JSONSerializer.js

branch	popcorn-port
changeset 528	a5894f09825a
parent 513	4589b90fe1ad
child 536	b7e545e35287

equal deleted inserted replaced

-:90d77cc01ec0
+:a5894f09825a
+/** @class This class implement a serializer for the JSON-Cinelab format
+@params DataLoader a dataloader reference
+@url the url from which to get our cinelab
+*/
 IriSP.JSONSerializer = function(DataLoader, url) {
 IriSP.Serializer.call(this, DataLoader, url);
 };
 IriSP.JSONSerializer.prototype = new IriSP.Serializer();
+/** serialize data */
 IriSP.JSONSerializer.prototype.serialize = function(data) {
 return JSON.stringify(data);
 };
+/** deserialize data */
 IriSP.JSONSerializer.prototype.deserialize = function(data) {
 return JSON.parse(data);
 };
+/** load JSON-cinelab data and also sort the annotations by start time
+@param callback function to call when the data is ready.
+*/
 IriSP.JSONSerializer.prototype.sync = function(callback) {
 /* we don't have to do much because jQuery handles json for us */
 var self = this;
 };
 this._DataLoader.get(this._url, fn);
 };
+/** @return the metadata about the media being read FIXME: always return the first media. */
 IriSP.JSONSerializer.prototype.currentMedia = function() {
 return this._data.medias[0]; /* FIXME: don't hardcode it */
 };
-/* this function searches for an annotation which matches title, description and keyword
+/** searches for an annotation which matches title, description and keyword
 "" matches any field.
 Note: it ignores tweets.
+@return a list of matching ids.
 */
 IriSP.JSONSerializer.prototype.searchAnnotations = function(title, description, keyword) {
 /* we can have many types of annotations. We want search to only look for regular segments */
 /* the next two lines are a bit verbose because for some test data, _serializer.data.view is either
 null or undefined.
 return this.searchAnnotationsFilter(title, description, keyword, filterfn);
 };
-/*
+/**
-the previous function call this one, which is more general:
+search an annotation according to its title, description and keyword
+@param filter a function to filter the results with. Used to select between annotation types.
 */
 IriSP.JSONSerializer.prototype.searchAnnotationsFilter = function(title, description, keyword, filter) {
 var rTitle;
 var rDescription;
 }
 return ret_array;
 };
-/* breaks a string in words and searches each of these words. Returns an array
+/** breaks a string in words and searches each of these words. Returns an array
 of objects with the id of the annotation and its number of occurences.
+@param searchString a string of words.
 FIXME: optimize ? seems to be n^2 in the worst case.
 */
 IriSP.JSONSerializer.prototype.searchOccurences = function(searchString) {
 var ret = { };
 var keywords = searchString.split(/\s+/);
 };
 return ret;
 };
-/* breaks a string in words and searches each of these words. Returns an array
+/** breaks a string in words and searches each of these words. Returns an array
 of objects with the id of the annotation and its number of occurences.
 FIXME: optimize ? seems to be n^2 in the worst case.
 */
 IriSP.JSONSerializer.prototype.searchTweetsOccurences = function(searchString) {
 };
 return ret;
 };
-/* takes the currentTime and returns all the annotations that are displayable at the moment
+/** returns all the annotations that are displayable at the moment
 NB: only takes account the first type of annotations - ignores tweets
 currentTime is in seconds.
+@param currentTime the time at which we search.
 */
 IriSP.JSONSerializer.prototype.currentAnnotations = function(currentTime) {
 var view;
 var currentTimeMs = 1000 * currentTime;
 return ret_array;
 };
-/* this function returns a list of ids of tweet lines */
+/** returns a list of ids of tweet lines (aka: groups in cinelab) */
 IriSP.JSONSerializer.prototype.getTweetIds = function() {
 if (typeof(this._data.lists) === "undefined" || this._data.lists === null)
 return [];
 var tweetsId = [];
 tweetsId = IriSP.underscore.pluck(tweets[0].items, "id-ref");
 return tweetsId;
 };
-/* this function returns a list of lines which are not tweet lines */
+/** this function returns a list of lines which are not tweet lines */
 IriSP.JSONSerializer.prototype.getNonTweetIds = function() {
 if (typeof(this._data.lists) === "undefined" || this._data.lists === null)
 return [];
 /* get all the ids */

metadataplayer