Numerical Identifiers

The OEO switched from human readable names to alphanumeric identifiers. To get a personal user ID, add yourself to the list.

List of user ID's

The list of user ID's can be found in the main ontology file "oeo.omn". The ID's got added in front of the dc:contributor annotation of the person they belong to. Please add yourself via pull request.

Motivation

See the #133 for the whole discussion. Alphanumeric identifiers are listed as best practice and commonly used because in most cases their advantages outweigh the disadvantages. A short summary is given below:

Advantages

• versioning and backward compatibility: a name for a concept can change in a new version of the ontology without its identifier (in databases etc) having to be changed everywhere.
• user groups: if people talk about the same concept but can't decide on a main name for it they can both be added as labels for this concept and the people can get their own views of the ontology showing their preferred label.
• better readability of long names: in labels we dont have to use CamelCase. Long names like NonRenewableMunicipalWasteFuel are better readable in lower case as "non renewable municipial waste fuel".

Disadvantages

• the file is harder to read without a tool like protege (that will automatically show labels instead of the alphanumerical identifiers).

Implementation in the OEO

Identifiers look like this: OEO_00140123

They are structured in three parts: OEO_[yyyy][xxxx]

• "OEO_" identifies them as part of the OEO ontology
• [yyyy] identifies the user who added the classes. Each user gets a unique ID (list below). Entities with the ID 0000 were created before the change to alphanumeric identifiers was made.
• [xxxx] identifies the specific class added by the user. This enables every user to create 10000 entities before having to get a new ID. IDs are assigned chronologically to each entity, starting with 0000.

How to Change your Settings

Every user has to set his protégé user settings according to the structure of the identifiers used in the OEO.

This is done by opening the "oeo.omn" file in Protégé and clicking on File -> Preferences -> new entities.

Then the following settings are selected:

Entity IRI:

• Specific IRI: http://openenergy-platform.org/ontology/oeo/
• /
• Auto-generated ID

Entity Label:

• Same as label renderer

Auto-generated ID:

• Numeric (iterative)
• prefix: OEO_[your user id] e.g. OEO_0001 if you user ID is 1
• Digit count: 4
• Start: 0
• End: -1

check "Remember last ID between Protégé sessions"

then click "OK"