Package com._1c.g5.v8.dt.internal.dcs.compare

Class DcsComparisonParticipant

java.lang.Object
com._1c.g5.v8.dt.compare.participant.AbstractEmfBasedComparisonParticipant
com._1c.g5.v8.dt.md.compare.participant.AbstractMdAwareComparisonParticipant
com._1c.g5.v8.dt.internal.dcs.compare.DcsComparisonParticipant
All Implemented Interfaces:
IComparisonParticipant, ISymlinkTranslationContributor
public class DcsComparisonParticipant extends AbstractMdAwareComparisonParticipant implements ISymlinkTranslationContributor
The DCS comparison participant.

  • Constructor Details

    • DcsComparisonParticipant

      public DcsComparisonParticipant()
      Creates an instance of the participant.

    • DcsComparisonParticipant

      public DcsComparisonParticipant(org.eclipse.xtext.scoping.IScopeProvider scopeProvider)
      Creates an instance of the participant with the specified scope provider.
      Parameters:
      scopeProvider - the scope provider for Dcs objects, can not be null

  • Method Details

    • adoptExternalProperty

      public boolean adoptExternalProperty(IComparisonSession session, ExternalPropertyComparisonData extPropData)
      Description copied from interface: IComparisonParticipant
      Adopts the given external property if it is supported by the participant instance. If adopting is possible, the method fills the provided comparison data container by its own data to be used for adoption.
      Specified by:
      adoptExternalProperty in interface IComparisonParticipant
      Parameters:
      session - the comparison session, not null
      extPropData - the data of the external property to be adopted, cannot be null
      Returns:
      true if adopting is possible, false otherwise

    • supports

      public boolean supports(ComparisonNode node)
      Description copied from interface: IComparisonParticipant
      Indicates whether the participant supports comparison and merging of the specified node.
      Specified by:
      supports in interface IComparisonParticipant
      Parameters:
      node - the node, not null
      Returns:
      true if the participant supports comparison and merging, false otherwise

    • getModelPackage

      public org.eclipse.emf.ecore.EPackage getModelPackage()
      Description copied from interface: IComparisonParticipant
      Get EMF model package.
      Specified by:
      getModelPackage in interface IComparisonParticipant
      Returns:
      the EMF model packge. Never code null.

    • compare

      public List<Long> compare(TopComparisonNode node, ComparisonContext comparisonContext, org.eclipse.core.runtime.IProgressMonitor monitor)
      Description copied from interface: IComparisonParticipant
      Compares objects contained in the specified model top node and returns a list of child nodes to be compared.
      Specified by:
      compare in interface IComparisonParticipant
      Parameters:
      node - the top node to run comparison for, not null
      comparisonContext - the comparison context, not null
      monitor - the progress monitor, can be null. The clients are not supposed to report work to the monitor, except for the top object matching phase
      Returns:
      a list of model node identifiers, never null

    • createMergeContext

      public MergeContext createMergeContext(TopComparisonNode node, IMergeSession mergeSession, ComparisonContext comparisonContext)
      Description copied from interface: IComparisonParticipant
      Creates merge context for an upcoming merge operation.
      Specified by:
      createMergeContext in interface IComparisonParticipant
      Parameters:
      node - the top node to be merged, not null
      mergeSession - the current merge session, not null
      comparisonContext - the comparison context, not null
      Returns:

    • merge

      public org.eclipse.core.runtime.IStatus merge(TopComparisonNode node, MergeContext context, org.eclipse.core.runtime.IProgressMonitor monitor)
      Description copied from interface: IComparisonParticipant
      Merges the differences in the specified top node in the specified merge session. This may include deletion of the main object if the other object is absent, or, conversely, import ("copying") of the other object if the main object is absent.
      Specified by:
      merge in interface IComparisonParticipant
      Parameters:
      node - the top node to run merge for, not null
      context - the current merge context, not null
      monitor - the progress monitor, not null
      Returns:
      the result of the merge operation

    • getPotentialCorrespondingNodes

      public List<ComparisonNode> getPotentialCorrespondingNodes(ComparisonNode node, ComparisonSide sourceSide)
      Description copied from interface: IComparisonParticipant
      Returns a list of candidate nodes for setting as corresponding to the specified node.
      Specified by:
      getPotentialCorrespondingNodes in interface IComparisonParticipant
      Parameters:
      node - the comparison result node to find potential correspondences for, not null
      sourceSide - the source side of the correspondence, not null
      Returns:
      a list of comparison result nodes, may be empty, never null

    • breakCorrespondence

      public void breakCorrespondence(ComparisonContext comparisonContext, ComparisonNode node)
      Description copied from interface: IComparisonParticipant
      Breaks the correspondence for the specified node.
      Specified by:
      breakCorrespondence in interface IComparisonParticipant
      Parameters:
      comparisonContext - the comparison context, not null
      node - the node with the correspondence to break, not null

    • updateComparison

      public void updateComparison(ComparisonContext comparisonContext, ComparisonNode node, List<Long> newNodeIds)
      Description copied from interface: IComparisonParticipant
      Updates comparison for the given result node. Participants could introduce their own specific logic for managing internal states on comparison update.
      Specified by:
      updateComparison in interface IComparisonParticipant
      Parameters:
      comparisonContext - the comparison context, not null
      node - the node to update comparison for, not null
      newNodeIds - the list of created new node Ids to fill, not null

    • addNewTopObjectToComparison

      public TopComparisonNode addNewTopObjectToComparison(IComparisonSession comparisonSession, String mainSymlink, org.eclipse.emf.ecore.EClass eClass)
      Description copied from interface: IComparisonParticipant
      Adds a new node to the comparison for the top object. Participants could introduce their own specific logic for managing internal states on comparison update.
      Specified by:
      addNewTopObjectToComparison in interface IComparisonParticipant
      Parameters:
      comparisonSession - the comparison session hosting the model, not null
      mainSymlink - the symlink for the top object to add, not null
      eClass - of the object ot add, not null
      Returns:
      The created result node for the object if supports. null otherwise.

    • combineOneSideNodes

      public void combineOneSideNodes(ComparisonContext comparisonContext, ComparisonNode mainNode, ComparisonNode otherNode, List<Long> newNodeIds)
      Description copied from interface: IComparisonParticipant
      Combines the specified two one-side nodes. The participant fills array of new node Ids created while combining the specified nodes. These node Ids must be scheduled for comparison in the external code.
      Specified by:
      combineOneSideNodes in interface IComparisonParticipant
      Parameters:
      comparisonContext - the comparison context, not null
      mainNode - the one-side MAIN node to be combined, not null
      otherNode - the one-side OTHER node to be combined, not null
      newNodeIds - the list of new node Ids to fill, not null

    • ableToBreakCorrespondence

      public boolean ableToBreakCorrespondence(ComparisonNode node)
      Description copied from interface: IComparisonParticipant
      Tells whether to able to break the correspondence for the specified node.
      Specified by:
      ableToBreakCorrespondence in interface IComparisonParticipant
      Parameters:
      node - the comparison node to check, not null
      Returns:
      true if it is possible to break the correspondence, false otherwise

    • retrieveComparedObjects

      public ComparedDcsObjects retrieveComparedObjects(ComparisonContext comparisonContext, ComparisonNode node)
      Description copied from interface: IComparisonParticipant
      Returns a compared EObjects triple for the specified model node.
      Specified by:
      retrieveComparedObjects in interface IComparisonParticipant
      Parameters:
      comparisonContext - the comparison context, not null
      node - the model node, cannot be null
      Returns:
      the compared objects triple, never null

    • validateMerge

      public void validateMerge(IMergeSession mergeSession, ComparisonContext comparisonContext, ComparisonNode node, List<MergeValidationProblem> validationProblems)
      Description copied from interface: IComparisonParticipant
      Validates the process of merge of the specified model node.
      Specified by:
      validateMerge in interface IComparisonParticipant
      Parameters:
      mergeSession - the merge session, not null
      comparisonContext - the comparison context, not null
      node - the model node
      validationProblems - the list of collected validation problems to add new problem to

    • breakMainSideCorrespondence

      public void breakMainSideCorrespondence(IComparisonSession session, ComparisonNode node)
      Description copied from interface: IComparisonParticipant
      Breaks the main side correspondence represented by the specified model node.
      Specified by:
      breakMainSideCorrespondence in interface IComparisonParticipant
      Parameters:
      session - the comparison session hosting the model, can not be null
      node - the node with the correspondence to break, can not be null

    • getMatchingSymlinks

      public IMatchingSymlinks getMatchingSymlinks(ComparisonNode node, org.eclipse.emf.ecore.EObject eObject, org.eclipse.emf.ecore.EReference reference, ComparisonSide sourceSide, String symlink, ComparisonContext comparisonContext, IMergeSession mergeSession)
      Description copied from interface: ISymlinkTranslationContributor
      Returns a "matching symlinks" object for the specified symbolic link in the specified context.
      Specified by:
      getMatchingSymlinks in interface ISymlinkTranslationContributor
      Parameters:
      node - the comparison result node hosting the
      eObject - the referencing EObject
      reference - the reference
      sourceSide - the side of the symbolic link
      symlink - the symbolic link for which to get matching symlinks
      mergeSession - the merge session. If not null, the resulting matching symlinks must contain an accordingly translated other symlink in case when the other object will be imported during the merge session
      Returns:
      a matching symbolic links object or null if the context is not supported by the contributor

    • getMatchingSymlinksToTopObject

      public IMatchingSymlinks getMatchingSymlinksToTopObject(ComparisonContext comparisonContext, String symlink, ComparisonSide side, IMergeSession mergeSession)
      Description copied from interface: ISymlinkTranslationContributor
      Returns matched symlinks to the top object with the given symlink on a given comparison side.
      Specified by:
      getMatchingSymlinksToTopObject in interface ISymlinkTranslationContributor
      Parameters:
      comparisonContext - the comparison context, cannot be null
      symlink - the top object symlink to be matched, cannot be null
      side - the comparison side where the top object lies, cannot be null
      mergeSession - the merge session, can be null if no merge process run
      Returns:
      the triple of matched symlinks or null if no matched symlinks found

    • getDefaultMustBeMerged

      public Boolean getDefaultMustBeMerged(ComparisonNode node, IComparisonSession session)
      Description copied from interface: IComparisonParticipant
      Returns the default must be merged value for the given node.
      Specified by:
      getDefaultMustBeMerged in interface IComparisonParticipant
      Parameters:
      node - the node to get default must be merged value for, can not be null
      session - the comparison session, can not be null
      Returns:
      the default must be merged value or null if it wasn't specified

    • areDifferentEClassObjectsMergeable

      protected boolean areDifferentEClassObjectsMergeable(org.eclipse.emf.ecore.EObject main, org.eclipse.emf.ecore.EObject other, ComparisonContext comparisonContext)
      Overrides:
      areDifferentEClassObjectsMergeable in class AbstractMdAwareComparisonParticipant

    • createImportedEObject

      protected org.eclipse.emf.ecore.EObject createImportedEObject(org.eclipse.emf.ecore.EObject otherObject, IMergeSession mergeSession)
      Specified by:
      createImportedEObject in class AbstractEmfBasedComparisonParticipant

    • isFeatureWithCustomMerge

      protected boolean isFeatureWithCustomMerge(org.eclipse.emf.ecore.EStructuralFeature feature)
      Specified by:
      isFeatureWithCustomMerge in class AbstractEmfBasedComparisonParticipant

    • getCustomMatcher

      protected IEmfObjectMatcher getCustomMatcher(TopComparisonNode topNode, org.eclipse.emf.ecore.EReference reference, ComparisonContext comparisonContext)
      Description copied from class: AbstractEmfBasedComparisonParticipant
      Returns a custom matcher for the specified reference.
      Overrides:
      getCustomMatcher in class AbstractMdAwareComparisonParticipant
      Parameters:
      topNode - the top node
      reference - the reference to get a custom matcher for
      comparisonContext - the current comparison context, cannot be null
      Returns:
      a custom matcher or null if no custom matcher can be found

    • isUnmatchableContainment

      protected boolean isUnmatchableContainment(org.eclipse.emf.ecore.EReference reference)
      Description copied from class: AbstractEmfBasedComparisonParticipant
      Checks whether the specified containment feature cannot be matched by an identity-based matcher.
      Overrides:
      isUnmatchableContainment in class AbstractEmfBasedComparisonParticipant
      Parameters:
      reference - the containment feature to check
      Returns:
      true if the feature cannot be matched by an identity matcher

    • getMultiReferenceSymlinks

      protected List<String> getMultiReferenceSymlinks(org.eclipse.emf.ecore.EObject contextObject, org.eclipse.emf.ecore.EReference reference, IComparisonSession session, ComparisonSide side)
      Description copied from class: AbstractEmfBasedComparisonParticipant
      Returns list of symbolic links for objects referenced by the specified multi-reference feature from the specified context object.
      Overrides:
      getMultiReferenceSymlinks in class AbstractEmfBasedComparisonParticipant
      Parameters:
      contextObject - the context object owning the feature, cannot be null
      reference - the multi-reference feature, cannot be null
      session - the comparison session, cannot be null
      side - the comparison side where the context object lies, cannot be null
      Returns:
      list of symbolic links, may be empty, never null

    • getMultiReferenceValueSymlink

      protected String getMultiReferenceValueSymlink(org.eclipse.emf.ecore.EObject contextObject, org.eclipse.emf.ecore.EReference reference, org.eclipse.emf.ecore.EObject eObject, IComparisonSession session, ComparisonSide side)
      Description copied from class: AbstractEmfBasedComparisonParticipant
      Returns symbolic link of the specified target object lying into collection of referencing objects specified by the given multi-reference feature.
      Overrides:
      getMultiReferenceValueSymlink in class AbstractEmfBasedComparisonParticipant
      Parameters:
      contextObject - the context object owning the multi-reference feature, cannot be null
      reference - the multi-reference feature, cannot be null
      eObject - the object to get symbolic link for, cannot be null
      session - the comparison session, cannot be null
      side - the comparison side where the context object lies, cannot be null
      Returns:
      symbolic link or null in case the target object cannot be indentified by a symbolic name in the specified context object