aboutsummaryrefslogtreecommitdiffstats
path: root/src/main/java/org/onap/aai/spike/event/incoming/GizmoEdge.java
blob: af10a6e8c0ee1cb8759cd7722be8771d0d11b989 (plain)
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
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
/**
 * ============LICENSE_START=======================================================
 * org.onap.aai
 * ================================================================================
 * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved.
 * Copyright © 2017-2018 Amdocs
 * ================================================================================
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * ============LICENSE_END=========================================================
 */
package org.onap.aai.spike.event.incoming;

import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.google.gson.JsonElement;
import com.google.gson.annotations.SerializedName;
import org.onap.aai.spike.exception.SpikeException;

/**
 * This class provides a generic representation of an Edge as provided by the graph data store.
 *
 */
public class GizmoEdge {

    /**
     * The unique identifier used to identify this edge in the graph data store.
     */
    @SerializedName("key")
    private String id;

    /** Type label assigned to this vertex. */
    private String type;

    /** Source vertex for our edge. */
    private GizmoVertex source;

    /** Target vertex for our edge. */
    private GizmoVertex target;

    /** Map of all of the properties assigned to this vertex. */
    private JsonElement properties;

    /** Marshaller/unmarshaller for converting to/from JSON. */
    private static final Gson gson = new GsonBuilder().disableHtmlEscaping().create();

    public String getId() {
        return id;
    }

    public void setId(String id) {
        this.id = id;
    }

    public String getType() {
        return type;
    }

    public void setType(String type) {
        this.type = type;
    }

    public GizmoVertex getSource() {
        return source;
    }

    public void setSource(GizmoVertex source) {
        this.source = source;
    }

    public GizmoVertex getTarget() {
        return target;
    }

    public void setTarget(GizmoVertex target) {
        this.target = target;
    }

    public JsonElement getProperties() {
        return properties;
    }

    public void setProperties(JsonElement properties) {
        this.properties = properties;
    }

    /**
     * Unmarshalls this Edge object into a JSON string.
     * 
     * @return - A JSON format string representation of this Edge.
     */
    public String toJson() {
        return gson.toJson(this);
    }

    /**
     * Marshalls the provided JSON string into a Edge object.
     * 
     * @param json - The JSON string to produce the Edge from.
     * 
     * @return - A Edge object.
     * 
     * @throws SpikeException
     */
    public static GizmoEdge fromJson(String json) throws SpikeException {

        try {

            // Make sure that we were actually provided a non-empty string
            // before we
            // go any further.
            if (json == null || json.isEmpty()) {
                throw new SpikeException("Empty or null JSON string.");
            }

            // Marshall the string into an Edge object.
            return gson.fromJson(json, GizmoEdge.class);

        } catch (Exception ex) {
            throw new SpikeException("Unable to parse JSON string: " + ex.getMessage());
        }
    }
}