CONCONDEC: Simplify JSON to object mapping (#6)

* Replace ContainerManager.autowireComponent(this) with Spring annotations and dependency injection

* Test KnowledgePersistenceManager

Author: kleebaum

src/main/java/de/uhd/ifi/se/decision/management/confluence/macro/DecisionKnowledgeImportMacro.java

@@ -1,9 +1,7 @@
 package de.uhd.ifi.se.decision.management.confluence.macro;
 
-import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;
-import java.util.Optional;
 
 import org.springframework.beans.factory.annotation.Autowired;
 
@@ -14,12 +12,12 @@
 import com.atlassian.confluence.renderer.radeox.macros.MacroUtils;
 import com.atlassian.confluence.util.velocity.VelocityUtils;
 import com.atlassian.confluence.xhtml.api.MacroDefinition;
+import com.atlassian.fugue.Option;
 import com.atlassian.plugin.spring.scanner.annotation.imports.ComponentImport;
 import com.atlassian.webresource.api.assembler.PageBuilderService;
 
 import de.uhd.ifi.se.decision.management.confluence.model.DecisionKnowledgeElement;
 import de.uhd.ifi.se.decision.management.confluence.persistence.KnowledgePersistenceManager;
-import de.uhd.ifi.se.decision.management.confluence.persistence.impl.KnowledgePersistenceManagerImpl;
 
 public class DecisionKnowledgeImportMacro implements Macro {
 
@@ -39,13 +37,11 @@ public String execute(Map<String, String> map, String s, ConversionContext conve
 		String macroId = getMacroId(conversionContext);
 
 		// Save all issues in an ArrayList data structure.
-		KnowledgePersistenceManager persistenceManager = KnowledgePersistenceManagerImpl.getInstance();
-		List<ArrayList<DecisionKnowledgeElement>> jsonIssueArray = persistenceManager
-				.getElementsGroupedFromPageIdAndMacroId(pageId, macroId);
+		List<DecisionKnowledgeElement> knowledgeElements = KnowledgePersistenceManager.getElements(pageId, macroId);
 
 		// Create a new context for rendering...
 		Map<String, Object> renderContext = MacroUtils.defaultVelocityContext();
-		renderContext.put("jsonArrays", jsonIssueArray);
+		renderContext.put("knowledgeElements", knowledgeElements);
 
 		return VelocityUtils.getRenderedTemplate("/templates/standUpTable.vm", renderContext);
 	}
@@ -54,8 +50,9 @@ private String getMacroId(ConversionContext conversionContext) {
 		String macroId = "0";
 		try {
 			MacroDefinition macroDefinition = (MacroDefinition) conversionContext.getProperty("macroDefinition");
-			Optional<MacroId> option = macroDefinition.getMacroIdentifier();
+			Option<MacroId> option = macroDefinition.getMacroId();
 			macroId = option.get().getId();
+			System.out.println(macroId);
 		} catch (Exception e) {
 		}
 		return macroId;

src/main/java/de/uhd/ifi/se/decision/management/confluence/model/DecisionKnowledgeElement.java

@@ -1,5 +1,11 @@
 package de.uhd.ifi.se.decision.management.confluence.model;
 
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+
+import org.codehaus.jackson.map.JsonMappingException;
+import org.codehaus.jackson.map.ObjectMapper;
 import org.codehaus.jackson.map.annotate.JsonDeserialize;
 
 import de.uhd.ifi.se.decision.management.confluence.model.impl.DecisionKnowledgeElementImpl;
@@ -10,6 +16,30 @@
 @JsonDeserialize(as = DecisionKnowledgeElementImpl.class)
 public interface DecisionKnowledgeElement {
 
+	public static List<DecisionKnowledgeElement> parseJsonString(String jsonString) {
+		ObjectMapper objectMapper = new ObjectMapper();
+		objectMapper.writerWithDefaultPrettyPrinter();
+
+		List<DecisionKnowledgeElement> elements = new ArrayList<DecisionKnowledgeElement>();
+
+		try {
+			elements = objectMapper.readValue(jsonString, objectMapper.getTypeFactory()
+					.constructCollectionType(List.class, DecisionKnowledgeElementImpl.class));
+		} catch (JsonMappingException e) {
+			try {
+				List<DecisionKnowledgeElement[]> myelements = objectMapper.readValue(jsonString, objectMapper
+						.getTypeFactory().constructCollectionType(List.class, DecisionKnowledgeElementImpl[].class));
+				elements = Arrays.asList(myelements.get(0));
+			} catch (Exception e1) {
+				e1.printStackTrace();
+			}
+		} catch (Exception e) {
+			e.printStackTrace();
+		}
+
+		return elements;
+	}
+
 	int getPageId();
 
 	void setPageId(int pageId);
@@ -38,10 +68,6 @@ public interface DecisionKnowledgeElement {
 
 	void setMacroId(String macroId);
 
-	int getGroup();
-
-	void setGroup(Integer group);
-
 	String getDescription();
 
 	void setDescription(String description);

src/main/java/de/uhd/ifi/se/decision/management/confluence/model/impl/DecisionKnowledgeElementImpl.java

@@ -8,10 +8,14 @@
 import javax.xml.bind.annotation.XmlElement;
 import javax.xml.bind.annotation.XmlRootElement;
 
+import org.codehaus.jackson.annotate.JsonIgnoreProperties;
+import org.codehaus.jackson.annotate.JsonProperty;
+
 import de.uhd.ifi.se.decision.management.confluence.model.DecisionKnowledgeElement;
 
 @XmlRootElement
 @XmlAccessorType(XmlAccessType.FIELD)
+@JsonIgnoreProperties(ignoreUnknown = true)
 public class DecisionKnowledgeElementImpl implements DecisionKnowledgeElement {
 
 	@XmlElement
@@ -29,19 +33,16 @@ public class DecisionKnowledgeElementImpl implements DecisionKnowledgeElement {
 	@XmlElement
 	private String macroId;
 	@XmlElement
-	private Integer group;
-	@XmlElement
 	private String description;
 
 	public DecisionKnowledgeElementImpl(String link, int pageId, String summary, String type, String key,
-			String description, Integer group, String macroId) {
+			String description, String macroId) {
 		this.pageId = pageId;
 		this.summary = summary;
 		this.type = type;
 		this.key = key;
 		this.link = link;
 		this.description = description;
-		this.group = group;
 		this.macroId = macroId;
 
 		// generate unique id
@@ -114,6 +115,11 @@ public void setLink(String link) {
 		this.link = link;
 	}
 
+	@JsonProperty("url")
+	public void setUrl(String link) {
+		this.setLink(link);
+	}
+
 	@Override
 	public String getMacroId() {
 		return macroId;
@@ -124,16 +130,6 @@ public void setMacroId(String macroId) {
 		this.macroId = macroId;
 	}
 
-	@Override
-	public int getGroup() {
-		return this.group;
-	}
-
-	@Override
-	public void setGroup(Integer group) {
-		this.group = group;
-	}
-
 	@Override
 	public String getDescription() {
 		return description;

src/main/java/de/uhd/ifi/se/decision/management/confluence/persistence/KnowledgePersistenceManager.java

@@ -3,28 +3,83 @@
 import java.util.ArrayList;
 import java.util.List;
 
+import javax.inject.Inject;
+import javax.inject.Named;
+
+import com.atlassian.bandana.BandanaContext;
 import com.atlassian.bandana.BandanaManager;
+import com.atlassian.confluence.setup.bandana.ConfluenceBandanaContext;
+import com.atlassian.plugin.spring.scanner.annotation.imports.ConfluenceImport;
 
 import de.uhd.ifi.se.decision.management.confluence.model.DecisionKnowledgeElement;
 
-/**
- * Interface to store the knowledge imported from Jira.
+/*
+ * @issue How to store the knowledge in Confluence?
+ * @decision Use the Confluence BandanaManager for persistent storage! 
+ * See http://docs.atlassian.com/atlassian-bandana/0.2.0/com/atlassian/bandana/BandanaManager.html
  */
-public interface KnowledgePersistenceManager {
+@Named
+public class KnowledgePersistenceManager {
+
+	@ConfluenceImport
+	private static BandanaManager bandanaManager;
+	private static BandanaContext bandanaContext;
+
+	@Inject
+	public KnowledgePersistenceManager(BandanaManager bandanaManager) {
+		setBandanaManager(bandanaManager);
+		setBandanaContext(new ConfluenceBandanaContext("knowledge"));
+	}
+
+	public static void addDecisionKnowledgeElement(DecisionKnowledgeElement decisionKnowledgeElement) {
+		bandanaManager.setValue(bandanaContext, decisionKnowledgeElement.getId(), decisionKnowledgeElement);
+	}
+
+	public static void removeDecisionKnowledgeElement(String id) {
+		bandanaManager.removeValue(bandanaContext, id);
+	}
 
-	void addDecisionKnowledgeElement(DecisionKnowledgeElement decisionKnowledgeElement);
+	public static List<DecisionKnowledgeElement> getElements(int pageId, String macroId) {
+		List<DecisionKnowledgeElement> elements = new ArrayList<DecisionKnowledgeElement>();
 
-	void removeDecisionKnowledgeElement(String id);
+		for (String id : bandanaManager.getKeys(bandanaContext)) {
+			DecisionKnowledgeElement decisionKnowledgeElement = (DecisionKnowledgeElement) bandanaManager
+					.getValue(bandanaContext, id);
+			// add only if the page id and Macro id corresponds // if macro id is null
+			// return all from page
+			if (decisionKnowledgeElement != null && decisionKnowledgeElement.getPageId() == pageId
+					&& decisionKnowledgeElement.getMacroId() != null
+					&& (decisionKnowledgeElement.getMacroId().equals(macroId)) || macroId == null) {
+				elements.add(decisionKnowledgeElement);
+			}
+		}
+		return elements;
+	}
 
-	List<DecisionKnowledgeElement> getElements(int pageId, String macroId);
+	public static void removeDecisionKnowledgeElements(int pageId, String macroId) {
+		for (String id : bandanaManager.getKeys(bandanaContext)) {
+			DecisionKnowledgeElement decisionKnowledgeElement = (DecisionKnowledgeElement) bandanaManager
+					.getValue(bandanaContext, id);
+			// remove only if the page id and Macro id corresponds remove all where macroId
+			// is null
+			String issueMacroId = decisionKnowledgeElement.getMacroId();
 
-	List<ArrayList<DecisionKnowledgeElement>> getElementsGroupedFromPageIdAndMacroId(int pageId, String macroId);
+			if (isNullOrEmpty(issueMacroId) || (!isNullOrEmpty(issueMacroId)
+					&& decisionKnowledgeElement.getPageId() == pageId && issueMacroId.equals(macroId))) {
+				removeDecisionKnowledgeElement(decisionKnowledgeElement.getId());
+			}
+		}
+	}
 
-	void removeDecisionKnowledgeElement(int pageId, String macroId);
+	public static void setBandanaManager(BandanaManager bandanaManager) {
+		KnowledgePersistenceManager.bandanaManager = bandanaManager;
+	}
 
-	// Getters and setters for the BandanaManager are called by Confluence
-	// (injection).
-	BandanaManager getBandanaManager();
+	public static void setBandanaContext(BandanaContext bandanaContext) {
+		KnowledgePersistenceManager.bandanaContext = bandanaContext;
+	}
 
-	void setBandanaManager(BandanaManager bandanaManager);
+	public static boolean isNullOrEmpty(String myString) {
+		return myString == null || myString.isEmpty();
+	}
 }

src/main/java/de/uhd/ifi/se/decision/management/confluence/persistence/impl/KnowledgePersistenceManagerImpl.java

@@ -10,7 +10,7 @@ public interface KnowledgeRest {
 
 	Response storeKnowledgeElements(HttpServletRequest request, int pageId, String macroId, String jsonObjectString);
 
-	Response getKnowledgeElements(int pageId, String macroId);
+	Response getStoredKnowledgeElements(int pageId, String macroId);
 
 	Response getKnowledgeElementsFromJira(String projectKey, String query);