Adding interfaces in documentation
[aai/sparky-be.git] / sparkybe-onap-service / src / main / java / org / onap / aai / sparky / viewandinspect / entity / JsonNode.java
1 /**
2  * ============LICENSE_START===================================================
3  * SPARKY (AAI UI service)
4  * ============================================================================
5  * Copyright © 2017 AT&T Intellectual Property.
6  * Copyright © 2017 Amdocs
7  * All rights reserved.
8  * ============================================================================
9  * Licensed under the Apache License, Version 2.0 (the "License");
10  * you may not use this file except in compliance with the License.
11  * You may obtain a copy of the License at
12  *
13  *      http://www.apache.org/licenses/LICENSE-2.0
14  *
15  * Unless required by applicable law or agreed to in writing, software
16  * distributed under the License is distributed on an "AS IS" BASIS,
17  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18  * See the License for the specific language governing permissions and
19  * limitations under the License.
20  * ============LICENSE_END=====================================================
21  *
22  * ECOMP and OpenECOMP are trademarks
23  * and service marks of AT&T Intellectual Property.
24  */
25 package org.onap.aai.sparky.viewandinspect.entity;
26
27 import java.util.Collection;
28 import java.util.HashMap;
29 import java.util.Map;
30
31 import org.apache.log4j.Logger;
32 import org.onap.aai.sparky.viewandinspect.config.VisualizationConfigs;
33
34 import com.fasterxml.jackson.annotation.JsonIgnore;
35
36 /*
37  * We can use annotations to differentiate between intermediate data we use to build the node, and
38  * the data that we actually want to appear in the exported JSON.
39  */
40
41 /*
42  * This is our current ( 14-June-2016 ) working schema that will remain organic until we get it just
43  * right.
44  *
45  * { "item-type": "customer", "item-name-key": "subscriber-name", “item-name-value” :
46  * “subscriber-name-123456789-aai847-data-01”, "item-properties": [{ "property-name":
47  * "subscriber-name", "property-value": "subscriber-name-123456789-aai847-data-01" }, {
48  * "property-name": "global-customer-id", "property-value":
49  * "global-customer-id-123456789-aai847-data-01" } ], "node-meta": { “color” : “#f2d2d2”,
50  * "isSearchTarget" : false, "nodeGroups" : "1,2,3,4" }, }
51  * 
52  */
53
54
55 /**
56  * The Class JsonNode.
57  */
58 public class JsonNode {
59
60   private String id;
61   private String itemType;
62   private String itemNameKey;
63   private String itemNameValue;
64   private Map<String, String> itemProperties;
65   private NodeMeta nodeMeta;
66
67   @JsonIgnore
68   private boolean isRootNode;
69
70
71   @JsonIgnore
72   private String resourceKey;
73   @JsonIgnore
74   private Collection<String> inboundNeighbors;
75
76   @JsonIgnore
77   private Collection<String> outboundNeighbors;
78
79
80   @JsonIgnore
81   private static final Logger LOG = Logger.getLogger(JsonNode.class);
82
83   private VisualizationConfigs visualizationConfigs;
84
85
86   /**
87    * Instantiates a new json node.
88    *
89    * @param ain the ain
90    */
91   public JsonNode(ActiveInventoryNode ain, VisualizationConfigs visualizationConfigs) {
92     this.resourceKey = ain.getNodeId();
93     this.itemProperties = ain.getProperties();
94     this.setItemType(ain.getEntityType());
95     this.setItemNameKey(ain.getPrimaryKeyName());
96     this.setItemNameValue(ain.getPrimaryKeyValue());
97     this.setId(ain.getNodeId());
98     this.isRootNode = ain.isRootNode();
99     this.visualizationConfigs = visualizationConfigs;
100
101     if (LOG.isDebugEnabled()) {
102       LOG.debug("---");
103       LOG.debug("JsonNode constructor using AIN = " + ain.dumpNodeTree(true));
104       LOG.debug("---");
105     }
106
107     inboundNeighbors = ain.getInboundNeighbors();
108     outboundNeighbors = ain.getOutboundNeighbors();
109
110     nodeMeta = new NodeMeta(this.visualizationConfigs);
111
112     nodeMeta.setNodeIssue(ain.isNodeIssue());
113     nodeMeta.setNodeValidated(ain.isNodeValidated());
114     nodeMeta.setNodeDepth(ain.getNodeDepth());
115
116     nodeMeta.setNumInboundNeighbors(ain.getInboundNeighbors().size());
117     nodeMeta.setNumOutboundNeighbors(ain.getOutboundNeighbors().size());
118
119     nodeMeta.setAtMaxDepth(ain.isAtMaxDepth());
120     nodeMeta.setSelfLinkResolved(!ain.isSelflinkRetrievalFailure());
121     nodeMeta.setProcessingErrorOccurred(ain.isProcessingErrorOccurred());
122     nodeMeta.setHasNeighbors(
123         ain.getOutboundNeighbors().size() > 0 || ain.getInboundNeighbors().size() > 0);
124     nodeMeta.setProcessingState(ain.getState());
125
126   }
127
128   public String getId() {
129     return id;
130   }
131
132   public void setId(String id) {
133     this.id = id;
134   }
135
136   public String getItemNameKey() {
137     return itemNameKey;
138   }
139
140   public String getItemNameValue() {
141     return itemNameValue;
142   }
143
144   public Map<String, String> getItemProperties() {
145     return itemProperties;
146   }
147
148   public String getItemType() {
149     return itemType;
150   }
151
152   public String getResourceKey() {
153     return resourceKey;
154   }
155
156   public void setItemNameKey(String itemNameKey) {
157     this.itemNameKey = itemNameKey;
158   }
159
160   public void setItemNameValue(String itemNameValue) {
161     this.itemNameValue = itemNameValue;
162   }
163
164   public void setItemProperties(HashMap<String, String> itemProperties) {
165     this.itemProperties = itemProperties;
166   }
167
168   public void setItemType(String itemType) {
169     this.itemType = itemType;
170   }
171
172   public void setResourceKey(String resourceKey) {
173     this.resourceKey = resourceKey;
174   }
175
176   public NodeMeta getNodeMeta() {
177     return nodeMeta;
178   }
179
180   public void setNodeMeta(NodeMeta nodeMeta) {
181     this.nodeMeta = nodeMeta;
182   }
183
184   public boolean isRootNode() {
185     return isRootNode;
186   }
187
188   /*
189    * (non-Javadoc)
190    * 
191    * @see java.lang.Object#toString()
192    */
193   @Override
194   public String toString() {
195     return "JsonNode [" + (id != null ? "id=" + id + ", " : "")
196         + (itemType != null ? "itemType=" + itemType + ", " : "")
197         + (itemNameKey != null ? "itemNameKey=" + itemNameKey + ", " : "")
198         + (itemNameValue != null ? "itemNameValue=" + itemNameValue + ", " : "")
199         + (itemProperties != null ? "itemProperties=" + itemProperties + ", " : "")
200         + (nodeMeta != null ? "nodeMeta=" + nodeMeta + ", " : "")
201         + (resourceKey != null ? "resourceKey=" + resourceKey + ", " : "")
202         + (inboundNeighbors != null ? "inboundNeighbors=" + inboundNeighbors + ", " : "")
203         + (outboundNeighbors != null ? "outboundNeighbors=" + outboundNeighbors : "") + "]";
204   }
205
206
207 }