ChannelData.java

/*******************************************************************************
 * ALMA - Atacama Large Millimeter Array
 * Copyright (c) ESO - European Southern Observatory, 2011
 * (in the framework of the ALMA collaboration).
 * All rights reserved.
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library 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
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
 *******************************************************************************/
package alma.acs.nsstatistics;

import java.util.ArrayList;

import org.omg.CosNotifyChannelAdmin.EventChannel;


/**
 * Gets created by EventModel#getChannelStatistics()
 * @author jschwarz
 *
 */
public class ChannelData extends AbstractNotifyServiceElement implements Comparable<ChannelData> {
	
	private final NotifyServiceData parent;
	private final EventChannel corbaRef;
	private int ncId = -1;
	
	private boolean isNewNc = true;
	
	private int numberConsumers;
	private int numberSuppliers;
	private int deltaConsumers;
	private int deltaSuppliers;

	/**
	 * False for system NCs that are not registered in the naming service (which would confuse the NCSubscriber),
	 * or NCs that transmit non-standard event types. 
	 */
	private boolean isSubscribable = true;

	private boolean subscribed = false;
	
	private final ChannelConsumers ccon;
	private final ChannelSuppliers csup;
	private final ChannelQueueSize cqs;
	private final SlowestConsumers slcon;

	
	public ChannelData(EventChannel corbaRef, String name, NotifyServiceData parent) {
		super(name);
		this.corbaRef = corbaRef;
		this.parent = parent;
		
		ccon = new ChannelConsumers(this);
		csup = new ChannelSuppliers(this);
		cqs = new ChannelQueueSize(this);
		slcon = new SlowestConsumers(this, cqs);
	}
	
	public NotifyServiceData getParent() {
		return parent;
	}

	/**
	 * Returns the concatenation of the simple service name and the channel name, with a '#' in between.
	 * This is useful to get globally unique NC names even for the case where
	 * in the absence of a real name we use the channel Id as the name. 
	 */
	public String getQualifiedName() {
		return ( parent.getName() + "#" + getName() );
	}
	
	public void setIsNewNc(boolean isNewNc) {
		this.isNewNc = isNewNc;
	}
	
	public boolean isNewNc() {
		return isNewNc;
	}
	
	public boolean isSubscribable() {
		return isSubscribable;
	}

	public void markUnsubscribable() {
		this.isSubscribable = false;;
	}

	public EventChannel getCorbaRef() {
		return corbaRef;
	}
	
	public int getNcId() {
		return ncId;
	}

	public void setNcId(int ncId) {
		if (this.ncId < 0) {
			// allow setting the id only once
			this.ncId = ncId;
		}
		else {
			throw new IllegalStateException("ncId has already been set.");
		}
	}

	public void setNumberConsumers(int numberConsumers) {
		this.numberConsumers = numberConsumers;
	}

	public void setNumberSuppliers(int numberSuppliers) {
		this.numberSuppliers = numberSuppliers;
	}

	public void setDeltaConsumers(int numberConsumers) {
		this.deltaConsumers = numberConsumers;
	}

	public void setDeltaSuppliers(int numberSuppliers) {
		this.deltaSuppliers = numberSuppliers;
	}

	@Override
	public int getNumberConsumers() {
		return numberConsumers;
	}

	@Override
	public int getNumberSuppliers() {
		return numberSuppliers;
	}

	@Override
	public int getDeltaConsumers() {
		return deltaConsumers;
	}

	@Override
	public int getDeltaSuppliers() {
		return deltaSuppliers;
	}


	/**
	 * The returned nodes will show up as children of the NC in the channel tree view.
	 */
	public ArrayList<MCStatistics> getStatistics() {
		ArrayList<MCStatistics> statistics= new ArrayList<MCStatistics>(4);
		if (parent.isReachable()) {
			statistics.add(ccon);
			statistics.add(csup);
			statistics.add(cqs);
			if (cqs.getQueueSize() != 0) {// Only display "slowest consumers" for a non-zero queue 
				statistics.add(slcon);
			}
		}
		return statistics;
	}
	
	/**
	 * Sets the subscription flag, without taking any subscription actions.
	 */
	public void setSubscribed(boolean isSubscribed) {
		subscribed = isSubscribed;
	}
	
	public boolean isSubscribed() {
		return subscribed;
	}

	
	
	@Override
	public int compareTo(ChannelData o) {
		return getName().compareTo(o.getName());
	}
	
	@Override
	public boolean equals(Object o) {
		if (o == null || !(o instanceof ChannelData)) {
			return false;
		}
		return getName().equals(((AbstractNotifyServiceElement)o).getName());
	}
	
	@Override
	public int hashCode() {
		return getName().hashCode();
	}

}