ComparisonSelection.java

/**
 * <copyright>
 * 
 * Copyright (c) 2010-2016  Thales Global Services S.A.S.
 * 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:
 *    Thales Global Services S.A.S. - initial API and implementation
 * 
 * </copyright>
 */
package org.eclipse.emf.diffmerge.ui.diffuidata;

import org.eclipse.emf.common.util.EList;
import org.eclipse.emf.diffmerge.diffdata.EMatch;
import org.eclipse.emf.diffmerge.diffdata.EMergeableDifference;
import org.eclipse.emf.diffmerge.diffdata.EValuePresence;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.emf.ecore.EStructuralFeature;
import org.eclipse.jface.viewers.IStructuredSelection;
import org.eclipse.jface.viewers.TreePath;


/**
 * <!-- begin-user-doc -->
 * A selection model for Comparison Viewer.
 * <!-- end-user-doc -->
 *
 * <p>
 * The following features are supported:
 * <ul>
 *   <li>{@link org.eclipse.emf.diffmerge.ui.diffuidata.ComparisonSelection#getSelectedMatches <em>Selected Matches</em>}</li>
 *   <li>{@link org.eclipse.emf.diffmerge.ui.diffuidata.ComparisonSelection#getSelectedMatchAndFeature <em>Selected Match And Feature</em>}</li>
 *   <li>{@link org.eclipse.emf.diffmerge.ui.diffuidata.ComparisonSelection#getSelectedTreePath <em>Selected Tree Path</em>}</li>
 *   <li>{@link org.eclipse.emf.diffmerge.ui.diffuidata.ComparisonSelection#getSelectedValuePresences <em>Selected Value Presences</em>}</li>
 * </ul>
 * </p>
 *
 * @see org.eclipse.emf.diffmerge.ui.diffuidata.DiffuidataPackage#getComparisonSelection()
 * @model superTypes="org.eclipse.emf.diffmerge.ui.diffuidata.IStructuredSelection"
 * @generated
 */
public interface ComparisonSelection extends EObject, IStructuredSelection {
	/**
	 * Returns the value of the '<em><b>Selected Matches</b></em>' reference list.
	 * The list contents are of type {@link org.eclipse.emf.diffmerge.diffdata.EMatch}.
	 * <!-- begin-user-doc -->
	 * <p>
	 * If the meaning of the '<em>Selected Matches</em>' reference list isn't clear,
	 * there really should be more of a description here...
	 * </p>
	 * <!-- end-user-doc -->
	 * @return the value of the '<em>Selected Matches</em>' reference list.
	 * @see org.eclipse.emf.diffmerge.ui.diffuidata.DiffuidataPackage#getComparisonSelection_SelectedMatches()
	 * @model changeable="false"
	 * @generated
	 */
	EList<EMatch> getSelectedMatches();

	/**
	 * Returns the value of the '<em><b>Selected Match And Feature</b></em>' containment reference.
	 * <!-- begin-user-doc -->
	 * <!-- end-user-doc -->
	 * @return the value of the '<em>Selected Match And Feature</em>' containment reference.
	 * @see org.eclipse.emf.diffmerge.ui.diffuidata.DiffuidataPackage#getComparisonSelection_SelectedMatchAndFeature()
	 * @model containment="true" changeable="false"
	 * @generated
	 */
	MatchAndFeature getSelectedMatchAndFeature();

	/**
	 * Returns the value of the '<em><b>Selected Tree Path</b></em>' reference list.
	 * The list contents are of type {@link org.eclipse.emf.diffmerge.diffdata.EMatch}.
	 * <!-- begin-user-doc -->
	 * <!-- end-user-doc -->
	 * @return the value of the '<em>Selected Tree Path</em>' reference list.
	 * @see org.eclipse.emf.diffmerge.ui.diffuidata.DiffuidataPackage#getComparisonSelection_SelectedTreePath()
	 * @model changeable="false"
	 * @generated
	 */
	EList<EMatch> getSelectedTreePath();

	/**
	 * Returns the value of the '<em><b>Selected Value Presences</b></em>' reference list.
	 * The list contents are of type {@link org.eclipse.emf.diffmerge.diffdata.EValuePresence}.
	 * <!-- begin-user-doc -->
	 * <p>
	 * If the meaning of the '<em>Selected Value Presences</em>' reference list isn't clear,
	 * there really should be more of a description here...
	 * </p>
	 * <!-- end-user-doc -->
	 * @return the value of the '<em>Selected Value Presences</em>' reference list.
	 * @see org.eclipse.emf.diffmerge.ui.diffuidata.DiffuidataPackage#getComparisonSelection_SelectedValuePresences()
	 * @model changeable="false"
	 * @generated
	 */
	EList<EValuePresence> getSelectedValuePresences();

	/**
	 * <!-- begin-user-doc -->
   * Return the set of differences to merge according to this selection
   * @return a non-null, potentially empty, unmodifiable collection
	 * <!-- end-user-doc -->
	 * @model
	 * @generated
	 */
	EList<EMergeableDifference> asDifferencesToMerge();

	/**
	 * <!-- begin-user-doc -->
	 * Return the content of the selection in terms of structural feature
	 * @return a potentially null structural feature
	 * <!-- end-user-doc -->
	 * @model
	 * @generated
	 */
	EStructuralFeature asFeature();

	/**
	 * <!-- begin-user-doc -->
	 * Return the content of the selection in terms of match
	 * @return a potentially null match
	 * <!-- end-user-doc -->
	 * @model
	 * @generated
	 */
	EMatch asMatch();

	/**
	 * <!-- begin-user-doc -->
	 * Return the content of the selection in terms of a set of matches
	 * <!-- end-user-doc -->
	 * @model
	 * @generated
	 */
	EList<EMatch> asMatches();

	/**
	 * <!-- begin-user-doc -->
	 * Return the content of the selection as a tree path of matches
	 * @return a potentially null tree path
	 * <!-- end-user-doc -->
	 * @model dataType="org.eclipse.emf.diffmerge.ui.diffuidata.TreePath"
	 * @generated
	 */
	TreePath asMatchPath();

	/**
	 * <!-- begin-user-doc -->
	 * <!-- end-user-doc -->
	 * @model
	 * @generated
	 */
	EValuePresence asValuePresence();

	/**
	 * <!-- begin-user-doc -->
	 * <!-- end-user-doc -->
	 * @model
	 * @generated
	 */
	EList<EValuePresence> asValuePresences();

	/**
	 * <!-- begin-user-doc -->
	 * Dispose the receiver
	 * <!-- end-user-doc -->
	 * @model
	 * @generated
	 */
	void dispose();

} // ComparisonSelection