153 lines
4.3 KiB
YAML
153 lines
4.3 KiB
YAML
|
# NAMING LEXICON
|
||
|
|
# =============================================================================
|
||
|
|
# The word knowledge the naming checks need and cannot derive. No script can
|
||
|
|
# decide on its own that "qualified" is a participle and "ordinal" an adjective.
|
||
|
|
#
|
||
|
|
# Anything absent from this file is not a violation: it is reported as REVIEW.
|
||
|
|
# A checker that guessed would either block on false positives or, worse, stay
|
||
|
|
# silent on real ones. Adding a word here is a deliberate act, reviewed like any
|
||
|
|
# other change to the vocabulary.
|
||
|
|
#
|
||
|
|
# Consumed by check_tbox_naming.py.
|
||
|
|
# =============================================================================
|
||
|
|
|
||
|
|
# -----------------------------------------------------------------------------
|
||
|
|
# VERBS — TN-009. A relation begins with one of these.
|
||
|
|
# -----------------------------------------------------------------------------
|
||
|
|
|
||
|
|
active_verbs:
|
||
|
|
- belongs
|
||
|
|
- computes
|
||
|
|
- consumes
|
||
|
|
- constrains
|
||
|
|
- contains
|
||
|
|
- depends
|
||
|
|
- exposes
|
||
|
|
- has
|
||
|
|
- lives
|
||
|
|
- measures
|
||
|
|
- packages
|
||
|
|
- produces
|
||
|
|
- references
|
||
|
|
- represents
|
||
|
|
- serves
|
||
|
|
- sources
|
||
|
|
- stores
|
||
|
|
- uses
|
||
|
|
|
||
|
|
# A past participle is a verb in first position (TN-009). Listed separately
|
||
|
|
# because the two forms read differently on an edge: the active says what the
|
||
|
|
# subject does, the participial what was done to it.
|
||
|
|
participles:
|
||
|
|
- computed
|
||
|
|
- derived
|
||
|
|
- governed
|
||
|
|
- hosted
|
||
|
|
- monitored
|
||
|
|
- operated
|
||
|
|
- owned
|
||
|
|
- packaged
|
||
|
|
- qualified
|
||
|
|
- served
|
||
|
|
- sourced
|
||
|
|
- stored
|
||
|
|
|
||
|
|
# The copula, admitted by TN-010 on object properties only.
|
||
|
|
copula:
|
||
|
|
- is
|
||
|
|
|
||
|
|
# TN-009: an adverb qualifying the verb is transparent. The checker skips it and
|
||
|
|
# tests the token that follows.
|
||
|
|
adverbs:
|
||
|
|
- primarily
|
||
|
|
- fully
|
||
|
|
- partially
|
||
|
|
- directly
|
||
|
|
- initially
|
||
|
|
- currently
|
||
|
|
|
||
|
|
# -----------------------------------------------------------------------------
|
||
|
|
# ACRONYMS — TN-002 and TN-019.
|
||
|
|
# Forbidden in an IRI, with the single exception of TN-011: a relation
|
||
|
|
# reproducing the short label of the class it targets carries it as it stands.
|
||
|
|
# Listed so that the checker names what it found rather than reporting an
|
||
|
|
# anonymous run of capitals.
|
||
|
|
# -----------------------------------------------------------------------------
|
||
|
|
|
||
|
|
known_acronyms:
|
||
|
|
BI: Business Intelligence
|
||
|
|
KPI: Key Performance Indicator
|
||
|
|
DD: Data Domain
|
||
|
|
SD: Data Sub Domain
|
||
|
|
BO: Business Object
|
||
|
|
DDO: Data Domain Owner
|
||
|
|
SDO: Data Sub Domain Owner
|
||
|
|
PO: Data Product Owner
|
||
|
|
DGL: Data Governance Lead
|
||
|
|
URI: Uniform Resource Identifier
|
||
|
|
URL: Uniform Resource Locator
|
||
|
|
API: Application Programming Interface
|
||
|
|
SQL: Structured Query Language
|
||
|
|
ETL: Extract Transform Load
|
||
|
|
UAT: User Acceptance Testing
|
||
|
|
|
||
|
|
# -----------------------------------------------------------------------------
|
||
|
|
# TYPE WORDS — TN-005. A class name carries none of these unless the word names
|
||
|
|
# a genuine abstraction of the model, which the exceptions below record.
|
||
|
|
# -----------------------------------------------------------------------------
|
||
|
|
|
||
|
|
type_words:
|
||
|
|
- Entity
|
||
|
|
- Item
|
||
|
|
- Element
|
||
|
|
- Thing
|
||
|
|
- Record
|
||
|
|
|
||
|
|
type_word_exceptions:
|
||
|
|
- MetaModelObject
|
||
|
|
- DefinedObject
|
||
|
|
- CapturedObject
|
||
|
|
- OwnershipLayerObject
|
||
|
|
- BusinessLayerObject
|
||
|
|
- LogicalLayerObject
|
||
|
|
- PhysicalLayerObject
|
||
|
|
- DeliveryLayerObject
|
||
|
|
- ConsumptionLayerObject
|
||
|
|
- GovernanceLayerObject
|
||
|
|
- BusinessObject
|
||
|
|
- DataElement
|
||
|
|
|
||
|
|
# -----------------------------------------------------------------------------
|
||
|
|
# PLURALS — TN-005. A class name is singular. English plural detection is
|
||
|
|
# unreliable, so the checker reports a suspected plural as REVIEW and this list
|
||
|
|
# silences the words that only look plural.
|
||
|
|
# -----------------------------------------------------------------------------
|
||
|
|
|
||
|
|
not_plural:
|
||
|
|
- Status
|
||
|
|
- Address
|
||
|
|
- Business
|
||
|
|
- Analysis
|
||
|
|
- Schema
|
||
|
|
|
||
|
|
# -----------------------------------------------------------------------------
|
||
|
|
# RELATIONAL SUFFIXES — TN-014. Reserved for object properties. An attribute
|
||
|
|
# ending in one of these reads as an edge and will be mistaken for one.
|
||
|
|
# -----------------------------------------------------------------------------
|
||
|
|
|
||
|
|
relational_suffixes:
|
||
|
|
- By
|
||
|
|
- In
|
||
|
|
- From
|
||
|
|
- On
|
||
|
|
- To
|
||
|
|
|
||
|
|
# -----------------------------------------------------------------------------
|
||
|
|
# DATE RANGES — TN-013. A property of one of these ranges is a date attribute
|
||
|
|
# and takes the nominal form.
|
||
|
|
# -----------------------------------------------------------------------------
|
||
|
|
|
||
|
|
date_ranges:
|
||
|
|
- "http://www.w3.org/2001/XMLSchema#date"
|
||
|
|
- "http://www.w3.org/2001/XMLSchema#dateTime"
|