XmlDataCollection.java

/*******************************************************************************
 * This file is part of OpenNMS(R).
 *
 * Copyright (C) 2010-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.protocols.xml.config;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;

import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlTransient;
import javax.xml.bind.annotation.XmlType;

import org.apache.commons.lang.builder.CompareToBuilder;
import org.apache.commons.lang.builder.EqualsBuilder;

/**
 * The Class XmlDataCollection.
 * 
 * <pre>
 * <xml-datacollection-config rrdRepository="/opt/opennms/share/rrd/snmp/"
 *    xmlns="http://xmlns.opennms.org/xsd/config/xml-datacollection">
 *    <xml-collection name="3GPP">
 *         <rrd step="300">
 *              <rra>RRA:AVERAGE:0.5:1:8928</rra>
 *              <rra>RRA:AVERAGE:0.5:12:8784</rra>
 *              <rra>RRA:MIN:0.5:12:8784</rra>
 *              <rra>RRA:MAX:0.5:12:8784</rra>
 *         </rrd>
 *         <xml-source url="sftp://{ipaddr}/opt/hitachi/cnp/data/pm/reports/3gpp/5/A{3gpp-range}_MME00001.xml"
 *              user-name="opennms" password="Op3nNmS!">
 *             <xml-group name="platform-system-resource" resource-type="platformSystemResource"
 *                  key-xpath="@measObjLdn"
 *                  resource-xpath="/measCollecFile/measData/measInfo[@measInfoId='platform-system|resource']/measValue">
 *                  <xml-object name="cpuUtilization" type="GAUGE" xpath="r[@p=1]" />
 *                  <xml-object name="memUtilization" type="GAUGE" xpath="r[@p=2]" />
 *                  <xml-object name="suspect" type="STRING" xpath="suspect" />
 *             </xml-group>
 *         </xml-source>
 *    </xml-collection>
 * </xml-datacollection-config>
 * </pre>
 * 
 * @author <a href="mailto:agalue@opennms.org">Alejandro Galue</a>
 */
@XmlType(name="xml-collection")
public class XmlDataCollection implements Serializable, Comparable<XmlDataCollection> {

    /** The Constant serialVersionUID. */
    private static final long serialVersionUID = 6448438583337362122L;

    /** The Constant OF_XML_SOURCES. */
    private static final XmlSource[] OF_XML_SOURCES = new XmlSource[0];

    /** The data collection name. */
    @XmlAttribute(name="name")
    private String m_name;

    /** The RRD configuration object. */
    @XmlElement(name="rrd")
    private XmlRrd m_xmlRrd;

    /** The XML Sources list. */
    @XmlElement(name="xml-source")
    private List<XmlSource> m_xmlSources = new ArrayList<XmlSource>();

    /**
     * Instantiates a new XML data collection.
     */
    public XmlDataCollection() {
    }

    /**
     * Gets the name.
     *
     * @return the name
     */
    @XmlTransient
    public String getName() {
        return m_name;
    }

    /**
     * Sets the name.
     *
     * @param name the new name
     */
    public void setName(String name) {
        m_name = name;
    }

    /**
     * Gets the XML RRD.
     *
     * @return the XML RRD
     */
    @XmlTransient
    public XmlRrd getXmlRrd() {
        return m_xmlRrd;
    }

    /**
     * Sets the XML RRD.
     *
     * @param xmlRrd the new XML RRD
     */
    public void setXmlRrd(XmlRrd xmlRrd) {
        m_xmlRrd = xmlRrd;
    }

    /**
     * Gets the XML sources.
     *
     * @return the XML sources
     */
    @XmlTransient
    public List<XmlSource> getXmlSources() {
        return m_xmlSources;
    }

    /**
     * Sets the XML sources.
     *
     * @param xmlSources the new XML sources
     */
    public void setXmlSources(List<XmlSource> xmlSources) {
        m_xmlSources = xmlSources;
    }

    /**
     * Adds a new XML source.
     *
     * @param source the source
     */
    public void addXmlSource(XmlSource source) {
        m_xmlSources.add(source);
    }

    /**
     * Removes a XML source.
     *
     * @param source the source
     */
    public void removeXmlSource(XmlSource source) {
        m_xmlSources.remove(source);
    }

    /* (non-Javadoc)
     * @see java.lang.Comparable#compareTo(java.lang.Object)
     */
    public int compareTo(XmlDataCollection obj) {
        return new CompareToBuilder()
        .append(getName(), obj.getName())
        .append(getXmlRrd(), obj.getXmlRrd())
        .append(getXmlSources().toArray(OF_XML_SOURCES), obj.getXmlSources().toArray(OF_XML_SOURCES))
        .toComparison();
    }

    /* (non-Javadoc)
     * @see java.lang.Object#equals(java.lang.Object)
     */
    @Override
    public boolean equals(Object obj) {
        if (obj instanceof XmlDataCollection) {
            XmlDataCollection other = (XmlDataCollection) obj;
            return new EqualsBuilder()
            .append(getName(), other.getName())
            .append(getXmlRrd(), other.getXmlRrd())
            .append(getXmlSources().toArray(OF_XML_SOURCES), other.getXmlSources().toArray(OF_XML_SOURCES))
            .isEquals();
        }
        return false;
    }

}