From de5fbe325ca8c4df252072293889e89e73b70f93 Mon Sep 17 00:00:00 2001
From: Claudio Atzori <claudio.atzori@isti.cnr.it>
Date: Mon, 4 May 2020 16:00:48 +0200
Subject: [PATCH] bits of javadoc

---
 .../java/eu/dnetlib/dhp/schema/oaf/Oaf.java   |  3 +++
 .../eu/dnetlib/dhp/schema/oaf/Relation.java   | 21 +++++++++++++++++++
 2 files changed, 24 insertions(+)

diff --git a/dhp-schemas/src/main/java/eu/dnetlib/dhp/schema/oaf/Oaf.java b/dhp-schemas/src/main/java/eu/dnetlib/dhp/schema/oaf/Oaf.java
index 4bfc05039..3496492e8 100644
--- a/dhp-schemas/src/main/java/eu/dnetlib/dhp/schema/oaf/Oaf.java
+++ b/dhp-schemas/src/main/java/eu/dnetlib/dhp/schema/oaf/Oaf.java
@@ -7,6 +7,9 @@ import java.util.Objects;
 
 public abstract class Oaf implements Serializable {
 
+	/**
+	 * The list of datasource id/name pairs providing this relationship.
+	 */
 	protected List<KeyValue> collectedfrom;
 
 	private DataInfo dataInfo;
diff --git a/dhp-schemas/src/main/java/eu/dnetlib/dhp/schema/oaf/Relation.java b/dhp-schemas/src/main/java/eu/dnetlib/dhp/schema/oaf/Relation.java
index 2c282c29e..76503f885 100644
--- a/dhp-schemas/src/main/java/eu/dnetlib/dhp/schema/oaf/Relation.java
+++ b/dhp-schemas/src/main/java/eu/dnetlib/dhp/schema/oaf/Relation.java
@@ -7,16 +7,37 @@ import java.util.*;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
+/**
+ * Relation models any edge between two nodes in the OpenAIRE graph. It has a source id and a target id
+ * pointing to graph node identifiers and it is further characterised by the semantic of the link through the fields
+ * relType, subRelType and relClass. Provenance information is modeled according to the dataInfo element and collectedFrom,
+ * while individual relationship types can provide extra information via the properties field.
+ */
 public class Relation extends Oaf {
 
+	/**
+	 * Main relationship classifier, values include 'resultResult', 'resultProject', 'resultOrganization', etc.
+	 */
 	private String relType;
 
+	/**
+	 * Further classifies a relationship, values include 'affiliation', 'similarity', 'supplement', etc.
+	 */
 	private String subRelType;
 
+	/**
+	 * Indicates the direction of the relationship, values include 'isSupplementTo', 'isSupplementedBy', 'merges, 'isMergedIn'.
+	 */
 	private String relClass;
 
+	/**
+	 * The source entity id.
+	 */
 	private String source;
 
+	/**
+	 * The target entity id.
+	 */
 	private String target;
 
 	public String getRelType() {