/*******************************************************************************
 * Copyright (c) 2010 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/

package org.eclipse.help.internal.base.scope;

import java.util.Locale;

import org.eclipse.help.IIndexEntry;
import org.eclipse.help.IIndexSee;
import org.eclipse.help.IToc;
import org.eclipse.help.ITopic;
import org.eclipse.help.base.AbstractHelpScope;

/**
 * A scope which represents the union of two or more other scopes
 * An element is in scope if it is included in any scope passed to the constructor
 */

public class UnionScope extends AbstractHelpScope {
	
	AbstractHelpScope[] scopes;
	
	public UnionScope(AbstractHelpScope[] scopes) {
		this.scopes = scopes;
	}

	public boolean inScope(IToc toc) {
		for (int scope = 0; scope < scopes.length; scope ++) {
			if (scopes[scope].inScope(toc)) {
				return true;
			}
		}
		return false;
	}

	public boolean inScope(ITopic topic) {
		for (int scope = 0; scope < scopes.length; scope ++) {
			if (scopes[scope].inScope(topic)) {
				return true;
			}
		}
		return false;
	}

	public boolean inScope(IIndexEntry entry) {
		for (int scope = 0; scope < scopes.length; scope ++) {
			if (scopes[scope].inScope(entry)) {
				return true;
			}
		}
		return false;
	}

	public boolean inScope(IIndexSee see) {
		for (int scope = 0; scope < scopes.length; scope ++) {
			if (scopes[scope].inScope(see)) {
				return true;
			}
		}
		return false;
	}

	public String getName(Locale locale) {
		return null;
	}
	
	public boolean isHierarchicalScope() {
		for (int scope = 0; scope < scopes.length; scope ++) {
			if (!scopes[scope].isHierarchicalScope()) {
				return false;
			}
		}
		return true;
	}

	public String toString()
	{
		String str = "("; //$NON-NLS-1$
		for (int s=0;s<scopes.length;s++)
		{
			str+=scopes[s];
			if (s<scopes.length-1)
				str+=' '+ScopeRegistry.SCOPE_OR+' ';
		}
		return str+')';
	}
}
