gCubeSystem
/
information-system-model-documentation-generator
16
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Refactoring

This commit is contained in:
Luca Frosini 2023-02-08 16:57:32 +01:00
parent b82552b522
commit 8d117454d0
3 changed files with 11 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/main/java/org/gcube/informationsystem/utils/documentation/generator/Generator.java → src/main/java/org/gcube/informationsystem/utils/documentation/generator/DocumentationGenerator.java
View File

@ -23,13 +23,13 @@ import org.slf4j.LoggerFactory;
/** /**
* @author Luca Frosini (ISTI - CNR) * @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; protected ModelKnowledge modelKnowledge;
public Generator() { public DocumentationGenerator() {
this.modelKnowledge = new ModelKnowledge(); this.modelKnowledge = new ModelKnowledge();
} }

9
src/main/java/org/gcube/informationsystem/utils/documentation/generator/TreeGenerator.java → src/main/java/org/gcube/informationsystem/utils/documentation/generator/ModelKnowledgeGenerator.java
View File

@ -16,11 +16,14 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory; import org.slf4j.LoggerFactory;
/** /**
* Generate the documentation creating a ModelKnowledge
* for the specified RegistrationProvider
*
* @author Luca Frosini (ISTI - CNR) * @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 EXTENSION = ".rst";
public static final String FILENAME_SEPARATOR = "-"; public static final String FILENAME_SEPARATOR = "-";
@ -29,7 +32,7 @@ public class TreeGenerator extends Generator {
protected boolean splittedFiles; protected boolean splittedFiles;
protected String desiredFileName; protected String desiredFileName;
public TreeGenerator(RegistrationProvider rp) { public ModelKnowledgeGenerator(RegistrationProvider rp) {
super(); super();
this.rp = rp; this.rp = rp;
this.splittedFiles = false; this.splittedFiles = false;

4
src/test/java/org/gcube/informationsystem/utils/documentation/GenerateTest.java
View File

@ -8,7 +8,7 @@ import org.gcube.informationsystem.discovery.ISModelRegistrationProvider;
import org.gcube.informationsystem.discovery.RegistrationProvider; import org.gcube.informationsystem.discovery.RegistrationProvider;
import org.gcube.informationsystem.discovery.knowledge.ModelKnowledge; import org.gcube.informationsystem.discovery.knowledge.ModelKnowledge;
import org.gcube.informationsystem.tree.Tree; 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.gcube.informationsystem.utils.documentation.model.Documentation;
import org.junit.Test; import org.junit.Test;
import org.slf4j.Logger; import org.slf4j.Logger;
@ -28,7 +28,7 @@ public class GenerateTest {
ServiceLoader<? extends RegistrationProvider> registrationProviders = ServiceLoader ServiceLoader<? extends RegistrationProvider> registrationProviders = ServiceLoader
.load(RegistrationProvider.class); .load(RegistrationProvider.class);
for(RegistrationProvider rp : registrationProviders) { for(RegistrationProvider rp : registrationProviders) {
TreeGenerator treeGenerator = new TreeGenerator(rp); ModelKnowledgeGenerator treeGenerator = new ModelKnowledgeGenerator(rp);
if(rp instanceof ISModelRegistrationProvider) { if(rp instanceof ISModelRegistrationProvider) {
treeGenerator.setSplittedFiles(false); treeGenerator.setSplittedFiles(false);
treeGenerator.setDesiredFileName("is-model"); treeGenerator.setDesiredFileName("is-model");