EA-3236 information model

pom.xml

@@ -3,6 +3,7 @@
     <modelVersion>4.0.0</modelVersion>
     <modules>
         <module>record-api-definitions</module>
+        <module>record-api-impl</module>
     </modules>
 
     <parent>

record-api-definitions/src/main/java/eu/europeana/api/record/datatypes/CustomDataTypeLiteral.java

@@ -0,0 +1,5 @@
+package eu.europeana.api.record.datatypes;
+
+public interface CustomDataTypeLiteral extends DataTypeLiteral<String> {
+
+}

record-api-definitions/src/main/java/eu/europeana/api/record/datatypes/DataTypeLiteral.java

@@ -0,0 +1,5 @@
+package eu.europeana.api.record.datatypes;
+
+public interface DataTypeLiteral<T> extends Literal<T> {
+
+}

record-api-definitions/src/main/java/eu/europeana/api/record/datatypes/LanguageTaggedLiteral.java

@@ -0,0 +1,8 @@
+package eu.europeana.api.record.datatypes;
+
+public interface LanguageTaggedLiteral<T> extends Literal<T> {
+
+    T getValue();
+    String getLang();
+
+}

record-api-definitions/src/main/java/eu/europeana/api/record/datatypes/Literal.java

@@ -0,0 +1,6 @@
+package eu.europeana.api.record.datatypes;
+
+public interface Literal<T> {
+
+    T getValue();
+}

record-api-definitions/src/main/java/eu/europeana/api/record/datatypes/NonLanguageTaggedLiteral.java

@@ -0,0 +1,5 @@
+package eu.europeana.api.record.datatypes;
+
+public interface NonLanguageTaggedLiteral<T> extends Literal<T> {
+
+}

record-api-definitions/src/main/java/eu/europeana/api/record/datatypes/ObjectReference.java

@@ -0,0 +1,8 @@
+package eu.europeana.api.record.datatypes;
+
+public interface ObjectReference {
+
+    String getId();
+    Object getReferencedObject();
+
+}

record-api-impl/pom.xml

@@ -0,0 +1,27 @@
+<?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">
+    <parent>
+        <artifactId>record-api</artifactId>
+        <groupId>eu.europeana.api</groupId>
+        <version>1.0-SNAPSHOT</version>
+    </parent>
+    <modelVersion>4.0.0</modelVersion>
+
+    <artifactId>record-api-impl</artifactId>
+
+    <properties>
+        <maven.compiler.source>${java.version}</maven.compiler.source>
+        <maven.compiler.target>${java.version}</maven.compiler.target>
+    </properties>
+
+    <dependencies>
+        <dependency>
+            <groupId>eu.europeana.api</groupId>
+            <artifactId>record-api-definitions</artifactId>
+            <version>1.0-SNAPSHOT</version>
+        </dependency>
+    </dependencies>
+
+</project>

record-api-impl/src/main/java/eu/europeana/api/record/impl/Agent.java

@@ -0,0 +1,9 @@
+package eu.europeana.api.record.impl;
+
+import eu.europeana.api.record.vocabulary.EntityTypes;
+
+public class Agent extends Entity {
+
+    private String type = EntityTypes.Agent.getEntityType();
+
+}

record-api-impl/src/main/java/eu/europeana/api/record/impl/Aggregation.java

@@ -0,0 +1,38 @@
+package eu.europeana.api.record.impl;
+
+import eu.europeana.api.record.datatypes.Literal;
+import eu.europeana.api.record.datatypes.ObjectReference;
+
+import java.util.List;
+
+// TODO make inteface
+public class Aggregation extends EdmEntity {
+
+    private Literal<String> type;
+    private Literal<String> isShownBy;
+    private List<ObjectReference> hasViews;  // multiple object refre
+
+    public Literal<String> getType() {
+        return type;
+    }
+
+    public void setType(Literal<String> type) {
+        this.type = type;
+    }
+
+    public Literal<String> getIsShownBy() {
+        return isShownBy;
+    }
+
+    public void setIsShownBy(Literal<String> isShownBy) {
+        this.isShownBy = isShownBy;
+    }
+
+    public List<ObjectReference> getHasViews() {
+        return hasViews;
+    }
+
+    public void setHasViews(List<ObjectReference> hasViews) {
+        this.hasViews = hasViews;
+    }
+}

record-api-impl/src/main/java/eu/europeana/api/record/impl/EdmEntity.java

@@ -0,0 +1,14 @@
+package eu.europeana.api.record.impl;
+
+public class EdmEntity {
+
+    private String about;
+
+    public String getAbout() {
+        return about;
+    }
+
+    public void setAbout(String about) {
+        this.about = about;
+    }
+}

record-api-impl/src/main/java/eu/europeana/api/record/impl/Entity.java

@@ -0,0 +1,12 @@
+package eu.europeana.api.record.impl;
+
+import eu.europeana.api.record.datatypes.Literal;
+
+import java.util.Map;
+
+public abstract class Entity {
+
+    // ID of entity
+    protected String about;
+    protected Map<Literal<String>, Literal<String>> prefLabel;
+}

record-api-impl/src/main/java/eu/europeana/api/record/impl/EuropeanaAggregation.java

@@ -0,0 +1,12 @@
+package eu.europeana.api.record.impl;
+
+import eu.europeana.api.record.datatypes.Literal;
+
+public class EuropeanaAggregation extends EdmEntity {
+
+    private Literal<String> type;
+
+    public Literal<String> getType() {
+        return type;
+    }
+}

record-api-impl/src/main/java/eu/europeana/api/record/impl/ProvidedCHO.java

@@ -0,0 +1,24 @@
+package eu.europeana.api.record.impl;
+
+public class ProvidedCHO extends EdmEntity {
+
+    private String type;
+
+    public String getType() {
+        return type;
+    }
+
+    public void setType(String type) {
+        this.type = type;
+    }
+
+    @Override
+    public String getAbout() {
+        return super.getAbout();
+    }
+
+    @Override
+    public void setAbout(String about) {
+        super.setAbout(about);
+    }
+}

record-api-impl/src/main/java/eu/europeana/api/record/impl/Proxy.java

@@ -0,0 +1,105 @@
+package eu.europeana.api.record.impl;
+
+import eu.europeana.api.record.datatypes.Literal;
+
+import java.util.List;
+import java.util.Map;
+
+public class Proxy extends EdmEntity {
+
+    // TODO for def -> @none there are multiple values present
+    private Literal<String> type;
+    private Map<Literal<String>, List<Literal<String>>> title;
+
+    // todo
+    private Map<Literal<String>, List<Literal<String>>> alternative;
+    private Map<Literal<String>, List<Literal<String>>> description;
+    private Map<Literal<String>, List<Literal<String>>> creator;
+    private Map<Literal<String>, List<Literal<String>>> identifier;
+    private List<Literal<String>> proxyIn;
+    private Literal<String> proxyFor;
+
+    public Literal<String> getType() {
+        return type;
+    }
+
+    public void setType(Literal<String> type) {
+        this.type = type;
+    }
+
+    public Literal<String>  getTitle(String language) {
+        return title.get(language).get(0);
+    }
+
+    public void setTitle(Map<Literal<String>,List<Literal<String>>> title) {
+        this.title = title;
+    }
+
+    public Literal<String> getAlternative(String language) {
+        return alternative.get(language).get(0);
+    }
+
+    public void setAlternative(Map<Literal<String>, List<Literal<String>>> alternative) {
+        this.alternative = alternative;
+    }
+
+    public Literal<String> getDescription(String language) {
+        return description.get(language).get(0);
+    }
+
+    public void setDescription(Map<Literal<String>, List<Literal<String>>> description) {
+        this.description = description;
+    }
+
+    public Literal<String> getCreator(String language) {
+        return creator.get(language).get(0);
+    }
+
+    public void setCreator(Map<Literal<String>, List<Literal<String>>> creator) {
+        this.creator = creator;
+    }
+
+    public Literal<String> getIdentifier(String language) {
+        return identifier.get(language).get(0);
+    }
+
+    public void setIdentifier(Map<Literal<String>, List<Literal<String>>> identifier) {
+        this.identifier = identifier;
+    }
+
+    public List<Literal<String>> getProxyIn() {
+        return proxyIn;
+    }
+
+    public void setProxyIn(List<Literal<String>> proxyIn) {
+        this.proxyIn = proxyIn;
+    }
+
+    public Literal<String> getProxyFor() {
+        return proxyFor;
+    }
+
+    public void setProxyFor(Literal<String> proxyFor) {
+        this.proxyFor = proxyFor;
+    }
+
+    // this is for @none
+    public List<Literal<String>> getTitles() {
+        return title.get("@none");
+    }
+
+    public List<Literal<String>> getAlternatives() {
+        return alternative.get("@none");
+    }
+
+    public List<Literal<String>> getCreators() {
+        return creator.get("@none");
+    }
+
+    public List<Literal<String>> getIdentifiers() {
+        return identifier.get("@none");
+    }
+
+
+
+}

record-api-impl/src/main/java/eu/europeana/api/record/impl/Record.java

@@ -0,0 +1,13 @@
+package eu.europeana.api.record.impl;
+
+public class Record {
+
+    private ProvidedCHO providedCHO;
+    private Proxy proxy;
+    private Aggregation aggregation;
+    private EuropeanaAggregation europeanaAggregation;
+    private WebResource webResource;
+    private TechMetadata techMetadata;
+    private Agent agent;
+
+}

record-api-impl/src/main/java/eu/europeana/api/record/impl/TechMetadata.java

@@ -0,0 +1,6 @@
+package eu.europeana.api.record.impl;
+
+public class TechMetadata {
+
+    private Long fileByteSize;
+}

record-api-impl/src/main/java/eu/europeana/api/record/impl/WebResource.java

@@ -0,0 +1,16 @@
+package eu.europeana.api.record.impl;
+
+import eu.europeana.api.record.datatypes.Literal;
+
+public class WebResource extends EdmEntity {
+
+    private Literal<String> type;
+
+    public Literal<String> getType() {
+        return type;
+    }
+
+    public void setType(Literal<String> type) {
+        this.type = type;
+    }
+}

record-api-impl/src/main/java/eu/europeana/api/record/vocabulary/EntityKeyword.java

@@ -0,0 +1,6 @@
+package eu.europeana.api.record.vocabulary;
+
+public interface EntityKeyword {
+
+  public String getJsonValue();
+}

record-api-impl/src/main/java/eu/europeana/api/record/vocabulary/EntityTypes.java

@@ -0,0 +1,26 @@
+package eu.europeana.api.record.vocabulary;
+
+public enum EntityTypes implements EntityKeyword {
+  Organization("Organization"),
+  Concept("Concept"),
+  Agent("Agent"),
+  Place("Place"),
+  TimeSpan("TimeSpan");
+
+  private String entityType;
+
+  public String getEntityType() {
+    return entityType;
+  }
+
+
+  EntityTypes(String entityType) {
+    this.entityType = entityType;
+
+  }
+
+  @Override
+  public String getJsonValue() {
+    return getEntityType();
+  }
+}

record-api-impl/src/main/java/eu/europeana/api/record/vocabulary/RecordFields.java

@@ -0,0 +1,7 @@
+package eu.europeana.api.record.vocabulary;
+
+public interface RecordFields {
+
+    public static final String CONTEXT = "@context";
+    public static final String EDM_CONTEXT = "http://www.europeana.eu/schemas/context/edm.jsonld";
+}