Interface IPartialModelNode

All Superinterfaces:
IComparedElement
All Known Subinterfaces:
ICollectionPartialNode, IDirectPartialModelNode, IFragmentPartialNode, IMergeRulePartialModelNode, INodeWithAddibleChildren, IOrderMergeRulePartialModelNode, IPartialEqualFeatureNode, IPartialEqualNode, IPartialFeatureNode, IPartialListElementNode, IPartialObjectRightNode, IPartialObjectRightsNode, IPartialRoleRightsNode, IPartialRoleTemplateNode
All Known Implementing Classes:
AbstractDirectPartialModelNode, AbstractEqualNodeWithChildren, AbstractNodeWithLabels, AbstractNodeWithLabelsAndChildren, AbstractPartialModelNode, AbstractPartialModelNodeWithChildren, BslModuleSectionPartialModelNode, EmfFeatureNodeWithChildren, EmfFeatureTerminalNode, EqualEmfFeatureNodeWithChildren, EqualEmfFeatureTerminalNode, EqualFragmentPartialNode, EqualListElementNodeWithChildren, EqualListElementTerminalNode, EqualObjectRightsNodeWithChildren, EqualObjectRightTerminalNode, EqualReferenceListElementTerminalNode, EqualRoleRightsTerminalNode, EqualRoleTemplateTerminalNode, ExternalPropertyPartialModelNode, FragmentPartialNode, HtmlDocumentPageTerminalNode, ListElementNodeWithChildren, ListElementTerminalNode, ObjectRightsNodeWithChildren, ObjectRightTerminalNode, ProjectPartialModelNode, RoleRightsTerminalNode, RoleTemplateTerminalNode, RootPartialModelNode, VirtualFolderPartialModelNode

public interface IPartialModelNode extends IComparedElement
A node of the partial model.
  • Method Details

    • getParent

      IPartialModelNode getParent()
      Returns the parent node.
      Returns:
      the parent node
    • setParent

      IPartialModelNode setParent(IPartialModel partialModel, IPartialModelNode parent)
      Sets the specified parent and includes this node in the list of its children.
      Parameters:
      partialModel - the partial model
      parent - the parent node
      Returns:
      this node
    • hasChildren

      boolean hasChildren()
      Checks if the node has child nodes.
      Returns:
      true if the node has children, and false otherwise
    • getChildren

      Returns the child nodes. The order of child nodes is not defined.
      Returns:
      the child nodes
    • addChild

      void addChild(IPartialModelNode node)
      Adds the specified child node.
      Parameters:
      node - the node to add as a child
    • getImage

      org.eclipse.swt.graphics.Image getImage()
      Returns the node image.
      Returns:
      the node image
    • getLabel

      String getLabel()
      Returns the node label.
      Returns:
      the node label
    • getSortedChildren

      Object[] getSortedChildren()
      Returns an array of children according to this node's logic.
      Returns:
      a sorted array of child nodes
    • getStatus

      Returns the status of the node in the comparison process.
      Returns:
      node's current status during comparison
    • getSideLabel

      String getSideLabel(ComparisonSide side)
      Returns a label (textual representation) of the value referred from the specified side of the node.
      Parameters:
      side - the side of the node
      Returns:
      a label
    • getSide

      ComparisonSide getSide()
      If the compared object presents only on MAIN or on OTHER side and is absent on the other one, that side is returned.
      Returns:
      the MAIN or OTHER side or null if the compared object presents on both sides
    • isCheckable

      boolean isCheckable()
      Checks if the node is checkable.
      Returns:
      true if the node is checkable, and false otherwise
    • isChecked

      boolean isChecked()
      Checks whether this node is checked.
      Returns:
      true if the node is checked, and false otherwise
    • setChecked

      void setChecked(boolean value)
      Sets the "Checked" state of the partial model node.
      Parameters:
      value - the value to set
    • isGrayed

      boolean isGrayed()
      Checks whether the checkbox of this node is grayed if applicable (i.e. it has some children checked and others unchecked). This means that the node has checkable/mergeable children that will not be merged.
      Returns:
      true if the node's checkbox is grayed
    • check

      void check(boolean checked)
      Checks the node. It changes node's state in the model and sets corresponding flag in the partial model node.
      Parameters:
      checked - true to check, false to uncheck
    • prioritize

      void prioritize()
      Prioritize the node comparison in the specified session.
    • canExpand

      boolean canExpand()
      Checks whether this node can be expanded with specific inner content.
      Returns:
      true if the node can be expanded with inner elements
    • setStatus

      void setStatus(ComparisonNodeStatus value)
      Sets the status of the node.
      Parameters:
      status - the status to set
    • getCustomMergeSettingsStatus

      CustomMergeSettingsStatus getCustomMergeSettingsStatus()
      Returns the custom merge settings status of this node.
      Returns:
      the custom merge settings status, never null
    • setCustomMergeSettingsStatus

      void setCustomMergeSettingsStatus(CustomMergeSettingsStatus customMergeSettingsStatus)
      Sets the custom merge settings status to the node.
      Parameters:
      customMergeSettingsStatus - the status to set, can not be null
    • getTooltipText

      String getTooltipText()
      Returns node's tooltip text.
      Returns:
      the text to be displayed as tooltip or null if no tooltip to be displayed
    • getNodeId

      long getNodeId()
      Gets BM id of a comparison node associated with this UI partial node.
      Returns:
      the BM id or -1 if no comparison node associated
    • getComparisonSession

      IComparisonSession getComparisonSession()
      Gets the comparison session associated with this partial node.
      Returns:
      the comparison session or null if no associated session
    • retrieveComparisonNode

      ComparisonNode retrieveComparisonNode()
      Retrieves the corresponding comparison model node.
      Returns:
      the comparison model node or null if no comparison node associated