From 7ced3f45422c7832e6313a6001f02dc02059169a Mon Sep 17 00:00:00 2001
From: cramakri <cramakri>
Date: Mon, 22 Oct 2012 09:11:35 +0000
Subject: [PATCH] Switched to treating the REFCON as JSON.
SVN: 27276
---
openbis-ipad/BisKit/Classes/CISDOBIpadService.h | 2 +-
openbis-ipad/BisKit/Classes/CISDOBIpadService.m | 2 +-
openbis-ipad/BisKit/Tests/CISDOBIpadServiceTest.m | 5 ++++-
openbis-ipad/core-plugin/readme.md | 4 ++--
.../dss/reporting-plugins/ipad-read-service-v1/ipad_read.py | 6 +-----
5 files changed, 9 insertions(+), 10 deletions(-)
diff --git a/openbis-ipad/BisKit/Classes/CISDOBIpadService.h b/openbis-ipad/BisKit/Classes/CISDOBIpadService.h
index e7406c46185..b4c5741f329 100644
--- a/openbis-ipad/BisKit/Classes/CISDOBIpadService.h
+++ b/openbis-ipad/BisKit/Classes/CISDOBIpadService.h
@@ -56,7 +56,7 @@ enum CISOBIpadServiceErrorCode {
- (CISDOBAsyncCall *)listRootLevelEntities;
//! Get drill information from the openBIS ipad service -- this will include information about the children of the entity and possibly their children as well. The success message will be invoked with a collection of CISDOBIpadRawEntity objects.
-- (CISDOBAsyncCall *)drillOnEntityWithPermId:(NSString *)permId refcon:(NSString *)refcon;
+- (CISDOBAsyncCall *)drillOnEntityWithPermId:(NSString *)permId refcon:(id)refcon;
@end
diff --git a/openbis-ipad/BisKit/Classes/CISDOBIpadService.m b/openbis-ipad/BisKit/Classes/CISDOBIpadService.m
index 4e0e2571436..628c5747973 100644
--- a/openbis-ipad/BisKit/Classes/CISDOBIpadService.m
+++ b/openbis-ipad/BisKit/Classes/CISDOBIpadService.m
@@ -175,7 +175,7 @@ NSString *const CISDOBIpadServiceErrorDomain = @"CISDOBIpadServiceErrorDomain";
return iPadCall;
}
-- (CISDOBAsyncCall *)drillOnEntityWithPermId:(NSString *)permId refcon:(NSString *)refcon
+- (CISDOBAsyncCall *)drillOnEntityWithPermId:(NSString *)permId refcon:(id)refcon
{
// A simple version of the method that just request data for one entity.
NSDictionary *entity =
diff --git a/openbis-ipad/BisKit/Tests/CISDOBIpadServiceTest.m b/openbis-ipad/BisKit/Tests/CISDOBIpadServiceTest.m
index 3a318a53850..75446ccff31 100644
--- a/openbis-ipad/BisKit/Tests/CISDOBIpadServiceTest.m
+++ b/openbis-ipad/BisKit/Tests/CISDOBIpadServiceTest.m
@@ -105,7 +105,10 @@
}
// Drill
- call = [_service drillOnEntityWithPermId: entityWithChildren.permId refcon: entityWithChildren.refcon];
+ NSError *error;
+ id refconObject = [NSJSONSerialization JSONObjectWithData: [entityWithChildren.refcon dataUsingEncoding: NSASCIIStringEncoding] options: 0 error: &error];
+ STAssertNotNil(refconObject, @"Could not parse refcon string %@ : %@", entityWithChildren.refcon, error);
+ call = [_service drillOnEntityWithPermId: entityWithChildren.permId refcon: refconObject];
[self configureAndRunCallSynchronously: call];
rawEntities = _callResult;
diff --git a/openbis-ipad/core-plugin/readme.md b/openbis-ipad/core-plugin/readme.md
index db693a28486..30c59faa406 100644
--- a/openbis-ipad/core-plugin/readme.md
+++ b/openbis-ipad/core-plugin/readme.md
@@ -66,9 +66,9 @@ The iPad data model tracks information for displaying and navigating between ent
</tr>
<tr>
<td>REFCON</td>
- <td>Data that is passed unchanged back to the server when a row is modified. This can be used by the server to encode whatever it needs in order to modify the row.</td>
+ <td>Data that is passed unchanged back to the server when a row is modified. This can be used by the server to encode whatever it needs in order to modify the row. Transmitted as JSON.</td>
<td>For server use only; transmitted to the server on every call that it is appropriate.</td>
- <td>openBIS entity kind + type + permId</td>
+ <td>E.g., {code : [code], entityKind : [entity kind], entityType : [entity type], permId : [permId]}</td>
</tr>
<tr>
<td>CATEGORY</td>
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 9f1d5367f5e..a86a0052c7c 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
@@ -11,10 +11,6 @@ def json_encoded_value(coll):
"""Utility function for converting a list into a json-encoded list"""
return ObjectMapper().writeValueAsString(coll)
-def json_string_to_dict(string):
- """Utility function for converting a json-encoded dictionary into a Java/Jython dictionary."""
- return ObjectMapper().readValue(string, dict)
-
class RequestHandler:
"""Abstract superclass for the handlers for concrete requests like ROOT.
@@ -207,7 +203,7 @@ def samples_to_dict(samples, material_by_perm_id):
def retrieve_samples(sample_perm_ids_and_ref_cons):
sc = SearchCriteria()
for sample in sample_perm_ids_and_ref_cons:
- code = json_string_to_dict(sample['REFCON'])['code']
+ code = sample['REFCON']['code']
sc.addMatchClause(sc.MatchClause.createAttributeMatch(sc.MatchClauseAttribute.CODE, code))
return searchService.searchForSamples(sc)
--
GitLab