The Standard Application Model for Topic Maps

2.1 The basic types

The values of information item properties may be either other information items, or values of the following three basic types.

String

Strings are sequences of abstract Unicode characters conforming to Unicode Normalization Form C [unicode].

Strings are equal if they consist of the exact same sequence of abstract Unicode characters. This implies that all comparisons are case-sensitive.

Set

Sets are collections of zero or more unordered elements that contain no elements that are equal to each other. Attempts to add a new element that is equal to one already in the set will not cause the set to change; instead the new element must be merged with the equal element already in the set, following the rules for merging information items of that particular type (see section 4 Merging). In topic map information sets, the elements of a set are always information items.

Two sets are equal unless there exists an element in one set for which no equal element can be found in the other.

Null

Null is used to indicate that properties have no value; it does not necessarily indicate that the value of the property is unknown. In this model null can never be contained in a set.

Null is distinct from all other values (including the empty set and the empty string); it is only equal to itself.

2.2 Constraints

The model defined in this Technical Specification contains not only basic types and information item types with named properties, but also constraints on the allowed instances of the model. The purpose of these constraints is to prevent inconsistencies with respect to the data model described herein.

Topic map processors are required to be able to detect violations of the constraints marked as 'SAM constraints' on behalf of topic map applications. There are not requirements regarding when or how such detection is done, nor with how violations are reported.

3.1 Locator items

An information resource is a resource that can be represented as a sequence of bytes, and thus could potentially be retrieved over a network. Topic maps can refer to information resources external to themselves in order to make statements about them. These information resources are not part of the topic map; they are only referenced from it.

A locator is a string that references one or more information resources. Locators are always expressed in some notation, which defines their formal syntax and interpretation. The definition of locator notations is outside the scope of this Technical Specification.

In instances of this model locator items represent locators. Locator items have the following properties:

1. [notation]: A non-empty string. The string is the name of the notation used by this locator. If the string is "URI" the notation is that described in [RFC2396] and modified in [RFC2732]; if it is "HyTime" the notation is one of those described in [HyTime]. If it is neither, the two first characters of the string must be "X-"; all values that do not begin with "X-" are reserved.

2. [reference]: A non-empty string. The string is the locator, whose interpretation and syntax is governed by the value of the [notation] property.

Equality rule: Locator items are equal if they have the same values in their [notation] and [reference] properties.

3.2 Source locators

The source locators of an information item is a set of locators that may be used to refer to the item. When a topic map information set is created through deserialization from some topic map syntax, source locators are created that point back to the syntactical constructs that gave rise to the information items in the information set. In these cases the source locators will point to the minimal syntactical construct of origin, which means that for topic items created from the XTM syntax, for example, the source locator will point to the originating topic element, rather than the containing topicMap element.

It is not specified how and when source locators are assigned to information items; this is left to the deserialization specifications for each syntax. For topic maps not created by deserialization from a syntax it is not required that any source locators be assigned. Applications may also freely assign source locators to information items in any way they wish, for example in order to use them to refer to the information items.

Source locators are used to define reification, and in the syntax specifications to ensure that when information is deserialized from different information resources cross references to topic map constructs are correctly interpreted. Other specifications will use source locators to define mechanisms for referencing topic map constructs.

Topic map constructs may have any number source locators since when duplicate constructs are merged the resulting construct inherits all the source locators of the original constructs.

3.3 The topic map item

A topic map is a set of topics and associations, which may be represented in many forms. Its purpose is to convey information about subjects through the assignment of characteristics to topics representing those subjects. The topic map itself has no meaning or significance beyond its use as a container for the information about those subjects; in particular, the topic map does not represent anything but itself.

The topic map item may be reified, however, in order to make statements about the topic map (that is, the collection of topics and associations) as a whole. These statements may for example provide traditional metadata such as author, version, copyright, or they may reference system metadata such as a schema for the topic map, external documentation of it, and so on.

There is exactly one topic map item in each information set, and all information in the set is available from the properties of that item. Every topic map item represents a single topic map.

Topic map items have the following properties:

1. [topics]: A set of topic items. This is the set of all the topics in the topic map.

2. [associations]: A set of association items. This is the set of all the associations in the topic map.

3. [reifier]: A topic item, or null. The topic item is the topic that reifies this information item.

   Computed value: if there exists a topic item in whose [subject identifiers] property can be found a locator item equal to one in the [source locators] property of this information item that topic item is the value of the [reifier] property. If not, its value is null.

4. [base locator]: A locator item, or null. The locator item refers to the location where the topic map is stored.

5. [source locators]: A set of locator items. This is the set containing the source locators of the topic map item.

3.4 Topic items

A subject can be anything whatsoever, regardless of whether it exists or has any other specific characteristics, about which anything whatsoever may be asserted by any means whatsoever. In particular, it is anything on which the creator of a topic map chooses to discourse.

A topic is a symbol used within a topic map to represent some subject, about which the creator of the topic map wishes to make statements. Topics are proxies for the subjects they represent in order to allow statements to be made about the subjects through the assignment of characteristics to the topics that represent them. A statement is the assignment of a value to one of the properties of a topic item representing topic characteristics.

Every topic represents one, and only one, subject. The process of merging ensures that whenever two topics are known to represent the same subject they are merged. It may well be, however, that two topics may represent the same subject without this being detectable by the rules of this standard. Applications and users are therefore free to merge topics as they see fit. Most commonly this will be done by inferring the subject of the topics from their characteristics.

3.4.5 Properties

Topic items represent topics, and have the following properties:

1. [topic names]: A set of topic name items. This is the set of topic names assigned to this topic.

2. [occurrences]: A set of occurrence items. This is the set of occurrences assigned to this topic.

3. [roles played]: A set of association role items. This is the set of association roles played by this topic.

   Computed value: the set of all association role items whose [role playing topic] property contains this topic item.

4. [subject identifiers]: A set of locator items. The locator items refer to the subject indicators of this topic.

5. [subject addresses]: A set of locator items. The locators, if present, refer to the information resource that is the subject of this topic. If the set contains more than one locator this implies that the locators all address the same information resource.

6. [reified]: an information item, or null. This is the information item reified by this topic item; that is, the topic map construct that is the subject of this topic.

   Computed value: if any information item has in its [source locators] property a locator item equal to one in the [subject identifiers] property of this topic item, that information item is the value of the [reified] property. If no such information item is found the value is null.

7. [source locators]: A set of locator items. This is the set containing the source locators of the topic item.

SAM Constraint: Single reified

The computation that produces the value of the [reified] property must yield a single information item, as topics are required to have only one subject.

Equality rule: Two topic items are equal if they have:

• at least one equal locator item in their [subject identifiers] properties,

• at least one equal locator item in their [source locators] properties,

• at least one equal locator item in their [subject addresses] properties,

• an equal locator in the [subject identifiers] property of the one topic item and the [source locators] property of the other, or

• the same information item in their [reified] property

Topics which have a non-empty [subject addresses] property are considered to represent the information resource they reference in that property.

Note:

Locators which refer directly to subjects which are not information resources must be used with caution. They should not be used in the [subject addresses] property, as this is intended only for references to information resources. Rather, they should be placed in the [subject identifiers] property.

3.5 Topic name items

A topic name is a base name together with its associated variant names. It is the topic name which is a topic characteristic; the base name and variant names are only parts of the topic name characteristic.

Topic names may have a type, which defines what kind of name the topic name represents. They always have a scope, which defines in what contexts the topic name is an appropriate label for the subject. A subject may have any number of topic names, and the only basis for choosing which topic name(s) to use in any given situation is their type and scope.

A base name is a name or label for a subject, expressed as a string. That is, it is something that identifies the subject (though not necessarily uniquely) and can be used as a label for the subject in user interfaces. The notion of a base name corresponds closely to the common sense notion of a name. Suitable base names for people, countries, and organizations are their names, while base names for documents, musical works, and movies might be their titles. Base names may have variant names, which are alternative forms of the base name that may be more appropriate in specific contexts. Essentially, a base name is a specialized kind of occurrence.

Topic name items represent topic names, and have the following properties:

1. [value]: A string. This string is the base name.

2. [type]: A topic item, or null. The topic item represents the subject that defines what kind of topic name this is.

3. [scope]: A set of topic items. This set is the scope that represents the validity of this topic name as a label for the subject.

4. [variants]: A set of variant items. This set contains the variant names that are alternative forms of the base name.

5. [reifier]: A topic item, or null. The topic item is the topic that reifies this information item.

   Computed value: if there exists a topic item in whose [subject identifiers] property can be found a locator item equal to one in the [source locators] property of this information item that topic item is the value of the [reifier] property. If not, its value is null.

6. [source locators]: A set of locator items. This is the set containing the source locators of the topic name item.

Equality rule: Topic name items are equal if the values of their [value], [type], and [scope] properties are equal and they are contained in the [topic names] property of the same topic item.

3.6 Variant items

A variant name is an alternative form of a base name that may be more suitable in certain contexts than the base name itself. The scope of the variant name is the only basis for establishing what variant name is most suitable in any given situation. A variant name may be a string, but it may also be any other kind of information resource.

When choosing a label for a topic, applications are expected to select the base name they consider most appropriate, and then evaluate which of the forms of that base name is best suited for display in that particular context, which may be the base name or one of its variants. This standard does not constrain the process by which this is done.

Section 5.3 Variant name scopes defines some published subjects that may be useful for scope variant names.

Variant items represent variant names, and have the following properties:

1. [value]: A string, which may be empty, or it may be null. The string, if set, is the variant name.

2. [resource]: A locator item, or null. The locator, if set, refers to the information resource that is the variant name.

3. [scope]: A non-empty set of topic items. This set is the scope that describes in what context(s) the variant name may be preferred as a label for the topic.

4. [reifier]: A topic item, or null. The topic item is the topic that reifies this information item.

   Computed value: if there exists a topic item in whose [subject identifiers] property can be found a locator item equal to one in the [source locators] property of this information item that topic item is the value of the [reifier] property. If not, its value is null.

5. [source locators]: A set of locator items. This is the set containing the source locators of the variant item.

Equality rule: Variant items are equal if the values of their [value], [resource], and [scope] properties are equal and they are constained in the [variants] property of the same topic name item.

3.7 Occurrence items

An occurrence is a relationship between a subject and an information resource. The subject in question is that represented by the topic in whose [occurrences] property the occurrence item can be found. The precise nature of the relationship is described by the occurrence type, a subject which is attached to the occurrence. Occurrences are generally used to attach information resources to the subjects they are relevant to. The information resource may either be a string inside the topic map or an external information resource.

Note that the occurrence is properly not the resource, but the relationship between it and the subject. Occurrences are essentially a specialized kind of association, where one participant in the association must be an information resource.

All occurrences have a scope, which defines the contexts in which the occurrence relationship between the information resource and the subject is valid.

An occurrence item represents an occurrence and have the following properties:

1. [value]: A string, or null. The string, if present, is the information resource the occurrence connects with the subject.

2. [resource]: A locator item, or null. The locator, if set, is a reference to the information resource the occurrence connects with the subject.

3. [scope]: A set of topic items. This set is the scope that describes in what context the occurrence relationship may be considered valid.

4. [type]: A topic item, or null. The topic item represents the subject that defines the nature of the occurrence relationship.

5. [reifier]: A topic item, or null. The topic item is the topic that reifies this information item.

   Computed value: if there exists a topic item in whose [subject identifiers] property can be found a locator item equal to one in the [source locators] property of this information item that topic item is the value of the [reifier] property. If not, its value is null.

6. [source locators]: A set of locator items. This is the set containing the source locators of the occurrence item.

Equality rule: Occurrence items are equal if the values of their [value], [resource], [scope], and [type] properties are equal and they are contained in the [occurrences] property of the same topic item.

3.8 Association items

An association is a relationship between one or more subjects. Associations have an association type, a subject which describes the nature of the relationship. The involvement of each subject in the relationship is called its association role.

All associations have a scope, which defines the context in which the statement represented by the association can be considered valid. The scope applies to the association roles as characteristics of the topics that play these roles, but all association roles in an association have the same scope, and so the scope is considered to apply to the association as a whole as well.

Association items represent associations, and have the following properties:

1. [scope]: A set of topic items. This set is the scope that describes in what context the association may be considered valid.

2. [type]: A topic item, or null. The topic item represents the association type of the association.

3. [roles]: A non-empty set of association role items. The association role items represent the association roles that make up this association.

4. [reifier]: A topic item, or null. The topic item is the topic that reifies this information item.

   Computed value: if there exists a topic item in whose [subject identifiers] property can be found a locator item equal to one in the [source locators] property of this information item that topic item is the value of the [reifier] property. If not, its value is null.

5. [source locators]: A set of locator items. This is the set containing the source locators of the association item.

Equality rule: Association items are equal if the values of their [scope], [type], and [roles] properties are equal.

3.9 Association role items

An association role connects two pieces of information within an association: the subject participating in the association, known as the association role player, and the subject defining the nature of its participation, known as the association role type.

Ed. Note:
The UML should declare that there is an inverse of rolePlayingTopic, which is roles.

Association role items represent association roles, and may have the following properties:

1. [role playing topic]: A topic item. This is the topic item that represents the association role player.

2. [type]: A topic item. This is the topic item that represents the association role type.

3. [reifier]: A topic item, or null. The topic item is the topic that reifies this information item.

   Computed value: if there exists a topic item in whose [subject identifiers] property can be found a locator item equal to one in the [source locators] property of this information item that topic item is the value of the [reifier] property. If not, its value is null.

4. [source locators]: A set of locator items. This is the set containing the source locators of the association role item.

Equality rule: Association role items are equal if the values of their [type] and [role playing topic] properties are equal and they are contained in the [roles] property of the same association item.

4.1 Merging topics

Topics are merged whenever the [topics] property of the topic map item contains two equal topic items. The merging of the topic items is done by the following procedure. The two topic items to be merged are known as A and B.

1. Create a new topic item C.

2. Replace A by C wherever it appears in one of the following properties of some information item: [topics], [scope], [type], and [role playing topic].

3. Repeat for B.

4. Set C's [source locators] property to the union of the values of A and B's [source locators] properties.

5. Set C's [subject identifiers] property to the union of the values of A and B's [subject identifiers] properties.

6. Set C's [subject addresses] property to the union of the values of A and B's [subject addresses] properties.

7. Set C's [topic names] property to the union of the values of A and B's [topic names] properties.

8. Set C's [occurrences] property to the union of the values of A and B's [occurrences] properties.

9. Remove A and B from the topic map item's [topics] property.

4.2 Merging topic names

Topic names are merged when the [topic names] property of a topic item contains two equal topic name items. The procedure for merging two topic name items A and B is given below.

1. Create a new topic name item C.

2. Set C's [source locators] value to the union of the value of the [source locators] properties of A and B.

3. Set C's [value] value to the value of the [value] property of A. B's value is equal that of A, and need therefore not be taken into account.

4. Set C's [scope] value to the value of the [scope] property of A. B's value is equal that of A, and need therefore not be taken into account.

5. Set C's [variants] value to the union of the [variants] properties of A and B.

6. Remove A and B from the parent topic item's [topic names] property, and add C in their place.

4.3 Merging variant items

Variant items are merged whenever the [variants] property of a topic name item contains two equal variant items. Two variant items, A and B, are merged by following the procedure below.

1. Create a new variant item, C.

2. Set C's [source locators] property to the union of the values of A's and B's [source locators] properties.

3. Set C's [value], [resource], and [scope] properties to the value of A's [value], [resource], and [scope] properties, respectively. B's values are equal to those of A, and need therefore not be taken into account.

4. Remove A and B from the parent topic name item's [variants] property.

4.4 Merging occurrence items

Occurrence items are merged whenever the [occurrences] property of a topic item contains two equal occurrence items. Two occurrence items, A and B, are merged by following the procedure below.

1. Create a new occurrence item, C.

2. Set C's [source locators] property to the union of the values of A's and B's [source locators] properties.

3. Set C's [value], [resource], [scope], and [type] properties to the value of A's [value], [resource], [scope], and [type] properties, respectively. B's values are equal to those of A, and need therefore not be taken into account.

4. Remove A and B from the parent topic item's [occurrences] property.

4.5 Merging association items

Association items are merged whenever the [associations] property of the topic map item contains two equal association items. To merge two association items, A and B, follow the procedure below.

1. Create a new association item, C.

2. Set C's [source locators] property to the union of the values of A's and B's [source locators] properties.

3. Set C's [scope], [roles], and [type] properties to the value of A's [scope], [roles], and [type] properties, respectively. B's values are equal to those of A, and need therefore not be taken into account.

4. Remove A and B from the topic map item's [associations] property.

4.6 Merging association role items

Association role items are merged whenever the [roles] property of an association item contains two equal association role items. Two association role items, A and B, are merged by following the procedure below.

1. Create a new association role item, C.

2. Set C's [source locators] property to the union of the values of A's and B's [source locators] properties.

3. Set C's [type] and [role playing topic] properties to the value of A's [type] and [role playing topic] properties, respectively. B's values are equal to those of A, and need therefore not be taken into account.

4. Remove A and B from the parent association's [roles] property.

4.7 Merging locator items

Locator items are not merged. If one locator item being added to a set is equal to one already in it the new locator can be discarded as being redundant.

5.1 The type-instance relationship

A type is a set of individual subjects, each of which is an instance of the type. Types are generally used to represent sets of subjects which share some commonality, but the possible uses of types are not required, nor are their meanings. A type may itself be an instance of another type, and there is no limit to the number of types a subject may be an instance of. Scope applies to this association type in just the same way as it does to any other.

The type-instance relationship is not transitive. That is, if A is a type of which B is an instance, and B is a type of which C is an instance, it does not follow that C is an instance of A.

The type-instance relationship between two topic items can be asserted in topic maps using an association item that conforms to the following rules:

• The [type] property must be set to a topic item that has in its [subject identifiers] property a locator item with [notation] set to "URI" and [reference] set to "http://psi.topicmaps.org/sam/1.0/#type-instance".

• The [roles] property must contain exactly two association role items.

• One of the association items in the [roles] property must have its [type] property set to a topic whose [subject identifiers] property is set to a locator item with [notation] set to "URI" and [reference] set to "http://psi.topicmaps.org/sam/1.0/#type". The [role player] property will then contain the topic item representing the type.

• One of the association items in the [roles] property must have its [type] property set to a topic whose [subject identifiers] property is set to a locator item with [notation] set to "URI" and [reference] set to "http://psi.topicmaps.org/sam/1.0/#instance". The [role player] property will then contain the topic item representing the instance.

Associations that use one or more of the published subjects defined in this section, but which do not conform to these structural rules, are not considered to represent type-instance relationships.

5.2 The supertype-subtype relationship

A type may be a subtype of another, which is then considered the supertype of the first. If B is the subtype of A, it follows that every instance of B is also an instance of A. The converse is not necessarily true. The relationship between a supertype and its subtypes is known as the supertype-subtype relationship. A type may have any number of subtypes and supertypes. Scope applies to this association type in just the same way as it does to any other.

The supertype-subtype relationship is transitive, which means that if B is a subtype of A, and C a subtype of B, C is also a subtype of A.

The supertype-subtype relationship between two types can be asserted in topic maps using an association item that conforms to the following rules:

• The [type] property must be set to a topic item that has in its [subject identifiers] property a locator item with [notation] set to "URI" and [reference] set to "http://psi.topicmaps.org/sam/1.0/#supertype-subtype".

• The [roles] property must contain exactly two association role items.

• One of the association items in the [roles] property must have its [type] property set to a topic whose [subject identifiers] property is set to a locator item with [notation] set to "URI" and [reference] set to "http://psi.topicmaps.org/sam/1.0/#supertype". The [role player] property will then contain the topic item representing the supertype.

• One of the association items in the [roles] property must have its [type] property set to a topic whose [subject identifiers] property is set to a locator item with [notation] set to "URI" and [reference] set to "http://psi.topicmaps.org/sam/1.0/#subtype". The [role player] property will then contain the topic item representing the subtype.

Associations that use one or more of the published subjects defined in this section, but which do not conform to these structural rules, are not considered to represent supertype-subtype relationships. Their interpretation is not defined.

5.3 Variant name scopes

The subject identifier http://psi.topicmaps.org/sam/1.0/#sort (notation "URI"), identifies the notion of "suitability of a variant name for use as a sort key for a subject". A variant item that has a topic with this subject identifier in its [scope] property represents a variant name intended to be used as one of the possible sort keys for the topic item it belongs to in contexts which are indicated by the scope of the variant name.

Sort names will be sorted in Unicode code point order. Applications are expected to produce sort names that, when sorted with this algorithm, will give the sort order desired.

The subject identifier http://psi.topicmaps.org/sam/1.0/#display (notation "URI"), identifies the notion of "suitability of a variant name for use as a display name for a subject". A variant item that has a topic with this subject identifier in its [scope] property represents a variant name intended to be used as one of the possible labels for the topic item it belongs to in contexts which are indicated by the scope of the variant name.

5.4 Topic characteristic types

The subject identifier http://psi.topicmaps.org/sam/1.0/#unique-characteristic (notation "URI"), identifies the type of topic characteristic types that are unique. A topic characteristic whose type is an instance of this type must be unique across all topics in the topic map. This means that if two topics are found to have equal information items representing such a topic characteristic they must be merged according to the rules of 4.1 Merging topics.

5.5 Topic map constructs

This section describes published subjects for the main topic map constructs, useful as types for topics reifying topic map constructs of various kinds.

The subject identifier http://psi.topicmaps.org/sam/1.0/#topic-name (notation "URI") identifies the type of topic names, as described in 3.5 Topic name items.

The subject identifier http://psi.topicmaps.org/sam/1.0/#variant (notation "URI") identifies the type of variant names, as described in 3.6 Variant items.

The subject identifier http://psi.topicmaps.org/sam/1.0/#occurrence (notation "URI") identifies the type of occurrences, as described in 3.7 Occurrence items.

The subject identifier http://psi.topicmaps.org/sam/1.0/#association (notation "URI") identifies the type of associations, as described in 3.8 Association items.

The subject identifier http://psi.topicmaps.org/sam/1.0/#association-role (notation "URI") identifies the type of association roles, as described in 3.9 Association role items.