ENH: add convenience functions

Summary

added convenience functions value_matches_versionid, get_id_from_versionid and get_versionid

Test Environment

pipeline

Check List for the Author

Please, prepare your MR for a review. Be sure to write a summary and a focus and create gitlab comments for the reviewer. They should guide the reviewer through the changes, explain your changes and also point out open questions. For further good practices have a look at our review guidelines

• All automated tests pass
• Reference related issues
• Up-to-date CHANGELOG.md (or not necessary)
• Up-to-date JSON schema (or not necessary)
• Appropriate user and developer documentation (or not necessary)
  • How do I use the software? Assume "stupid" users.
  • How do I develop or debug the software? Assume novice developers.
• Annotations in code (Gitlab comments)
  • Intent of new code
  • Problems with old code
  • Why this implementation?

Check List for the Reviewer

• I understand the intent of this MR
• All automated tests pass
• Up-to-date CHANGELOG.md (or not necessary)
• Appropriate user and developer documentation (or not necessary)
• The test environment setup works and the intended behavior is reproducible in the test environment
• In-code documentation and comments are up-to-date.
• Check: Are there specifications? Are they satisfied?

For further good practices have a look at our review guidelines.

src/linkahead/common/models.py

@@ -505,6 +505,10 @@ class Entity:
 
         return self
 
+    def get_versionid(self):
+        """Returns the concatenation of ID and version"""
+        return str(self.id)+"@"+str(self.version.id)
+
     def get_importance(self, property):  # @ReservedAssignment
         """Get the importance of a given property regarding this entity."""
 
@@ -2125,6 +2129,14 @@ class Property(Entity):
         else:
             return is_reference(self.datatype)
 
+    def value_matches_versionid(self):
+        """Returns True if the value matches the pattern <id>@<version>"""
+        return value_matches_versionid(self.value)
+
+    def get_id_from_versionid_value(self):
+        """Returns the ID part of the versionid with the pattern <id>@<version>"""
+        return get_id_from_versionid(self.value)
+
 
 class Message(object):
 
@@ -5670,3 +5682,18 @@ def _filter_entity_list_by_identity(listobject: list[Entity],
             if pid_none and name_match:
                 matches.append(candidate)
     return matches
+
+
+def value_matches_versionid(value: Union[int, str]):
+    """Returns True if the value matches the pattern <id>@<version>"""
+    if isinstance(value, int):
+        return False
+    if not isinstance(value, str):
+        raise ValueError(f"A reference value needs to be int or str. It was {type(value)}. "
+                         "Did you call value_matches_versionid on a non reference value?")
+    return "@" in value
+
+
+def get_id_from_versionid(versionid: str):
+    """Returns the ID part of the versionid with the pattern <id>@<version>"""
+    return versionid.split("@")[0]