Package org.faktorips.runtime

Interface IModelObjectDelta

All Known Implementing Classes:
ModelObjectDelta
public interface IModelObjectDelta
A model object delta represents the delta between two model objects. The two model objects must be instances of the same model class. One typical use case is that the two (technical) objects represent the same business object but at two different points in time.
Author:
Jan Ortmann

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ADDED
    Delta kind constant indicating that the model object has been added to it's parent.
    static final int
    CHANGED
    Delta kind constant indicating that the model object has changed somehow.
    static final int
    CHILD_CHANGED
    Delta change type constant indicating that at least one child (that has neither been added or removed or just moved) has changed.
    static final int
    CLASS_CHANGED
    Delta change type constant indicating that the class of the object has changed.
    static final int
    DIFFERENT_OBJECT_AT_POSITION
    Delta kind constant indicating that a different model object is now at a given position.
    static final int
    EMPTY
    Constant indicating that the delta is empty, no difference exists between the two objects.
    static final int
    MOVED
    Delta kind constant indicating that the model object has been moved, meaning it's position in the ordered list of objects has been changed.
    static final int
    PROPERTY_CHANGED
    Delta change type constant indicating that at least one of the object's properties has changed.
    static final int
    REMOVED
    Delta kind constant indicating that the model object has been removed from it's parent.
    static final int
    STRUCTURE_CHANGED
    Delta change type constant indicating that the object's structure has changed, that means either a child has been added, removed or changed its position (if the computation method is IDeltaComputationOptions.ComputationMethod.BY_OBJECT or a different object is now at a given position (if the computation method is IDeltaComputationOptions.ComputationMethod.BY_OBJECT.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    accept(IModelObjectDeltaVisitor visitor)
    Accepts the given visitor.
    String
    getAssociation()
    The name of the association in which the object has been added, removed or changed.
    AssociationKind
    getAssociationKind()
    Returns the kind of association if this delta has any incoming association, that means it is part of a composite or the object is associated from another object.
    List<String>
    getChangedProperties()
    Returns the properties that have a different value in the model object and the reference model object.
    List<IModelObjectDelta>
    getChildDeltas()
    Returns deltas for all children of the model object which were added, removed, or changed.
    List<IModelObjectDelta>
    getChildDeltas(int kind)
    Returns deltas for all children of this model object whose kind is included in the given mask.
    int
    getKind()
    Returns the kind of change.
    int
    getKindOfChange()
    If delta's kind is CHANGED, this method returns the kind of changed defined by the constant listed below.
    IModelObject
    getOriginalObject()
    The model object this delta is computed for.
    IModelObject
    getReferenceObject()
    The model object that is taken as a reference to which the orginal model object is compared to.
    boolean
    isAdded()
    Returns true if this model object has been added to its parent, false otherwise.
    boolean
    isChanged()
    Returns true if this model object has been changed.
    boolean
    isChildChanged()
    Returns true if at least one model object's children has been changed.
    boolean
    isClassChanged()
    Returns true if the model object's Java class has "changed".
    boolean
    isDifferentObjectAtPosition()
    Returns true if a different model object is at a position, otherwise false.
    boolean
    isEmpty()
    Returns true if the delta is empty, the two objects are the same, otherwise false.
    boolean
    isMoved()
    Returns true if this model object has changed its position in the ordered association.
    boolean
    isPropertyChanged()
    Returns true if at least one the model object's properties has changed, otherwise false.
    boolean
    isPropertyChanged(String propertyName)
    Returns true if the model object contains a different value for the given property than the reference model object.
    boolean
    isRemoved()
    Returns true if this model object has been removed from its parent, false otherwise.
    boolean
    isStructureChanged()
    Returns true if this model object's structure has changed.

  • Field Details

    • EMPTY

      static final int EMPTY
      Constant indicating that the delta is empty, no difference exists between the two objects.

      If the object is a root object, this means that all properties are equal, no children have been removed, added or have changed their position.

      If this object is a dependent object (it belongs to a parent), this means that all properties are equal and this object has neither been added to or removed from its parent nor has the position of the object changed.

      See Also:

    • ADDED

      static final int ADDED
      Delta kind constant indicating that the model object has been added to it's parent.
      See Also:

    • REMOVED

      static final int REMOVED
      Delta kind constant indicating that the model object has been removed from it's parent.
      See Also:

    • MOVED

      static final int MOVED
      Delta kind constant indicating that the model object has been moved, meaning it's position in the ordered list of objects has been changed. This type of delta is only returned if the computation method is IDeltaComputationOptions.ComputationMethod.BY_OBJECT.

      Note that an object can be moved and changed! In this case getKind() returns MOVED & CHANGED.

      See Also:

    • DIFFERENT_OBJECT_AT_POSITION

      static final int DIFFERENT_OBJECT_AT_POSITION
      Delta kind constant indicating that a different model object is now at a given position. This type of delta is only returned if the computation method is IDeltaComputationOptions.ComputationMethod.BY_POSITION.
      See Also:

    • CHANGED

      static final int CHANGED
      Delta kind constant indicating that the model object has changed somehow. If the object has changed, the type of change is further specified with the following constants. Note that these constants are bit masks as more than one type of change can occur.

      Note that an object can be moved and changed! In this case getKind() returns MOVED & CHANGED.

      See Also:

    • STRUCTURE_CHANGED

      static final int STRUCTURE_CHANGED
      Delta change type constant indicating that the object's structure has changed, that means either a child has been added, removed or changed its position (if the computation method is IDeltaComputationOptions.ComputationMethod.BY_OBJECT or a different object is now at a given position (if the computation method is IDeltaComputationOptions.ComputationMethod.BY_OBJECT.
      See Also:

    • PROPERTY_CHANGED

      static final int PROPERTY_CHANGED
      Delta change type constant indicating that at least one of the object's properties has changed.
      See Also:

    • CHILD_CHANGED

      static final int CHILD_CHANGED
      Delta change type constant indicating that at least one child (that has neither been added or removed or just moved) has changed. Either one of the child's properties has changed or it's structure (or both).
      See Also:

    • CLASS_CHANGED

      static final int CLASS_CHANGED
      Delta change type constant indicating that the class of the object has changed.
      See Also:

  • Method Details

    • getOriginalObject

      IModelObject getOriginalObject()
      The model object this delta is computed for. If this is a delta for a a child that was added to the new object, the method returns null.

    • getReferenceObject

      IModelObject getReferenceObject()
      The model object that is taken as a reference to which the orginal model object is compared to.

      If this is a delta for a a child that was removed from the orginial model object, the method returns null.

    • getKind

      int getKind()
      Returns the kind of change. Note that an object can be moved and changed! To allow this type of information to be returned, a bit mask is used!
      See Also:

    • getKindOfChange

      int getKindOfChange()
      If delta's kind is CHANGED, this method returns the kind of changed defined by the constant listed below. Not that the kind of changes are not mututally excluded, so the returned kinds are bit masked. The method returns 0, if the delta's kind is not CHANGED.
      See Also:

    • isEmpty

      boolean isEmpty()
      Returns true if the delta is empty, the two objects are the same, otherwise false.

    • isAdded

      boolean isAdded()
      Returns true if this model object has been added to its parent, false otherwise.

    • isRemoved

      boolean isRemoved()
      Returns true if this model object has been removed from its parent, false otherwise.

    • isMoved

      boolean isMoved()
      Returns true if this model object has changed its position in the ordered association. This type of delta is only returned if the computation method is IDeltaComputationOptions.ComputationMethod.BY_OBJECT.

    • isDifferentObjectAtPosition

      boolean isDifferentObjectAtPosition()
      Returns true if a different model object is at a position, otherwise false. This type of delta is only returned if the computation method is IDeltaComputationOptions.ComputationMethod.BY_POSITION.

    • isChanged

      boolean isChanged()
      Returns true if this model object has been changed.

    • isStructureChanged

      boolean isStructureChanged()
      Returns true if this model object's structure has changed. That means either a child has been added or removed or a child has been been moved.

    • isClassChanged

      boolean isClassChanged()
      Returns true if the model object's Java class has "changed". (Technically its of course just an instance of another class). Returns false otherwise.

    • isPropertyChanged

      boolean isPropertyChanged()
      Returns true if at least one the model object's properties has changed, otherwise false.

    • isChildChanged

      boolean isChildChanged()
      Returns true if at least one model object's children has been changed.

    • getAssociation

      String getAssociation()
      The name of the association in which the object has been added, removed or changed. The association name is always null for the root of the delta.

    • getAssociationKind

      AssociationKind getAssociationKind()
      Returns the kind of association if this delta has any incoming association, that means it is part of a composite or the object is associated from another object.
      Returns:
      the AssociationKind or null if this is the root

    • getChangedProperties

      List<String> getChangedProperties()
      Returns the properties that have a different value in the model object and the reference model object. Returns an empty list if no such property exists.

      The order of properties in the list corresponds to the order defined in the model type. Properties not manually defined in the model type, such as the product component, are placed before manually defined attributes.

    • isPropertyChanged

      boolean isPropertyChanged(String propertyName)
      Returns true if the model object contains a different value for the given property than the reference model object. Returns false otherwise. Returns false if propertyName is null.

    • getChildDeltas

      List<IModelObjectDelta> getChildDeltas()
      Returns deltas for all children of the model object which were added, removed, or changed. Returns an empty array if there are no affected children.

    • getChildDeltas

      List<IModelObjectDelta> getChildDeltas(int kind)
      Returns deltas for all children of this model object whose kind is included in the given mask. Kind masks are formed by the bitwise or of IModelObjectDelta kind constants. Returns an empty array if there are no affected children.

    • accept

      void accept(IModelObjectDeltaVisitor visitor)
      Accepts the given visitor.

      The visitor's visit method is called. If the visitor returns true, the delta's children are also visited.

      Parameters:
      visitor - the visitor
      Throws:
      NullPointerException - if visitor is null.
      See Also: