All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.github.jsonldjava.core.JsonLdUtils Maven / Gradle / Ivy

package com.github.jsonldjava.core;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;

import com.github.jsonldjava.utils.Obj;

public class JsonLdUtils {

    private static final int MAX_CONTEXT_URLS = 10;

    /**
     * Returns whether or not the given value is a keyword (or a keyword alias).
     *
     * @param v
     *            the value to check.
     * @param [ctx]
     *            the active context to check against.
     *
     * @return true if the value is a keyword, false if not.
     */
    static boolean isKeyword(Object key) {
        if (!isString(key)) {
            return false;
        }
        return "@base".equals(key) || "@context".equals(key) || "@container".equals(key)
                || "@default".equals(key) || "@embed".equals(key) || "@explicit".equals(key)
                || "@graph".equals(key) || "@id".equals(key) || "@index".equals(key)
                || "@language".equals(key) || "@list".equals(key) || "@omitDefault".equals(key)
                || "@reverse".equals(key) || "@preserve".equals(key) || "@set".equals(key)
                || "@type".equals(key) || "@value".equals(key) || "@vocab".equals(key)
                || "@requireAll".equals(key);
    }

    public static Boolean deepCompare(Object v1, Object v2, Boolean listOrderMatters) {
        if (v1 == null) {
            return v2 == null;
        } else if (v2 == null) {
            return v1 == null;
        } else if (v1 instanceof Map && v2 instanceof Map) {
            final Map m1 = (Map) v1;
            final Map m2 = (Map) v2;
            if (m1.size() != m2.size()) {
                return false;
            }
            for (final String key : m1.keySet()) {
                if (!m2.containsKey(key)
                        || !deepCompare(m1.get(key), m2.get(key), listOrderMatters)) {
                    return false;
                }
            }
            return true;
        } else if (v1 instanceof List && v2 instanceof List) {
            final List l1 = (List) v1;
            final List l2 = (List) v2;
            if (l1.size() != l2.size()) {

                return false;
            }
            // used to mark members of l2 that we have already matched to avoid
            // matching the same item twice for lists that have duplicates
            final boolean alreadyMatched[] = new boolean[l2.size()];
            for (int i = 0; i < l1.size(); i++) {
                final Object o1 = l1.get(i);
                Boolean gotmatch = false;
                if (listOrderMatters) {
                    gotmatch = deepCompare(o1, l2.get(i), listOrderMatters);
                } else {
                    for (int j = 0; j < l2.size(); j++) {
                        if (!alreadyMatched[j] && deepCompare(o1, l2.get(j), listOrderMatters)) {
                            alreadyMatched[j] = true;
                            gotmatch = true;
                            break;
                        }
                    }
                }
                if (!gotmatch) {
                    return false;
                }
            }
            return true;
        } else {
            return v1.equals(v2);
        }
    }

    public static Boolean deepCompare(Object v1, Object v2) {
        return deepCompare(v1, v2, false);
    }

    public static boolean deepContains(List values, Object value) {
        for (final Object item : values) {
            if (deepCompare(item, value, false)) {
                return true;
            }
        }
        return false;
    }

    static void mergeValue(Map obj, String key, Object value) {
        if (obj == null) {
            return;
        }
        List values = (List) obj.get(key);
        if (values == null) {
            values = new ArrayList();
            obj.put(key, values);
        }
        if ("@list".equals(key)
                || (value instanceof Map && ((Map) value).containsKey("@list"))
                || !deepContains(values, value)) {
            values.add(value);
        }
    }

    static void laxMergeValue(Map obj, String key, Object value) {
        if (obj == null) {
            return;
        }
        List values = (List) obj.get(key);
        if (values == null) {
            values = new ArrayList();
            obj.put(key, values);
        }
        // if ("@list".equals(key)
        // || (value instanceof Map && ((Map)
        // value).containsKey("@list"))
        // || !deepContains(values, value)
        // ) {
        values.add(value);
        // }
    }

    public static boolean isAbsoluteIri(String value) {
        // TODO: this is a bit simplistic!
        return value.contains(":");
    }

    /**
     * Returns true if the given value is a subject with properties.
     *
     * @param v
     *            the value to check.
     *
     * @return true if the value is a subject with properties, false if not.
     */
    static boolean isNode(Object v) {
        // Note: A value is a subject if all of these hold true:
        // 1. It is an Object.
        // 2. It is not a @value, @set, or @list.
        // 3. It has more than 1 key OR any existing key is not @id.
        if (v instanceof Map && !(((Map) v).containsKey("@value") || ((Map) v).containsKey("@set")
                || ((Map) v).containsKey("@list"))) {
            return ((Map) v).size() > 1 || !((Map) v).containsKey("@id");
        }
        return false;
    }

    /**
     * Returns true if the given value is a subject reference.
     *
     * @param v
     *            the value to check.
     *
     * @return true if the value is a subject reference, false if not.
     */
    static boolean isNodeReference(Object v) {
        // Note: A value is a subject reference if all of these hold true:
        // 1. It is an Object.
        // 2. It has a single key: @id.
        return (v instanceof Map && ((Map) v).size() == 1
                && ((Map) v).containsKey("@id"));
    }

    // TODO: fix this test
    public static boolean isRelativeIri(String value) {
        if (!(isKeyword(value) || isAbsoluteIri(value))) {
            return true;
        }
        return false;
    }

    /**
     * Removes the @preserve keywords as the last step of the framing algorithm.
     *
     * @param ctx
     *            the active context used to compact the input.
     * @param input
     *            the framed, compacted output.
     * @param options
     *            the compaction options used.
     *
     * @return the resulting output.
     * @throws JsonLdError
     */
    static Object removePreserve(Context ctx, Object input, JsonLdOptions opts) throws JsonLdError {
        // recurse through arrays
        if (isArray(input)) {
            final List output = new ArrayList();
            for (final Object i : (List) input) {
                final Object result = removePreserve(ctx, i, opts);
                // drop nulls from arrays
                if (result != null) {
                    output.add(result);
                }
            }
            input = output;
        } else if (isObject(input)) {
            // remove @preserve
            if (((Map) input).containsKey("@preserve")) {
                if ("@null".equals(((Map) input).get("@preserve"))) {
                    return null;
                }
                return ((Map) input).get("@preserve");
            }

            // skip @values
            if (isValue(input)) {
                return input;
            }

            // recurse through @lists
            if (isList(input)) {
                ((Map) input).put("@list",
                        removePreserve(ctx, ((Map) input).get("@list"), opts));
                return input;
            }

            // recurse through properties
            for (final String prop : ((Map) input).keySet()) {
                Object result = removePreserve(ctx, ((Map) input).get(prop), opts);
                final String container = ctx.getContainer(prop);
                if (opts.getCompactArrays() && isArray(result)
                        && ((List) result).size() == 1 && container == null) {
                    result = ((List) result).get(0);
                }
                ((Map) input).put(prop, result);
            }
        }
        return input;
    }

    /**
     * Removes the @id member of each node object where the member value is a
     * blank node identifier which appears only once in any property value
     * within input.
     *
     * @param input
     *            the framed output before compaction
     */

    static void pruneBlankNodes(final Object input) {
        final Map toPrune = new HashMap<>();
        fillNodesToPrune(input, toPrune);
        for (final String id : toPrune.keySet()) {
            final Object node = toPrune.get(id);
            if (node == null) {
                continue;
            }
            ((Map) node).remove(JsonLdConsts.ID);
        }
    }

    /**
     * Gets the objects on which we'll prune the blank node ID
     *
     * @param input
     *            the framed output before compaction
     * @param toPrune
     *            the resulting object.
     */
    static void fillNodesToPrune(Object input, final Map toPrune) {
        // recurse through arrays
        if (isArray(input)) {
            for (final Object i : (List) input) {
                fillNodesToPrune(i, toPrune);
            }
        } else if (isObject(input)) {
            // skip @values
            if (isValue(input)) {
                return;
            }
            // recurse through @lists
            if (isList(input)) {
                fillNodesToPrune(((Map) input).get("@list"), toPrune);
                return;
            }
            // recurse through properties
            for (final String prop : new LinkedHashSet<>(((Map) input).keySet())) {
                if (prop.equals(JsonLdConsts.ID)) {
                    final String id = (String) ((Map) input).get(JsonLdConsts.ID);
                    if (id.startsWith("_:")) {
                        // if toPrune contains the id already, it was already
                        // present somewhere else,
                        // so we just null the value
                        if (toPrune.containsKey(id)) {
                            toPrune.put(id, null);
                        } else {
                            // else we add the object as the value
                            toPrune.put(id, input);
                        }
                    }
                } else {
                    fillNodesToPrune(((Map) input).get(prop), toPrune);
                }
            }
        } else if (input instanceof String) {
            // this is an id, as non-id values will have been discarded by the
            // isValue() above
            final String p = (String) input;
            if (p.startsWith("_:")) {
                // the id is outside of the context of an @id property, if we're
                // in that case,
                // then we're referencing a blank node id so this id should not
                // be removed
                toPrune.put(p, null);
            }
        }
    }

    /**
     * Compares two strings first based on length and then lexicographically.
     *
     * @param a
     *            the first string.
     * @param b
     *            the second string.
     *
     * @return -1 if a < b, 1 if a > b, 0 if a == b.
     */
    static int compareShortestLeast(String a, String b) {
        if (a.length() < b.length()) {
            return -1;
        } else if (b.length() < a.length()) {
            return 1;
        }
        return Integer.signum(a.compareTo(b));
    }

    /**
     * Compares two JSON-LD values for equality. Two JSON-LD values will be
     * considered equal if:
     *
     * 1. They are both primitives of the same type and value. 2. They are
     * both @values with the same @value, @type, and @language, OR 3. They both
     * have @ids they are the same.
     *
     * @param v1
     *            the first value.
     * @param v2
     *            the second value.
     *
     * @return true if v1 and v2 are considered equal, false if not.
     */
    static boolean compareValues(Object v1, Object v2) {
        if (v1.equals(v2)) {
            return true;
        }

        if (isValue(v1) && isValue(v2)
                && Obj.equals(((Map) v1).get("@value"),
                        ((Map) v2).get("@value"))
                && Obj.equals(((Map) v1).get("@type"),
                        ((Map) v2).get("@type"))
                && Obj.equals(((Map) v1).get("@language"),
                        ((Map) v2).get("@language"))
                && Obj.equals(((Map) v1).get("@index"),
                        ((Map) v2).get("@index"))) {
            return true;
        }

        if ((v1 instanceof Map && ((Map) v1).containsKey("@id"))
                && (v2 instanceof Map && ((Map) v2).containsKey("@id"))
                && ((Map) v1).get("@id")
                        .equals(((Map) v2).get("@id"))) {
            return true;
        }

        return false;
    }

    /**
     * Returns true if the given value is a blank node.
     *
     * @param v
     *            the value to check.
     *
     * @return true if the value is a blank node, false if not.
     */
    static boolean isBlankNode(Object v) {
        // Note: A value is a blank node if all of these hold true:
        // 1. It is an Object.
        // 2. If it has an @id key its value begins with '_:'.
        // 3. It has no keys OR is not a @value, @set, or @list.
        if (v instanceof Map) {
            final Map map = (Map) v;
            if (map.containsKey("@id")) {
                return ((String) map.get("@id")).startsWith("_:");
            } else {
                return map.isEmpty() || !map.containsKey("@value") || map.containsKey("@set")
                        || map.containsKey("@list");
            }
        }
        return false;
    }

    static Object clone(Object value) {// throws
        // CloneNotSupportedException {
        Object rval = null;
        if (value instanceof Cloneable) {
            try {
                rval = value.getClass().getMethod("clone").invoke(value);
            } catch (final Exception e) {
                rval = e;
            }
        }
        if (rval == null || rval instanceof Exception) {
            // the object wasn't cloneable, or an error occured
            if (value == null || value instanceof String || value instanceof Number
                    || value instanceof Boolean) {
                // strings numbers and booleans are immutable
                rval = value;
            } else {
                // TODO: making this throw runtime exception so it doesn't have
                // to be caught
                // because simply it should never fail in the case of JSON-LD
                // and means that
                // the input JSON-LD is invalid
                throw new RuntimeException(new CloneNotSupportedException(
                        (rval instanceof Exception ? ((Exception) rval).getMessage() : "")));
            }
        }
        return rval;
    }

    /**
     * Returns true if the given value is a JSON-LD Array
     *
     * @param v
     *            the value to check.
     * @return
     */
    static Boolean isArray(Object v) {
        return (v instanceof List);
    }

    /**
     * Returns true if the given value is a JSON-LD List
     *
     * @param v
     *            the value to check.
     * @return
     */
    static Boolean isList(Object v) {
        return (v instanceof Map && ((Map) v).containsKey("@list"));
    }

    /**
     * Returns true if the given value is a JSON-LD Object
     *
     * @param v
     *            the value to check.
     * @return
     */
    static Boolean isObject(Object v) {
        return (v instanceof Map);
    }

    /**
     * Returns true if the given value is a JSON-LD value
     *
     * @param v
     *            the value to check.
     * @return
     */
    static Boolean isValue(Object v) {
        return (v instanceof Map && ((Map) v).containsKey("@value"));
    }

    /**
     * Returns true if the given value is a JSON-LD string
     *
     * @param v
     *            the value to check.
     * @return
     */
    static Boolean isString(Object v) {
        // TODO: should this return true for arrays of strings as well?
        return (v instanceof String);
    }
}