Class NamingRuleIdentifier

  • Direct Known Subclasses:
    DefaultNamingRuleIdentifier

    public abstract class NamingRuleIdentifier
    extends java.lang.Object
    Class used for representing Naming Rule Identifiers (attributes taking part in a naming rule).
    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected java.lang.String attributeName
      The name of the attribute.
      protected boolean isRelationshipSource
      The role of this attribute in the relationship it represent.
      protected boolean isRequired
      Whether this attribute is needed by the rule.
      protected java.lang.String relatedClass
      The class type of the item which this attribute links to.
      protected java.lang.String relationshipType
      The type of the relationship represented by this attribute.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)
      java.lang.String getAttributeName()
      Returns the attribute name.
      java.lang.String getRelatedClass()
      Returns the class type of the item which this attribute links to.
      java.lang.String getRelationshipType()
      Returns the type of the relationship represented by this attribute.
      int hashCode()
      boolean isImplicit()
      Returns whether this attribute is implicit or not.
      boolean isRelationshipSource()
      Returns if this attribute represents the source of a relationship.
      boolean isRequired()
      Returns if this attribute is required.
      java.lang.String toString()
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Field Detail

      • attributeName

        protected java.lang.String attributeName
        The name of the attribute.
      • relatedClass

        protected java.lang.String relatedClass
        The class type of the item which this attribute links to. Only relevant for implicit attributes.
      • relationshipType

        protected java.lang.String relationshipType
        The type of the relationship represented by this attribute. Only relevant for implicit attributes.
      • isRelationshipSource

        protected boolean isRelationshipSource
        The role of this attribute in the relationship it represent. It can be either the source or the target. Only relevant for implicit attributes.
      • isRequired

        protected boolean isRequired
        Whether this attribute is needed by the rule. If true this attribute must be present for the rule to match. On the other hand, if false, this attribute must not be present.
    • Constructor Detail

      • NamingRuleIdentifier

        public NamingRuleIdentifier()
    • Method Detail

      • getAttributeName

        public final java.lang.String getAttributeName()
        Returns the attribute name.
        Returns:
        name.
      • getRelatedClass

        public final java.lang.String getRelatedClass()
        Returns the class type of the item which this attribute links to.
        Returns:
        related class type.
      • getRelationshipType

        public final java.lang.String getRelationshipType()
        Returns the type of the relationship represented by this attribute.
        Returns:
        relationship type.
      • isRelationshipSource

        public final boolean isRelationshipSource()
        Returns if this attribute represents the source of a relationship.
        Returns:
        trueif this attribute is implicit and source of the relationship, otherwise false.
      • isRequired

        public final boolean isRequired()
        Returns if this attribute is required.
        Returns:
        trueif this attribute required, otherwise false.
      • isImplicit

        public final boolean isImplicit()
        Returns whether this attribute is implicit or not.
        Returns:
        trueif this attribute is implicit, otherwise false.
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object