JavaOclSet.java

/**
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 * Copyright (C) 2007 Ronny Brandt (Ronny_Brandt@web.de).                    *
 * All rights reserved.                                                      *
 *                                                                           *
 * This work was done as a project at the Chair for Software Technology,     *
 * Dresden University Of Technology, Germany (http://st.inf.tu-dresden.de).  *
 * It is understood that any modification not identified as such is not      *
 * covered by the preceding statement.                                       *
 *                                                                           *
 * This work is free software; you can redistribute it and/or modify it      *
 * under the terms of the GNU Library General Public License as published    *
 * by the Free Software Foundation; either version 2 of the License, or      *
 * (at your option) any later version.                                       *
 *                                                                           *
 * This work 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 Library General Public     *
 * License for more details.                                                 *
 *                                                                           *
 * You should have received a copy of the GNU Library General Public License *
 * along with this library; if not, you can view it online at                *
 * http://www.fsf.org/licensing/licenses/gpl.html.                           *
 *                                                                           *
 * To submit a bug report, send a comment, or get the latest news on this    *
 * project, please visit the website: http://dresden-ocl.sourceforge.net.    *
 * For more information on OCL and related projects visit the OCL Portal:    *
 * http://st.inf.tu-dresden.de/ocl                                           *
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 */
package org.dresdenocl.standardlibrary.java.internal.library;

import java.util.ArrayList;
import java.util.Collection;
import java.util.HashSet;
import java.util.Set;

import org.dresdenocl.essentialocl.EssentialOclPlugin;
import org.dresdenocl.essentialocl.standardlibrary.OclAny;
import org.dresdenocl.essentialocl.standardlibrary.OclBag;
import org.dresdenocl.essentialocl.standardlibrary.OclBoolean;
import org.dresdenocl.essentialocl.standardlibrary.OclSet;
import org.dresdenocl.modelinstancetype.types.IModelInstanceCollection;
import org.dresdenocl.modelinstancetype.types.IModelInstanceElement;
import org.dresdenocl.pivotmodel.Type;
import org.dresdenocl.standardlibrary.java.factory.JavaStandardLibraryFactory;

/**
 * <p>
 * Provides an implementation of {@link OclSet} in Java.
 * </p>
 * 
 * @author Michael Thiele
 * @author Ronny Brandt
 */
@SuppressWarnings("unchecked")
public class JavaOclSet<T extends OclAny> extends JavaOclUnsortedCollection<T>
		implements OclSet<T> {

	/**
	 * <p>
	 * Instantiates a {@link JavaOclSet}.
	 * </p>
	 * 
	 * @param adaptee
	 *            The adapted model instance object of this {@link JavaOclSet}.
	 */
	public JavaOclSet(
			IModelInstanceCollection<IModelInstanceElement> imiCollection,
			Type genericType) {

		super(imiCollection, genericType);
	}

	public JavaOclSet(String undefinedReason, Type genericType) {

		super(undefinedReason, genericType);
	}

	public JavaOclSet(Throwable invalidReason, Type genericType) {

		super(invalidReason, genericType);
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see
	 * org.dresdenocl.essentialocl.standardlibrary.OclSet#complement(
	 * org.dresdenocl.essentialocl.standardlibrary.OclSet)
	 */
	public OclSet<T> complement(OclSet<T> that) {

		OclSet<T> result = null;

		result = checkInvalid(EssentialOclPlugin.getOclLibraryProvider()
				.getOclLibrary().getSetType(genericType), this, that);

		if (result == null)
			result = checkUndefined("complement",
					EssentialOclPlugin.getOclLibraryProvider().getOclLibrary()
							.getSetType(genericType), this, that);

		if (result == null) {
			Set<IModelInstanceElement> complement = new HashSet<IModelInstanceElement>();

			Collection<IModelInstanceElement> otherCollection = (Collection<IModelInstanceElement>) that
					.getModelInstanceCollection().getCollection();

			complement.addAll(getModelInstanceCollection().getCollection());
			complement.removeAll(otherCollection);

			result = JavaStandardLibraryFactory.INSTANCE.createOclSet(
					complement, genericType);
		}

		return result;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see
	 * org.dresdenocl.essentialocl.standardlibrary.OclSet#excluding(java
	 * .lang.Object)
	 */
	public OclSet<T> excluding(T that) {

		OclSet<T> result = null;

		result = checkInvalid(EssentialOclPlugin.getOclLibraryProvider()
				.getOclLibrary().getSetType(genericType), this, that);

		if (result == null)
			result = checkUndefined("excluding",
					EssentialOclPlugin.getOclLibraryProvider().getOclLibrary()
							.getSetType(genericType), this);

		if (result == null) {
			Set<IModelInstanceElement> exclude = new HashSet<IModelInstanceElement>();

			exclude.addAll(getModelInstanceCollection().getCollection());
			exclude.remove(that.getModelInstanceElement());

			result = JavaStandardLibraryFactory.INSTANCE.createOclSet(exclude,
					genericType);
		}

		return result;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see
	 * org.dresdenocl.essentialocl.standardlibrary.OclCollection#flatten
	 * ()
	 */
	public <T2 extends OclAny> OclSet<T2> flatten() {

		OclSet<T2> result = null;

		result = checkInvalid(EssentialOclPlugin.getOclLibraryProvider()
				.getOclLibrary().getSetType(genericType), this);

		if (result == null)
			result = checkUndefined("flatten",
					EssentialOclPlugin.getOclLibraryProvider().getOclLibrary()
							.getSetType(genericType), this);

		if (result == null) {
			Set<IModelInstanceElement> flat = new HashSet<IModelInstanceElement>();

			Type resultType = flatRec(this.getModelInstanceCollection()
					.getCollection(), flat);

			result = JavaStandardLibraryFactory.INSTANCE.createOclSet(flat,
					resultType);
		}

		return result;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see
	 * org.dresdenocl.essentialocl.standardlibrary.OclSet#including(java
	 * .lang.Object)
	 */
	public OclSet<T> including(T that) {

		OclSet<T> result = null;

		result = checkInvalid(EssentialOclPlugin.getOclLibraryProvider()
				.getOclLibrary().getSetType(genericType), this, that);

		if (result == null)
			result = checkUndefined("including",
					EssentialOclPlugin.getOclLibraryProvider().getOclLibrary()
							.getSetType(genericType), this);

		if (result == null) {
			Set<IModelInstanceElement> include = new HashSet<IModelInstanceElement>();

			include.addAll(getModelInstanceCollection().getCollection());
			include.add(that.getModelInstanceElement());

			result = JavaStandardLibraryFactory.INSTANCE.createOclSet(include,
					genericType);
		}

		return result;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see
	 * org.dresdenocl.essentialocl.standardlibrary.OclSet#intersection(
	 * org.dresdenocl.essentialocl.standardlibrary.OclBag)
	 */
	public OclSet<T> intersection(OclBag<T> that) {

		return intersection(that.asSet());
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see
	 * org.dresdenocl.standardlibrary.java.internal.library.JavaOclCollection
	 * #isEqualTo(org.dresdenocl.essentialocl.standardlibrary.OclAny)
	 */
	public OclBoolean isEqualTo(OclAny that) {

		OclBoolean result;

		result = checkIsEqualTo(that);

		if (result == null) {
			/* Check if the given object is no OclSet. */
			if (!(that instanceof OclSet)) {
				result = JavaOclBoolean.getInstance(false);
			}

			/* Else compare the two OrderedSets. */
			else {

				boolean booleanResult;

				// copy, since elements are removed later
				Set<IModelInstanceElement> set1 = new HashSet<IModelInstanceElement>(
						(Set<IModelInstanceElement>) this
								.getModelInstanceCollection().getCollection());
				Set<IModelInstanceElement> set2 = (Set<IModelInstanceElement>) ((IModelInstanceCollection) that
						.getModelInstanceElement()).getCollection();

				if (set1.size() != set2.size()) {
					booleanResult = false;
				}

				/* Else iterate over the elements and compare them. */
				else {

					for (IModelInstanceElement element : set2) {
						if (!set1.remove(element)) {
							booleanResult = false;
							break;
						}
					}

					/* set1 should have no elements by now */
					booleanResult = set1.isEmpty();

				}

				result = JavaOclBoolean.getInstance(booleanResult);
			}
		}

		return result;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see
	 * org.dresdenocl.essentialocl.standardlibrary.OclSet#symmetricDifference
	 * (org.dresdenocl.essentialocl.standardlibrary.OclSet)
	 */
	public OclSet<T> symmetricDifference(OclSet<T> that) {

		OclSet<T> result = null;

		result = checkInvalid(EssentialOclPlugin.getOclLibraryProvider()
				.getOclLibrary().getSetType(genericType), this, that);

		if (result == null)
			result = checkUndefined("symmetricDifference",
					EssentialOclPlugin.getOclLibraryProvider().getOclLibrary()
							.getSetType(genericType), this, that);

		if (result == null) {
			Set<IModelInstanceElement> symmetricDifference = new HashSet<IModelInstanceElement>();

			Collection<IModelInstanceElement> otherCollectionCopy = new ArrayList<IModelInstanceElement>(
					that.getModelInstanceCollection().getCollection());

			/* Iterate over this bag. */
			for (IModelInstanceElement element : getModelInstanceCollection()
					.getCollection()) {
				/*
				 * if other collection has not the same element, then it is in
				 * the symmetric difference; remove it, so that it is not
				 * counted multiple times
				 */
				if (!otherCollectionCopy.remove(element)) {
					symmetricDifference.add(element);
				}
			}
			/*
			 * add the other collection that is already without intersection
			 * elements
			 */
			symmetricDifference.addAll(otherCollectionCopy);

			result = JavaStandardLibraryFactory.INSTANCE.createOclSet(
					symmetricDifference, genericType);
		}

		return result;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see
	 * org.dresdenocl.essentialocl.standardlibrary.OclSet#union(tudresden
	 * .ocl20.pivot.essentialocl.standardlibrary.OclSet)
	 */
	public OclSet<T> union(OclSet<T> that) {

		OclSet<T> result = null;

		result = checkInvalid(EssentialOclPlugin.getOclLibraryProvider()
				.getOclLibrary().getSetType(genericType), this, that);

		if (result == null)
			result = checkUndefined("union",
					EssentialOclPlugin.getOclLibraryProvider().getOclLibrary()
							.getSetType(genericType), this, that);

		if (result == null) {
			Set<IModelInstanceElement> union = new HashSet<IModelInstanceElement>();

			Collection<IModelInstanceElement> otherCollection = that
					.getModelInstanceCollection().getCollection();

			union.addAll(getModelInstanceCollection().getCollection());
			union.addAll(otherCollection);

			result = JavaStandardLibraryFactory.INSTANCE.createOclSet(union,
					genericType);
		}

		return result;
	}

	/**
	 * <p>
	 * Implements the operation '-' on {@link OclSet}.
	 * </p>
	 * 
	 * @param aSet
	 *            The {@link OclSet} which shall be subtracted.
	 * 
	 * @return The {@link OclSet} which is the result of the subtraction.
	 */
	public OclSet<T> subtract(OclSet<T> aSet) {

		return complement(aSet);
	}
}