diff --git a/src/main/java/com/falkordb/Driver.java b/src/main/java/com/falkordb/Driver.java index 8e618d9..8f94c61 100644 --- a/src/main/java/com/falkordb/Driver.java +++ b/src/main/java/com/falkordb/Driver.java @@ -3,9 +3,21 @@ import java.io.Closeable; import redis.clients.jedis.Jedis; - +/** + * An interface which aligned to FalkorDB Driver interface + */ public interface Driver extends Closeable{ + + /** + * Returns a selected Graph + * @param graphId Graph name + * @return a selected Graph + */ GraphContextGenerator graph(String graphId); + /** + * Returns a underline connection to the database + * @return a underline connection to the database + */ Jedis getConnection(); } diff --git a/src/main/java/com/falkordb/FalkorDB.java b/src/main/java/com/falkordb/FalkorDB.java index 77b3fe3..5cd1dc5 100644 --- a/src/main/java/com/falkordb/FalkorDB.java +++ b/src/main/java/com/falkordb/FalkorDB.java @@ -2,14 +2,27 @@ import com.falkordb.impl.api.DriverImpl; +/** + * FalkorDB driver factory + */ final public class FalkorDB { private FalkorDB() {} + /** + * Creates a new driver instance + * @return a new driver instance + */ public static Driver driver (){ return new DriverImpl(); } + /** + * Creates a new driver instance + * @param host host name + * @param port port number + * @return a new driver instance + */ public static Driver driver (String host, int port){ return new DriverImpl(host, port); } diff --git a/src/main/java/com/falkordb/graph_entities/Property.java b/src/main/java/com/falkordb/graph_entities/Property.java index b53bdfd..220fcbb 100644 --- a/src/main/java/com/falkordb/graph_entities/Property.java +++ b/src/main/java/com/falkordb/graph_entities/Property.java @@ -11,6 +11,11 @@ public class Property { private String name; private T value; + /** + * Default constructor + */ + public Property() {} + /** * Parameterized constructor * diff --git a/src/main/java/com/falkordb/impl/api/AbstractGraph.java b/src/main/java/com/falkordb/impl/api/AbstractGraph.java index 6372b05..6df718d 100644 --- a/src/main/java/com/falkordb/impl/api/AbstractGraph.java +++ b/src/main/java/com/falkordb/impl/api/AbstractGraph.java @@ -28,7 +28,7 @@ public abstract class AbstractGraph implements Graph { /** * Sends a query to the redis graph.Implementation and context dependent * @param preparedQuery prepared query - * @param timeout + * @param timeout timeout in milliseconds * @return Result set */ protected abstract ResultSet sendQuery(String preparedQuery, long timeout); @@ -36,7 +36,7 @@ public abstract class AbstractGraph implements Graph { /** * Sends a read-query to the redis graph.Implementation and context dependent * @param preparedQuery prepared query - * @param timeout + * @param timeout timeout in milliseconds * @return Result set */ protected abstract ResultSet sendReadOnlyQuery(String preparedQuery, long timeout); @@ -109,9 +109,9 @@ public ResultSet readOnlyQuery(String query, Map params) { /** * Executes a cypher query with parameters and timeout. - * @param timeout * @param query Cypher query. * @param params parameters map. + * @param timeout timeout in milliseconds * @return a result set. */ @Override @@ -122,9 +122,9 @@ public ResultSet query(String query, Map params, long timeout) { /** * Executes a cypher read-only query with parameters and timeout. - * @param timeout * @param query Cypher query. * @param params parameters map. + * @param timeout timeout in milliseconds * @return a result set. */ @Override diff --git a/src/main/java/com/falkordb/impl/api/GraphCommand.java b/src/main/java/com/falkordb/impl/api/GraphCommand.java index 906609e..f351eee 100644 --- a/src/main/java/com/falkordb/impl/api/GraphCommand.java +++ b/src/main/java/com/falkordb/impl/api/GraphCommand.java @@ -3,7 +3,7 @@ import redis.clients.jedis.commands.ProtocolCommand; /** - * + * An enum which aligned to FalkorDB Graph commands */ public enum GraphCommand implements ProtocolCommand { QUERY("graph.QUERY"), @@ -12,10 +12,17 @@ public enum GraphCommand implements ProtocolCommand { private final byte[] raw; + /** + * Generates a new instance with a specific command + * @param alt command + */ GraphCommand(String alt) { raw = SafeEncoder.encode(alt); } + /** + * Returns the raw command + */ public byte[] getRaw() { return raw; } diff --git a/src/main/java/com/falkordb/impl/api/GraphContextImpl.java b/src/main/java/com/falkordb/impl/api/GraphContextImpl.java index 534ca30..fe49dce 100644 --- a/src/main/java/com/falkordb/impl/api/GraphContextImpl.java +++ b/src/main/java/com/falkordb/impl/api/GraphContextImpl.java @@ -27,7 +27,9 @@ public class GraphContextImpl extends AbstractGraph implements GraphContext { /** * Generates a new instance with a specific Jedis connection - * @param connectionContext + * @param connection Jedis connection + * @param cache GraphCache + * @param graphId graph id */ public GraphContextImpl(Jedis connection, GraphCache cache, String graphId) { this.connection = connection; diff --git a/src/main/java/com/falkordb/impl/api/GraphImpl.java b/src/main/java/com/falkordb/impl/api/GraphImpl.java index 7e9c6fb..161580b 100644 --- a/src/main/java/com/falkordb/impl/api/GraphImpl.java +++ b/src/main/java/com/falkordb/impl/api/GraphImpl.java @@ -8,7 +8,7 @@ import redis.clients.jedis.util.SafeEncoder; /** - * + * An implementation of GraphContextGenerator. */ public class GraphImpl extends AbstractGraph implements GraphContextGenerator { diff --git a/src/main/java/com/falkordb/impl/api/GraphPipelineImpl.java b/src/main/java/com/falkordb/impl/api/GraphPipelineImpl.java index 85384b3..b89f27a 100644 --- a/src/main/java/com/falkordb/impl/api/GraphPipelineImpl.java +++ b/src/main/java/com/falkordb/impl/api/GraphPipelineImpl.java @@ -69,7 +69,7 @@ public ResultSet build(Object o) { * * NOTE: timeout is simply sent to DB. Socket timeout will not be changed. * @param query Cypher query - * @param timeout + * @param timeout timeout in milliseconds * @return a response which builds the result set with the query answer. */ @Override @@ -90,7 +90,7 @@ public ResultSet build(Object o) { * * NOTE: timeout is simply sent to DB. Socket timeout will not be changed. * @param query Cypher query - * @param timeout + * @param timeout timeout in milliseconds * @return a response which builds the result set with the query answer. */ @Override @@ -151,7 +151,7 @@ public ResultSet build(Object o) { * timeout. * @param query Cypher query. * @param params parameters map. - * @param timeout + * @param timeout timeout in milliseconds * @return a response which builds the result set with the query answer. */ @Override @@ -175,7 +175,7 @@ public ResultSet build(Object o) { * timeout. * @param query Cypher query. * @param params parameters map. - * @param timeout + * @param timeout timeout in milliseconds * @return a response which builds the result set with the query answer. */ @Override diff --git a/src/main/java/com/falkordb/impl/api/GraphTransaction.java b/src/main/java/com/falkordb/impl/api/GraphTransaction.java index feee590..7899537 100644 --- a/src/main/java/com/falkordb/impl/api/GraphTransaction.java +++ b/src/main/java/com/falkordb/impl/api/GraphTransaction.java @@ -92,7 +92,7 @@ public ResultSet build(Object o) { * * NOTE: timeout is simply sent to DB. Socket timeout will not be changed. * @param query Cypher query - * @param timeout + * @param timeout timeout in milliseconds * @return a response which builds the result set with the query answer. */ @Override @@ -152,7 +152,7 @@ public ResultSet build(Object o) { * NOTE: timeout is simply sent to DB. Socket timeout will not be changed. * @param query Cypher query. * @param params parameters map. - * @param timeout + * @param timeout timeout in milliseconds * @return a response which builds the result set with the query answer. */ @Override @@ -175,7 +175,7 @@ public ResultSet build(Object o) { * NOTE: timeout is simply sent to DB. Socket timeout will not be changed. * @param query Cypher query. * @param params parameters map. - * @param timeout + * @param timeout timeout in milliseconds * @return a response which builds the result set with the query answer. */ @Override