XSD Add semantic tag on things

[andrewfg]

The purpose of this PR is to add a semantic (equipment) tag to things so that the UI can use that tag for putting items that are bound to channels on such things in the semantic model.

Adds two things:

1. Extends the XSD schema definition to add a semantic (equipment) tag on thing types. See also XSD Add restrictions for semantic tags on channel type definitions #4615
2. Adds code to permeate this tag throughout OH core wherever it may be needed. Specifically in the classes, DTOs and (de)serializers for thing types and things.

Signed-off-by: Andrew Fiddian-Green [email protected]

[openhab-bot]

This pull request has been mentioned on openHAB Community. There might be relevant details there:

https://community.openhab.org/t/openhab-5-semantic-model-proposal/162526/96

[andrewfg]

@mherwege can I kindly ask you to be a sparring partner for this PR? My goal is to allow developers to set a (proposed) semantic (equipment) tag in their thing type xml, and have this permeated through the thing type instances to the actual thing instances so that the UI can use that semantic (equipment) tag (as a hint) in creating a semantic model.

[mherwege]

@mherwege can I kindly ask you to be a sparring partner for this PR? My goal is to allow developers to set a (proposed) semantic (equipment) tag in their thing type xml, and have this permeated through the thing type instances to the actual thing instances so that the UI can use that semantic (equipment) tag (as a hint) in creating a semantic model.

@andrewfg Sure. I like the idea as long as it does not then enforce anything on the item semantics. So I would think that it should be carried to the point of a having a tag on the thing, but then it should be up to the UI to pick this up as a suggested equipment semantic when creating the group item with its points (create model from thing).
As it should not be used on the thing directly, except when creating items, I am wondering what it should be called. Some day someone may think it carries meaning beyond a suggestion for an equipment group item, and may want to also show that in the UI...

[andrewfg]

Indeed. The tags in the ChannelType xml are hints for semantic “point” and semantic “property” tags which are intended for functional Item creation. And the single tag in the ThingType xml would be a hint for the semantic “equipment” tag intended for semantic GroupItem creation. The remaining “location” semantic tag is entirely user dependent and would not come from the xml.

PS we could even explicitly name it equipmentTag ..

[jlaur]

Typo:

Suggested change

	public ThingBuilder withSemanticEqipmentTag(@Nullable String semanticEquipmentTag) {
	public ThingBuilder withSemanticEquipmentTag(@Nullable String semanticEquipmentTag) {

[jlaur]

I'm wondering if it would be better to stay consistent and generic like e.g. here:

openhab-core/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/type/ChannelTypeBuilder.java

Lines 54 to 68 in 6bf5960

	/**
	* Adds a tag to the ChannelType
	*
	* @param tag Tag to be added to the ChannelType
	* @return this Builder
	*/
	T withTag(String tag);
	/**
	* Sets the StateDescription for the ChannelType
	*
	* @param tags Collection of tags to be added to the ChannelType
	* @return this Builder
	*/
	T withTags(Collection<String> tags);

so simply withTag?

[andrewfg]

See #4617 (comment) above.