From 63fc03888d5437bde99e543b9621ccfe450e2e7c Mon Sep 17 00:00:00 2001
From: Rico Bergmann <rico.bergmann1@tu-dresden.de>
Date: Sat, 23 Mar 2019 18:16:10 +0100
Subject: [PATCH] Add cross-references to join implementations in JavaDoc
---
.../model_join/representation/grammar/JoinExpression.java | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/src/main/java/org/rosi_project/model_sync/model_join/representation/grammar/JoinExpression.java b/src/main/java/org/rosi_project/model_sync/model_join/representation/grammar/JoinExpression.java
index 97f4169..956a427 100644
--- a/src/main/java/org/rosi_project/model_sync/model_join/representation/grammar/JoinExpression.java
+++ b/src/main/java/org/rosi_project/model_sync/model_join/representation/grammar/JoinExpression.java
@@ -22,6 +22,8 @@ import org.rosi_project.model_sync.model_join.representation.core.ClassResource;
*
* @author Rico Bergmann
* @see NaturalJoinExpression
+ * @see OuterJoinExpression
+ * @see ThetaJoinExpression
*/
public abstract class JoinExpression implements Iterable<KeepExpression> {
@@ -32,6 +34,8 @@ public abstract class JoinExpression implements Iterable<KeepExpression> {
/**
* The {@code natural join} combines two classes based on attributes with equal name and type.
+ *
+ * @see NaturalJoinExpression
*/
NATURAL,
@@ -39,12 +43,16 @@ public abstract class JoinExpression implements Iterable<KeepExpression> {
* The {@code outer join} works like the {@link #NATURAL} one, but leaves instances from one
* class with no corresponding instance in the other class according to the {@code outer join
* type}. See the subclass for details.
+ *
+ * @see OuterJoinExpression
*/
OUTER,
/**
* The {@code theta join} is more general than the {@link #NATURAL} and {@link #OUTER} one as
* it enables an arbitrary criteria to define whether two instances are "joinable" or not.
+ *
+ * @see ThetaJoinExpression
*/
THETA
}
--
GitLab