plugins/org.eclipse.graphiti/src/org/eclipse/graphiti/features/context/impl/ReconnectionContext.java

/*********************************************************************
* Copyright (c) 2005, 2019 SAP SE
*
* This program and the accompanying materials are made
* available under the terms of the Eclipse Public License 2.0
* which is available at https://www.eclipse.org/legal/epl-2.0/
*
* Contributors:
*    SAP SE - initial API, implementation and documentation
*
* SPDX-License-Identifier: EPL-2.0
**********************************************************************/
package org.eclipse.graphiti.features.context.impl;

import org.eclipse.graphiti.datatypes.ILocation;
import org.eclipse.graphiti.features.context.IReconnectionContext;
import org.eclipse.graphiti.internal.features.context.impl.base.DefaultContext;
import org.eclipse.graphiti.mm.pictograms.Anchor;
import org.eclipse.graphiti.mm.pictograms.Connection;
import org.eclipse.graphiti.mm.pictograms.PictogramElement;

/**
 * The Class ReconnectionContext.
 */
public class ReconnectionContext extends DefaultContext implements IReconnectionContext {

	/**
	 * Constant used to indicate that the <i>source</i> end of an existing
	 * connection is being reconnected to a new source node.
	 */
	public static String RECONNECT_SOURCE = "Reconnection source";//$NON-NLS-1$

	/**
	 * Constant used to indicate that the <i>target</i> end of an existing
	 * connection is being reconnected to a new target node.
	 */
	public static String RECONNECT_TARGET = "Reconnection target";//$NON-NLS-1$

	private Connection connection;

	private Anchor oldAnchor;

	private Anchor newAnchor;

	private PictogramElement targetPictogramElement;

	private String reconnectType = ""; //$NON-NLS-1$

	private ILocation targetLocation;

	/**
	 * Creates a new {@link ReconnectionContext}.
	 * 
	 * @param connection
	 *            the connection
	 * @param oldAnchor
	 *            the old anchor
	 * @param newAnchor
	 *            the new anchor
	 */
	public ReconnectionContext(Connection connection, Anchor oldAnchor, Anchor newAnchor, ILocation targetLocation) {
		super();
		setConnection(connection);
		setOldAnchor(oldAnchor);
		setNewAnchor(newAnchor);
		setTargetLocation(targetLocation);
	}

	/**
	 * Gets the connection.
	 * 
	 * @return Returns the connection.
	 */
	public Connection getConnection() {
		return this.connection;
	}

	/**
	 * Sets the connection.
	 * 
	 * @param connection
	 *            The connection to set.
	 */
	public void setConnection(Connection connection) {
		this.connection = connection;
	}

	/**
	 * Gets the new anchor.
	 * 
	 * @return Returns the newAnchor.
	 */
	public Anchor getNewAnchor() {
		return this.newAnchor;
	}

	/**
	 * Sets the new anchor.
	 * 
	 * @param newAnchor
	 *            The newAnchor to set.
	 */
	public void setNewAnchor(Anchor newAnchor) {
		this.newAnchor = newAnchor;
	}

	/**
	 * Gets the old anchor.
	 * 
	 * @return Returns the oldAnchor.
	 */
	public Anchor getOldAnchor() {
		return this.oldAnchor;
	}

	/**
	 * Sets the old anchor.
	 * 
	 * @param oldAnchor
	 *            The oldAnchor to set.
	 */
	public void setOldAnchor(Anchor oldAnchor) {
		this.oldAnchor = oldAnchor;
	}

	public PictogramElement getTargetPictogramElement() {
		return this.targetPictogramElement;
	}

	public void setTargetPictogramElement(PictogramElement targetPictogramElement) {
		this.targetPictogramElement = targetPictogramElement;
	}

	@Override
	public String toString() {
		String ret = super.toString();
		return ret + " connection: " + getConnection() + " newAnchor: " + getNewAnchor() + " oldAnchor: " + getOldAnchor() //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
				+ " targetPctogramElement: " + getTargetPictogramElement(); //$NON-NLS-1$
	}

	/**
	 * Indicate whether the end of an existing connection is being reconnected
	 * to a new source node or a new target node.
	 * 
	 * @return {@link ReconnectionContext#RECONNECT_TARGET} or
	 *         {@link ReconnectionContext#RECONNECT_SOURCE}
	 */
	public String getReconnectType() {
		return this.reconnectType;
	}

	/**
	 * Sets the reconnection type. {@link ReconnectionContext#RECONNECT_TARGET}
	 * or {@link ReconnectionContext#RECONNECT_SOURCE}
	 * 
	 * @param reconnectType
	 */
	public void setReconnectType(String reconnectType) {
		this.reconnectType = reconnectType;
	}

	/**
	 * @return the targetLocation
	 */
	public ILocation getTargetLocation() {
		return targetLocation;
	}

	/**
	 * @param targetLocation
	 *            the targetLocation to set
	 */
	public void setTargetLocation(ILocation targetLocation) {
		this.targetLocation = targetLocation;
	}
}