Skip to content

01.01 Naming Conventions for Object Properties

JuergenGrupp edited this page Jun 3, 2024 · 1 revision

The Editorial Committee agreed on the following rules. However, there will be exceptions, eg. due to readability, grammatical considerations or alike.

Prefix with "has" for possessive relationships:

  • Use "has" to denote ownership or containment.
  • Example: "VersionType" should be "hasVersionType"

Prefix with "is" for state or existential relationships:

  • Use "is" for properties that indicate a state, condition, or existential relationship
  • Example: "ApprovedBy" should be rephrased as "isApprovedBy"

Use of "of" for Inverse Relationships:

  • Rename properties to include "of" when defining inverse relationships, making them passive
  • Example: "ChildOf" as opposed to "hasParent"

Active vs. Passive Voice:

  • Apply active voice for forward relationships and passive voice for inverse relationships
  • Example: "Controls" can have an inverse property "isControlledBy"

Unify verb tenses and forms:

  • Maintain tense consistency across properties.
  • Example: "applyTo" should be "appliesTo".
  • Ensure properties that imply action use a verb that clearly states the action.
  • Example: "dubbedTo" should be "hasDubbedVersion" or "dubsTo".

Specificity in Relationships:

  • Use specific relational phrase that accurately describe the interaction between entities.
  • Example: "memberOf" can be detailed further into "isMemberOf"