com.yahoo.elide.jsonapi.JsonApiMapper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of elide-core Show documentation
Elide Core
There is a newer version: 7.1.4
/*
 * Copyright 2015, Yahoo Inc.
 * Licensed under the Apache License, Version 2.0
 * See LICENSE file in project root for terms.
 */
package com.yahoo.elide.jsonapi;

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.node.JsonNodeFactory;
import com.yahoo.elide.core.EntityDictionary;
import com.yahoo.elide.jsonapi.models.JsonApiDocument;
import com.yahoo.elide.jsonapi.models.Patch;

import java.io.IOException;
import java.util.List;

/**
 * Serializer/Deserializer for JSON API.
 */
public class JsonApiMapper {
    private final ObjectMapper mapper;

    /**
     * Instantiates a new JSON API OBJECT_MAPPER.
     *
     * @param dictionary the dictionary
     */
    public JsonApiMapper(EntityDictionary dictionary) {
        mapper = new ObjectMapper();
        mapper.registerModule(JsonApiSerializer.getModule(dictionary));
    }

    /**
     * Write out JSON API Document as a string.
     *
     * @param jsonApiDocument the json api document
     * @return Document as string
     * @throws JsonProcessingException the json processing exception
     */
    public String writeJsonApiDocument(JsonApiDocument jsonApiDocument) throws JsonProcessingException {
        return mapper.writeValueAsString(jsonApiDocument);
    }

    /**
     * To json object.
     *
     * @param jsonApiDocument the json api document
     * @return the json node
     */
    public JsonNode toJsonObject(JsonApiDocument jsonApiDocument) {
        return mapper.convertValue(jsonApiDocument, JsonNode.class);
    }

    /**
     * Write json api document.
     *
     * @param node the node
     * @return the string
     * @throws JsonProcessingException the json processing exception
     */
    public String writeJsonApiDocument(JsonNode node) throws JsonProcessingException {
        return mapper.writeValueAsString(node);
    }

    /**
     * Read json api document.
     *
     * @param doc the doc
     * @return the json api document
     * @throws IOException the iO exception
     */
    public JsonApiDocument readJsonApiDocument(String doc) throws IOException {
        JsonNode node = mapper.readTree(doc);
        return readJsonApiDocument(node);
    }

    /**
     * Read json api document.
     *
     * @param node the node
     * @return the json api document
     * @throws IOException the iO exception
     */
    public JsonApiDocument readJsonApiDocument(JsonNode node) throws IOException {
        return mapper.treeToValue(node,  JsonApiDocument.class);
    }

    /**
     * Read json api patch ext value.
     *
     * @param value the value
     * @return the json api document
     * @throws JsonProcessingException the json processing exception
     */
    public JsonApiDocument readJsonApiPatchExtValue(JsonNode value) throws JsonProcessingException {
        JsonNode data = JsonNodeFactory.instance.objectNode().set("data", value);
        return mapper.treeToValue(data, JsonApiDocument.class);
    }

    /**
     * Read json api patch ext doc.
     *
     * @param doc the doc
     * @return the list
     * @throws IOException the iO exception
     */
    public List readJsonApiPatchExtDoc(String doc) throws IOException {
        return mapper.readValue(doc, mapper.getTypeFactory().constructCollectionType(List.class, Patch.class));
    }

    /**
     * Gets object OBJECT_MAPPER.
     *
     * @return the object OBJECT_MAPPER
     */
    public ObjectMapper getObjectMapper() {
        return mapper;
    }
}