diff --git a/openbis-ipad/BisKit/Classes/CISDOBIpadEntity.m b/openbis-ipad/BisKit/Classes/CISDOBIpadEntity.m
index 4c4450be503f309c41c4cd1a0d66ac399ba7a927..3971c593f7febccba97971570d39891768fe10c4 100644
--- a/openbis-ipad/BisKit/Classes/CISDOBIpadEntity.m
+++ b/openbis-ipad/BisKit/Classes/CISDOBIpadEntity.m
@@ -168,6 +168,18 @@ id ObjectFromJsonData(NSString *jsonDataString, NSError **error)
if (rawEntity.children) self.childrenPermIdsJson = rawEntity.children;
if (rawEntity.identifier) self.identifier = rawEntity.identifier;
if (rawEntity.imageUrl) self.imageUrlString = rawEntity.imageUrl;
+ if (rawEntity.images) {
+ NSError *error;
+ NSDictionary *imageSpecs = ObjectFromJsonData(rawEntity.images, &error);
+ if (!imageSpecs) {
+ NSLog(@"Could not parse images %@", error);
+ } else {
+ NSDictionary *marqueeImage = [imageSpecs objectForKey: @"MARQUEE"];
+ if (marqueeImage) {
+ self.imageUrlString = [marqueeImage objectForKey: @"URL"];
+ }
+ }
+ }
if (rawEntity.properties) self.propertiesJson = rawEntity.properties;
if (rawEntity.rootLevel) {
BOOL rootLevel = [rawEntity.rootLevel length] > 0;
diff --git a/openbis-ipad/BisKit/Classes/CISDOBIpadService.h b/openbis-ipad/BisKit/Classes/CISDOBIpadService.h
index 86963fff45438e572e358939cd8e4c2a682225f7..e5b94f3dca13d0a4c63af0071c66be0575df62d9 100644
--- a/openbis-ipad/BisKit/Classes/CISDOBIpadService.h
+++ b/openbis-ipad/BisKit/Classes/CISDOBIpadService.h
@@ -87,7 +87,8 @@ enum CISOBIpadServiceErrorCode {
@property(readonly) NSString *summary;
@property(readonly) NSString *children; //<! The permIds of the children as a JSON string
@property(readonly) NSString *identifier;
-@property(readonly) NSString *imageUrl;
+@property(readonly) NSString *images; //<! The image specifications as a JSON string
+@property(readonly) NSString *imageUrl; //<! Deprecated
@property(readonly) NSString *properties; //<! The properties as a JSON string.
@property(readonly) NSString *rootLevel;
diff --git a/openbis-ipad/BisKit/Classes/CISDOBIpadService.m b/openbis-ipad/BisKit/Classes/CISDOBIpadService.m
index bb6c01c4ce692b00df89d069c777a7234278f6f1..f5fe64acecb2f8744b620e8e6c27f1a26b7517d3 100644
--- a/openbis-ipad/BisKit/Classes/CISDOBIpadService.m
+++ b/openbis-ipad/BisKit/Classes/CISDOBIpadService.m
@@ -285,6 +285,7 @@ NSString *const CISDOBIpadServiceErrorDomain = @"CISDOBIpadServiceErrorDomain";
- (NSString *)summary { return [self stringContentValueAtName: @"SUMMARY"]; }
- (NSString *)children { return [self stringContentValueAtName: @"CHILDREN"]; }
- (NSString *)identifier { return [self stringContentValueAtName: @"IDENTIFIER"]; }
+- (NSString *)images { return [self stringContentValueAtName: @"IMAGES"]; }
- (NSString *)imageUrl { return [self stringContentValueAtName: @"IMAGE_URL"]; }
- (NSString *)properties { return [self stringContentValueAtName: @"PROPERTIES"]; }
- (NSString *)rootLevel { return [self stringContentValueAtName: @"ROOT_LEVEL"]; }
diff --git a/openbis-ipad/Research/BisMac.xcodeproj/project.xcworkspace/xcuserdata/cramakri.xcuserdatad/UserInterfaceState.xcuserstate b/openbis-ipad/Research/BisMac.xcodeproj/project.xcworkspace/xcuserdata/cramakri.xcuserdatad/UserInterfaceState.xcuserstate
index b75994b654ab9ecca10ce34c4715991c875443d5..dc184d9f7c658c4bdcead7d4066eb1c2b88f2c2e 100644
Binary files a/openbis-ipad/Research/BisMac.xcodeproj/project.xcworkspace/xcuserdata/cramakri.xcuserdatad/UserInterfaceState.xcuserstate and b/openbis-ipad/Research/BisMac.xcodeproj/project.xcworkspace/xcuserdata/cramakri.xcuserdatad/UserInterfaceState.xcuserstate differ
diff --git a/openbis-ipad/core-plugin/readme.md b/openbis-ipad/core-plugin/readme.md
index 30c59faa406eadf915b608c65a811e47ae4dd337..e3c215002c739b616530bf2048f06dc5193311bb 100644
--- a/openbis-ipad/core-plugin/readme.md
+++ b/openbis-ipad/core-plugin/readme.md
@@ -100,12 +100,20 @@ The iPad data model tracks information for displaying and navigating between ent
<td>Shown in detail views.</td>
<td>openBIS identifier</td>
</tr>
+<!--
<tr>
- <td>IMAGE_URL</td>
+ <td>IMAGE_URL (deprecated)</td>
<td>A url for an image associated with this entity. If None or empty, no image is shown.</td>
<td>Shown in detail views.</td>
<td>An image from the DSS. An external image.</td>
</tr>
+-->
+ <tr>
+ <td>IMAGES</td>
+ <td>A hash map containing image specifications (described below). Two keys are possible: MARQUEE, a single image specification shown in a prominant location; TILED, many image specification shown in a tiled display.</td>
+ <td>Shown in detail views.</td>
+ <td>An image from the DSS or an external image from the web.</td>
+ </tr>
<tr>
<td>PROPERTIES</td>
<td>Properties (metadata) that should be displayed for this entity. Transmitted as JSON.</td>
@@ -126,6 +134,30 @@ There are two fields in the data model that have a purpose beyond the UI. These
The `REFCON` field is a field that is not touched by the iPad app at all. The server is free to place whatever information it wishes in this field. The content of the `REFCON` is sent back to the server when the iPad makes requests for more data for an existing entity. The server can thus use the `REFCON` to keep track for itself how several openBIS entities are merged into one iPad entity, for example. The `REFCON` is updated on every request, so the service can modify this value if it is appropriate.
+Image Specification
+-------------------
+
+Image specifications describe images. They may contain either a URL for the image or the data for the image itself.
+
+<table>
+ <thead>
+ <tr>
+ <th>Key</th>
+ <th>Value</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>URL</td>
+ <td>A url to the image. The url may refer to the DSS or somewhere in the Internet.</td>
+ </tr>
+ <tr>
+ <td>DATA</td>
+ <td>A map containing the data for the image. The format has not yet been finalized, but we expect it to include the following keys: 'BASE64' (base-64 coded data for the image), 'FORMAT' (the image format, e.g., PNG, JPG, etc.).</td>
+ </tr>
+ </tbody>
+</table>
+
Communication
-------------
@@ -164,7 +196,7 @@ The communication model between the iPad and the service has been designed to tr
<td>entities : List of {"PERM_ID" : String, REFCON : String}</td>
<td>Return detail information for the specified entities.</td>
<td>Display the entity in the detail view. This should return all information necessary to show the entity</td>
- <td>PERM_ID, REFCON, SUMMARY_HEADER, SUMMARY, IDENTIFIER, IMAGE_URL, PROPERTIES</td>
+ <td>PERM_ID, REFCON, SUMMARY_HEADER, SUMMARY, IDENTIFIER, IMAGES, PROPERTIES</td>
</tr>
</tbody>
</table>
diff --git a/openbis-ipad/ipad-example-data/ipad-ui/1/dss/reporting-plugins/ipad-read-service-v1/ipad_read.py b/openbis-ipad/ipad-example-data/ipad-ui/1/dss/reporting-plugins/ipad-read-service-v1/ipad_read.py
index ac392a4336aa47b3c821369e6d215aa403f16015..7107f9881171cffc2ed6579f56e059103c08a823 100644
--- a/openbis-ipad/ipad-example-data/ipad-ui/1/dss/reporting-plugins/ipad-read-service-v1/ipad_read.py
+++ b/openbis-ipad/ipad-example-data/ipad-ui/1/dss/reporting-plugins/ipad-read-service-v1/ipad_read.py
@@ -66,8 +66,9 @@ class RequestHandler:
SUMMARY : A potentially longer summary of the entity.
CHILDREN : The permIds of the children of this entity. Transmitted as JSON.
IDENTIFIER : An identifier for the object.
- IMAGE_URL : A url for an image associated with this entity. If None or empty, no
- image is shown.
+ IMAGES : A map with keys coming from the set 'MARQUEE', 'TILED'. The values are image specs or lists of image specs.
+ Image specs are maps with the keys: 'URL' (a URL for the iamge) or 'DATA'. The data key contains a map that
+ includes the image data and may include some image metadata as well. This format has not yet been specified.
PROPERTIES : Properties (metadata) that should be displayed for this entity. Transmitted as JSON.
ROOT_LEVEL : True if the entity should be shown on the root level.
@@ -100,7 +101,7 @@ class AllDataRequestHandler(RequestHandler):
"""Abstract Handler for the ALLDATA request."""
def optional_headers(self):
- return ["CATEGORY", "SUMMARY_HEADER", "SUMMARY", "CHILDREN", "IDENTIFIER", "IMAGE_URL", "PROPERTIES"]
+ return ["CATEGORY", "SUMMARY_HEADER", "SUMMARY", "CHILDREN", "IDENTIFIER", "IMAGES", "PROPERTIES"]
class EmptyDataRequestHandler(RequestHandler):
"""Return nothing to the caller."""
@@ -124,7 +125,7 @@ class DetailRequestHandler(RequestHandler):
"""Abstract Handler for the DETAIL request."""
def optional_headers(self):
- return ["CATEGORY", "SUMMARY_HEADER", "SUMMARY", "IDENTIFIER", "IMAGE_URL", "PROPERTIES"]
+ return ["CATEGORY", "SUMMARY_HEADER", "SUMMARY", "IDENTIFIER", "IMAGES", "PROPERTIES"]
#
# END Infrastructure
@@ -154,6 +155,9 @@ def properties_for_entity(entity, property_definitions, prop_names_set):
properties.append(prop)
return properties
+def marquee_image_spec_for_url(image_url):
+ return { 'MARQUEE' : { 'URL' : image_url } }
+
def navigation_dict(name, children):
"""Create a navigational entity"""
navigation_dict = {}
@@ -190,10 +194,10 @@ def material_to_dict(material, material_type_properties_definitions):
material_dict['CATEGORY'] = material.getMaterialType()
if material.getMaterialType() == '5HT_COMPOUND':
material_dict['SUMMARY'] = material.getPropertyValue("FORMULA")
- material_dict['IMAGE_URL'] = image_url_for_compound(material)
+ material_dict['IMAGES'] = json_encoded_value(marquee_image_spec_for_url(image_url_for_compound(material)))
else:
material_dict['SUMMARY'] = material.getPropertyValue("DESC")
- material_dict['IMAGE_URL'] = ""
+ material_dict['IMAGES'] = []
material_dict['ROOT_LEVEL'] = None
material_dict['CHILDREN'] = json_encoded_value([])
@@ -218,7 +222,7 @@ def sample_to_dict(five_ht_sample, material_by_perm_id, data_sets, sample_type_p
sample_dict['REFCON'] = json_encoded_value(refcon)
sample_dict['CATEGORY'] = five_ht_sample.getSampleType()
compound = material_by_perm_id[five_ht_sample.getPropertyValue("COMPOUND")]
- sample_dict['IMAGE_URL'] = image_url_for_sample(five_ht_sample, data_sets, compound)
+ sample_dict['IMAGES'] = json_encoded_value(marquee_image_spec_for_url(image_url_for_sample(five_ht_sample, data_sets, compound)))
children = [five_ht_sample.getPropertyValue("TARGET"), five_ht_sample.getPropertyValue("COMPOUND")]
sample_dict['CHILDREN'] = json_encoded_value(children)
diff --git a/openbis-ipad/openBIS/openBIS.xcodeproj/project.xcworkspace/xcuserdata/cramakri.xcuserdatad/UserInterfaceState.xcuserstate b/openbis-ipad/openBIS/openBIS.xcodeproj/project.xcworkspace/xcuserdata/cramakri.xcuserdatad/UserInterfaceState.xcuserstate
index 95fbf48203516dc3f05e72328b2816fe16ba874d..04bae1e7685cbbda0822711ecdbea5aaf8428bcc 100644
Binary files a/openbis-ipad/openBIS/openBIS.xcodeproj/project.xcworkspace/xcuserdata/cramakri.xcuserdatad/UserInterfaceState.xcuserstate and b/openbis-ipad/openBIS/openBIS.xcodeproj/project.xcworkspace/xcuserdata/cramakri.xcuserdatad/UserInterfaceState.xcuserstate differ