JSON Batch Pointer

Like JSON Pointer, except that it:

• can be used to refer to multiple items in a JSON document at once
• is JSON itself, and can therefore be embedded in JSON documents or sent via the application/json content type

Example Usage

Given the following JSON document:

{
    "foo": 23,
    "bar": "hello",
    "baz": {
        "quux": true,
        "bang": [7, "wow", {"yello": "dello"}],
        "pow": [
            {
                "a": 3,
                "b": "yes"
            },
            {
                "a": 5,
                // notice: no "b"
                "c": "no"
            }
        ]
    }
}

and this corresponding JSON batch pointer:

[
    "foo",  // select "foo" from the root document
    {
        "baz": [
            "quux",  // like JSON Pointer "/baz/quux"
            {
                // grab indexes 1 and 2 out of an array, also the length of the array
                "bang": [1, "2", "length"],

                // grab items "a" and "b" out of each element in this array
                "pow": [["a", "b"]]
            }
        ]
    },
    "nonexistent"   // target document doesn't have this key
]

one can expect the following extraction:

{
    "foo": 23,
    "baz": {
        "quux": true,

        // "bang" is treated as though it was an object rather than an array
        "bang": {
            "1": "wow",
            "2": {"yello": "dello"},
            "length": 3
        },
        "pow": [
            {
                "a": 3,
                "b": "yes"
            },
            {
                "a": 5
                // no "b" here because it wasn't present in the target document
            }
        ]
    }
    // no "nonexistent" here because it wasn't present in the target document
}

Documentation

More detailed, specification-like documentation: https://github.com/richard-gebbia/json-batch-pointer/blob/master/doc/intro.md.

Distribution

Clojure (1.8 and above)

Leiningen/Boot

[json-batch-pointer "0.2.0"]

This library exposes one function: (extract ptr json), where ptr is a JSON batch pointer and json is a target document. The function expects both ptr and json to be decoded from JSON into Clojure data structures using the likes of clj-json or Cheshire.

Java

Maven

<dependency>
  <groupId>json-batch-pointer</groupId>
  <artifactId>json-batch-pointer</artifactId>
  <version>0.2.0</version>
</dependency>

Gradle

compile 'json-batch-pointer:json-batch-pointer:0.2.0'

Example usage:

import com.github.richardgebbia.jsonbatchpointer.JsonBatchPointer;

class MyClass {
    public void myMethod() {
        String pointer = "[\"foo\"]";
        String targetDocument = "{\"foo\": 3}";
        String extraction = JsonBatchPointer.extract(pointer, targetDocument));
    }
}