PrefabGraph.java

/*******************************************************************************
 * This file is part of OpenNMS(R).
 *
 * Copyright (C) 2007-2011 The OpenNMS Group, Inc.
 * OpenNMS(R) is Copyright (C) 1999-2011 The OpenNMS Group, Inc.
 *
 * OpenNMS(R) is a registered trademark of The OpenNMS Group, Inc.
 *
 * OpenNMS(R) is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published
 * by the Free Software Foundation, either version 3 of the License,
 * or (at your option) any later version.
 *
 * OpenNMS(R) is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with OpenNMS(R).  If not, see:
 *      http://www.gnu.org/licenses/
 *
 * For more information contact:
 *     OpenNMS(R) Licensing <license@opennms.org>
 *     http://www.opennms.org/
 *     http://www.opennms.com/
 *******************************************************************************/

package org.opennms.netmgt.model;

import org.springframework.util.Assert;

/**
 * <p>PrefabGraph class.</p>
 */
public class PrefabGraph extends Object implements Comparable<PrefabGraph> {
    private String m_name;

    private String m_title;

    private String[] m_columns;

    private String m_command;

    private String[] m_externalValues;
    
    private String[] m_propertiesValues;

    private int m_order;

    private String[] m_types = new String[0];

    private String m_description;

    private Integer m_graphWidth;

    private Integer m_graphHeight;
    
    private String[] m_suppress;

    /**
     * <p>Constructor for PrefabGraph.</p>
     *
     * @param name a {@link java.lang.String} object.
     * @param title a {@link java.lang.String} object.
     * @param columns an array of {@link java.lang.String} objects.
     * @param command a {@link java.lang.String} object.
     * @param externalValues an array of {@link java.lang.String} objects.
     * @param propertiesValues an array of {@link java.lang.String} objects.
     * @param order a int.
     * @param types an array of {@link java.lang.String} objects.
     * @param description a {@link java.lang.String} object.
     * @param graphWidth a {@link java.lang.Integer} object.
     * @param graphHeight a {@link java.lang.Integer} object.
     * @param suppress an array of {@link java.lang.String} objects.
     */
    public PrefabGraph(String name, String title, String[] columns,
            String command, String[] externalValues,
            String[] propertiesValues, int order, String[] types,
            String description, Integer graphWidth, Integer graphHeight,
            String[] suppress) {
        Assert.notNull(name, "name argument cannot be null");
        Assert.notNull(title, "title argument cannot be null");
        Assert.notNull(columns, "columns argument cannot be null");
        Assert.notNull(command, "command argument cannot be null");
        Assert.notNull(externalValues, "externalValues argument cannot be null");
        Assert.notNull(propertiesValues, "propertiesValues argument cannot be null");
        Assert.notNull(suppress, "suppress argument cannot be null");

        m_name = name;
        m_title = title;
        m_columns = columns;
        m_command = command;
        m_externalValues = externalValues;
        m_propertiesValues = propertiesValues;
        m_order = order;
        m_suppress = suppress;

        m_types = types;
        m_description = description;
        m_graphWidth = graphWidth;
        m_graphHeight = graphHeight;
    }

    /**
     * <p>getName</p>
     *
     * @return a {@link java.lang.String} object.
     */
    public String getName() {
        return m_name;
    }

    /**
     * <p>getTitle</p>
     *
     * @return a {@link java.lang.String} object.
     */
    public String getTitle() {
        return m_title;
    }

    /**
     * <p>getOrder</p>
     *
     * @return a int.
     */
    public int getOrder() {
        return m_order;
    }

    /**
     * <p>getColumns</p>
     *
     * @return an array of {@link java.lang.String} objects.
     */
    public String[] getColumns() {
        return m_columns;
    }

    /**
     * <p>getCommand</p>
     *
     * @return a {@link java.lang.String} object.
     */
    public String getCommand() {
        return m_command;
    }

    /**
     * <p>getExternalValues</p>
     *
     * @return an array of {@link java.lang.String} objects.
     */
    public String[] getExternalValues() {
        return m_externalValues;
    }

    /**
     * <p>getPropertiesValues</p>
     *
     * @return list of required string properties
     * @see org.opennms.netmgt.model.StringPropertyAttribute
     */
    public String[] getPropertiesValues() {
        return m_propertiesValues;
    }

    /**
     * Can be null.
     *
     * @return an array of {@link java.lang.String} objects.
     */
    public String[] getTypes() {
        return m_types;
    }
    
    /**
     * <p>hasMatchingType</p>
     *
     * @param matchingTypes a {@link java.lang.String} object.
     * @return a boolean.
     */
    public boolean hasMatchingType(String... matchingTypes) {
        for (String matchingType : matchingTypes) {
            for (String type : m_types) {
                if (type != null && type.equals(matchingType)) {
                    return true;
                }
            }
        }
        return false;
    }

    /**
     * Can be null.
     *
     * @return a {@link java.lang.String} object.
     */
    public String getDescription() {
        return m_description;
    }

    /**
     * Can be null.
     *
     * @return a {@link java.lang.Integer} object.
     */
    public Integer getGraphWidth() {
        return m_graphWidth;
    }

    /**
     * Can be null.
     *
     * @return a {@link java.lang.Integer} object.
     */
    public Integer getGraphHeight() {
        return m_graphHeight;
    }
    
    /**
     * <p>getSuppress</p>
     *
     * @return an array of {@link java.lang.String} objects.
     */
    public String[] getSuppress() {
        return m_suppress;
    }

    /**
     * <p>compareTo</p>
     *
     * @param other a {@link org.opennms.netmgt.model.PrefabGraph} object.
     * @return a int.
     */
    public int compareTo(PrefabGraph other) {
        if (other == null) {
            throw new IllegalArgumentException("Cannot take null parameters.");
        }

        return getOrder() - other.getOrder();
    }
}