mapping/tests/org.eclipse.intent.mapping.tests/src/org/eclipse/intent/mapping/tests/base/BaseElementFactoryTests.java

/*******************************************************************************
 * Copyright (c) 2015 Obeo.
 * 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:
 *    Obeo - initial API and implementation and/or initial documentation
 *    ...
 *******************************************************************************/
package org.eclipse.intent.mapping.tests.base;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;

import org.eclipse.intent.mapping.base.BaseElementFactory;
import org.eclipse.intent.mapping.base.BaseElementFactory.FactoryDescriptor;
import org.eclipse.intent.mapping.base.ILink;
import org.eclipse.intent.mapping.base.ILinkListener;
import org.eclipse.intent.mapping.base.ILocation;
import org.eclipse.intent.mapping.base.ILocationContainer;
import org.eclipse.intent.mapping.base.ILocationListener;
import org.eclipse.intent.mapping.base.IReport;
import org.eclipse.intent.mapping.base.IReportListener;
import org.eclipse.intent.mapping.emf.ICouple;
import org.junit.Test;

import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertTrue;

/**
 * Tests {@link BaseElementFactory}.
 *
 * @author <a href="mailto:yvan.lussaud@obeo.fr">Yvan Lussaud</a>
 */
public class BaseElementFactoryTests {

	/**
	 * A test location interface.
	 *
	 * @author <a href="mailto:yvan.lussaud@obeo.fr">Yvan Lussaud</a>
	 */
	public interface ITestLocation extends ILocation {

		void setObject(Object object);

		Object getObject();

	}

	/**
	 * A test location interface.
	 *
	 * @author <a href="mailto:yvan.lussaud@obeo.fr">Yvan Lussaud</a>
	 */
	public static class TestLocation implements ITestLocation {

		/**
		 * The {@link ILocationContainer}.
		 */
		private ILocationContainer container;

		/**
		 * The {@link List} of source {@link ILink}.
		 */
		private List<ILink> sourceLinks = new ArrayList<ILink>();

		/**
		 * The {@link List} of target {@link ILink}.
		 */
		private List<ILink> targetLinks = new ArrayList<ILink>();

		/**
		 * The contents.
		 */
		private final List<ILocation> contents = new ArrayList<ILocation>();

		/**
		 * Tells if the location is marked as deleted.
		 */
		private boolean markedAsDeleted;

		/**
		 * The {@link Object}.
		 */
		private Object object;

		public void setObject(Object o) {
			object = o;
		}

		public Object getObject() {
			return object;
		}

		public void markAsChanged() {
			// nothing to do here
		}

		public void markAsDeleted() {
			// nothing to do here
		}

		public void change(String reportDescription) {
			// nothing to do here
		}

		public List<ILink> getSourceLinks() {
			return sourceLinks;
		}

		public List<ILink> getTargetLinks() {
			return targetLinks;
		}

		public void setContainer(ILocationContainer container) {
			if (container != null) {
				container.getContents().add(this);
			}
			if (this.container != null) {
				this.container.getContents().remove(this);
			}
			this.container = container;
		}

		public ILocationContainer getContainer() {
			return container;
		}

		public List<ILocation> getContents() {
			return contents;
		}

		public void addListener(ILocationListener listener) {
			// nothing to do here
		}

		public void removeListener(ILocationListener listener) {
			// nothing to do here
		}

		public Serializable getType() {
			// nothing to do here
			return null;
		}

		public void setType(Serializable type) {
			// nothing to do here
		}

		public void setMarkedAsDeleted(boolean markedAsDeleted) {
			this.markedAsDeleted = markedAsDeleted;
		}

		public boolean isMarkedAsDeleted() {
			return markedAsDeleted;
		}

	}

	/**
	 * Test implementation of {@link ILink}.
	 * 
	 * @author <a href="mailto:yvan.lussaud@obeo.fr">Yvan Lussaud</a>
	 */
	public static class TestLink implements ILink {

		/**
		 * The source {@link ILocation}.
		 */
		private ILocation target;

		/**
		 * The target {@link ILocation}.
		 */
		private ILocation source;

		/**
		 * The {@link List} of {@link IReport}.
		 */
		private final List<IReport> reports = new ArrayList<IReport>();

		public void setType(Serializable type) {
			// nothing to do here
		}

		public void setTarget(ILocation location) {
			target = location;
		}

		public void setSource(ILocation location) {
			source = location;
		}

		public void setDescription(String description) {
			// nothing to do here
		}

		public void removeListener(ILinkListener listener) {
			// nothing to do here
		}

		public Serializable getType() {
			// nothing to do here
			return null;
		}

		public ILocation getTarget() {
			return target;
		}

		public ILocation getSource() {
			return source;
		}

		public List<IReport> getReports() {
			return reports;
		}

		public String getDescription() {
			// nothing to do here
			return null;
		}

		public void addListener(ILinkListener listener) {
			// nothing to do here
		}

	}

	/**
	 * Test implementation of {@link IReport}.
	 * 
	 * @author <a href="mailto:yvan.lussaud@obeo.fr">Yvan Lussaud</a>
	 */
	public static class TestReport implements IReport {

		/**
		 * The {@link ILink}.
		 */
		private ILink link;

		/**
		 * The description.
		 */
		private String description;

		public void setLink(ILink link) {
			this.link = link;
		}

		public ILink getLink() {
			return link;
		}

		public void setDescription(String description) {
			this.description = description;
		}

		public String getDescription() {
			return description;
		}

		public void addListener(IReportListener listener) {
			// nothing to do here
		}

		public void removeListener(IReportListener listener) {
			// nothing to do here
		}

	}

	/**
	 * Test implementation of {@link ICouple}.
	 * 
	 * @author <a href="mailto:yvan.lussaud@obeo.fr">Yvan Lussaud</a>
	 */
	public static class TestCouple implements ICouple {

		/**
		 * The key.
		 */
		private String key;

		/**
		 * The value.
		 */
		private String value;

		public String getKey() {
			// TODO Auto-generated method stub
			return key;
		}

		public void setKey(String key) {
			this.key = key;

		}

		public String getValue() {
			return value;
		}

		public void setValue(String value) {
			this.value = value;
		}

	}

	@Test
	public void addClassInstance() throws InstantiationException, IllegalAccessException,
			ClassNotFoundException {
		final BaseElementFactory factory = new BaseElementFactory();

		factory.addDescriptor(ITestLocation.class, new FactoryDescriptor<TestLocation>(TestLocation.class));

		final ITestLocation location = factory.createElement(ITestLocation.class);

		assertTrue(location instanceof TestLocation);
	}

	@Test
	public void removeClassInstance() throws InstantiationException, IllegalAccessException,
			ClassNotFoundException {
		final BaseElementFactory factory = new BaseElementFactory();

		factory.addDescriptor(ITestLocation.class, new FactoryDescriptor<TestLocation>(TestLocation.class));
		factory.removeDescriptor(ITestLocation.class);

		final ITestLocation location = factory.createElement(ITestLocation.class);

		assertNull(location);
	}

}