NGSIv1 regs isDomain/metadta removal and render() to toJsonv1() renaming

doc/manuals/devel/sourceCode.md

@@ -208,8 +208,8 @@ The **ngsi** library contains a collection of classes for the different payloads
 
 These classes (as well as the classes in the libraries `ngsi9`, `ngsi10`, `convenience`) all have a standard set of methods:
 
-* `render()`, to render the object to a JSON string (mainly for NGSIv1)
 * `toJson()`, to render the object to a JSON string (for NGSIv2)
+* `toJsonV1()`, to render the object to a JSON string (for NGSIv1)
 * `present()`, for debugging (the object is dumped as text to the log file)
 * `release()`, to release all allocated resources of the object
 * `check()`, to make sure the object follows the rules, i.e. about no forbidden characters, or mandatory fields missing, etc.
@@ -222,7 +222,7 @@ The classes follow a hierarchy, e.g. `UpdateContextRequest` (top hierarchy class
 * `ContextAttributeVector`
 * `MetadataVector` (this field `MetadataVector domainMetadataVector` is part of NGSIv1 but Orion doesn't make use of it)
 
-The methods `render()`, `check()`, `release()`, etc. are called in a tree-like fashion, starting from the top hierarchy class, e.g. `UpdateContextRequest`:
+The methods `toJson()`, `check()`, `release()`, etc. are called in a tree-like fashion, starting from the top hierarchy class, e.g. `UpdateContextRequest`:
 
 * `UpdateContextRequest::check()` calls:
   * `ContextElementVector::check()` calls (for each item in the vector):

src/lib/apiTypesV2/Attribute.cpp

@@ -38,9 +38,9 @@
 
 /* ****************************************************************************
 *
-* Attribute::render -
+* Attribute::toJson -
 */
-std::string Attribute::render
+std::string Attribute::toJson
 (
   bool                             acceptedTextPlain,   // in parameter (pass-through)
   bool                             acceptedJson,        // in parameter (pass-through)

src/lib/apiTypesV2/Attribute.h

@@ -55,7 +55,7 @@ class Attribute
 
   Attribute(): pcontextAttribute(0) {}
 
-  std::string  render(bool                             acceptedTextPlain,
+  std::string  toJson(bool                             acceptedTextPlain,
                       bool                             acceptedJson,
                       MimeType                         outFormatSelection,
                       MimeType*                        outMimeTypeP,

src/lib/apiTypesV2/Entities.cpp

@@ -57,18 +57,18 @@ Entities::~Entities()
 
 /* ****************************************************************************
 *
-* Entities::render -
+* Entities::toJson -
 *
 */
-std::string Entities::render
+std::string Entities::toJson
 (
   RenderFormat                     renderFormat,
   const std::vector<std::string>&  attrsFilter,
   bool                             blacklist,
   const std::vector<std::string>&  metadataFilter
 )
 {
-  return vec.render(renderFormat, attrsFilter, blacklist, metadataFilter);
+  return vec.toJson(renderFormat, attrsFilter, blacklist, metadataFilter);
 }
 
 

src/lib/apiTypesV2/Entities.h

@@ -55,7 +55,7 @@ class Entities
   Entities();
   ~Entities();
 
-  std::string  render(RenderFormat                     renderFormat,
+  std::string  toJson(RenderFormat                     renderFormat,
                       const std::vector<std::string>&  attrsFilter,
                       bool                             blacklist,
                       const std::vector<std::string>&  metadataFilter);

src/lib/apiTypesV2/Entity.cpp

@@ -239,8 +239,8 @@ std::string Entity::toJsonV1
   filterAndOrderAttrs(attrsFilter, blacklist, &orderedAttrs);
 
   EntityId en(id, type, isPattern);
-  out += en.render(contextAttributeVectorRendered, false);
-  out += attributeVector.render(asJsonObject, requestType, orderedAttrs, metadataFilter, false, omitAttributeValues);
+  out += en.toJsonV1(contextAttributeVectorRendered, false);
+  out += attributeVector.toJsonV1(asJsonObject, requestType, orderedAttrs, metadataFilter, false, omitAttributeValues);
 
   out += endTag(comma, false);
 

src/lib/apiTypesV2/EntityVector.cpp

@@ -42,9 +42,9 @@
 
 /* ****************************************************************************
 *
-* EntityVector::render -
+* EntityVector::toJson -
 */
-std::string EntityVector::render
+std::string EntityVector::toJson
 (
   RenderFormat                     renderFormat,
   const std::vector<std::string>&  attrsFilter,

src/lib/apiTypesV2/EntityVector.h

@@ -41,10 +41,10 @@ typedef struct EntityVector
 {
   std::vector<Entity*>  vec;
 
-  std::string render(RenderFormat                     renderFormat,
-                     const std::vector<std::string>&  attrsFilter,
-                     bool                             blacklist,
-                     const std::vector<std::string>&  metadataFilter);
+  std::string  toJson(RenderFormat                     renderFormat,
+                      const std::vector<std::string>&  attrsFilter,
+                      bool                             blacklist,
+                      const std::vector<std::string>&  metadataFilter);
 
 
   std::string   check(RequestType requestType);

src/lib/convenience/AppendContextElementRequest.cpp

@@ -46,9 +46,9 @@ AppendContextElementRequest::AppendContextElementRequest()
 
 /* ****************************************************************************
 *
-* render - 
+* toJsonV1 -
 */
-std::string AppendContextElementRequest::render
+std::string AppendContextElementRequest::toJsonV1
 (
   bool         asJsonObject,
   RequestType  requestType
@@ -60,14 +60,14 @@ std::string AppendContextElementRequest::render
 
   if (entity.id != "")
   {
-    out += entity.render(false);
+    out += entity.toJsonV1(false);
   }
 
   // No metadata filter in this case, an empty vector is used to fulfil method signature.
   // For attribute filter, we use the ContextAttributeVector itself
   std::vector<std::string> emptyMdV;
 
-  out += contextAttributeVector.render(asJsonObject, requestType, contextAttributeVector.vec, emptyMdV);
+  out += contextAttributeVector.toJsonV1(asJsonObject, requestType, contextAttributeVector.vec, emptyMdV);
   out += endTag();
 
   return out;
@@ -104,7 +104,7 @@ std::string AppendContextElementRequest::check
     return "OK";
   }
 
-  return response.render(asJsonObject, requestType);
+  return response.toJsonV1(asJsonObject, requestType);
 }
 
 

src/lib/convenience/AppendContextElementRequest.h

@@ -53,7 +53,7 @@ typedef struct AppendContextElementRequest
 
   AppendContextElementRequest();
 
-  std::string  render(bool asJsonObject, RequestType requestType);
+  std::string  toJsonV1(bool asJsonObject, RequestType requestType);
   void         release();
   std::string  check(ApiVersion          apiVersion,
                      bool                asJsonObject,

src/lib/convenience/AppendContextElementResponse.cpp

@@ -50,9 +50,9 @@ AppendContextElementResponse::AppendContextElementResponse() : errorCode("errorC
 
 /* ****************************************************************************
 *
-* AppendContextElementResponse::render - 
+* AppendContextElementResponse::toJsonV1 -
 */
-std::string AppendContextElementResponse::render
+std::string AppendContextElementResponse::toJsonV1
 (
   bool         asJsonObject,
   RequestType  requestType
@@ -64,16 +64,16 @@ std::string AppendContextElementResponse::render
 
   if ((errorCode.code != SccNone) && (errorCode.code != SccOk))
   {
-    out += errorCode.render(false);
+    out += errorCode.toJsonV1(false);
   }
   else
   {
     if (entity.id != "")
     {
-      out += entity.render(true);
+      out += entity.toJsonV1(true);
     }
 
-    out += contextAttributeResponseVector.render(asJsonObject, requestType);
+    out += contextAttributeResponseVector.toJsonV1(asJsonObject, requestType);
   }
 
   out += endTag();
@@ -110,7 +110,7 @@ std::string AppendContextElementResponse::check
     return "OK";
   }
 
-  return render(asJsonObject, requestType);
+  return toJsonV1(asJsonObject, requestType);
 }
 
 

src/lib/convenience/AppendContextElementResponse.h

@@ -71,8 +71,7 @@ typedef struct AppendContextElementResponse
 
   AppendContextElementResponse();
 
-  std::string  render(bool                asJsonObject,
-                      RequestType         requestType);
+  std::string  toJsonV1(bool asJsonObject, RequestType requestType);
   void         release(void);
   std::string  check(ApiVersion          apiVersion,
                      bool                asJsonObject,

src/lib/convenience/ContextAttributeResponse.cpp

@@ -40,9 +40,9 @@
 
 /* ****************************************************************************
 *
-* render - 
+* toJsonV1 -
 */
-std::string ContextAttributeResponse::render
+std::string ContextAttributeResponse::toJsonV1
 (
   bool         asJsonObject,
   RequestType  request
@@ -55,8 +55,8 @@ std::string ContextAttributeResponse::render
   std::vector<std::string> emptyMdV;
 
   out += startTag();
-  out += contextAttributeVector.render(asJsonObject, request, contextAttributeVector.vec, emptyMdV, true);
-  out += statusCode.render(false);
+  out += contextAttributeVector.toJsonV1(asJsonObject, request, contextAttributeVector.vec, emptyMdV, true);
+  out += statusCode.toJsonV1(false);
   out += endTag();
 
   return out;
@@ -102,7 +102,7 @@ std::string ContextAttributeResponse::check
     return "OK";
   }
 
-  return render(asJsonObject, requestType);
+  return toJsonV1(asJsonObject, requestType);
 }
 
 

src/lib/convenience/ContextAttributeResponse.h

@@ -51,8 +51,7 @@ typedef struct ContextAttributeResponse
   ContextAttributeVector     contextAttributeVector;     // Mandatory
   StatusCode                 statusCode;                 // Mandatory
 
-  std::string render(bool         asJsonObject,
-                     RequestType  request);
+  std::string toJsonV1(bool asJsonObject, RequestType request);
   void        release(void);
   std::string check(ApiVersion          apiVersion,
                     bool                asJsonObject,

src/lib/convenience/ContextAttributeResponseVector.cpp

@@ -36,9 +36,9 @@
 
 /* ****************************************************************************
 *
-* ContextAttributeResponseVector::render - 
+* ContextAttributeResponseVector::toJsonV1 -
 */
-std::string ContextAttributeResponseVector::render
+std::string ContextAttributeResponseVector::toJsonV1
 (
   bool         asJsonObject,
   RequestType  request
@@ -55,7 +55,7 @@ std::string ContextAttributeResponseVector::render
   out += startTag(key, true);
   for (unsigned int ix = 0; ix < vec.size(); ++ix)
   {
-    out += vec[ix]->render(asJsonObject, request);
+    out += vec[ix]->toJsonV1(asJsonObject, request);
   }
   out += endTag(false, true);
 

src/lib/convenience/ContextAttributeResponseVector.h

@@ -41,8 +41,7 @@ typedef struct ContextAttributeResponseVector
 {
   std::vector<ContextAttributeResponse*>  vec;
 
-  std::string                render(bool         asJsonObject,
-                                    RequestType  request);
+  std::string                toJsonV1(bool asJsonObject, RequestType request);
   void                       push_back(ContextAttributeResponse* item);
   unsigned int               size(void);
   void                       release(void);

src/lib/convenience/UpdateContextAttributeRequest.cpp

@@ -51,9 +51,9 @@ UpdateContextAttributeRequest::UpdateContextAttributeRequest()
 
 /* ****************************************************************************
 *
-* render - 
+* toJsonV1 -
 */
-std::string UpdateContextAttributeRequest::render(void)
+std::string UpdateContextAttributeRequest::toJsonV1(void)
 {
   std::string out = "";
 
@@ -69,7 +69,7 @@ std::string UpdateContextAttributeRequest::render(void)
     out += JSON_STR("value") + ":" + compoundValueP->toJson(true);
   }
 
-  out += metadataVector.render(metadataVector.vec, false);
+  out += metadataVector.toJsonV1(metadataVector.vec, false);
   out += endTag();
 
   return out;
@@ -103,7 +103,7 @@ std::string UpdateContextAttributeRequest::check
     return "OK";
   }
 
-  std::string out = response.render(false);
+  std::string out = response.toJsonV1(false);
 
   out = "{" + out + "}";
 

src/lib/convenience/UpdateContextAttributeRequest.h

@@ -49,7 +49,7 @@ typedef struct UpdateContextAttributeRequest
   orion::CompoundValueNode*  compoundValueP;
 
   UpdateContextAttributeRequest();
-  std::string  render(void);
+  std::string  toJsonV1(void);
   std::string  check(ApiVersion apiVersion, const std::string& preError);
   void         release();
 } UpdateContextAttributeRequest;

src/lib/convenience/UpdateContextElementRequest.cpp

@@ -36,10 +36,10 @@
 
 /* ****************************************************************************
 *
-* render - 
+* toJsonV1 -
 *
 */
-std::string UpdateContextElementRequest::render(bool asJsonObject, RequestType requestType)
+std::string UpdateContextElementRequest::toJsonV1(bool asJsonObject, RequestType requestType)
 {
   std::string out = "";
 
@@ -48,7 +48,7 @@ std::string UpdateContextElementRequest::render(bool asJsonObject, RequestType r
   std::vector<std::string> emptyMdV;
 
   out += startTag();
-  out += contextAttributeVector.render(asJsonObject, requestType, contextAttributeVector.vec, emptyMdV);
+  out += contextAttributeVector.toJsonV1(asJsonObject, requestType, contextAttributeVector.vec, emptyMdV);
   out += endTag();
 
   return out;
@@ -85,7 +85,7 @@ std::string UpdateContextElementRequest::check
     return "OK";
   }
 
-  return response.render(asJsonObject, requestType);
+  return response.toJsonV1(asJsonObject, requestType);
 }
 
 

src/lib/convenience/UpdateContextElementRequest.h

@@ -41,7 +41,7 @@ typedef struct UpdateContextElementRequest
 {
   ContextAttributeVector     contextAttributeVector;     // Optional
 
-  std::string  render(bool asJsonObject, RequestType requestType);
+  std::string  toJsonV1(bool asJsonObject, RequestType requestType);
   void         release(void);
   std::string  check(ApiVersion          apiVersion,
                      bool                asJsonObject,

src/lib/convenience/UpdateContextElementResponse.cpp

@@ -48,9 +48,9 @@ UpdateContextElementResponse::UpdateContextElementResponse()
 
 /* ****************************************************************************
 *
-* render -
+* toJsonV1 -
 */
-std::string UpdateContextElementResponse::render
+std::string UpdateContextElementResponse::toJsonV1
 (
   bool                asJsonObject,
   RequestType         requestType
@@ -62,11 +62,11 @@ std::string UpdateContextElementResponse::render
 
   if ((errorCode.code != SccNone) && (errorCode.code != SccOk))
   {
-    out += errorCode.render(false);
+    out += errorCode.toJsonV1(false);
   }
   else
   {
-    out += contextAttributeResponseVector.render(asJsonObject, requestType);
+    out += contextAttributeResponseVector.toJsonV1(asJsonObject, requestType);
   }
 
   out += endTag();
@@ -103,7 +103,7 @@ std::string UpdateContextElementResponse::check
     return "OK";
   }
 
-  return render(asJsonObject, requestType);
+  return toJsonV1(asJsonObject, requestType);
 }