NotifyServices.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 java.util.List;
import java.util.Map;

import alma.ACSErrTypeCommon.wrappers.AcsJCouldntPerformActionEx;

/**
 * Encapsulates a <code>List<NotifyServiceData></code>.
 * It gets created by {@link EventModel} to pass around its (alive) list of Notify Services to GUI elements.
 * <p>
 * TODO: Replace with EMF generated class.
 */
public class NotifyServices {
	
	private final Map<String, NotifyServiceData> services;
	
	NotifyServices(Map<String, NotifyServiceData> services) {
		this.services = services;
	}
	
	/**
	 * Gets the live, unordered list of notify services.
	 */
	public List<NotifyServiceData> getServices() {
		return new ArrayList<NotifyServiceData>(services.values());
	}
	
	public NotifyServiceData findHostingService(String channelName) {
		for (NotifyServiceData service : services.values()) {
			ChannelData channelData = service.getChannelByName(channelName);
			if (channelData != null) {
				return service;
			}
		}
		return null;
	}
	
	/**
	 * Searches the local data structures for an NC of the given name.
	 * 
	 * @param channelName
	 *            The name of the NC to search for.
	 * @return The matching ChannelData, or <code>null</code> if no match was found.
	 * @throws AcsJCouldntPerformActionEx
	 *             If more than one channel was found with this name. Such a misconfiguration could happen for channels
	 *             not registered in the naming service, or if two NCs have the same name but different NC domains. In
	 *             any case it is considered an error.
	 */
	public ChannelData findChannel(String channelName) throws AcsJCouldntPerformActionEx {
		List<ChannelData> matches = new ArrayList<ChannelData>();
		for (NotifyServiceData service : services.values()) {
			ChannelData channelData = service.getChannelByName(channelName);
			if (channelData != null) {
				matches.add(channelData);
			}
		}
		if (matches.isEmpty()) {
			return null;
		}
		else if (matches.size() == 1) {
			return matches.get(0);
		}
		else {
			String msg = "Found more than one NC matching the name '" + channelName + "': ";
			for (ChannelData channelData : matches) {
				msg += channelData.getQualifiedName() + " ";
			}
			AcsJCouldntPerformActionEx ex = new AcsJCouldntPerformActionEx(msg);
			// todo: set details, or use a better fitting exception type
			throw ex;
		}
	}

	public List<ChannelData> getAllChannels() {
		List<ChannelData> ret = new ArrayList<ChannelData>();
		for (NotifyServiceData service : services.values()) {
			ret.addAll(service.getChannels());
		}
		return ret;
	}


}