#3664 Stop using JsonObject on StructuredData (#3672)

* #3664 Stop using JsonObject on StructuredData - remove usage in Media classes - remove from depicts client - create partial network models

* #3664 Stop using JsonObject on StructuredData - allow partial mapping of polymorphic models by returning null in typeadapter

* #3664 Stop using JsonObject on StructuredData - use models for editing depicts property

* #3664 Stop using JsonObject on StructuredData - use models for sparql parent query

* #3664 Stop using JsonObject on StructuredData - fix unit test compilation

* #3664 Stop using JsonObject on StructuredData - unify sparql responses

* #3664 Stop using JsonObject on StructuredData - minor cleanup of misnamed/unused/too broad visibility

* #3664 Stop using JsonObject on StructuredData - share variable names and logic for the Sarql queries

* #3664 Stop using JsonObject on StructuredData - add error logging

Author: macgills

app/src/main/java/fr/free/nrw/commons/Media.java

@@ -7,14 +7,14 @@
 import androidx.annotation.Nullable;
 import androidx.room.Entity;
 import fr.free.nrw.commons.location.LatLng;
+import fr.free.nrw.commons.media.Depictions;
 import fr.free.nrw.commons.utils.CommonsDateUtil;
 import fr.free.nrw.commons.utils.MediaDataExtractorUtil;
 import java.text.ParseException;
 import java.util.ArrayList;
 import java.util.Date;
 import java.util.List;
 import java.util.Locale;
-import java.util.Map;
 import org.apache.commons.lang3.StringUtils;
 import org.wikipedia.dataclient.mwapi.MwQueryPage;
 import org.wikipedia.gallery.ExtMetadata;
@@ -56,7 +56,7 @@ public class Media implements Parcelable {
      * Depicts is a feature part of Structured data. Multiple Depictions can be added for an image just like categories.
      * However unlike categories depictions is multi-lingual
      */
-    private List<Map<String, String>> depictionList= new ArrayList<>();
+    private Depictions depictions;
     private boolean requestedDeletion;
     @Nullable private  LatLng coordinates;
 
@@ -305,12 +305,10 @@ public String getCaption() {
     /**
      * @return depictions associated with the current media
      */
-    public List<Map<String, String>> getDepiction() {
-        return depictionList;
+    public Depictions getDepiction() {
+        return depictions;
     }
 
-
-
     /**
      * Sets the file description.
      * @param description the new description of the file
@@ -489,8 +487,8 @@ public void setCaption(String caption) {
     }
 
     /* Sets depictions for the current media obtained fro  Wikibase API*/
-    public void setDepictionList(List<Map<String, String>> depictions) {
-        this.depictionList = depictions;
+    public void setDepictions(Depictions depictions) {
+        this.depictions = depictions;
     }
 
     public void setLocalUri(@Nullable final Uri localUri) {
@@ -509,8 +507,8 @@ public void setLicenseUrl(final String licenseUrl) {
         this.licenseUrl = licenseUrl;
     }
 
-    public List<Map<String, String>> getDepictionList() {
-        return depictionList;
+    public Depictions getDepictions() {
+        return depictions;
     }
 
     @Override
@@ -542,7 +540,7 @@ public void writeToParcel(Parcel dest, int flags) {
         dest.writeString(this.creator);
         dest.writeString(this.pageId);
         dest.writeStringList(this.categories);
-        dest.writeList(this.depictionList);
+        dest.writeParcelable(this.depictions, flags);
         dest.writeByte(this.requestedDeletion ? (byte) 1 : (byte) 0);
         dest.writeParcelable(this.coordinates, flags);
     }
@@ -568,7 +566,7 @@ protected Media(Parcel in) {
         final ArrayList<String> list = new ArrayList<>();
         in.readStringList(list);
         this.categories=list;
-        in.readList(depictionList,null);
+        in.readParcelable(Depictions.class.getClassLoader());
         this.requestedDeletion = in.readByte() != 0;
         this.coordinates = in.readParcelable(LatLng.class.getClassLoader());
     }

app/src/main/java/fr/free/nrw/commons/MediaDataExtractor.java

@@ -3,13 +3,9 @@
 import static fr.free.nrw.commons.depictions.Media.DepictedImagesFragment.PAGE_ID_PREFIX;
 
 import androidx.core.text.HtmlCompat;
-import com.google.gson.JsonArray;
-import com.google.gson.JsonObject;
+import fr.free.nrw.commons.media.Depictions;
 import fr.free.nrw.commons.media.MediaClient;
 import io.reactivex.Single;
-import java.util.ArrayList;
-import java.util.HashMap;
-import java.util.Map;
 import javax.inject.Inject;
 import javax.inject.Singleton;
 import org.jetbrains.annotations.NotNull;
@@ -24,10 +20,6 @@
 @Singleton
 public class MediaDataExtractor {
 
-  private static final int LABEL_BEGIN_INDEX = 3;
-  private static final int LABEL_END_OFFSET = 3;
-  private static final int ID_BEGIN_INDEX = 1;
-  private static final int ID_END_OFFSET = 1;
   private final MediaClient mediaClient;
 
     @Inject
@@ -53,10 +45,10 @@ public Single<Media> fetchMediaDetails(final String filename, final String pageI
 
   @NotNull
   private Media combineToMedia(final Media media, final Boolean deletionStatus, final String discussion,
-      final String caption, final JsonObject depiction) {
+      final String caption, final Depictions depictions) {
     media.setDiscussion(discussion);
     media.setCaption(caption);
-    media.setDepictionList(formatDepictions(depiction));
+    media.setDepictions(depictions);
     if (deletionStatus) {
         media.setRequestedDeletion(true);
     }
@@ -75,39 +67,12 @@ private Single<String> getCaption(final String wikibaseIdentifier) {
     }
 
     /**
-     * From the Json Object extract depictions into an array list
-     * @param mediaResponse
-     * @return List containing map for depictions, the map has two keys,
-     *  first key is for the label and second is for the url of the item
-     */
-    private ArrayList<Map<String, String>> formatDepictions(final JsonObject mediaResponse) {
-        try {
-            final JsonArray depictionArray = (JsonArray) mediaResponse.get("Depiction");
-            final ArrayList<Map<String, String>> depictedItemList = new ArrayList<>();
-            for (int i = 0; i <depictionArray.size() ; i++) {
-                final JsonObject depictedItem = (JsonObject) depictionArray.get(i);
-                final Map <String, String> depictedObject = new HashMap<>();
-                final String label = depictedItem.get("label").toString();
-                final String id =  depictedItem.get("id").toString();
-                final String transformedLabel = label.substring(LABEL_BEGIN_INDEX, label.length()- LABEL_END_OFFSET);
-                final String transformedId = id.substring(ID_BEGIN_INDEX,id.length() - ID_END_OFFSET);
-                depictedObject.put("label", transformedLabel); //remove the additional characters obtained in label and ID object to extract the relevant string (since the string also contains extra quites that are not required)
-                depictedObject.put("id", transformedId);
-                depictedItemList.add(depictedObject);
-            }
-            return depictedItemList;
-        } catch (final ClassCastException | NullPointerException ignore) {
-            return new ArrayList<>();
-        }
-    }
-
-    /**
-     * Fetch caption and depictions from the MediaWiki API
+     * Fetch depictions from the MediaWiki API
      * @param filename the filename we will return the caption for
-     * @return a map containing caption and depictions (empty string in the map if no caption/depictions)
+     * @return Depictions
      */
- private Single<JsonObject> getDepictions(final String filename)  {
-         return mediaClient.getCaptionAndDepictions(filename)
+ private Single<Depictions> getDepictions(final String filename)  {
+         return mediaClient.getDepictions(filename)
              .doOnError(throwable -> Timber.e(throwable, "error while fetching depictions"));
     }
 

app/src/main/java/fr/free/nrw/commons/db/Converters.java

@@ -7,6 +7,7 @@
 import fr.free.nrw.commons.CommonsApplication;
 import fr.free.nrw.commons.di.ApplicationlessInjection;
 import fr.free.nrw.commons.location.LatLng;
+import fr.free.nrw.commons.media.Depictions;
 import fr.free.nrw.commons.upload.WikidataPlace;
 import fr.free.nrw.commons.upload.structure.depictions.DepictedItem;
 import java.util.Date;
@@ -72,16 +73,6 @@ public static LatLng stringToLatLng(String objectList) {
         return readObjectFromString(objectList,LatLng.class);
     }
 
-    @TypeConverter
-    public static String listOfMapToString(List<Map<String,String>> listOfMaps) {
-        return writeObjectToString(listOfMaps);
-    }
-
-    @TypeConverter
-    public static List<Map<String,String>> stringToListOfMap(String listOfMaps) {
-        return readObjectWithTypeToken(listOfMaps, new TypeToken<List<Map<String, String>>>() {});
-    }
-
     @TypeConverter
     public static String wikidataPlaceToString(WikidataPlace wikidataPlace) {
         return writeObjectToString(wikidataPlace);
@@ -102,6 +93,16 @@ public static List<DepictedItem> stringToList(String depictedItems) {
         return readObjectWithTypeToken(depictedItems, new TypeToken<List<DepictedItem>>() {});
     }
 
+    @TypeConverter
+    public static String depictionsToString(Depictions depictedItems) {
+        return writeObjectToString(depictedItems);
+    }
+
+    @TypeConverter
+    public static Depictions stringToDepictions(String depictedItems) {
+        return readObjectFromString(depictedItems, Depictions.class);
+    }
+
     private static String writeObjectToString(Object object) {
         return object == null ? null : getGson().toJson(object);
     }

app/src/main/java/fr/free/nrw/commons/depictions/DepictionModule.java

@@ -4,8 +4,8 @@
 import dagger.Module;
 import fr.free.nrw.commons.depictions.Media.DepictedImagesContract;
 import fr.free.nrw.commons.depictions.Media.DepictedImagesPresenter;
-import fr.free.nrw.commons.depictions.SubClass.SubDepictionListContract;
-import fr.free.nrw.commons.depictions.SubClass.SubDepictionListPresenter;
+import fr.free.nrw.commons.depictions.subClass.SubDepictionListContract;
+import fr.free.nrw.commons.depictions.subClass.SubDepictionListPresenter;
 
 /**
  * The Dagger Module for explore:depictions related presenters and (some other objects maybe in future)