Kinds as rdfs:subClassOf

checkstyle-suppressions.xml

@@ -2,19 +2,20 @@
 <!DOCTYPE suppressions PUBLIC "-//Checkstyle//DTD Suppressions 1.2//EN" "https://checkstyle.org/dtds/suppressions_1_2.dtd">
 
 <suppressions>
-  <!-- global suppressions -->
-  <suppress checks="AvoidStarImport" files="\.java" />
+    <!-- global suppressions -->
+    <suppress checks="AvoidStarImport" files="\.java" />
 
-  <!-- core suppressions -->
-  <suppress checks="AbbreviationAsWordInName" files="UID\.java" />
+    <!-- core suppressions -->
+    <suppress checks="AbbreviationAsWordInName" files="UID\.java" />
 
-  <!-- examples suppressions -->
-  <suppress checks="LineLength" files="ExampleDataObjects.java|ExampleRdl.java|ExampleAssociations.java|MagmaCoreService.java" />
-  <suppress checks="MethodLength" files="ExampleDataObjects.java" />
+    <!-- examples suppressions -->
+    <suppress checks="LineLength"
+        files="ClassServices.java|ExampleDataObjects.java|ExampleRdl.java|ExampleAssociations.java|MagmaCoreService.java" />
+    <suppress checks="MethodLength" files="ExampleDataObjects.java" />
 
-  <!-- hqdm-core suppressions -->
-  <suppress checks="MethodName" files="impl/*" />
-  <suppress checks="TypeName" files="Function_.java" />
-  <suppress checks="ConstantName" files="HQDM.java" />
-  <suppress checks="AbbreviationAsWordInName" files="IRI.java|HQDM.java|RDFS.java|UID.java" />
-</suppressions>
+    <!-- hqdm-core suppressions -->
+    <suppress checks="MethodName" files="impl/*" />
+    <suppress checks="TypeName" files="Function_.java" />
+    <suppress checks="ConstantName" files="HQDM.java" />
+    <suppress checks="AbbreviationAsWordInName" files="IRI.java|HQDM.java|RDFS.java|UID.java" />
+</suppressions>

examples/pom.xml

@@ -1,5 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
   <modelVersion>4.0.0</modelVersion>
   <parent>
     <groupId>uk.gov.gchq.magma-core</groupId>
@@ -23,10 +25,14 @@
       <groupId>uk.gov.gchq.magma-core</groupId>
       <artifactId>core</artifactId>
     </dependency>
+    <dependency>
+      <groupId>uk.gov.gchq.magma-core</groupId>
+      <artifactId>hqdm-canonical</artifactId>
+    </dependency>
     <dependency>
       <groupId>uk.gov.gchq.magma-core</groupId>
       <artifactId>model-extension-example</artifactId>
-    </dependency>  
+    </dependency>
     <dependency>
       <groupId>junit</groupId>
       <artifactId>junit</artifactId>
@@ -36,4 +42,4 @@
       <artifactId>slf4j-jdk14</artifactId>
     </dependency>
   </dependencies>
-</project>
+</project>

examples/src/test/java/uk/gov/gchq/magmacore/examples/kinds/CreateOrganizationSubTypeUsingKinds.java

@@ -0,0 +1,87 @@
+package uk.gov.gchq.magmacore.examples.kinds;
+
+import static org.junit.Assert.assertTrue;
+
+import java.util.UUID;
+
+import org.junit.Test;
+
+import uk.gov.gchq.magmacore.hqdm.model.Individual;
+import uk.gov.gchq.magmacore.hqdm.model.KindOfOrganization;
+import uk.gov.gchq.magmacore.hqdm.model.KindOfOrganizationComponent;
+import uk.gov.gchq.magmacore.hqdm.model.Organization;
+import uk.gov.gchq.magmacore.hqdm.model.PossibleWorld;
+import uk.gov.gchq.magmacore.hqdm.model.Thing;
+import uk.gov.gchq.magmacore.hqdm.rdf.iri.IRI;
+import uk.gov.gchq.magmacore.hqdm.rdf.iri.IriBase;
+import uk.gov.gchq.magmacore.hqdm.rdfbuilders.IndividualBuilder;
+import uk.gov.gchq.magmacore.hqdm.rdfbuilders.KindOfOrganizationBuilder;
+import uk.gov.gchq.magmacore.hqdm.rdfbuilders.KindOfOrganizationComponentBuilder;
+import uk.gov.gchq.magmacore.hqdm.services.SpatioTemporalExtentServices;
+import uk.gov.gchq.magmacore.service.MagmaCoreService;
+import uk.gov.gchq.magmacore.service.MagmaCoreServiceFactory;
+
+/**
+ * Create a KindOfOrganization and make a Thing a member_of_kind of it, then persist the Thing and
+ * make sure it is read back as an Organization.
+ *
+ * <p>
+ * This demonstrates the implementation of instances of 'kinds' as new entity types.
+ * </p>
+ */
+public class CreateOrganizationSubTypeUsingKinds {
+    /*
+     * A Base URL for the tests.
+     */
+    private static IriBase TEST_BASE = new IriBase("test", "http://example.com/test#");
+
+    /**
+     * Unit test.
+     */
+    @Test
+    public void test() {
+        // ACME Ltd will be a part of this possibleWorld.
+        final PossibleWorld possibleWorld = SpatioTemporalExtentServices.createPossibleWorld(randomIri());
+
+        // We need a kind of organization component for the kind of organization.
+        final KindOfOrganizationComponent componentKind = new KindOfOrganizationComponentBuilder(randomIri())
+                .build();
+
+        // Create a new kind of organization to represent companies.
+        // This will also make the new kind into a sub-type of organization.
+        final KindOfOrganization companies = new KindOfOrganizationBuilder(randomIri())
+                .has_Component_By_Class_M(componentKind)
+                .build();
+
+        // Create an Individual and make it a member_of_kind of the companies kind.
+        // This will also mean that the individual is of type organization, via its kind.
+        final Individual acmeLtd = new IndividualBuilder(randomIri())
+                .member_Of_Kind(companies)
+                .part_Of_Possible_World_M(possibleWorld)
+                .build();
+
+        // Persist everything.
+        final MagmaCoreService service = MagmaCoreServiceFactory.createWithJenaDatabase();
+        service.beginWrite();
+        service.create(companies);
+        service.create(acmeLtd);
+        service.commit();
+
+        // Read back the organization.
+        service.beginRead();
+        final Thing acmeFromDatabase = service.get(acmeLtd.getId());
+        service.commit();
+
+        // Confirm that the entity created as an individual is now actually an organization as well.
+        assertTrue(acmeFromDatabase instanceof Organization);
+    }
+
+    /**
+     * Utility method.
+     *
+     * @return IRI
+     */
+    private static IRI randomIri() {
+        return new IRI(TEST_BASE, UUID.randomUUID().toString());
+    }
+}

hqdm-canonical/src/main/java/uk/gov/gchq/magmacore/hqdm/rdfbuilders/AcceptanceOfOfferBuilder.java

@@ -49,6 +49,7 @@
 import uk.gov.gchq.magmacore.hqdm.model.SpatioTemporalExtent;
 import uk.gov.gchq.magmacore.hqdm.model.Thing;
 import uk.gov.gchq.magmacore.hqdm.rdf.iri.IRI;
+import uk.gov.gchq.magmacore.hqdm.rdf.iri.RDFS;
 import uk.gov.gchq.magmacore.hqdm.services.SpatioTemporalExtentServices;
 
 /**
@@ -213,6 +214,7 @@ public final AcceptanceOfOfferBuilder member_Of(
      */
     public final AcceptanceOfOfferBuilder member_Of_Kind_M(final KindOfActivity kindOfActivity) {
         this.acceptanceOfOffer.addValue(MEMBER_OF_KIND, kindOfActivity.getId());
+        this.acceptanceOfOffer.addValue(RDFS.RDF_TYPE, kindOfActivity.getId());
         return this;
     }
 
@@ -245,8 +247,7 @@ public final AcceptanceOfOfferBuilder part_Of_M(final AgreeContract agreeContrac
     /**
      * A {@link uk.gov.gchq.magmacore.hqdm.rdf.iri.HQDM#PART_OF} relationship type where a
      * {@link uk.gov.gchq.magmacore.hqdm.model.SociallyConstructedObject} may be a
-     * {@link uk.gov.gchq.magmacore.hqdm.rdf.iri.HQDM#PART_OF} one or more
-     * {@link AgreementExecution}.
+     * {@link uk.gov.gchq.magmacore.hqdm.rdf.iri.HQDM#PART_OF} one or more {@link AgreementExecution}.
      *
      * @param agreementExecution The AgreementExecution.
      * @return This builder.
@@ -258,13 +259,12 @@ public final AcceptanceOfOfferBuilder part_Of_(final AgreementExecution agreemen
 
     /**
      * A {@link uk.gov.gchq.magmacore.hqdm.rdf.iri.HQDM#PART_OF} relationship type where a
-     * {@link SpatioTemporalExtent} may be {@link uk.gov.gchq.magmacore.hqdm.rdf.iri.HQDM#PART_OF}
-     * one or more {@link PossibleWorld}.
+     * {@link SpatioTemporalExtent} may be {@link uk.gov.gchq.magmacore.hqdm.rdf.iri.HQDM#PART_OF} one
+     * or more {@link PossibleWorld}.
      *
      * <p>
      * Note: The relationship is optional because a {@link PossibleWorld} is not
-     * {@link uk.gov.gchq.magmacore.hqdm.rdf.iri.HQDM#PART_OF} any other
-     * {@link SpatioTemporalExtent}.
+     * {@link uk.gov.gchq.magmacore.hqdm.rdf.iri.HQDM#PART_OF} any other {@link SpatioTemporalExtent}.
      * </p>
      *
      * @param possibleWorld The PossibleWorld.
@@ -277,8 +277,8 @@ public final AcceptanceOfOfferBuilder part_Of_Possible_World_M(final PossibleWor
 
     /**
      * A {@link uk.gov.gchq.magmacore.hqdm.rdf.iri.HQDM#REFERENCES} relationship type where an
-     * {@link AcceptanceOfOffer} {@link uk.gov.gchq.magmacore.hqdm.rdf.iri.HQDM#REFERENCES} exactly
-     * one {@link Offer} that is accepted.
+     * {@link AcceptanceOfOffer} {@link uk.gov.gchq.magmacore.hqdm.rdf.iri.HQDM#REFERENCES} exactly one
+     * {@link Offer} that is accepted.
      *
      * @param offer The Offer.
      * @return Builder
@@ -304,16 +304,15 @@ public final AcceptanceOfOfferBuilder temporal__Part_Of(final SpatioTemporalExte
     /**
      * A {@link uk.gov.gchq.magmacore.hqdm.rdf.iri.HQDM#TEMPORAL_PART_OF} relationship type where a
      * {@link uk.gov.gchq.magmacore.hqdm.model.State} may be a
-     * {@link uk.gov.gchq.magmacore.hqdm.rdf.iri.HQDM#TEMPORAL_PART_OF} one or more
-     * {@link Individual}.
+     * {@link uk.gov.gchq.magmacore.hqdm.rdf.iri.HQDM#TEMPORAL_PART_OF} one or more {@link Individual}.
      *
      * <p>
      * Note: The relationship is optional because an {@link Individual} is not necessarily a
-     * {@link uk.gov.gchq.magmacore.hqdm.rdf.iri.HQDM#TEMPORAL_PART_OF} another {@link Individual},
-     * yet is a {@link uk.gov.gchq.magmacore.hqdm.rdf.iri.HQDM#MEMBER_OF}
+     * {@link uk.gov.gchq.magmacore.hqdm.rdf.iri.HQDM#TEMPORAL_PART_OF} another {@link Individual}, yet
+     * is a {@link uk.gov.gchq.magmacore.hqdm.rdf.iri.HQDM#MEMBER_OF}
      * {@link uk.gov.gchq.magmacore.hqdm.model.State} as well as {@link Individual}. This applies to all
-     * subtypes of {@link uk.gov.gchq.magmacore.hqdm.rdf.iri.HQDM#TEMPORAL_PART_OF} that are between
-     * a {@code state_of_X} and {@code X}.
+     * subtypes of {@link uk.gov.gchq.magmacore.hqdm.rdf.iri.HQDM#TEMPORAL_PART_OF} that are between a
+     * {@code state_of_X} and {@code X}.
      * </p>
      *
      * @param individual The Individual.

hqdm-canonical/src/main/java/uk/gov/gchq/magmacore/hqdm/rdfbuilders/AcceptanceOfOfferForGoodsBuilder.java

@@ -49,6 +49,7 @@
 import uk.gov.gchq.magmacore.hqdm.model.SpatioTemporalExtent;
 import uk.gov.gchq.magmacore.hqdm.model.Thing;
 import uk.gov.gchq.magmacore.hqdm.rdf.iri.IRI;
+import uk.gov.gchq.magmacore.hqdm.rdf.iri.RDFS;
 import uk.gov.gchq.magmacore.hqdm.services.SpatioTemporalExtentServices;
 
 /**
@@ -209,6 +210,7 @@ public final AcceptanceOfOfferForGoodsBuilder member_Of(
      */
     public final AcceptanceOfOfferForGoodsBuilder member_Of_Kind_M(final KindOfActivity kindOfActivity) {
         this.acceptanceOfOfferForGoods.addValue(MEMBER_OF_KIND, kindOfActivity.getId());
+        this.acceptanceOfOfferForGoods.addValue(RDFS.RDF_TYPE, kindOfActivity.getId());
         return this;
     }
 
@@ -227,9 +229,8 @@ public final AcceptanceOfOfferForGoodsBuilder part__Of(final SpatioTemporalExten
 
     /**
      * A {@link uk.gov.gchq.magmacore.hqdm.rdf.iri.HQDM#PART_OF} relationship type where an
-     * {@link AcceptanceOfOfferForGoods} is a
-     * {@link uk.gov.gchq.magmacore.hqdm.rdf.iri.HQDM#PART_OF} exactly one
-     * {@link OfferAndAcceptanceForGoods}.
+     * {@link AcceptanceOfOfferForGoods} is a {@link uk.gov.gchq.magmacore.hqdm.rdf.iri.HQDM#PART_OF}
+     * exactly one {@link OfferAndAcceptanceForGoods}.
      *
      * @param offerAndAcceptanceForGoods The OfferAndAcceptanceForGoods.
      * @return This builder.
@@ -243,8 +244,7 @@ public final AcceptanceOfOfferForGoodsBuilder part_Of_M(
     /**
      * A {@link uk.gov.gchq.magmacore.hqdm.rdf.iri.HQDM#PART_OF} relationship type where a
      * {@link uk.gov.gchq.magmacore.hqdm.model.SociallyConstructedObject} may be a
-     * {@link uk.gov.gchq.magmacore.hqdm.rdf.iri.HQDM#PART_OF} one or more
-     * {@link AgreementExecution}.
+     * {@link uk.gov.gchq.magmacore.hqdm.rdf.iri.HQDM#PART_OF} one or more {@link AgreementExecution}.
      *
      * @param agreementExecution The AgreementExecution.
      * @return This builder.
@@ -256,13 +256,12 @@ public final AcceptanceOfOfferForGoodsBuilder part_Of_(final AgreementExecution
 
     /**
      * A {@link uk.gov.gchq.magmacore.hqdm.rdf.iri.HQDM#PART_OF} relationship type where a
-     * {@link SpatioTemporalExtent} may be {@link uk.gov.gchq.magmacore.hqdm.rdf.iri.HQDM#PART_OF}
-     * one or more {@link PossibleWorld}.
+     * {@link SpatioTemporalExtent} may be {@link uk.gov.gchq.magmacore.hqdm.rdf.iri.HQDM#PART_OF} one
+     * or more {@link PossibleWorld}.
      *
      * <p>
      * Note: The relationship is optional because a {@link PossibleWorld} is not
-     * {@link uk.gov.gchq.magmacore.hqdm.rdf.iri.HQDM#PART_OF} any other
-     * {@link SpatioTemporalExtent}.
+     * {@link uk.gov.gchq.magmacore.hqdm.rdf.iri.HQDM#PART_OF} any other {@link SpatioTemporalExtent}.
      * </p>
      *
      * @param possibleWorld The PossibleWorld.
@@ -301,16 +300,15 @@ public final AcceptanceOfOfferForGoodsBuilder temporal__Part_Of(final SpatioTemp
     /**
      * A {@link uk.gov.gchq.magmacore.hqdm.rdf.iri.HQDM#TEMPORAL_PART_OF} relationship type where a
      * {@link uk.gov.gchq.magmacore.hqdm.model.State} may be a
-     * {@link uk.gov.gchq.magmacore.hqdm.rdf.iri.HQDM#TEMPORAL_PART_OF} one or more
-     * {@link Individual}.
+     * {@link uk.gov.gchq.magmacore.hqdm.rdf.iri.HQDM#TEMPORAL_PART_OF} one or more {@link Individual}.
      *
      * <p>
      * Note: The relationship is optional because an {@link Individual} is not necessarily a
-     * {@link uk.gov.gchq.magmacore.hqdm.rdf.iri.HQDM#TEMPORAL_PART_OF} another {@link Individual},
-     * yet is a {@link uk.gov.gchq.magmacore.hqdm.rdf.iri.HQDM#MEMBER_OF}
+     * {@link uk.gov.gchq.magmacore.hqdm.rdf.iri.HQDM#TEMPORAL_PART_OF} another {@link Individual}, yet
+     * is a {@link uk.gov.gchq.magmacore.hqdm.rdf.iri.HQDM#MEMBER_OF}
      * {@link uk.gov.gchq.magmacore.hqdm.model.State} as well as {@link Individual}. This applies to all
-     * subtypes of {@link uk.gov.gchq.magmacore.hqdm.rdf.iri.HQDM#TEMPORAL_PART_OF} that are between
-     * a {@code state_of_X} and {@code X}.
+     * subtypes of {@link uk.gov.gchq.magmacore.hqdm.rdf.iri.HQDM#TEMPORAL_PART_OF} that are between a
+     * {@code state_of_X} and {@code X}.
      * </p>
      *
      * @param individual The Individual.

hqdm-canonical/src/main/java/uk/gov/gchq/magmacore/hqdm/rdfbuilders/ActivityBuilder.java

@@ -44,6 +44,7 @@
 import uk.gov.gchq.magmacore.hqdm.model.SpatioTemporalExtent;
 import uk.gov.gchq.magmacore.hqdm.model.Thing;
 import uk.gov.gchq.magmacore.hqdm.rdf.iri.IRI;
+import uk.gov.gchq.magmacore.hqdm.rdf.iri.RDFS;
 import uk.gov.gchq.magmacore.hqdm.services.SpatioTemporalExtentServices;
 
 /**
@@ -179,8 +180,8 @@ public final ActivityBuilder member__Of(final Class clazz) {
 
     /**
      * A {@link uk.gov.gchq.magmacore.hqdm.rdf.iri.HQDM#MEMBER_OF} relationship type where an
-     * {@link Activity} may be a {@link uk.gov.gchq.magmacore.hqdm.rdf.iri.HQDM#MEMBER_OF} one or
-     * more {@link ClassOfActivity}.
+     * {@link Activity} may be a {@link uk.gov.gchq.magmacore.hqdm.rdf.iri.HQDM#MEMBER_OF} one or more
+     * {@link ClassOfActivity}.
      *
      * @param classOfActivity The ClassOfActivity.
      * @return This builder.
@@ -200,6 +201,7 @@ public final ActivityBuilder member_Of(final ClassOfActivity classOfActivity) {
      */
     public final ActivityBuilder member_Of_Kind_M(final KindOfActivity kindOfActivity) {
         this.activity.addValue(MEMBER_OF_KIND, kindOfActivity.getId());
+        this.activity.addValue(RDFS.RDF_TYPE, kindOfActivity.getId());
         return this;
     }
 
@@ -231,13 +233,12 @@ public final ActivityBuilder part_Of(final Activity activity) {
 
     /**
      * A {@link uk.gov.gchq.magmacore.hqdm.rdf.iri.HQDM#PART_OF} relationship type where a
-     * {@link SpatioTemporalExtent} may be {@link uk.gov.gchq.magmacore.hqdm.rdf.iri.HQDM#PART_OF}
-     * one or more {@link PossibleWorld}.
+     * {@link SpatioTemporalExtent} may be {@link uk.gov.gchq.magmacore.hqdm.rdf.iri.HQDM#PART_OF} one
+     * or more {@link PossibleWorld}.
      *
      * <p>
      * Note: The relationship is optional because a {@link PossibleWorld} is not
-     * {@link uk.gov.gchq.magmacore.hqdm.rdf.iri.HQDM#PART_OF} any other
-     * {@link SpatioTemporalExtent}.
+     * {@link uk.gov.gchq.magmacore.hqdm.rdf.iri.HQDM#PART_OF} any other {@link SpatioTemporalExtent}.
      * </p>
      *
      * @param possibleWorld The PossibleWorld.
@@ -275,16 +276,15 @@ public final ActivityBuilder temporal__Part_Of(final SpatioTemporalExtent spatio
     /**
      * A {@link uk.gov.gchq.magmacore.hqdm.rdf.iri.HQDM#TEMPORAL_PART_OF} relationship type where a
      * {@link uk.gov.gchq.magmacore.hqdm.model.State} may be a
-     * {@link uk.gov.gchq.magmacore.hqdm.rdf.iri.HQDM#TEMPORAL_PART_OF} one or more
-     * {@link Individual}.
+     * {@link uk.gov.gchq.magmacore.hqdm.rdf.iri.HQDM#TEMPORAL_PART_OF} one or more {@link Individual}.
      *
      * <p>
      * Note: The relationship is optional because an {@link Individual} is not necessarily a
-     * {@link uk.gov.gchq.magmacore.hqdm.rdf.iri.HQDM#TEMPORAL_PART_OF} another {@link Individual},
-     * yet is a {@link uk.gov.gchq.magmacore.hqdm.rdf.iri.HQDM#MEMBER_OF}
+     * {@link uk.gov.gchq.magmacore.hqdm.rdf.iri.HQDM#TEMPORAL_PART_OF} another {@link Individual}, yet
+     * is a {@link uk.gov.gchq.magmacore.hqdm.rdf.iri.HQDM#MEMBER_OF}
      * {@link uk.gov.gchq.magmacore.hqdm.model.State} as well as {@link Individual}. This applies to all
-     * subtypes of {@link uk.gov.gchq.magmacore.hqdm.rdf.iri.HQDM#TEMPORAL_PART_OF} that are between
-     * a {@code state_of_X} and {@code X}.
+     * subtypes of {@link uk.gov.gchq.magmacore.hqdm.rdf.iri.HQDM#TEMPORAL_PART_OF} that are between a
+     * {@code state_of_X} and {@code X}.
      * </p>
      *
      * @param individual The Individual.