(Excel) JSON Paths

Demonstrates using "Chilkat JSON Paths" to access parts of a JSON document, or to iterate over parts.

This example uses the following JSON document:

{
    "nestedArray" : [
			[
				[1,2,3],
				[4,5,6],
				[7,8,9,10]
			],
			[
				[11,12,13],
				[14,15,16],
				[17,18,19,20]
			],
			[
				[21,22,23],
				[24,25,26],
				[27,28,29,30],
				[31,32,33,34,35,36]
			]
		],

	"nestedObject" : {
		"aaa" : {
			"bb1" : {
				"cc1" : "c1Value",
				"cc2" : "c2Value",
				"cc3" : "c3Value"
			},
			"bb2" : {
				"dd1" : "d1Value",
				"dd2" : "d2Value",
				"dd3" : "d3Value"
			}
		}
	},

	"mixture" : {
		"arrayA" : [  
			{ "fruit": "apple", "animal": "horse", "job": "fireman", "colors": ["red","blue","green"] },
			{ "fruit": "pear", "animal": "plankton", "job": "waiter", "colors": ["yellow","orange","purple"] },
			{ "fruit": "kiwi", "animal": "echidna", "job": "astronaut", "colors": ["magenta","tan","pink"] }
			]
	},


        "name.with.dots" : { "grain" : "oats" }

	
}

Download Excel Class Modules Chilkat Excel Class Modules

Dim json As Chilkat.JsonObject
Set json = Chilkat.NewJsonObject
json.EmitCompact = False

' Assume the file contains the data as shown above..

success = json.LoadFile("qa_data/json/pathSample.json")
If (success <> True) Then
    Debug.Print json.LastErrorText
    Exit Sub
End If

' First, let's get the value of "cc1"
' The path to this value is: nestedObject.aaa.bb1.cc1
Debug.Print json.StringOf("nestedObject.aaa.bb1.cc1")

' Now let's get number 18 from the nestedArray.
' It is located at nestedArray[1][2][1]
' (remember: Indexing is 0-based)
Debug.Print "This should be 18: "; json.IntOf("nestedArray[1][2][1]")

' We can do the same thing in a more roundabout way using the 
' I, J, and K properties.  (The I,J,K properties will be convenient
' for iterating over arrays, as we'll see later.)
json.I = 1
json.J = 2
json.K = 1
Debug.Print "This should be 18: "; json.IntOf("nestedArray[i][j][k]")

' Let's iterate over the array containing the numbers 17, 18, 19, 20.
' First, use the SizeOfArray method to get the array size:

sz = json.SizeOfArray("nestedArray[1][2]")
' The size should be 4.
Debug.Print "size of array = "; sz; " (should equal 4)"

' Now iterate...

For i = 0 To sz - 1
    json.I = i
    Debug.Print json.IntOf("nestedArray[1][2][i]")
Next

' Let's use a triple-nested loop to iterate over the nestedArray:

' szI should equal 1.

szI = json.SizeOfArray("nestedArray")
For i = 0 To szI - 1
    json.I = i


    szJ = json.SizeOfArray("nestedArray[i]")
    For j = 0 To szJ - 1
        json.J = j


        szK = json.SizeOfArray("nestedArray[i][j]")
        For k = 0 To szK - 1
            json.K = k

            Debug.Print json.IntOf("nestedArray[i][j][k]")
        Next
    Next
Next

' Now let's examine how to navigate to JSON objects contained within JSON arrays.
' This line of code gets the value "kiwi" contained within "mixture"
Debug.Print json.StringOf("mixture.arrayA[2].fruit")

' This line of code gets the color "yellow"
Debug.Print json.StringOf("mixture.arrayA[1].colors[0]")

' Getting an object at a path:
' This gets the 2nd object in "arrayA"

Set obj2 = json.ObjectOf("mixture.arrayA[1]")
' This object's "animal" should be "plankton"
Debug.Print obj2.StringOf("animal")

' Note that paths are relative to the object, not the absolute root of the JSON document.
' Starting from obj2, "purple" is at "colors[2]"
Debug.Print obj2.StringOf("colors[2]")

' Getting an array at a path:
' This gets the array containing the colors red, green, blue:

Set arr1 = json.ArrayOf("mixture.arrayA[0].colors")

szArr1 = arr1.Size
For i = 0 To szArr1 - 1
    Debug.Print i; ": "; arr1.StringAt(i)
Next

' The Chilkat JSON path uses ".", "[", and "]" chars for separators.  When a name
' contains one of these chars, use double-quotes in the path:
Debug.Print json.StringOf("""name.with.dots"".grain")