Skip to content

Commit 4d5310d

Browse files
committed
docs: update documentation on graph
Signed-off-by: Otavio Santana <[email protected]>
1 parent f0bef2b commit 4d5310d

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

jnosql-tinkerpop/src/main/java/org/eclipse/jnosql/databases/tinkerpop/mapping/configuration/AbstractTinkerpopConfiguration.java

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,27 @@
2424
import java.util.Objects;
2525
import java.util.logging.Logger;
2626

27+
/**
28+
* An abstract configuration class that serves as an adapter to integrate Apache TinkerPop's {@link Graph}
29+
* with Eclipse JNoSQL. This class implements a template method pattern to provide a standardized way
30+
* to create and manage graph database instances.
31+
* <p>
32+
* Subclasses are required to implement the {@link #graph(Settings)} method to provide the specific
33+
* {@link Graph} instance based on the given settings.
34+
* </p>
35+
*/
2736
public abstract class AbstractTinkerpopConfiguration implements DatabaseConfiguration {
2837

2938
private static final Logger LOGGER = Logger.getLogger(AbstractTinkerpopConfiguration.class.getName());
3039

3140

41+
/**
42+
* Abstract method to be implemented by subclasses to provide the specific {@link Graph} instance
43+
* based on the given settings.
44+
*
45+
* @param settings the settings to configure the graph instance
46+
* @return the configured {@link Graph} instance
47+
*/
3248
abstract Graph graph(Settings settings);
3349

3450
@Override
@@ -39,6 +55,9 @@ public DatabaseManagerFactory apply(Settings settings) {
3955
return new GraphDatabaseManagerFactory(graph);
4056
}
4157

58+
/**
59+
* A factory class to create instances of {@link DatabaseManager} for the graph database.
60+
*/
4261
static class GraphDatabaseManagerFactory implements DatabaseManagerFactory {
4362

4463
private final Graph graph;

0 commit comments

Comments
 (0)