Package com.aquima.interactions.rule

Interface IAttributeNode

All Known Implementing Classes:
AttributeNode
public interface IAttributeNode
This interface represents an attribute in the dependency graph. When an attribute is present in several entities (due to inheritance), there will be several objects implementing this interface for that same attribute. The combination of attribute name and entity name is used to uniquely identify the node.
Since:
5.0
Author:
o.kerpershoek

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getAttributeName()
    This method will return the name of the attribute the node represents.
    IBusinessRule[]
    getBusinessRules(RuleType type)
    This method returns the business rules that are directly coupled to this attribute node.
    String
    getEntityName()
    This method will return the name of the entity the attribute node belongs to.
    IAttributeNode
    getParentNode()
    This method returns the node representing this same attribute in the super type of the current entity.
    boolean
    hasSharedParent(IAttributeNode node)
    This method returns a boolean indicating if this node shares a common parent with the specified attribute node.

  • Method Details

    • getAttributeName

      String getAttributeName()
      This method will return the name of the attribute the node represents.
      Returns:
      the name of the attribute the node represents.

    • getEntityName

      String getEntityName()
      This method will return the name of the entity the attribute node belongs to. The entity name of this node needs not be the same as the entity the attribute was defined in, as a single attribute may be represented by several attribute nodes belonging to different entities.
      Returns:
      the name of the entity the attribute node belongs to.

    • getParentNode

      IAttributeNode getParentNode()
      This method returns the node representing this same attribute in the super type of the current entity. If the entity that contains the attribute this node represents does not have a super-type, then the method will return a null value.
      Returns:
      The attribute node of the attribute in the super-type entity.

    • hasSharedParent

      boolean hasSharedParent(IAttributeNode node)
      This method returns a boolean indicating if this node shares a common parent with the specified attribute node.
      Parameters:
      node - The attribute node for which the check should be performed.
      Returns:
      a boolean indicating if this node shares a common parent with the specified attribute node.

    • getBusinessRules

      IBusinessRule[] getBusinessRules(RuleType type)
      This method returns the business rules that are directly coupled to this attribute node. The resulting array is not sorted in any way. The resulting array will never be null, but the array may be empty when no rules are found.
      Parameters:
      type - The type of the business rules that are requested.
      Returns:
      IBusinessRule[]