Skip to content
Snippets Groups Projects
Commit 92d9776f authored by Julien Lopez's avatar Julien Lopez
Browse files

Even more adds and fixes in documentation

parent a6fe07d5
No related branches found
No related tags found
No related merge requests found
......@@ -10,7 +10,8 @@ import qir.util.QIRAny;
* This class represents a QIR expression that should be executed in a database using the driver
* {@link QIRDBNode#driver}.
*
* @param DBRepr The type of representation of a query for the database.
* @param <DBRepr> The type of representation of a query for the database.
* @param <ConnData> The type of the configuration data to connect to the database.
*/
public final class QIRDBNode<DBRepr, ConnData> extends QIRNode {
/**
......
......@@ -10,7 +10,9 @@ import qir.util.QIRAny;
/**
* The {@link QIRTable} is the representation of a table of a database in QIR.
*
* @param DBRepr The type of representation of a query for the database.
* @param <DBRepr> The type of representation of a query for the database.
* @param <ConnData> The type of representation of the configuration data to connect to the targeted
* database.
*/
public final class QIRTable<DBRepr, ConnData> extends QIRNode {
/**
......
......@@ -10,6 +10,10 @@ import qir.util.QIRAny;
* The {@link QIRJoin} represents the join operation of relational algebra.
*/
public final class QIRJoin extends QIROperator {
/**
* The filter function that takes two tuples and returns a value (typically a boolean) that
* describes whether or not the tuples should be merged and added to the result set.
*/
public final QIRNode filter;
/**
* The left {@link QIROperator} of the join.
......
......@@ -10,6 +10,10 @@ import qir.util.QIRAny;
* The {@link QIRLeftJoin} represents the join operation of relational algebra.
*/
public final class QIRLeftJoin extends QIROperator {
/**
* The filter function that takes two tuples and returns a value (typically a boolean) that
* describes whether or not the tuples should be merged and added to the result set.
*/
public final QIRNode filter;
/**
* The left {@link QIROperator} of the join.
......
......@@ -10,6 +10,10 @@ import qir.util.QIRAny;
* The {@link QIRRightJoin} represents the join operation of relational algebra.
*/
public final class QIRRightJoin extends QIROperator {
/**
* The filter function that takes two tuples and returns a value (typically a boolean) that
* describes whether or not the tuples should be merged and added to the result set.
*/
public final QIRNode filter;
/**
* The left {@link QIROperator} of the join.
......
......@@ -7,8 +7,8 @@ import qir.util.QIRException;
/**
* Generic driver for databases.
*
* @param DBRepr The type of representation of a query for the targeted database.
* @param ConnData The type of representation of the configuration data to connect to the targeted
* @param <DBRepr> The type of representation of a query for the targeted database.
* @param <ConnData> The type of representation of the configuration data to connect to the targeted
* database.
*/
public abstract class DBDriver<DBRepr, ConnData> {
......
......@@ -10,8 +10,10 @@ import qir.ast.value.*;
import qir.util.QIRException;
/**
* Implement IQIRVisitor<T> to visit a QIR tree. The return type of the visit functions in the
* visitor and the accept functions in the QIR nodes is T.
* Implement IQIRVisitor to visit a QIR tree.
*
* @param <T> The return type of the visit functions in the visitor and the accept functions in the
* QIR nodes.
*/
public interface IQIRVisitor<T> {
public default T visit(final QIRProject qirProject) {
......
......@@ -9,7 +9,7 @@ import qir.util.QIRException;
/**
* Abstract driver for SQL databases. Drivers for SQL databases should extend this class.
*
* @param DBRepr The type of representation of a query for the database.
* @param <DBRepr> The type of representation of a query for the database.
*/
public abstract class SQLDriver<DBRepr> extends DBDriver<DBRepr, ConnectionData> {
protected Connection conn;
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment