Changes for page 10 RepresentationMap

Summary

• Page properties (1 modified, 0 added, 0 removed)
• Objects (1 modified, 0 added, 0 removed)
  • SUZ.Methodology.Code.MethodologyClass[0]

Details

Page properties

Content

...	...	@@ -1,49 +1,47 @@
1		-{{box title="**Contents**"}}
2		-{{toc/}}
3		-{{/box}}
	1	+=== 10.1 Scope ===
4	4
5		-== 10.1 Scope ==
6		-
7	7	A RepresentationMap describes a mapping between source value(s) and target value(s) where the values are restricted to those in a Codelist, ValueList or be of a certain data type, e.g., Integer.
8	8
	5	+
9	9	The RepresentationMap maps information from one or more sources, where the values for each source are used in combination to derive the output value for one or more targets. Each source value may match a substring of the original data (using startIndex and/or endIndex) or define a pattern matching rule described by a regular expression. The target value is provided as an absolute string, although it can make use of regular expression groups to carry across values from the source string to the target string without having to explicitly state the value to carry. An example is a regular expression which states ‘match a value starting with AB followed by anything, where the anything is marked a capture group’, the target can state ‘take the anything value and postfix it with AB’ thus enabling the mapping of ABX to XAB and ABY to YAB.
10	10
11	11	The absence of an output for an input is interpreted as ‘no output value for the given source value(s)’.
12	12
13		-=== 10.1.1 Class Diagram – Relationship ===
	10	+==== 10.1.1 Class Diagram – Relationship ====
14	14
15	15	[[image:1749246600710-168.jpeg]]
16	16
17	17	**Figure 39: Representation Map**
18	18
19		-=== 10.1.2 Explanation of the Diagram ===
	16	+==== 10.1.2 Explanation of the Diagram ====
20	20
21		-==== 10.1.2.1 Narrative ====
	18	+===== 10.1.2.1 Narrative =====
22	22
23	23	The RepresentationMap is a //MaintainableArtefact//. It maps one or more source values to one or more target values, where values that are being mapped are defined by the //ValueRepresentation//. A //ValueRepresentation// is an abstract container which is either a Codelist, ValueList or a FacetValueType. Source and target values are in a list where the list order is important as the RepresentationMapping sourceValues and targetValues must match the order. It is permissible to mix types for both source and target values, allowing for example a Codelist to map to an Integer (which is a FacetValueType). The list of source or targets can also be mixed, for example a Codelist in conjunction with a FacetValueType and ValueList and can be defined as the source of a mapping, thus 1917 allowing rules such as ‘When CL_AREA=UK AND AGE=26 CURRENCY=$’.
24	24
25	25	==== 10.1.2.2 Definitions ====
26	26
27		-(% style="width:974.835px" %)
28		-|**Class**|**Feature**|(% style="width:576px" %)**Description**
	24	+|**Class**|**Feature**|**Description**
29	29	|RepresentationMap|(((
30	30	Inherits from
	27	+
31	31	//MaintainableArtefact//
32		-)))|(% style="width:576px" %)Links source and target representations, whose values may conform to a linked Codelist, ValueList or enumerated type such as Integer.
33		-| |source|(% style="width:576px" %)Association to one or more Codelist, ValueList, or FacetValue – mixed types are permissible
34		-| |target|(% style="width:576px" %)Association to one or more Codelist, ValueList, or FacetValue – mixed types are permissible
	29	+)))|Links source and target representations, whose values may conform to a linked Codelist, ValueList or enumerated type such as Integer.
	30	+| |source|Association to one or more Codelist, ValueList, or FacetValue – mixed types are permissible
	31	+| |target|Association to one or more Codelist, ValueList, or FacetValue – mixed types are permissible
35	35	|RepresentationMapping|(((
36	36	Inherits from
	34	+
37	37	//AnnotableArtefact//
38		-)))|(% style="width:576px" %)Describes how the source value(s) map to the target value(s)
39		-| |validFrom|(% style="width:576px" %)Optional period describing when the mapping is applicable
40		-| |validTo|(% style="width:576px" %)Optional period describing which the mapping is no longer applicable.
41		-| |sourceValues|(% style="width:576px" %)Input value for source in the RepresentationMap
42		-| |targetValues|(% style="width:576px" %)Output value for each mapped target in the RepresentationMap
43		-|MappedValue| |(% style="width:576px" %)Describes an input value that is part of the sourceValues in a RepresentationMapping
44		-| |value|(% style="width:576px" %)The value to compare the source data with
45		-| |isRegEx|(% style="width:576px" %)If true, the value field should be treated as a regular expression when comparing with the source data
46		-| |startIndex|(% style="width:576px" %)If provided, a substring of the source data should be taken, starting from this index (starting at zero) before comparing with the //value// field for matching
47		-| |endIndex|(% style="width:576px" %)If provided, a substring of the source data should be taken, ending at this index (starting at zero) before comparing with the //value// field for matching
48		-|TargetValue| |(% style="width:576px" %)Describes the target value that is part of the targetValues of a RepresentationMapping
49		-| |value|(% style="width:576px" %)Represents a value for the targetValues of a RepresenationMapping
	36	+)))|Describes how the source value(s) map to the target value(s)
	37	+| |validFrom|Optional period describing when the mapping is applicable
	38	+| |validTo|Optional period describing which the mapping is no longer applicable.
	39	+| |sourceValues|Input value for source in the RepresentationMap
	40	+| |targetValues|Output value for each mapped target in the RepresentationMap
	41	+|MappedValue| |Describes an input value that is part of the sourceValues in a RepresentationMapping
	42	+| |value|The value to compare the source data with
	43	+| |isRegEx|If true, the value field should be treated as a regular expression when comparing with the source data
	44	+| |startIndex|If provided, a substring of the source data should be taken, starting from this index (starting at zero) before comparing with the //value// field for matching
	45	+| |endIndex|If provided, a substring of the source data should be taken, ending at this index (starting at zero) before comparing with the //value// field for matching
	46	+|TargetValue| |Describes the target value that is part of the targetValues of a RepresentationMapping
	47	+| |value|Represents a value for the targetValues of a RepresenationMapping

SUZ.Methodology.Code.MethodologyClass[0]

index

...	...	@@ -1,1 +1,1 @@
1		-11
	1	+12