/**
* Copyright (c) 2013, 2014 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
*/
package org.eclipse.emf.compare;
import org.eclipse.emf.common.util.Diagnostic;
import org.eclipse.emf.common.util.EList;
import org.eclipse.emf.compare.utils.IEqualityHelper;
import org.eclipse.emf.ecore.EObject;
/**
* <!-- begin-user-doc --> A representation of the model object '<em><b>Comparison</b></em>'. <!--
* end-user-doc --> <!-- begin-model-doc --> This will act as the "root" of a comparison. It will reference
* one match for every root of the input models, along with the differences detected for each of them. <!--
* end-model-doc -->
* <p>
* The following features are supported:
* <ul>
* <li>{@link org.eclipse.emf.compare.Comparison#getMatchedResources <em>Matched Resources</em>}</li>
* <li>{@link org.eclipse.emf.compare.Comparison#getMatches <em>Matches</em>}</li>
* <li>{@link org.eclipse.emf.compare.Comparison#getConflicts <em>Conflicts</em>}</li>
* <li>{@link org.eclipse.emf.compare.Comparison#getEquivalences <em>Equivalences</em>}</li>
* <li>{@link org.eclipse.emf.compare.Comparison#isThreeWay <em>Three Way</em>}</li>
* </ul>
* </p>
*
* @see org.eclipse.emf.compare.ComparePackage#getComparison()
* @model
* @generated
*/
public interface Comparison extends EObject {
/**
* <!-- begin-user-doc --> <!-- end-user-doc -->
*
* @generated
*/
String copyright = "Copyright (c) 2012 Obeo.\r\nAll rights reserved. This program and the accompanying materials\r\nare made available under the terms of the Eclipse Public License v1.0\r\nwhich accompanies this distribution, and is available at\r\nhttp://www.eclipse.org/legal/epl-v10.html\r\n\r\nContributors:\r\n Obeo - initial API and implementation"; //$NON-NLS-1$
/**
* Returns the value of the '<em><b>Matched Resources</b></em>' containment reference list. The list
* contents are of type {@link org.eclipse.emf.compare.MatchResource}. <!-- begin-user-doc --> <!--
* end-user-doc --> <!-- begin-model-doc --> This contains the mappings for each compared Resource. <!--
* end-model-doc -->
*
* @return the value of the '<em>Matched Resources</em>' containment reference list.
* @see org.eclipse.emf.compare.ComparePackage#getComparison_MatchedResources()
* @model containment="true"
* @generated
*/
EList<MatchResource> getMatchedResources();
/**
* Returns the value of the '<em><b>Matches</b></em>' containment reference list. The list contents are of
* type {@link org.eclipse.emf.compare.Match}. <!-- begin-user-doc --> <!-- end-user-doc --> <!--
* begin-model-doc --> This contains the match tree "mimicking" the input models' hierarchy. <!--
* end-model-doc -->
*
* @return the value of the '<em>Matches</em>' containment reference list.
* @see org.eclipse.emf.compare.ComparePackage#getComparison_Matches()
* @model containment="true"
* @generated
*/
EList<Match> getMatches();
/**
* Returns the value of the '<em><b>Conflicts</b></em>' containment reference list. The list contents are
* of type {@link org.eclipse.emf.compare.Conflict}. <!-- begin-user-doc --> <!-- end-user-doc --> <!--
* begin-model-doc --> If we detected any conflict during the comparison process, this will contain them.
* <!-- end-model-doc -->
*
* @return the value of the '<em>Conflicts</em>' containment reference list.
* @see org.eclipse.emf.compare.ComparePackage#getComparison_Conflicts()
* @model containment="true"
* @generated
*/
EList<Conflict> getConflicts();
/**
* Returns the value of the '<em><b>Equivalences</b></em>' containment reference list. The list contents
* are of type {@link org.eclipse.emf.compare.Equivalence}. <!-- begin-user-doc --> <!-- end-user-doc -->
* <!-- begin-model-doc --> If we detected any equivalence between diffs during the comparison process,
* this will contain them. <!-- end-model-doc -->
*
* @return the value of the '<em>Equivalences</em>' containment reference list.
* @see org.eclipse.emf.compare.ComparePackage#getComparison_Equivalences()
* @model containment="true"
* @generated
*/
EList<Equivalence> getEquivalences();
/**
* <!-- begin-user-doc --> <!-- end-user-doc --> <!-- begin-model-doc --> Returns all differences
* contained by this Comparison and its children. <!-- end-model-doc -->
*
* @model kind="operation"
* @generated
*/
EList<Diff> getDifferences();
/**
* <!-- begin-user-doc --> <!-- end-user-doc --> <!-- begin-model-doc --> Returns all differences that
* reference the given EObject (for instance, all ReferenceChanges that reference the given EObject
* through the "value" EReference).
* <p>
* To get differences detected on the given EObject or one of its counterpart in left, right or origin,
* you should call the following code:
*
* <pre>
* Match match = getMatch(eObject);
* if (match != null) {
* differences = match.getDifferences();
* }
* </pre>
*
* @param element
* The EObject for which we seek all related differences. <!-- end-model-doc -->
* @model
* @generated
*/
EList<Diff> getDifferences(EObject element);
/**
* <!-- begin-user-doc --> <!-- end-user-doc --> <!-- begin-model-doc --> Finds and return the Match for
* the given EObject.
*
* @param element
* The EObject for which we seek the match. <!-- end-model-doc -->
* @model
* @generated
*/
Match getMatch(EObject element);
/**
* <!-- begin-user-doc --> <!-- end-user-doc -->
*
* @model kind="operation" dataType="org.eclipse.emf.compare.IEqualityHelper"
* @generated
*/
IEqualityHelper getEqualityHelper();
/**
* Returns the value of the '<em><b>Three Way</b></em>' attribute. <!-- begin-user-doc --> <!--
* end-user-doc -->
*
* @return the value of the '<em>Three Way</em>' attribute.
* @see #setThreeWay(boolean)
* @see org.eclipse.emf.compare.ComparePackage#getComparison_ThreeWay()
* @model
* @generated
*/
boolean isThreeWay();
/**
* Sets the value of the '{@link org.eclipse.emf.compare.Comparison#isThreeWay <em>Three Way</em>}'
* attribute. <!-- begin-user-doc --> <!-- end-user-doc -->
*
* @param value
* the new value of the '<em>Three Way</em>' attribute.
* @see #isThreeWay()
* @generated
*/
void setThreeWay(boolean value);
/**
* Returns the value of the '<em><b>Diagnostic</b></em>' attribute. <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Diagnostic</em>' attribute isn't clear, there really should be more of a
* description here...
* </p>
* <!-- end-user-doc -->
*
* @return the value of the '<em>Diagnostic</em>' attribute.
* @see #setDiagnostic(Diagnostic)
* @see org.eclipse.emf.compare.ComparePackage#getComparison_Diagnostic()
* @model dataType="org.eclipse.emf.compare.Diagnostic" transient="true"
* @generated
*/
Diagnostic getDiagnostic();
/**
* Sets the value of the '{@link org.eclipse.emf.compare.Comparison#getDiagnostic <em>Diagnostic</em>}'
* attribute. <!-- begin-user-doc --> <!-- end-user-doc -->
*
* @param value
* the new value of the '<em>Diagnostic</em>' attribute.
* @see #getDiagnostic()
* @generated
*/
void setDiagnostic(Diagnostic value);
} // Comparison