package org.onap.aai.serialization.queryformats;
import com.google.gson.JsonArray;
+import com.google.gson.JsonElement;
import com.google.gson.JsonObject;
import org.apache.tinkerpop.gremlin.process.traversal.Path;
import org.apache.tinkerpop.gremlin.process.traversal.step.util.Tree;
import org.apache.tinkerpop.gremlin.structure.Vertex;
import org.onap.aai.serialization.queryformats.exceptions.AAIFormatQueryResultFormatNotSupported;
import org.onap.aai.serialization.queryformats.exceptions.AAIFormatVertexException;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
-import java.util.List;
-import java.util.Map;
-import java.util.Optional;
+import java.util.*;
public abstract class MultiFormatMapper implements FormatMapper {
+ Logger logger = LoggerFactory.getLogger(MultiFormatMapper.class);
+
protected boolean isTree = false;
@Override
public Optional<JsonObject> formatObject(Object input)
- throws AAIFormatVertexException, AAIFormatQueryResultFormatNotSupported {
+ throws AAIFormatVertexException, AAIFormatQueryResultFormatNotSupported {
if (input instanceof Vertex) {
+ logger.debug("Formatting vertex object");
return this.getJsonFromVertex((Vertex) input);
} else if (input instanceof Tree) {
+ logger.debug("Formatting tree object");
if (isTree) {
- return this.getRelatedNodesFromTree((Tree<?>) input);
+ return this.getRelatedNodesFromTree((Tree<?>) input, null);
} else {
- return this.getJsonFomTree((Tree<?>) input);
+ return this.getJsonFromTree((Tree<?>) input);
}
} else if (input instanceof Path) {
+ logger.debug("Formatting path object");
return this.getJsonFromPath((Path) input);
} else {
throw new AAIFormatQueryResultFormatNotSupported();
public Optional<JsonObject> formatObject(Object input, Map<String, List<String>> properties)
throws AAIFormatVertexException, AAIFormatQueryResultFormatNotSupported {
if (input instanceof Vertex) {
+ logger.debug("Formatting vertex object with properties map filter");
return this.getJsonFromVertex((Vertex) input, properties);
} else if (input instanceof Tree) {
+ logger.debug("Formatting tree object with properties map filter");
if (isTree) {
- return this.getRelatedNodesFromTree((Tree<?>) input);
+ return this.getRelatedNodesFromTree((Tree<?>) input, properties);
} else {
- return this.getJsonFomTree((Tree<?>) input);
+ return this.getJsonFromTree((Tree<?>) input);
}
} else if (input instanceof Path) {
+ logger.debug("Formatting path object");
return this.getJsonFromPath((Path) input);
} else {
throw new AAIFormatQueryResultFormatNotSupported();
return Optional.of(jo);
}
- protected Optional<JsonObject> getJsonFomTree(Tree<?> tree) throws AAIFormatVertexException {
-
+ /**
+ * Returns an Optional<JsonObject> object using "nodes" as a wrapper to encapsulate json objects
+ * @param tree
+ * @return
+ * @throws AAIFormatVertexException
+ */
+ protected Optional<JsonObject> getJsonFromTree(Tree<?> tree) throws AAIFormatVertexException {
if (tree.isEmpty()) {
return Optional.of(new JsonObject());
}
+ String nodeIdentifier = "nodes";
JsonObject t = new JsonObject();
- JsonArray ja = this.getNodesArray(tree, "nodes");
+ JsonArray ja = this.getNodesArray(tree, null, nodeIdentifier);
if (ja.size() > 0) {
t.add("nodes", ja);
+ } else {
+ logger.debug("Returned empty JsonArray - Could not populate nested json objects for wrapper: {}", nodeIdentifier);
}
return Optional.of(t);
}
- protected Optional<JsonObject> getRelatedNodesFromTree(Tree<?> tree) throws AAIFormatVertexException {
+ /**
+ * Returns an Optional<JsonObject> object using "related-nodes" to encapsulate nested json objects.
+ * Primarily intended to be utilized by the "as-tree" query parameter feature
+ * @param tree
+ * @param properties
+ * @return
+ * @throws AAIFormatVertexException
+ */
+ protected Optional<JsonObject> getRelatedNodesFromTree(Tree<?> tree, Map<String, List<String>> properties) throws AAIFormatVertexException {
if (tree.isEmpty()) {
return Optional.of(new JsonObject());
}
+ String nodeIdentifier = "related-nodes";
+
+ // Creating another DS to help with calls in O(1)
+ Map<String, Set<String>> filterPropertiesMap = createFilteredPropertyMap(properties);
JsonObject t = new JsonObject();
- JsonArray ja = this.getNodesArray(tree, "related-nodes");
+ JsonArray ja = this.getNodesArray(tree, filterPropertiesMap, nodeIdentifier);
if (ja.size() > 0) {
t.add("results", ja);
return Optional.of(t);
+ } else {
+ logger.debug("Returned empty JsonArray - Could not populate nested json objects for wrapper: {}", nodeIdentifier);
}
return Optional.empty();
}
- protected JsonArray getNodesArray(Tree<?> tree, String nodeIdentifier) throws AAIFormatVertexException {
-
+ /**
+ * Returns JsonArray Object populated with nested json wrapped by the nodeIdentifier parameter
+ * @param tree
+ * @param filterPropertiesMap
+ * @param nodeIdentifier
+ * @return
+ * @throws AAIFormatVertexException
+ */
+ protected JsonArray getNodesArray(Tree<?> tree, Map<String, Set<String>> filterPropertiesMap, String nodeIdentifier) throws AAIFormatVertexException {
JsonArray nodes = new JsonArray();
for (Map.Entry<?, ? extends Tree<?>> entry : tree.entrySet()) {
JsonObject me = new JsonObject();
if (entry.getKey() instanceof Vertex) {
Optional<JsonObject> obj = this.getJsonFromVertex((Vertex) entry.getKey());
if (obj.isPresent()) {
- me = obj.get();
+ me = getPropertyFilteredObject(obj, filterPropertiesMap);
} else {
continue;
}
}
- JsonArray ja = this.getNodesArray(entry.getValue(), nodeIdentifier);
+ JsonArray ja = this.getNodesArray(entry.getValue(), filterPropertiesMap, nodeIdentifier);
if (ja.size() > 0) {
me.add(nodeIdentifier, ja);
+ } else {
+ logger.debug("Returned empty JsonArray - Could not populate nested json objects for wrapper: {}", nodeIdentifier);
}
nodes.add(me);
}
return nodes;
}
+ /**
+ * Returns a Map<String, Set<String>> object through converting given map parameter
+ * @param properties
+ * @return
+ */
+ protected Map<String, Set<String>> createFilteredPropertyMap(Map<String, List<String>> properties) {
+ if (properties == null)
+ return new HashMap<>();
+
+ Map<String, Set<String>> filterPropertiesMap = new HashMap<>();
+ for (String key : properties.keySet()) {
+ if (!filterPropertiesMap.containsKey(key)) {
+ Set<String> newSet = new HashSet<>();
+ for (String currProperty : properties.get(key)) {
+ currProperty = truncateApostrophes(currProperty);
+ newSet.add(currProperty);
+ }
+ filterPropertiesMap.put(key, newSet);
+ }
+ }
+ return filterPropertiesMap;
+ }
+
+ /**
+ * Returns a string with it's apostrophes truncated at the start and end.
+ * @param s
+ * @return
+ */
+ protected String truncateApostrophes(String s) {
+ if (s == null || s.isEmpty()) {
+ return s;
+ }
+ if (s.startsWith("'") && s.endsWith("'")) {
+ s = s.substring(1, s.length() - 1);
+ }
+ return s;
+ }
+
+ /**
+ * Filters the given Optional<JsonObject> with the properties under a properties field
+ * or the properties under its respective node type.
+ * @param obj
+ * @param filterPropertiesMap
+ * @return
+ */
+ protected JsonObject getPropertyFilteredObject(Optional<JsonObject> obj, Map<String, Set<String>> filterPropertiesMap) {
+ if (filterPropertiesMap == null || filterPropertiesMap.isEmpty()) {
+ return obj.get();
+ }
+ JsonObject jsonObj = obj.get();
+ JsonObject result = new JsonObject();
+ if (jsonObj != null) {
+ String nodeType = "";
+ JsonObject properties = null;
+ // clone object
+ for (Map.Entry<String, JsonElement> mapEntry : jsonObj.entrySet()) {
+ String key = mapEntry.getKey(); JsonElement value = mapEntry.getValue();
+
+ // also, check if payload has node-type and properties fields
+ if (key.equals("node-type") && value != null) {
+ nodeType = value.getAsString();
+ } else if (key.equals("properties") && value != null && value.isJsonObject()) {
+ properties = value.getAsJsonObject();
+ }
+ result.add(key, value);
+ }
+
+ // Filter current object based on it containing fields: "node-type" and "properties"
+ if (!nodeType.isEmpty() && properties != null) {
+ filterByNodeTypeAndProperties(result, nodeType, properties, filterPropertiesMap);
+ } else {
+ // filter current object based on the: key - nodeType & value - JsonObject of nodes properties
+ filterByJsonObj(result, jsonObj, filterPropertiesMap);
+ }
+ }
+ return result;
+ }
+
+ /**
+ * Returns a JsonObject with filtered properties using "node-type" and "properties"
+ * Used for formats with payloads similar to simple and raw
+ * @param result
+ * @param nodeType
+ * @param properties
+ * @param filterPropertiesMap
+ * @return
+ */
+ private JsonObject filterByNodeTypeAndProperties(JsonObject result, String nodeType, JsonObject properties, Map<String, Set<String>> filterPropertiesMap) {
+ if (result == null || nodeType == null || nodeType.isEmpty() || properties == null || filterPropertiesMap == null) {
+ return result;
+ }
+ if (filterPropertiesMap.containsKey(nodeType)) { // filterPropertiesMap keys are nodeTypes - keys are obtained from the incoming query request
+ Set<String> filterSet = filterPropertiesMap.get(nodeType);
+ JsonObject filteredProperties = new JsonObject();
+ for (String property : filterSet) { // Each nodeType should have a set of properties to be retained in the response
+ if (properties.get(property) != null) {
+ filteredProperties.add(property, properties.get(property));
+ }
+ }
+ result.remove("properties");
+ result.add("properties", filteredProperties);
+ }
+ return result;
+ }
+
+ /**
+ * Returns a JsonObject with its properties filtered
+ * @param result
+ * @param jsonObj
+ * @param filterPropertiesMap
+ * @return
+ */
+ private JsonObject filterByJsonObj(JsonObject result, JsonObject jsonObj, Map<String, Set<String>> filterPropertiesMap) {
+ if (result == null || jsonObj == null || filterPropertiesMap == null) {
+ return result;
+ }
+
+ for (Map.Entry<String, JsonElement> mapEntry : jsonObj.entrySet()) {
+ String key = mapEntry.getKey(); JsonElement value = mapEntry.getValue();
+ JsonObject filteredProperties = new JsonObject();
+ if (value != null && value.isJsonObject() && filterPropertiesMap.containsKey(key)) {
+ JsonObject joProperties = value.getAsJsonObject();
+ Set<String> filterSet = filterPropertiesMap.get(key);
+ for (String property : filterSet) {
+ if (joProperties.get(property) != null) {
+ filteredProperties.add(property, joProperties.get(property));
+ }
+ }
+ result.remove(key);
+ result.add(key, filteredProperties);
+ }
+ }
+ return result;
+ }
+
+ /**
+ * Returns a filtered JsonObject with properties contained in the parameter filterPropertiesMap
+ * @param properties
+ * @param filterPropertiesMap
+ * @return
+ */
+ protected JsonObject filterProperties(Optional<JsonObject> properties, String nodeType, Map<String, Set<String>> filterPropertiesMap) {
+ if (filterPropertiesMap == null || filterPropertiesMap.isEmpty()) {
+ return properties.get();
+ }
+
+ JsonObject jo = properties.get();
+ JsonObject result = new JsonObject();
+ if (jo != null) {
+ // clone the object
+ for (Map.Entry<String, JsonElement> mapEntry : jo.entrySet()) {
+ String key = mapEntry.getKey();
+ JsonElement value = mapEntry.getValue();
+ result.add(key, value);
+ }
+
+ // filter the object
+ if (filterPropertiesMap.containsKey(nodeType)) {
+ Set<String> filterSet = filterPropertiesMap.get(nodeType);
+ for (Map.Entry<String, JsonElement> mapEntry : jo.entrySet()) {
+ String key = mapEntry.getKey();
+ if (!filterSet.contains(key)) {
+ result.remove(key);
+ }
+ }
+ }
+ }
+ return result;
+ }
+
@Override
public int parallelThreshold() {
return 100;
Code Review / aai / aai-common.git / blobdiff