Help:- Model & naming conventionsindexpreviousupside index
TO BE COMPLETED

This section outlines naming and modelling conventions that should be used when defining DEX's, Model Usage Guides and templates.

  1. When referring to the PLCS PSM, the following phrase should be used: "PLCS_PSM". Ideally use should be made of the pre-defined term <term.ref term="PLCS PSM"/>.
  1. The templates should be named according to the subject of the template. For example "Part".
  2. If the template represents an assignment, then it should be named <subject> <assignment>. For example "StateAssertion"
  3. The name should be CamelCase starting with a capital.

The template property shall be named in accordance with the following rules.

  1. Identifiers
    • Primary Identifiers, should be named "id" or "ids" if multiplicity is of one or more;
    • Version Identifiers should be named "versionId" or "versionIds". In general it will be multiplicity of 1
  2. Structure Relationships
    • the parent item of the relationship should be named "parent"
    • the child item of the relationship should be named "child"
    • the validity start date of the relationship should be named "startEffectivityDate"
    • the validity end date of the relationship should be named "endEffectivityDate"
    • the effectivity role of the relationship should be named "effectivityRole"

internal (private) parts of a template block should be named according to the following rules

  1. The name should be camelCase starting with a lowercase.
  2. If there is only one occurrence of a type as an internal part it is common practice to name the part as it's type applying the correct camel case.
    EXAMPLE    Use of the Part template within another template could be called part.
  3. It is acceptable to abbreviate the names of internal parts to avoid repetition of long type names.

A number of instances of ClassifiedByOwlClass and SameAsOwlObject instances are created in templates for use as defaults. These should be named according to the following rules:

  1. The name should be camelCase starting with a lowercase;
  2. The first part of the name should indicate the type of the instance. This should be "sameAs" for instances of a SameAsOwlObject. This should be "class" for instances of a ClassifiedByOwlClass.
  3. The last part of the name should actual name of the instance.
    EXAMPLE    The class CAGE_code represented by a ClassifiedByOwlObject is named classCAGECode.
Issue reporting