Difference between revisions of "Concept Domain Naming Conventions"
| Line 11: | Line 11: | ||
| − | === Examples === | + | === Act Examples === |
Where ''PrintName'' is the name of the domain being considered for addition, the following examples attempt to illustrate the application of the naming conventions. | Where ''PrintName'' is the name of the domain being considered for addition, the following examples attempt to illustrate the application of the naming conventions. | ||
| Line 18: | Line 18: | ||
ActReason -> '''Act'''''PrintName''''''ReasonType''' | ActReason -> '''Act'''''PrintName''''''ReasonType''' | ||
| − | |||
==== ActConsentType ==== | ==== ActConsentType ==== | ||
| Line 24: | Line 23: | ||
ActConsentType -> '''Act'''''PrintName'''''ConsentType''' | ActConsentType -> '''Act'''''PrintName'''''ConsentType''' | ||
| + | ==== ObservationType Subdomain ==== | ||
| + | |||
| + | ObservationType -> '''Act'''''PrintName'''''ObservationType''' | ||
== Backwards Compatibility == | == Backwards Compatibility == | ||
There will be no effort to modify existing concept domains to adhere to the naming conventions specified here. Any modification of an existing domain name will necessitate an update to all models making use of that domain. For the time being, this effort is considered unreasonable and focus will be directed at ensuring new domains are named in accordance with the recommended naming conventions. | There will be no effort to modify existing concept domains to adhere to the naming conventions specified here. Any modification of an existing domain name will necessitate an update to all models making use of that domain. For the time being, this effort is considered unreasonable and focus will be directed at ensuring new domains are named in accordance with the recommended naming conventions. | ||
| + | |||
| + | === Role and Entity Exceptions === | ||
| + | |||
| + | For the RoleCode and EntityClass concept domains, the concatenation of the '''Class''' and '''Type''' strings will be added as a suffix to the ''PrintName''. | ||
| + | |||
| + | RoleCode -> '''PrintName''''''RoleType''' | ||
| + | |||
| + | SpecializedRoleType -> ''PrintName'''''SpecializedRoleType''' | ||
| + | |||
| + | EntityCode -> '''PrintName''''''EntityType''' | ||
| + | |||
| + | SpecializedEntityType -> ''PrintName'''''SpecializedEntityType''' | ||
Revision as of 21:22, 8 June 2009
Contents
Overview
Naming Conventions
When naming Concept Domains, the following naming conventions will be applied:
- Concept Domain names shall begin with the applicable parent class name (Act, Entity or Role) as appropriate.
- Concept Domains shall end with Type
Act Examples
Where PrintName is the name of the domain being considered for addition, the following examples attempt to illustrate the application of the naming conventions.
ActReason
ActReason -> ActPrintName'ReasonType
ActConsentType
ActConsentType -> ActPrintNameConsentType
ObservationType Subdomain
ObservationType -> ActPrintNameObservationType
Backwards Compatibility
There will be no effort to modify existing concept domains to adhere to the naming conventions specified here. Any modification of an existing domain name will necessitate an update to all models making use of that domain. For the time being, this effort is considered unreasonable and focus will be directed at ensuring new domains are named in accordance with the recommended naming conventions.
Role and Entity Exceptions
For the RoleCode and EntityClass concept domains, the concatenation of the Class and Type strings will be added as a suffix to the PrintName.
RoleCode -> PrintName'RoleType'
SpecializedRoleType -> PrintNameSpecializedRoleType
EntityCode -> PrintName'EntityType'
SpecializedEntityType -> PrintNameSpecializedEntityType
