Swift

Using Pre-defined JSON Templates

See more JSON Examples

Demonstrates how to predefine a JSON template, and then use it to emit JSON with variable substitutions.

Note: This example requires Chilkat v9.5.0.67 or greater.

Swift

func chilkatTest() {
    // One way to create JSON is to do it in a straightforward manner:
    let json = CkoJsonObject()!
    json.emitCompact = false
    json.updateString(jsonPath: "id", value: "0001")
    json.updateString(jsonPath: "type", value: "donut")
    json.updateString(jsonPath: "name", value: "Cake")
    json.updateString(jsonPath: "image.url", value: "images/0001.jpg")
    json.updateInt(jsonPath: "image.width", value: 200)
    json.updateInt(jsonPath: "image.height", value: 200)
    json.updateString(jsonPath: "thumbnail.url", value: "images/thumbnails/0001.jpg")
    json.updateInt(jsonPath: "thumbnail.width", value: 32)
    json.updateInt(jsonPath: "thumbnail.height", value: 32)
    print("\(json.emit()!)")

    // The JSON created by the above code:

    // 	{ 
    // 	  "id": "0001",
    // 	  "type": "donut",
    // 	  "name": "Cake",
    // 	  "image": { 
    // 	    "url": "images/0001.jpg",
    // 	    "width": 200,
    // 	    "height": 200
    // 	  },
    // 	  "thumbnail": { 
    // 	    "url": "images/thumbnails/0001.jpg",
    // 	    "width": 32,
    // 	    "height": 32
    // 	  }
    // 	}

    // An alternative is to predefine a template, and then use it to emit with variable substitutions.
    // For example:

    let jsonTemplate = CkoJsonObject()!
    jsonTemplate.updateString(jsonPath: "id", value: "{$id}")
    jsonTemplate.updateString(jsonPath: "type", value: "donut")
    jsonTemplate.updateString(jsonPath: "name", value: "{$name}")
    jsonTemplate.updateString(jsonPath: "image.url", value: "{$imageUrl}")
    // The "i." indicates that it's an integer variable.
    jsonTemplate.updateString(jsonPath: "image.width", value: "{$i.imageWidth}")
    jsonTemplate.updateString(jsonPath: "image.height", value: "{$i.imageHeight}")
    jsonTemplate.updateString(jsonPath: "thumbnail.url", value: "{$thumbUrl}")
    jsonTemplate.updateString(jsonPath: "thumbnail.width", value: "{$i.thumbWidth}")
    jsonTemplate.updateString(jsonPath: "thumbnail.height", value: "{$i.thumbHeight}")
    // Give this template a name.
    jsonTemplate.predefine(name: "donut")

    // --------------------------------------------------------------------------
    // OK, the template is defined.  Defining a template can be done once
    // at the start of your program, and you can discard the jsonTemplate object (it
    // doesn't need to stick around..)

    // Now we can create instances of the JSON object by name:
    let jsonDonut = CkoJsonObject()!
    jsonDonut.emitCompact = false
    jsonDonut.loadPredefined(name: "donut")
    print("\(jsonDonut.emit()!)")

    // The output is this:

    // 	{ 
    // 	  "id": "{$id}",
    // 	  "type": "donut",
    // 	  "name": "{$name}",
    // 	  "image": { 
    // 	    "url": "{$imageUrl}",
    // 	    "width": "{$i.imageWidth}",
    // 	    "height": "{$i.imageHeight}"
    // 	  },
    // 	  "thumbnail": { 
    // 	    "url": "{$thumbUrl}",
    // 	    "width": "{$i.thumbWidth}",
    // 	    "height": "{$i.thumbHeight}"
    // 	  }
    // 	}

    // Finally, we can substitute variables like this:
    let donutValues = CkoHashtable()!
    donutValues.addStr(key: "id", value: "0001")
    donutValues.addStr(key: "name", value: "Cake")
    donutValues.addStr(key: "imageUrl", value: "images/0001.jpg")
    donutValues.addInt(key: "imageWidth", value: 200)
    donutValues.addInt(key: "imageHeight", value: 200)
    donutValues.addStr(key: "thumbUrl", value: "images/thumbnails/0001.jpg")
    donutValues.addInt(key: "thumbWidth", value: 32)
    donutValues.addInt(key: "thumbHeight", value: 32)

    // Emit with variable substitutions:
    var omitEmpty: Bool = true
    print("\(jsonDonut.emit(withSubs: donutValues, omitEmpty: omitEmpty)!)")

    // Output:

    // 	{ 
    // 	  "id": "0001",
    // 	  "type": "donut",
    // 	  "name": "Cake",
    // 	  "image": { 
    // 	    "url": "images/0001.jpg",
    // 	    "width": 200,
    // 	    "height": 200
    // 	  },
    // 	  "thumbnail": { 
    // 	    "url": "images/thumbnails/0001.jpg",
    // 	    "width": 32,
    // 	    "height": 32
    // 	  }
    // 	}

    // Change some of the values:
    donutValues.addStr(key: "id", value: "0002")
    donutValues.addStr(key: "imageUrl", value: "images/0002.jpg")
    donutValues.addStr(key: "thumbUrl", value: "images/thumbnails/0002.jpg")

    print("\(jsonDonut.emit(withSubs: donutValues, omitEmpty: omitEmpty)!)")

    // Output:

    // 	{ 
    // 	  "id": "0002",
    // 	  "type": "donut",
    // 	  "name": "Cake",
    // 	  "image": { 
    // 	    "url": "images/0002.jpg",
    // 	    "width": 200,
    // 	    "height": 200
    // 	  },
    // 	  "thumbnail": { 
    // 	    "url": "images/thumbnails/0002.jpg",
    // 	    "width": 32,
    // 	    "height": 32
    // 	  }
    // 	}

}