Changes between Version 8 and Version 9 of DataFormat

Timestamp:

04.09.2011 02:26:09 (13 years ago)

Author:

jri

Comment:

Association Definition explained

DataFormat

@@ -209 +209 @@
 || `composite` || Fixed. || {} ||
 || `data_type_uri` || The topic type's data type. That is the data type of one instance's payload.\\\\`dm4.core.composite` denotes a complex topic type which is composed of child types. The other 4 data types denote a simple topic type. || One of these 5 strings:\\\\`"dm4.core.text"`\\`"dm4.core.number"`\\`"dm4.core.boolean"`\\`"dm4.core.html"`\\`"dm4.core.composite"` ||
-|| `index_mode_uris` || For simple topic types: Controls how the topic instance's payload is indexed. Default is no indexing.\\\\For complex topic types: not used. || An array with zero or more of these strings:\\\\`"dm4.core.off"`\\`"dm4.core.key"`\\`"dm4.core.fulltext"`\\`"dm4.core.fulltext_key"` ||
-|| `assoc_defs` || For complex topic types: a list of child type definitions. Each definition references a child type and provides further declarations, e.g. cardinalities.\\\\For simple topic types: not used. || See [[#AssociationDefinition|Association Definition]] ||
-|| `view_config_topics` || A client-specific presentation models. || See [[#ViewConfiguration|View Configuration]] ||
+|| `index_mode_uris` || For simple topic types: Controls how the topic instance's payload is indexed. Default is no indexing.\\\\For complex topic types: not used. || An array with zero or more of these strings:\\\\`"dm4.core.off"`\\`"dm4.core.key"`\\`"dm4.core.fulltext"`\\`"dm4.core.fulltext_key"`\\\\See [[#IndexModes|Index Modes]] ||
+|| `assoc_defs` || For complex topic types: a list of child type definitions. Each definition references a child type and provides further declarations, e.g. cardinalities.\\\\For simple topic types: not used. || An array of child type definitions.\\\\See [[#AssociationDefinition|Association Definition]]^1)^ ||
+|| `view_config_topics` || View models for various clients. || An array of view configuration topics.\\\\See [[#ViewConfiguration|View Configuration]] ||
+
+^1)^ ''Association Definition'' is a legacy term but still reflected by the property name. It should be renamed to ''Child Type Definition''. The respective property should be renamed to ''child_type_defs''.
 
 Example 1: a simple topic type
@@ -296 +298 @@
 == Association Definition ==
 
+An ''Association Definition'' represents a parent-child relationship (=association) between 2 types. The parent type is a topic type or an association type; the child type is a topic type.
+
+||= Property =||= Description =||= Format =||
+|| `id` || The association ID. ||  ||
+|| `uri` || Same as `part_topic_type_uri`. ||  ||
+|| `assoc_type_uri ` || The type of the association.\\Either "composition" or "aggregation". || One of\\`"dm4.core.composition_def"`\\`"dm4.core.aggregation_def"` ||
+|| `whole_topic_type_uri ` || URI of the parent type. ||  ||
+|| `whole_role_type_uri ` || Fixed. || `"dm4.core.whole"` ||
+|| `whole_cardinality_uri ` || Cardinality at the "parent" end.\\For a composition: always "one".\\For an aggregation: "one" or "many". || One of\\`"dm4.core.one"`\\`"dm4.core.many"` ||
+|| `part_topic_type_uri ` || URI of the child type. ||  ||
+|| `part_role_type_uri ` || Fixed. || `"dm4.core.part"` ||
+|| `part_cardinality_uri ` || Cardinality at the "child" end: "one" or "many". || One of\\`"dm4.core.one"`\\`"dm4.core.many"` ||
+|| `view_config_topics` || View models for various clients. Allows overriding the child type's view models. || An array of view configuration topics.\\\\See [[#ViewConfiguration|View Configuration]] ||
+
 == View Configuration ==
 
 == Topic Map ==
+
+== Index Modes ==