com.ibm.xtools.comparemerge.emf.delta

Interface Delta

All Superinterfaces:

org.eclipse.emf.ecore.EObject, org.eclipse.core.runtime.IAdaptable, org.eclipse.emf.common.notify.Notifier, Printable

All Known Subinterfaces:

AddDelta, ChangeDelta, CompositeDelta, DeleteDelta, JoinDelta, ListDelta, MorphDelta, MoveDelta, SeparationDelta

All Known Implementing Classes:

AddDeltaImpl, ChangeDeltaImpl, CompositeDeltaImpl, CustomChangeDelta, DeleteDeltaImpl, DeltaImpl, JoinDeltaImpl, ListDeltaImpl, MorphDeltaImpl, MoveDeltaImpl, SeparationDeltaImpl

public interface Delta
extends org.eclipse.emf.ecore.EObject, Printable, org.eclipse.core.runtime.IAdaptable

A delta between the base and a contibutor resource. A delta is resolvable and can be involved in zero or more conflicts.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	RESOLUTION_PROPERTY

Method Summary

Modifier and Type	Method and Description
void	addComposite(CompositeDelta compositeDelta) Add another Delta as the container.
void	addConflict(Conflict conflict) Adds a conflict.
void	addDependent(Delta delta) adds a delta to the dependant list
void	addPrerequisite(Delta delta) adds a delta to the pre requisite list
void	addPropertyChangeListener(java.beans.PropertyChangeListener listener) Adds a listener that can register interest in a delta's RESOLVED_PROPERTY.
boolean	canAutoResolve() Returns whether or not this is delta is the target of any of its automatically resolvable conflcits.
boolean	canResolve(Resolution newResolution) Returns whether or not this delta can be resolved with the new resolution.
boolean	canUnresolve() Returns whether or not this delta can be unresolved.
void	collectAtomicDeltaSet(Resolution resolution, boolean includeRequiredDeltas, java.util.Set atomicDeltaSet) Collects all deltas, in the same contributor, required to resolve this delta with the given resolution, with the option of including required deltas or not.
void	collectResolutionSet(Resolution resolution, java.util.Set atomicDeltas, java.util.Set atomicConflicts, boolean includeRequiredDeltas) Recursively collects the atomic resolution set for this delta and a given resolution, being certain to only consider conflicts once.
void	deleteConflict(Conflict conflict) Deletes a conflict.
void	deleteDependent(Delta delta) delete a delta from the dependant list
void	deletePrerequisite(Delta delta) delete a delta from the prerequisite list
java.lang.Object	getAffectedObject() Returns the object that has been affected.
java.lang.String	getAffectedObjectMatchingId() Returns the matching ID of the object that has been affected if the feature of the location is a containment reference, otherwise null.
Resolution	getAppliedResolution()
java.util.Set	getAtomicComposites() Returns a set of all top containing atomics.
java.util.Set	getAtomicDeltaSet(Resolution resolution, boolean includeRequiredDeltas) Returns all deltas, in the same contributor, required to resolve this delta with the given resolution, with the option of including required deltas or not.
org.eclipse.emf.ecore.resource.Resource	getBase() Returns the base resource this delta was generated on.
java.util.Set	getComposites() Returns the composites referencing this delta.
java.util.Set	getConflicts() Returns the set of conflicts this delta is involved in.
org.eclipse.emf.ecore.resource.Resource	getContributor() Returns the contributor resource this delta was generated on.
java.lang.Object	getCustomProperty(java.lang.String key) Return custom property value
java.util.Set	getDependents() Returns a set of dependent Delta s for this delta.
void	getDependentsRecursively(java.util.Set visitedDependents) Returns a set of dependent Delta s for this delta.
Location	getDestinationLocation() Returns the destination location of the delta.
boolean	getDestinationNewSetState() Returns the new destination set state.
boolean	getDestinationOldSetState() Returns the old destination set state.
Delta	getEquivalentDelta() Return equivalent delta in opposite contributor when conflict is suppressed
java.lang.String	getId() Returns a unique ID for this delta.
java.util.Set	getPrerequisites() Returns a set of prerequisite Delta s for this delta.
void	getPrerequisitesRecursively(java.util.Set visitedPrerequisites) Returns a set of prerequisite Delta s for this delta.
Resolution	getResolution() Returns the current resolution of the delta.
java.util.Set	getResolutionSet(Resolution resolution, boolean includeRequiredDeltas) Returns all deltas, in all contributors, required to resolve this delta with the given resolution.
Location	getSourceLocation() Returns the source location of the delta.
boolean	getSourceNewSetState() Returns the new source set state.
boolean	getSourceOldSetState() Returns the old source set state.
DeltaType	getType() Returns the type.
boolean	hasUnresolvedConflicts() Returns whether or not any of this delta's conflicts are unresolved.
boolean	isAccepted() Returns whether or not this delta is accepted.
boolean	isConflicting() Returns whether or not this delta is conflicting with another delta.
boolean	isDestinationSetStateChanged() Returns whether or not the destination feature changed set state.
boolean	isInConflictedAtomicContainer() Returns whether or not any container delta is atomic and conflicting.
boolean	isRejected() Returns whether or not this delta is rejected.
boolean	isResolved() Returns whether or not this delta is resolved.
boolean	isSameDelta(Delta delta) Returns whether or not resolving this delta has the same effect as resolving the given delta.
boolean	isSourceSetStateChanged() Returns whether or not the source feature changed set state.
boolean	isSystemDelta() Returns whether or not this delta is a system delta.
void	removePropertyChangeListener(java.beans.PropertyChangeListener listener) Removes a listener.
void	resolve(Resolution newResolution) Applies the new resolution with this delta.
void	setAppliedResolution(Resolution newResolution)
void	setCustomProperty(java.lang.String key, java.lang.Object value) Setting custom property.
void	setEquivalentDelta(Delta delta) Set equivalent delta in opposite contributor when conflict is suppressed
void	setSystemDelta(boolean systemDelta) Sets whether or not this delta is a system delta.
void	toStringImpl(java.lang.StringBuilder sb) Appends an String representation to the string buffer.
void	unresolve() Unapplies the current resolution with this delta.

Methods inherited from interface org.eclipse.emf.ecore.EObject

eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset

Methods inherited from interface org.eclipse.emf.common.notify.Notifier

eAdapters, eDeliver, eNotify, eSetDeliver

Methods inherited from interface com.ibm.xtools.comparemerge.emf.delta.util.Printable

print

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

Field Detail

RESOLUTION_PROPERTY

static final java.lang.String RESOLUTION_PROPERTY

See Also:

Constant Field Values

Method Detail

getAppliedResolution

Resolution getAppliedResolution()

setAppliedResolution

void setAppliedResolution(Resolution newResolution)

getType

DeltaType getType()

Returns the type.

Returns:

delta type

getId

java.lang.String getId()

Returns a unique ID for this delta.

Returns:

a unique ID

isSameDelta

boolean isSameDelta(Delta delta)

Returns whether or not resolving this delta has the same effect as resolving the given delta.

Returns:

true if resolving this delta has the same effect as resolving the given delta, otherwise false

isSystemDelta

boolean isSystemDelta()

Returns whether or not this delta is a system delta.

Returns:

true if this delta is a system delta, otherwise false

setSystemDelta

void setSystemDelta(boolean systemDelta)

Sets whether or not this delta is a system delta.

Parameters:

systemDelta - boolean

getBase

org.eclipse.emf.ecore.resource.Resource getBase()

Returns the base resource this delta was generated on.

Returns:

base

getContributor

org.eclipse.emf.ecore.resource.Resource getContributor()

Returns the contributor resource this delta was generated on.

Returns:

contributor

getSourceLocation

Location getSourceLocation()

Returns the source location of the delta.

Returns:

a location, or null

getDestinationLocation

Location getDestinationLocation()

Returns the destination location of the delta.

Returns:

a location, or null

isSourceSetStateChanged

boolean isSourceSetStateChanged()

Returns whether or not the source feature changed set state.

Returns:

true if the source feature changed set state, otherwise false

getSourceOldSetState

boolean getSourceOldSetState()

Returns the old source set state.

Returns:

the old source set state

getDestinationOldSetState

boolean getDestinationOldSetState()

Returns the old destination set state.

Returns:

the old destination set state

getSourceNewSetState

boolean getSourceNewSetState()

Returns the new source set state.

Returns:

the new source set state

getDestinationNewSetState

boolean getDestinationNewSetState()

Returns the new destination set state.

Returns:

the new destination set state

isDestinationSetStateChanged

boolean isDestinationSetStateChanged()

Returns whether or not the destination feature changed set state.

Returns:

true if the destination feature changed set state, otherwise false

getAffectedObject

java.lang.Object getAffectedObject()

Returns the object that has been affected.

Returns:

affected object

getAffectedObjectMatchingId

java.lang.String getAffectedObjectMatchingId()

Returns the matching ID of the object that has been affected if the feature of the location is a containment reference, otherwise null.

Returns:

affected object

getComposites

java.util.Set getComposites()

Returns the composites referencing this delta.

Returns:

set of composites

addComposite

void addComposite(CompositeDelta compositeDelta)

Add another Delta as the container.

Parameters:

compositeDelta - the container delta

getAtomicComposites

java.util.Set getAtomicComposites()

Returns a set of all top containing atomics.

Returns:

set of all top containing atomic deltas

getPrerequisites

java.util.Set getPrerequisites()

Returns a set of prerequisite Delta s for this delta. Prerequisite deltas must be accepted before this delta can be accepted.

Returns:

Set of Delta s

getDependents

java.util.Set getDependents()

Returns a set of dependent Delta s for this delta. Dependent deltas must be rejected before this delta can be rejected.

Returns:

Set of Delta s

getPrerequisitesRecursively

void getPrerequisitesRecursively(java.util.Set visitedPrerequisites)

Returns a set of prerequisite Delta s for this delta. Prerequisite deltas must be accepted before this delta can be accepted.

getDependentsRecursively

void getDependentsRecursively(java.util.Set visitedDependents)

Returns a set of dependent Delta s for this delta. Dependent deltas must be rejected before this delta can be rejected.

addPrerequisite

void addPrerequisite(Delta delta)

adds a delta to the pre requisite list

Parameters:

delta -

addDependent

void addDependent(Delta delta)

adds a delta to the dependant list

Parameters:

delta -

deleteDependent

void deleteDependent(Delta delta)

delete a delta from the dependant list

Parameters:

delta -

deletePrerequisite

void deletePrerequisite(Delta delta)

delete a delta from the prerequisite list

Parameters:

delta -

isResolved

boolean isResolved()

Returns whether or not this delta is resolved. A resolved delta is either accepted or rejected. An unresolved delta has been neither accepted nor rejected.

Returns:

true if this delta is resolved, otherwise false

isAccepted

boolean isAccepted()

Returns whether or not this delta is accepted. An accepted delta has necessarily been resolved.

Returns:

true if this delta is accepted, otherwise false

isRejected

boolean isRejected()

Returns whether or not this delta is rejected. A rejected delta has necessarily been resolved.

Returns:

true if this delta is rejected, otherwise false

getResolution

Resolution getResolution()

Returns the current resolution of the delta.

Returns:

the resolution

canResolve

boolean canResolve(Resolution newResolution)

Returns whether or not this delta can be resolved with the new resolution.

Parameters:

newResolution - the resolution

Returns:

true if this delta can be resolved with the passed resolution, otherwise false

resolve

void resolve(Resolution newResolution)

Applies the new resolution with this delta.

Parameters:

newResolution - the resolution

canUnresolve

boolean canUnresolve()

Returns whether or not this delta can be unresolved.

Returns:

true if this delta can be unresolved, otherwise false

unresolve

void unresolve()

Unapplies the current resolution with this delta.

canAutoResolve

boolean canAutoResolve()

Returns whether or not this is delta is the target of any of its automatically resolvable conflcits.

Returns:

true if this delta can automatically resolve any of its automatically resolvable conflicts, otherwise false

getAtomicDeltaSet

java.util.Set getAtomicDeltaSet(Resolution resolution,
                                boolean includeRequiredDeltas)

Returns all deltas, in the same contributor, required to resolve this delta with the given resolution, with the option of including required deltas or not.

Parameters:

resolution - a resolution

includeRequiredDeltas - if true, include required deltas, otherwise don't

Returns:

all deltas required to resolve this delta with the given resoluiton

collectAtomicDeltaSet

void collectAtomicDeltaSet(Resolution resolution,
                           boolean includeRequiredDeltas,
                           java.util.Set atomicDeltaSet)

Collects all deltas, in the same contributor, required to resolve this delta with the given resolution, with the option of including required deltas or not. Deltas are collected into the atomicDeltaSet.

Parameters:

resolution - a resolution

includeRequiredDeltas - if true, include required deltas, otherwise don't

atomicDeltaSet - set atomic delta set

getResolutionSet

java.util.Set getResolutionSet(Resolution resolution,
                               boolean includeRequiredDeltas)

Returns all deltas, in all contributors, required to resolve this delta with the given resolution. The resulting set considers atomic composites, conflicts and optionally required deltas.

Parameters:

resolution - a resolution

includeRequiredDeltas - if true, include required deltas, otherwise don't

Returns:

all deltas required to resolve this delta with the given resoluiton

collectResolutionSet

void collectResolutionSet(Resolution resolution,
                          java.util.Set atomicDeltas,
                          java.util.Set atomicConflicts,
                          boolean includeRequiredDeltas)

Recursively collects the atomic resolution set for this delta and a given resolution, being certain to only consider conflicts once.

Parameters:

resolution - resolution considered

atomicDeltas - collected delta resolution set

atomicConflicts - set of conflicts already visited

includeRequiredDeltas - if true, includes all required deltas, otherwise ignores them

isConflicting

boolean isConflicting()

Returns whether or not this delta is conflicting with another delta.

Returns:

true if this delta is conflicting with another delta, otherwise false

getConflicts

java.util.Set getConflicts()

Returns the set of conflicts this delta is involved in.

Returns:

set of conflicts for this delta

addConflict

void addConflict(Conflict conflict)

Adds a conflict.

Parameters:

conflict - a conflict

deleteConflict

void deleteConflict(Conflict conflict)

Deletes a conflict.

Parameters:

conflict - a conflict

isInConflictedAtomicContainer

boolean isInConflictedAtomicContainer()

Returns whether or not any container delta is atomic and conflicting.

Returns:

true if any container delta is atomic and conflicting

hasUnresolvedConflicts

boolean hasUnresolvedConflicts()

Returns whether or not any of this delta's conflicts are unresolved.

Returns:

true if any of this delta's conflicts are unresolved, otherwise false

addPropertyChangeListener

void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

Adds a listener that can register interest in a delta's RESOLVED_PROPERTY.

Parameters:

listener - a property change listener

removePropertyChangeListener

void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

Removes a listener.

Parameters:

listener - a property change listener

toStringImpl

void toStringImpl(java.lang.StringBuilder sb)

Appends an String representation to the string buffer.

Parameters:

sb - the string buffer to append to

setCustomProperty

void setCustomProperty(java.lang.String key,
                       java.lang.Object value)

Setting custom property. Remove property if value is null

Parameters:

key -

value -

getCustomProperty

java.lang.Object getCustomProperty(java.lang.String key)

Return custom property value

Parameters:

key -

setEquivalentDelta

void setEquivalentDelta(Delta delta)

Set equivalent delta in opposite contributor when conflict is suppressed

Parameters:

delta -

getEquivalentDelta

Delta getEquivalentDelta()

Return equivalent delta in opposite contributor when conflict is suppressed