org.semanticweb.elk.reasoner.taxonomy.impl.SimpleNode Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of elk-reasoner Show documentation
The core ELK Reasoner package
There is a newer version: 0.29.0
/*
 * #%L
 * ELK Reasoner
 * $Id:$
 * $HeadURL:$
 * %%
 * Copyright (C) 2011 - 2013 Department of Computer Science, University of Oxford
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */
package org.semanticweb.elk.reasoner.taxonomy.impl;

import java.util.ArrayList;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;

import org.semanticweb.elk.reasoner.taxonomy.model.ComparatorKeyProvider;
import org.semanticweb.elk.reasoner.taxonomy.model.Node;

/**
 * A simple implementation of immutable node.
 * 
 * The members are stored in a sorted {@link ArrayList} and looked up by binary
 * search.
 * 
 * @author Peter Skocovsky
 *
 * @param 
 *            The type of members of this node.
 */
public class SimpleNode implements Node {

	/**
	 * The members of this node.
	 */
	protected final List members_;
	/**
	 * The key provider for the members of this node.
	 */
	private final ComparatorKeyProvider keyProvider_;

	/**
	 * Creates a node containing the specified members.
	 * 
	 * @param members
	 *            The members this node should contain.
	 * @param size
	 *            The number of the specified members.
	 * @param keyProvider
	 *            The key provider for the members.
	 */
	public SimpleNode(final Iterable members, final int size,
			final ComparatorKeyProvider keyProvider) {
		if (keyProvider == null) {
			throw new IllegalArgumentException("keyProvider cannot be null!");
		}
		keyProvider_ = keyProvider;
		if (members == null || size <= 0) {
			this.members_ = new ArrayList();
		} else {
			this.members_ = new ArrayList(size);
			for (T member : members) {
				this.members_.add(member);
			}
			Collections.sort(this.members_, getKeyProvider().getComparator());
		}
	}

	/**
	 * Creates an empty node.
	 * 
	 * @param comparatorKeyProvider
	 *            The key provider for the members.
	 */
	public SimpleNode(
			final ComparatorKeyProvider comparatorKeyProvider) {
		this(null, 0, comparatorKeyProvider);
	}

	@Override
	public ComparatorKeyProvider getKeyProvider() {
		return keyProvider_;
	}

	@Override
	public Iterator iterator() {
		return members_.iterator();
	}

	@Override
	public boolean contains(final T member) {
		return (Collections.binarySearch(members_, member,
				getKeyProvider().getComparator()) >= 0);
	}

	@Override
	public int size() {
		return members_.size();
	}

	@Override
	public T getCanonicalMember() {
		return members_.isEmpty() ? null : members_.get(0);
	}

	@Override
	public String toString() {
		return members_.toString();
	}

}