org.opennms.web.svclayer.model.GraphResults Maven / Gradle / Ivy

Go to download
/*
 * Licensed to The OpenNMS Group, Inc (TOG) under one or more
 * contributor license agreements.  See the LICENSE.md file
 * distributed with this work for additional information
 * regarding copyright ownership.
 *
 * TOG licenses this file to You under the GNU Affero General
 * Public License Version 3 (the "License") or (at your option)
 * any later version.  You may not use this file except in
 * compliance with the License.  You may obtain a copy of the
 * License at:
 *
 *      https://www.gnu.org/licenses/agpl-3.0.txt
 *
 * 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.
 */
package org.opennms.web.svclayer.model;

import java.util.Calendar;
import java.util.Date;
import java.util.GregorianCalendar;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;

import org.opennms.netmgt.model.OnmsResource;

/**
 * GraphResults class.
 *
 * @author ranger
 * @version $Id: $
 * @since 1.8.1
 */
public class GraphResults {
    //note these run from 0-11, this is because of java.util.Calendar!
    private static final String[] s_months = new String[] {
        "January",
        "February",
        "March",
        "April",
        "May",
        "June",
        "July",
        "August",
        "September",
        "October",
        "November",
        "December"
    };
    private static final Map s_monthMap;
    
    private static final String[] s_hours;
    private static final Map s_hourMap;

    private String[] m_reports;
    private String m_nodeCriteria;
    private String m_generatedId;
    
    private Date m_start;
    private Date m_end;
    private String m_relativeTime;
    private RelativeTimePeriod[] m_relativeTimePeriods;
    
    private List m_graphResultSets =
        new LinkedList();

    private List m_resourceTypes =
            new LinkedList();

    private Map> m_graphResultMap =
            new HashMap>();

    private int m_graphTopOffsetWithText;
    private int m_graphLeftOffset;
    private int m_graphRightOffset;
    private int m_resourceIndex = 0;
    
    // FIXME: this is very US-centric; can we have it use the system locale?
    static {
        s_monthMap = new LinkedHashMap();
        for (int i = 0; i < s_months.length; i++) {
            s_monthMap.put(i, s_months[i]);
        }
        
        s_hours = new String[24];
        for (int i = 0; i < s_hours.length; i++) {
            int hour = i % 12;
            if (hour == 0) {
                hour = 12;
            }
            s_hours[i] = hour + " " + (i < 12 ? "AM" : "PM");
        }
        
        s_hourMap = new LinkedHashMap();
        for (int i = 0; i < s_hours.length; i++) {
            s_hourMap.put(i, s_hours[i]);
        }
        
    }

    /**
     * setStart
     *
     * @param start a {@link java.util.Date} object.
     */
    public void setStart(Date start) {
        m_start = start;
    }

    /**
     * getStart
     *
     * @return a {@link java.util.Date} object.
     */
    public Date getStart() {
        return m_start;
    }
    
    /**
     * getStartCalendar
     *
     * @return a {@link org.opennms.web.svclayer.model.GraphResults.BeanFriendlyCalendar} object.
     */
    public BeanFriendlyCalendar getStartCalendar() {
        return new BeanFriendlyCalendar(m_start);
    }

    /**
     * setEnd
     *
     * @param end a {@link java.util.Date} object.
     */
    public void setEnd(Date end) {
        m_end = end;
    }

    /**
     * getEnd
     *
     * @return a {@link java.util.Date} object.
     */
    public Date getEnd() {
        return m_end;
    }

    /**
     * getEndCalendar
     *
     * @return a {@link org.opennms.web.svclayer.model.GraphResults.BeanFriendlyCalendar} object.
     */
    public BeanFriendlyCalendar getEndCalendar() {
        return new BeanFriendlyCalendar(m_end);
    }

    /**
     * setRelativeTime
     *
     * @param relativeTime a {@link java.lang.String} object.
     */
    public void setRelativeTime(String relativeTime) {
        m_relativeTime = relativeTime;
    }

    /**
     * getRelativeTime
     *
     * @return a {@link java.lang.String} object.
     */
    public String getRelativeTime() {
        return m_relativeTime;
    }

    /**
     * setRelativeTimePeriods
     *
     * @param relativeTimePeriods an array of {@link org.opennms.web.graph.RelativeTimePeriod} objects.
     */
    public void setRelativeTimePeriods(RelativeTimePeriod[]
				       relativeTimePeriods) {
	m_relativeTimePeriods = relativeTimePeriods;
    }

    /**
     * getRelativeTimePeriods
     *
     * @return an array of {@link org.opennms.web.graph.RelativeTimePeriod} objects.
     */
    public RelativeTimePeriod[] getRelativeTimePeriods() {
	return m_relativeTimePeriods;
    }
    
    /**
     * getMonths
     *
     * @return an array of {@link java.lang.String} objects.
     */
    public static String[] getMonths() {
        return s_months;
    }
    
    /**
     * getMonthMap
     *
     * @return a {@link java.util.Map} object.
     */
    public Map getMonthMap() {
        return s_monthMap;
    }
    
    /**
     * getHours
     *
     * @return an array of {@link java.lang.String} objects.
     */
    public static String[] getHours() {
        return s_hours;
    }
    
    /**
     * getHourMap
     *
     * @return a {@link java.util.Map} object.
     */
    public Map getHourMap() {
        return s_hourMap;
    }
    
    /**
     * addGraphResultSet
     *
     * @param resultSet a {@link org.opennms.web.svclayer.model.GraphResults.GraphResultSet} object.
     */
    public void addGraphResultSet(GraphResultSet resultSet) {
        resultSet.setIndex(m_resourceIndex++);
        m_graphResultSets.add(resultSet);
        String resourceType = resultSet.getResource().getResourceType().getLabel();
        if (!m_resourceTypes.contains(resourceType)) {
            m_resourceTypes.add(resourceType);
        }
        if (!m_graphResultMap.containsKey(resourceType)) {
            m_graphResultMap.put(resourceType, new LinkedList());
        }
        m_graphResultMap.get(resourceType).add(resultSet);
    }

    /**
     * getGraphResultSets
     *
     * @return a {@link java.util.List} object.
     */
    public List getResourceTypes() {
        return m_resourceTypes;
    }

    /**
     * getGraphResultSets
     *
     * @return a {@link java.util.List} object.
     */
    public List getGraphResultSets() {
        return m_graphResultSets;
    }
    
    /**
     * getGraphResultMap
     *
     * @return a {@link java.util.Map} object.
     */
    public Map> getGraphResultMap() {
        return m_graphResultMap;
    }
    
    /**
     * getReports
     *
     * @return an array of {@link java.lang.String} objects.
     */
    public String[] getReports() {
        return m_reports;
    }

    /**
     * setReports
     *
     * @param reports an array of {@link java.lang.String} objects.
     */
    public void setReports(String[] reports) {
        m_reports = reports;
    }

    public String getNodeCriteria() {
        return m_nodeCriteria;
    }

    public void setNodeCriteria(String nodeCriteria) {
        m_nodeCriteria = nodeCriteria;
    }

    public String getGeneratedId() {
        return m_generatedId;
    }

    public void setGeneratedId(String generatedId) {
        m_generatedId = generatedId;
    }

    /** Represents a group of graphs within a resource. */
    public class GraphResultSet {
        private List m_graphs = null;
        
        private OnmsResource m_resource;
        
        private int m_index;
        
        public GraphResultSet() {
        }
        
        public void setResource(OnmsResource resource) {
            m_resource = resource;
        }
        
        public OnmsResource getResource() {
            return m_resource;
        }

        public List getGraphs() {
            return m_graphs;
        }

        public void setGraphs(List graphs) {
            m_graphs = graphs;
        }

        public int getIndex() {
            return m_index;
        }

        public void setIndex(int index) {
            m_index = index;
        }
    }

    public static class BeanFriendlyCalendar extends GregorianCalendar {
        /**
         * 
         */
        private static final long serialVersionUID = -4145668894553732167L;

        public BeanFriendlyCalendar(Date date) {
            super();
            setTime(date);
        }
        
        public int getYear() {
            return get(Calendar.YEAR);
        }
        
        public int getMonth() {
            return get(Calendar.MONTH); 
        }
        
        public int getDate() {
            return get(Calendar.DATE); 
        }
        
        public int getHourOfDay() {
            return get(Calendar.HOUR_OF_DAY); 
        }
    }

    /**
     * getGraphLeftOffset
     *
     * @return a int.
     */
    public int getGraphLeftOffset() {
        return m_graphLeftOffset;
    }

    /**
     * setGraphLeftOffset
     *
     * @param graphLeftOffset a int.
     */
    public void setGraphLeftOffset(int graphLeftOffset) {
        m_graphLeftOffset = graphLeftOffset;
        
    }
    
    /**
     * getGraphRightOffset
     *
     * @return a int.
     */
    public int getGraphRightOffset() {
        return m_graphRightOffset;
    }

    /**
     * setGraphRightOffset
     *
     * @param graphRightOffset a int.
     */
    public void setGraphRightOffset(int graphRightOffset) {
        m_graphRightOffset = graphRightOffset;
    }

    /**
     * getGraphTopOffsetWithText
     *
     * @return a int.
     */
    public int getGraphTopOffsetWithText() {
        return m_graphTopOffsetWithText;
    }

    /**
     * setGraphTopOffsetWithText
     *
     * @param graphTopOffsetWithText a int.
     */
    public void setGraphTopOffsetWithText(int graphTopOffsetWithText) {
        m_graphTopOffsetWithText = graphTopOffsetWithText;
    }

}