Skip to content

Commit

Permalink
Merge pull request #36 from heidivanparys/guillemets
Browse files Browse the repository at this point in the history
Replace << and >> by « and » for keywords and stereotypes
  • Loading branch information
jechterhoff authored Apr 9, 2024
2 parents a51747a + c8a2db3 commit f5b2725
Show file tree
Hide file tree
Showing 19 changed files with 53 additions and 52 deletions.
2 changes: 1 addition & 1 deletion requirements/codelists-basic/REQ001.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
====
[%metadata]
identifier:: http://www.opengis.net/spec/uml2json/1.0/req/codelists-basic/schema-definition
statement:: A \<<CodeList>> shall be converted to a JSON Schema definition of a JSON object. That definition shall be added to the definitions schema, using the type name as definition key.
statement:: A «CodeList» shall be converted to a JSON Schema definition of a JSON object. That definition shall be added to the definitions schema, using the type name as definition key.
====
2 changes: 1 addition & 1 deletion requirements/codelists-basic/REQ002.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
====
[%metadata]
identifier:: http://www.opengis.net/spec/uml2json/1.0/req/codelists-basic/codelist-tag
statement:: If the \<<CodeList>> has tag _codeList_ (which is defined by <<ref_iso19103>>), with a non-blank value, then a "codeList" member shall be added to the JSON Schema definition of the code list, with the tag value as value.
statement:: If the «CodeList» has tag _codeList_ (which is defined by <<ref_iso19103>>), with a non-blank value, then a "codeList" member shall be added to the JSON Schema definition of the code list, with the tag value as value.
====
2 changes: 1 addition & 1 deletion requirements/codelists-link-object/REQ001.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
====
[%metadata]
identifier:: http://www.opengis.net/spec/uml2json/1.0/req/codelists-link-object/schema-ref
statement:: The JSON Schema definition of a \<<CodeList>> shall have a "$ref" member with value "https://register.geostandaarden.nl/jsonschema/uml2json/0.1/schema_definitions.json#/$defs/LinkObject".
statement:: The JSON Schema definition of a «CodeList» shall have a "$ref" member with value "https://register.geostandaarden.nl/jsonschema/uml2json/0.1/schema_definitions.json#/$defs/LinkObject".
====
2 changes: 1 addition & 1 deletion requirements/codelists-literal/REQ001.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
====
[%metadata]
identifier:: http://www.opengis.net/spec/uml2json/1.0/req/codelists-literal/type
statement:: The JSON Schema definition of a \<<CodeList>> shall have a "type" member defined by evaluating tagged value _literalEncodingType_. The tagged value _literalEncodingType_ identifies the conceptual type that applies to the code values. If the tagged value is not set on the code list, or has an empty value, then the literal encoding type is defined to be CharacterString.
statement:: The JSON Schema definition of a «CodeList» shall have a "type" member defined by evaluating tagged value _literalEncodingType_. The tagged value _literalEncodingType_ identifies the conceptual type that applies to the code values. If the tagged value is not set on the code list, or has an empty value, then the literal encoding type is defined to be CharacterString.
====
2 changes: 1 addition & 1 deletion requirements/codelists-uri/REQ001.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
====
[%metadata]
identifier:: http://www.opengis.net/spec/uml2json/1.0/req/codelists-uri/type
statement:: The JSON Schema definition of a \<<CodeList>> shall have a "type" member with value "string", as well as a "format" member with value "uri".
statement:: The JSON Schema definition of a «CodeList» shall have a "type" member with value "string", as well as a "format" member with value "uri".
====
2 changes: 1 addition & 1 deletion requirements/core/REQ009.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
====
[%metadata]
identifier:: http://www.opengis.net/spec/uml2json/1.0/req/core/data-types
statement:: A \<<DataType>> shall be converted to a JSON Schema definition of a JSON object. That definition shall be added to the definitions schema, using the type name as definition key.
statement:: A «DataType» shall be converted to a JSON Schema definition of a JSON object. That definition shall be added to the definitions schema, using the type name as definition key.
====
2 changes: 1 addition & 1 deletion requirements/core/REQ010.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ identifier:: http://www.opengis.net/spec/uml2json/1.0/req/core/enumerations
[.component,class=part]
--
An \<<Enumeration>> shall be converted to a JSON Schema definition with a type defined by evaluating tagged value _literalEncodingType_ on the enumeration.
An «Enumeration» shall be converted to a JSON Schema definition with a type defined by evaluating tagged value _literalEncodingType_ on the enumeration.
The tagged value _literalEncodingType_ identifies the conceptual type that applies to the enumeration values. If the tagged value is not set on the enumeration, or has an empty value, then the literal encoding type is defined to be CharacterString.
--
Expand Down
2 changes: 1 addition & 1 deletion requirements/core/REQ013.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ identifier:: http://www.opengis.net/spec/uml2json/1.0/req/core/property-multipli
[.component,class=part]
--
If the minimum cardinality of a UML property is 1 or greater, and the class that owns the property is not a \<<union>>, then the property shall be listed under the "required" properties of the JSON object to which the property belongs.
If the minimum cardinality of a UML property is 1 or greater, and the class that owns the property is not a «union», then the property shall be listed under the "required" properties of the JSON object to which the property belongs.
--
[.component,class=part]
Expand Down
2 changes: 1 addition & 1 deletion requirements/core/REQ017.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
====
[%metadata]
identifier:: http://www.opengis.net/spec/uml2json/1.0/req/core/property-initial-value
statement:: A UML attribute that has an initial value, is owned by a type with identity or a \<<DataType>>, and whose value type is encoded as one of the simple JSON Schema types "string", "number", "integer", or "boolean", shall be encoded as follows:
statement:: A UML attribute that has an initial value, is owned by a type with identity or a «DataType», and whose value type is encoded as one of the simple JSON Schema types "string", "number", "integer", or "boolean", shall be encoded as follows:
[.component,class=part]
--
Expand Down
2 changes: 1 addition & 1 deletion requirements/core/REQ018.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
====
[%metadata]
identifier:: http://www.opengis.net/spec/uml2json/1.0/req/core/association-class
statement:: Before applying the conversion to JSON Schema, a UML association class that is a type with identity (i.e., a class that has stereotype \<<FeatureType>>, \<<Type>>, no stereotype, or a stereotype that maps to one of these cases), shall be transformed as follows (in the following description the source class of the association is called S and the target class is called T):
statement:: Before applying the conversion to JSON Schema, a UML association class that is a type with identity (i.e., a class that has stereotype «FeatureType», «Type», no stereotype, or a stereotype that maps to one of these cases), shall be transformed as follows (in the following description the source class of the association is called S and the target class is called T):
* The association class A is transformed into a regular class with the same name, stereotype, tagged values, constraints, attributes, and relationships.
* The association is replaced by two associations, one from S to A ("SA"), and one from A to T ("AT").
Expand Down
8 changes: 4 additions & 4 deletions requirements/geojson-formats/REQ004.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,21 @@ identifier:: http://www.opengis.net/spec/uml2json/1.0/req/geojson-formats/primar
[.component,class=part]
--
If a UML property has tag "jsonPrimaryGeometry" with value equal to, ignoring case, "true", and the property is directly owned (i.e., not inherited) by a \<<FeatureType>>, then that property shall be encoded as the primary geometry of the feature type (see part C).
If a UML property has tag "jsonPrimaryGeometry" with value equal to, ignoring case, "true", and the property is directly owned (i.e., not inherited) by a «FeatureType», then that property shall be encoded as the primary geometry of the feature type (see part C).
--
[.component,class=part]
--
If the set of (direct and inherited, but ignoring redefined) UML properties of a \<<FeatureType>> only contains a single UML property with a geometric type (as defined in <<jsonschema_req_geojson_formats_iso19107_types>>), and that property is directly owned by the feature type, and that property does not have tag "jsonPrimaryGeometry" with value equal to, ignoring case, "false", then that property shall be encoded as the primary geometry of the feature type (see part C).
If the set of (direct and inherited, but ignoring redefined) UML properties of a «FeatureType» only contains a single UML property with a geometric type (as defined in <<jsonschema_req_geojson_formats_iso19107_types>>), and that property is directly owned by the feature type, and that property does not have tag "jsonPrimaryGeometry" with value equal to, ignoring case, "false", then that property shall be encoded as the primary geometry of the feature type (see part C).
--
[.component,class=part]
--
In the JSON Schema definition of the \<<FeatureType>>, the primary geometry property shall be encoded as a type restriction for the top-level "geometry" member. The primary geometry property shall not be encoded within the "properties" member.
In the JSON Schema definition of the «FeatureType», the primary geometry property shall be encoded as a type restriction for the top-level "geometry" member. The primary geometry property shall not be encoded within the "properties" member.
--
[.component,class=part]
--
In instance data, the value of the primary geometry property shall be encoded within the (GeoJSON) top-level "geometry" member of the JSON object that represents the \<<FeatureType>>.
In instance data, the value of the primary geometry property shall be encoded within the (GeoJSON) top-level "geometry" member of the JSON object that represents the «FeatureType».
--
====
4 changes: 2 additions & 2 deletions requirements/jsonfg/REQ003.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ identifier:: http://www.opengis.net/spec/uml2json/1.0/req/jsonfg/primary-place
[.component,class=part]
--
A UML property that is owned by a \<<FeatureType>> and that has tag "jsonPrimaryPlace" with value equal to, ignoring case, "true", shall be encoded as a type restriction for the top-level "place" member. The UML property shall not be encoded within the "properties" member.
A UML property that is owned by a «FeatureType» and that has tag "jsonPrimaryPlace" with value equal to, ignoring case, "true", shall be encoded as a type restriction for the top-level "place" member. The UML property shall not be encoded within the "properties" member.
--
[.component,class=part]
--
In instance data, the value of such a property shall be encoded within the (JSON-FG) top-level "place" member of the JSON object that represents the \<<FeatureType>>.
In instance data, the value of such a property shall be encoded within the (JSON-FG) top-level "place" member of the JSON object that represents the «FeatureType».
--
====
5 changes: 3 additions & 2 deletions requirements/jsonfg/REQ004.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,13 @@ identifier:: http://www.opengis.net/spec/uml2json/1.0/req/jsonfg/primary-instant
[.component,class=part]
--
A UML property that is owned by a \<<FeatureType>> and that has tag "jsonPrimaryInstant" with value equal to, ignoring case, "true", shall not be encoded within the "properties" member. Instead, it shall be encoded as a type restriction for the top-level "time" member. The additional restriction for the "time" member shall be encoded using "$ref" with value "https://register.geostandaarden.nl/jsonschema/uml2json/0.1/schema_definitions.json#/$defs/PrimaryInstantOptional", if the minimum multiplicity of the property is 0, otherwise "https://register.geostandaarden.nl/jsonschema/uml2json/0.1/schema_definitions.json#/$defs/PrimaryInstantRequired".
A UML property that is owned by a «FeatureType» and that has tag "jsonPrimaryInstant" with value equal to, ignoring case, "true", shall not be encoded within the "properties" member. Instead, it shall be encoded as a type restriction for the top-level "time" member. The additional restriction for the "time" member shall be encoded using "$ref" with value "https://register.geostandaarden.nl/jsonschema/uml2json/0.1/schema_definitions.json#/$defs/PrimaryInstantOptional", if the minimum multiplicity of the property is 0, otherwise "https://register.geostandaarden.nl/jsonschema/uml2json/0.1/schema_definitions.json#/$defs/PrimaryInstantRequired".
--
[.component,class=part]
--
In instance data, the value of such a property shall be encoded within the (JSON-FG) time/date or time/timestamp member of the JSON object that represents the \<<FeatureType>>.
In instance data, the value of such a property shall be encoded within the (JSON-FG) time/date or time/timestamp member of the JSON object that represents the «FeatureType».
--
====
8 changes: 4 additions & 4 deletions requirements/jsonfg/REQ005.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ identifier:: http://www.opengis.net/spec/uml2json/1.0/req/jsonfg/primary-interva
[.component,class=part]
--
A UML property that is owned by a \<<FeatureType>> and that has tag "jsonPrimaryInterval" with value equal to, ignoring case, one of the allowed values "start", "end", or "interval", shall not be encoded within the "properties" member.
A UML property that is owned by a «FeatureType» and that has tag "jsonPrimaryInterval" with value equal to, ignoring case, one of the allowed values "start", "end", or "interval", shall not be encoded within the "properties" member.
NOTE: The value types of UML properties that represent or contribute to the primary interval should be compatible with that use. For example, properties marked as primary interval start or end can have value type "Date", "DateTime", or "TM_Instant", whereas a property marked as primary interval can have value type "TM_Period".
Expand All @@ -14,16 +14,16 @@ The UML property shall be encoded as a type restriction for the top-level "time"
[.component,class=part]
--
A \<<FeatureType>> shall satisfy the following conditions:
A «FeatureType» shall satisfy the following conditions:
* At most one of the direct properties has tag "jsonPrimaryInterval" = "interval".
* At most one of the direct properties has tag "jsonPrimaryInterval" = "start".
* At most one of the direct properties has tag "jsonPrimaryInterval" = "end".
* The use of "interval" and "start"/"end" are mutually exclusive within the direct properties of the \<<FeatureType>>: If one direct property has tag "jsonPrimaryInterval" = "interval", none of the direct properties shall have tag "jsonPrimaryInterval" equal to "start" or "end". Likewise, if one direct property has tag "jsonPrimaryInterval" equal to "start" or "end", none of the direct properties shall have tag "jsonPrimaryInterval" = "interval".
* The use of "interval" and "start"/"end" are mutually exclusive within the direct properties of the «FeatureType»: If one direct property has tag "jsonPrimaryInterval" = "interval", none of the direct properties shall have tag "jsonPrimaryInterval" equal to "start" or "end". Likewise, if one direct property has tag "jsonPrimaryInterval" equal to "start" or "end", none of the direct properties shall have tag "jsonPrimaryInterval" = "interval".
--
[.component,class=part]
--
In instance data, the value of properties that represent or constitute to the primary interval shall be encoded within the (JSON-FG) time/interval member of the JSON object that represents the \<<FeatureType>>.
In instance data, the value of properties that represent or constitute to the primary interval shall be encoded within the (JSON-FG) time/interval member of the JSON object that represents the «FeatureType».
--
====
2 changes: 1 addition & 1 deletion requirements/union-property-choice/REQ001.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[%metadata]
identifier:: http://www.opengis.net/spec/uml2json/1.0/req/union-property-choice/encoding
part:: A \<<union>> shall be encoded as a JSON Schema definition of a JSON object, where each union option is represented as an optional member of the JSON object.
part:: A «union» shall be encoded as a JSON Schema definition of a JSON object, where each union option is represented as an optional member of the JSON object.
part:: The choice between the options defined by the union shall be encoded using "maxProperties" = "minProperties" = 1. That is, the number of members that are allowed for the JSON object is restricted to exactly one.
part:: An `"additionalProperties": false` shall be used to prevent any undefined properties.
Expand Down
2 changes: 1 addition & 1 deletion requirements/union-type-discriminator/REQ001.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[%metadata]
identifier:: http://www.opengis.net/spec/uml2json/1.0/req/union-type-discriminator/encoding
A \<<union>> shall be encoded as a JSON Schema definition that represents a choice between the value types of the union properties.
A «union» shall be encoded as a JSON Schema definition that represents a choice between the value types of the union properties.
* If the value types are only simple, without a specific format definition or other restrictions defined by JSON Schema keywords, then the JSON Schema shall only contain a "type" member, with an array of the simple types.
* Otherwise, a "oneOf" member shall be added to the JSON Schema definition, with:
Expand Down
2 changes: 1 addition & 1 deletion sections/clause_2_conformance.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Common encoding behavior is defined in the core requirements class (<<jsonschema
** a GeoJSON encoding (<<jsonschema_req_geojson>>), and
** a JSON-FG encoding (<<jsonschema_req_jsonfg>>).
* There are two requirements classes that represent options for realizing a by-reference encoding of property values, one using URIs (<<jsonschema_byreference_encoding_req_uri>>, and one using link objects <<jsonschema_byreference_encoding_req_link_object>>).
* Requirements classes also exist for the two ways in which \<<union>> types are used in practice: as type discriminator (<<jsonschema_unions_req_type_discriminator>>) and as property choice (<<jsonschema_unions_req_property_choice>>).
* Requirements classes also exist for the two ways in which «union» types are used in practice: as type discriminator (<<jsonschema_unions_req_type_discriminator>>) and as property choice (<<jsonschema_unions_req_property_choice>>).
* Code list valued properties can be represented in one of three ways, defined by requirements classes: as a literal (<<jsonschema_codelists_req_literal>>), as URI (<<jsonschema_codelists_req_uri>>), and as link object (<<jsonschema_codelists_req_link_object>>).
* Finally, an additional requirements class supports the encoding of a JSON member for storing the name of the conceptual type that a JSON object encodes (<<jsonschema_req_entitytype>>).

Expand Down
6 changes: 3 additions & 3 deletions sections/clause_4_terms_and_definitions.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,15 @@ Source: https://www.w3.org/2001/sw/wiki/Semantic_Web_terminology#linked_data[W3C

==== feature type

A _feature type_ as defined by the General Feature Model (see <<ref_iso19109>>). In an application schema, a _feature type_ is typically modeled using stereotype \<<FeatureType>>, or a stereotype that maps to that stereotype.
A _feature type_ as defined by the General Feature Model (see <<ref_iso19109>>). In an application schema, a _feature type_ is typically modeled using stereotype «FeatureType», or a stereotype that maps to that stereotype.

==== object type

An _object type_ is a standard class, instances are plain objects with identity. An _object type_ is not a _feature type_. In an application schema, an _object type_ has no stereotype, or has stereotype \<<Type>>, or has a stereotype that maps to one of these two options.
An _object type_ is a standard class, instances are plain objects with identity. An _object type_ is not a _feature type_. In an application schema, an _object type_ has no stereotype, or has stereotype «Type», or has a stereotype that maps to one of these two options.

==== data type

As defined by <<ref_iso19103>>, section 6.10, a _data type_ is a class with stereotype \<<DataType>> (or a stereotype that maps to that stereotype), which is a set of properties that lacks identity.
As defined by <<ref_iso19103>>, section 6.10, a _data type_ is a class with stereotype «DataType» (or a stereotype that maps to that stereotype), which is a set of properties that lacks identity.

==== type with identity

Expand Down
Loading

0 comments on commit f5b2725

Please sign in to comment.