plugins/org.eclipse.emf.edapt.history/src/org/eclipse/emf/edapt/history/reconstruction/HistoryReconstructor.java

/*******************************************************************************
 * Copyright (c) 2007, 2010 BMW Car IT, Technische Universitaet Muenchen, and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 * BMW Car IT - Initial API and implementation
 * Technische Universitaet Muenchen - Major refactoring and extension
 *******************************************************************************/
package org.eclipse.emf.edapt.history.reconstruction;

import java.util.List;

import org.eclipse.emf.common.util.URI;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.emf.ecore.EPackage;
import org.eclipse.emf.ecore.EReference;
import org.eclipse.emf.ecore.resource.Resource;
import org.eclipse.emf.ecore.resource.ResourceSet;
import org.eclipse.emf.edapt.history.util.HistoryUtils;
import org.eclipse.emf.edapt.internal.common.MetamodelExtent;
import org.eclipse.emf.edapt.spi.history.Change;
import org.eclipse.emf.edapt.spi.history.CompositeChange;
import org.eclipse.emf.edapt.spi.history.Create;
import org.eclipse.emf.edapt.spi.history.Delete;
import org.eclipse.emf.edapt.spi.history.History;
import org.eclipse.emf.edapt.spi.history.MigrationChange;
import org.eclipse.emf.edapt.spi.history.OperationChange;
import org.eclipse.emf.edapt.spi.history.OperationInstance;
import org.eclipse.emf.edapt.spi.history.Release;

/**
 * Reconstructor to reproduce the history.
 *
 * @author herrmama
 * @author $Author$
 * @version $Rev$
 * @levd.rating RED Rev:
 */
public class HistoryReconstructor extends ReconstructorBase {

	/** Mapping from old to new elements and vice versa. */
	private Mapping mapping;

	/** Resource for reproduced history. */
	private Resource historyResource;

	/** Reproduced history. */
	private History reproducedHistory;

	/** {@inheritDoc} */
	@Override
	public void init(Mapping mapping, MetamodelExtent extent) {
		this.mapping = mapping;
	}

	/** {@inheritDoc} */
	@Override
	public void startHistory(History originalHistory) {
		reproducedHistory = (History) mapping.copyResolveTarget(
			originalHistory, false);
		mapping.map(originalHistory, reproducedHistory);
	}

	/** {@inheritDoc} */
	@Override
	public void startRelease(Release originalRelease) {
		copy(originalRelease);
	}

	/** {@inheritDoc} */
	@Override
	public void startChange(Change originalChange) {
		if (isCompositeChange(originalChange)) {
			copy(originalChange);
		} else if (originalChange.eContainer() instanceof Create) {
			originalChange = (Create) originalChange.eContainer();
			if (mapping.getTarget(originalChange) != null) {
				return;
			}
			final Change reproducedChange = (Change) copy(originalChange);

			createHistoryResource(reproducedChange);
		}
	}

	/** {@inheritDoc} */
	@Override
	public void endChange(Change originalChange) {
		if (isCompositeChange(originalChange)) {
			// do nothing
		} else if (!(originalChange instanceof Create)
			|| ((Create) originalChange).getChanges().isEmpty()) {
			final Change reproducedChange = (Change) copy(originalChange);

			createHistoryResource(reproducedChange);
		}
	}

	/** Determine whether a change is composite. */
	private boolean isCompositeChange(Change change) {
		return change instanceof CompositeChange
			|| change instanceof MigrationChange;
	}

	/** Reproduce a history element. */
	private EObject copy(EObject original) {
		final EObject reproduced = mapping.copyResolveTarget(original, false);
		if (original instanceof Delete) {
			final Delete delete = (Delete) original;
			final EObject target = mapping.getTarget(delete.getElement());
			((Delete) reproduced).setElement(target);
		} else if (original instanceof OperationChange) {
			final OperationChange operationChange = (OperationChange) original;
			final OperationInstance target = (OperationInstance) mapping
				.copyResolveTarget(operationChange.getOperation());
			((OperationChange) reproduced).setOperation(target);
		}
		mapping.map(original, reproduced);
		attach(original, reproduced);
		return reproduced;
	}

	/** Attach a reproduced history element to its parent. */
	@SuppressWarnings("unchecked")
	private void attach(EObject original, EObject reproduced) {
		final EReference reference = original.eContainmentFeature();
		final EObject reproducedContainer = mapping.resolveTarget(original
			.eContainer());
		if (reference.isMany()) {
			((List) reproducedContainer.eGet(reference)).add(reproduced);
		} else {
			reproducedContainer.eSet(reference, reproduced);
		}
	}

	/** Create the resource containing the reproduced history. */
	private void createHistoryResource(Change reproducedChange) {
		if (reproducedChange instanceof Create) {
			final Create createChild = (Create) reproducedChange;
			if (createChild.getElement() instanceof EPackage
				&& createChild.getTarget() == null) {
				if (historyResource == null) {
					final EPackage reproducedPackage = (EPackage) createChild
						.getElement();
					final Resource modelResource = reproducedPackage.eResource();
					historyResource = createHistoryResource(modelResource);
					historyResource.getContents().add(reproducedHistory);
				}
			}
		}
	}

	/** Create the resource containing the reproduced history. */
	private Resource createHistoryResource(Resource modelResource) {
		final URI modelURI = modelResource.getURI();
		final String name = modelURI.trimFileExtension().lastSegment();
		final URI folder = modelURI.trimSegments(1);
		final ResourceSet resourceSet = modelResource.getResourceSet();
		final Resource historyResource = resourceSet.createResource(folder
			.appendSegment(name).appendFileExtension(
				HistoryUtils.HISTORY_FILE_EXTENSION));
		resourceSet.getResources().add(historyResource);
		return historyResource;
	}
}