All Downloads are FREE. Search and download functionalities are using the official Maven repository.

me.shib.java.lib.jiraclient.greenhopper.Backlog Maven / Gradle / Ivy

package me.shib.java.lib.jiraclient.greenhopper;

import me.shib.java.lib.jiraclient.Field;
import me.shib.java.lib.jiraclient.JiraException;
import me.shib.java.lib.jiraclient.RestClient;
import net.sf.json.JSON;
import net.sf.json.JSONArray;
import net.sf.json.JSONObject;

import java.net.URI;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * GreenHopper backlog data.
 */
public class Backlog {

    private RestClient restclient = null;
    private List issues = null;
    private List backlogIssues = null;
    private int rankCustomFieldId = 0;
    private List sprints = null;
    private List projects = null;
    private List markers = null;
    private List epics = null;
    private boolean canEditEpics = false;
    private boolean canManageSprints = false;
    private boolean maxIssuesExceeded = false;
    private int queryResultLimit = 0;
    private Map> versionsPerProject = null;

    /**
     * Creates the backlog from a JSON payload.
     *
     * @param restclient REST client instance
     * @param json       JSON payload
     */
    protected Backlog(RestClient restclient, JSONObject json) {
        this.restclient = restclient;

        if (json != null)
            deserialise(json);
    }

    /**
     * Retrieves the backlog data for the given rapid view.
     *
     * @param restclient REST client instance
     * @param rv         Rapid View instance
     * @return the backlog
     * @throws JiraException when the retrieval fails
     */
    public static Backlog get(RestClient restclient, RapidView rv)
            throws JiraException {

        final int rvId = rv.getId();
        JSON result = null;

        try {
            URI reporturi = restclient.buildURI(
                    GreenHopperResource.RESOURCE_URI + "xboard/plan/backlog/data",
                    new HashMap() {{
                        put("rapidViewId", Integer.toString(rvId));
                    }});
            result = restclient.get(reporturi);
        } catch (Exception ex) {
            throw new JiraException("Failed to retrieve backlog data", ex);
        }

        if (!(result instanceof JSONObject))
            throw new JiraException("JSON payload is malformed");

        return new Backlog(restclient, (JSONObject) result);
    }

    private void deserialise(JSONObject json) {
        Map map = json;

        issues = GreenHopperField.getResourceArray(
                SprintIssue.class,
                map.get("issues"),
                restclient);
        rankCustomFieldId = Field.getInteger(map.get("rankCustomFieldId"));
        sprints = GreenHopperField.getResourceArray(
                Sprint.class,
                map.get("sprints"),
                restclient);
        projects = GreenHopperField.getResourceArray(
                RapidViewProject.class,
                map.get("projects"),
                restclient);
        markers = GreenHopperField.getResourceArray(
                Marker.class,
                map.get("markers"),
                restclient);
        canManageSprints = Field.getBoolean(map.get("canManageSprints"));
        maxIssuesExceeded = Field.getBoolean(map.get("maxIssuesExceeded"));
        queryResultLimit = Field.getInteger(map.get("queryResultLimit"));

        if (map.containsKey("epicData") && map.get("epicData") instanceof JSONObject) {
            Map epicData = (Map) map.get("epicData");

            epics = GreenHopperField.getResourceArray(Epic.class, epicData.get("epics"), restclient);
            canEditEpics = Field.getBoolean(epicData.get("canEditEpics"));
        }

        if (map.containsKey("versionData") && map.get("versionData") instanceof JSONObject) {
            Map verData = (JSONObject) map.get("versionData");

            if (verData.containsKey("versionsPerProject") &&
                    verData.get("versionsPerProject") instanceof JSONObject) {

                Map verMap = (Map) verData.get("versionsPerProject");
                versionsPerProject = new HashMap>();

                for (Map.Entry kvp :
                        (Iterable>) verMap.entrySet()) {

                    if (!(kvp.getValue() instanceof JSONArray))
                        continue;

                    List versions = new ArrayList();

                    for (Object item : (JSONArray) kvp.getValue()) {
                        if (!(item instanceof JSONObject))
                            continue;

                        RapidViewVersion ver = new RapidViewVersion(restclient, (JSONObject) item);
                        versions.add(ver);
                    }

                    versionsPerProject.put(kvp.getKey(), versions);
                }
            }
        }

        //determining which issues are actually in the backlog vs the sprints
        //fill in the issues into the single sprints and the backlog issue list respectively
        for (SprintIssue issue : issues) {
            boolean addedToSprint = false;
            for (Sprint sprint : sprints) {
                if (sprint.getIssuesIds().contains(issue.getId())) {
                    sprint.getIssues().add(issue);
                    addedToSprint = true;
                }
            }
            if (!addedToSprint) {
                if (backlogIssues == null) {
                    backlogIssues = new ArrayList();
                }
                backlogIssues.add(issue);
            }
        }

    }

    public List getIssues() {
        return issues;
    }

    public List getBacklogIssues() {
        return backlogIssues;
    }

    public int getRankCustomFieldId() {
        return rankCustomFieldId;
    }

    public List getSprints() {
        return sprints;
    }

    public List getProjects() {
        return projects;
    }

    public List getMarkers() {
        return markers;
    }

    public List getEpics() {
        return epics;
    }

    public boolean canEditEpics() {
        return canEditEpics;
    }

    public boolean canManageSprints() {
        return canManageSprints;
    }

    public boolean maxIssuesExceeded() {
        return maxIssuesExceeded;
    }

    public int queryResultLimit() {
        return queryResultLimit;
    }

    public Map> getVersionsPerProject() {
        return versionsPerProject;
    }
}





© 2015 - 2025 Weber Informatics LLC | Privacy Policy