From 8d117454d0d80ce98eeafc92f596c9bc7f35716f Mon Sep 17 00:00:00 2001 From: Luca Frosini Date: Wed, 8 Feb 2023 16:57:32 +0100 Subject: [PATCH] Refactoring --- .../{Generator.java => DocumentationGenerator.java} | 6 +++--- .../{TreeGenerator.java => ModelKnowledgeGenerator.java} | 9 ++++++--- .../utils/documentation/GenerateTest.java | 4 ++-- 3 files changed, 11 insertions(+), 8 deletions(-) rename src/main/java/org/gcube/informationsystem/utils/documentation/generator/{Generator.java => DocumentationGenerator.java} (96%) rename src/main/java/org/gcube/informationsystem/utils/documentation/generator/{TreeGenerator.java => ModelKnowledgeGenerator.java} (92%) diff --git a/src/main/java/org/gcube/informationsystem/utils/documentation/generator/Generator.java b/src/main/java/org/gcube/informationsystem/utils/documentation/generator/DocumentationGenerator.java similarity index 96% rename from src/main/java/org/gcube/informationsystem/utils/documentation/generator/Generator.java rename to src/main/java/org/gcube/informationsystem/utils/documentation/generator/DocumentationGenerator.java index 2b51fc4..fe13c77 100644 --- a/src/main/java/org/gcube/informationsystem/utils/documentation/generator/Generator.java +++ b/src/main/java/org/gcube/informationsystem/utils/documentation/generator/DocumentationGenerator.java @@ -23,13 +23,13 @@ import org.slf4j.LoggerFactory; /** * @author Luca Frosini (ISTI - CNR) */ -public class Generator { +public class DocumentationGenerator { - private static final Logger logger = LoggerFactory.getLogger(Generator.class); + private static final Logger logger = LoggerFactory.getLogger(DocumentationGenerator.class); protected ModelKnowledge modelKnowledge; - public Generator() { + public DocumentationGenerator() { this.modelKnowledge = new ModelKnowledge(); } diff --git a/src/main/java/org/gcube/informationsystem/utils/documentation/generator/TreeGenerator.java b/src/main/java/org/gcube/informationsystem/utils/documentation/generator/ModelKnowledgeGenerator.java similarity index 92% rename from src/main/java/org/gcube/informationsystem/utils/documentation/generator/TreeGenerator.java rename to src/main/java/org/gcube/informationsystem/utils/documentation/generator/ModelKnowledgeGenerator.java index e35e31d..42373a0 100644 --- a/src/main/java/org/gcube/informationsystem/utils/documentation/generator/TreeGenerator.java +++ b/src/main/java/org/gcube/informationsystem/utils/documentation/generator/ModelKnowledgeGenerator.java @@ -16,11 +16,14 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** + * Generate the documentation creating a ModelKnowledge + * for the specified RegistrationProvider + * * @author Luca Frosini (ISTI - CNR) */ -public class TreeGenerator extends Generator { +public class ModelKnowledgeGenerator extends DocumentationGenerator { - private static final Logger logger = LoggerFactory.getLogger(TreeGenerator.class); + private static final Logger logger = LoggerFactory.getLogger(ModelKnowledgeGenerator.class); public static final String EXTENSION = ".rst"; public static final String FILENAME_SEPARATOR = "-"; @@ -29,7 +32,7 @@ public class TreeGenerator extends Generator { protected boolean splittedFiles; protected String desiredFileName; - public TreeGenerator(RegistrationProvider rp) { + public ModelKnowledgeGenerator(RegistrationProvider rp) { super(); this.rp = rp; this.splittedFiles = false; diff --git a/src/test/java/org/gcube/informationsystem/utils/documentation/GenerateTest.java b/src/test/java/org/gcube/informationsystem/utils/documentation/GenerateTest.java index 2789b17..5b21d41 100644 --- a/src/test/java/org/gcube/informationsystem/utils/documentation/GenerateTest.java +++ b/src/test/java/org/gcube/informationsystem/utils/documentation/GenerateTest.java @@ -8,7 +8,7 @@ import org.gcube.informationsystem.discovery.ISModelRegistrationProvider; import org.gcube.informationsystem.discovery.RegistrationProvider; import org.gcube.informationsystem.discovery.knowledge.ModelKnowledge; import org.gcube.informationsystem.tree.Tree; -import org.gcube.informationsystem.utils.documentation.generator.TreeGenerator; +import org.gcube.informationsystem.utils.documentation.generator.ModelKnowledgeGenerator; import org.gcube.informationsystem.utils.documentation.model.Documentation; import org.junit.Test; import org.slf4j.Logger; @@ -28,7 +28,7 @@ public class GenerateTest { ServiceLoader registrationProviders = ServiceLoader .load(RegistrationProvider.class); for(RegistrationProvider rp : registrationProviders) { - TreeGenerator treeGenerator = new TreeGenerator(rp); + ModelKnowledgeGenerator treeGenerator = new ModelKnowledgeGenerator(rp); if(rp instanceof ISModelRegistrationProvider) { treeGenerator.setSplittedFiles(false); treeGenerator.setDesiredFileName("is-model");