initialising the component
commit
8004983429
@ -0,0 +1,38 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<classpath>
|
||||
<classpathentry kind="src" output="target/classes" path="src/main/java">
|
||||
<attributes>
|
||||
<attribute name="optional" value="true"/>
|
||||
<attribute name="maven.pomderived" value="true"/>
|
||||
</attributes>
|
||||
</classpathentry>
|
||||
<classpathentry excluding="**" kind="src" output="target/classes" path="src/main/resources">
|
||||
<attributes>
|
||||
<attribute name="maven.pomderived" value="true"/>
|
||||
</attributes>
|
||||
</classpathentry>
|
||||
<classpathentry kind="src" output="target/test-classes" path="src/test/java">
|
||||
<attributes>
|
||||
<attribute name="optional" value="true"/>
|
||||
<attribute name="maven.pomderived" value="true"/>
|
||||
<attribute name="test" value="true"/>
|
||||
</attributes>
|
||||
</classpathentry>
|
||||
<classpathentry excluding="**" kind="src" output="target/test-classes" path="src/test/resources">
|
||||
<attributes>
|
||||
<attribute name="maven.pomderived" value="true"/>
|
||||
<attribute name="test" value="true"/>
|
||||
</attributes>
|
||||
</classpathentry>
|
||||
<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.8">
|
||||
<attributes>
|
||||
<attribute name="maven.pomderived" value="true"/>
|
||||
</attributes>
|
||||
</classpathentry>
|
||||
<classpathentry kind="con" path="org.eclipse.m2e.MAVEN2_CLASSPATH_CONTAINER">
|
||||
<attributes>
|
||||
<attribute name="maven.pomderived" value="true"/>
|
||||
</attributes>
|
||||
</classpathentry>
|
||||
<classpathentry kind="output" path="target/classes"/>
|
||||
</classpath>
|
@ -0,0 +1,18 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<projectDescription>
|
||||
<name>information-system-model-documentation-generator</name>
|
||||
<comment></comment>
|
||||
<projects>
|
||||
</projects>
|
||||
<buildSpec>
|
||||
<buildCommand>
|
||||
<name>org.eclipse.m2e.core.maven2Builder</name>
|
||||
<arguments>
|
||||
</arguments>
|
||||
</buildCommand>
|
||||
</buildSpec>
|
||||
<natures>
|
||||
<nature>org.eclipse.jdt.core.javanature</nature>
|
||||
<nature>org.eclipse.m2e.core.maven2Nature</nature>
|
||||
</natures>
|
||||
</projectDescription>
|
@ -0,0 +1,6 @@
|
||||
eclipse.preferences.version=1
|
||||
encoding//src/main/java=UTF-8
|
||||
encoding//src/main/resources=UTF-8
|
||||
encoding//src/test/java=UTF-8
|
||||
encoding//src/test/resources=UTF-8
|
||||
encoding/<project>=UTF-8
|
@ -0,0 +1,8 @@
|
||||
eclipse.preferences.version=1
|
||||
org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.8
|
||||
org.eclipse.jdt.core.compiler.compliance=1.8
|
||||
org.eclipse.jdt.core.compiler.problem.enablePreviewFeatures=disabled
|
||||
org.eclipse.jdt.core.compiler.problem.forbiddenReference=warning
|
||||
org.eclipse.jdt.core.compiler.problem.reportPreviewFeatures=ignore
|
||||
org.eclipse.jdt.core.compiler.release=disabled
|
||||
org.eclipse.jdt.core.compiler.source=1.8
|
@ -0,0 +1,4 @@
|
||||
activeProfiles=
|
||||
eclipse.preferences.version=1
|
||||
resolveWorkspaceProjects=true
|
||||
version=1
|
@ -0,0 +1,8 @@
|
||||
This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||
|
||||
# Changelog for Information System Model
|
||||
|
||||
## [v1.0.0]
|
||||
|
||||
- First Release
|
||||
|
@ -0,0 +1,26 @@
|
||||
# Acknowledgments
|
||||
|
||||
The projects leading to this software have received funding from a series of European Union programmes including:
|
||||
|
||||
- the Sixth Framework Programme for Research and Technological Development
|
||||
- [DILIGENT](https://cordis.europa.eu/project/id/004260) (grant no. 004260).
|
||||
- the Seventh Framework Programme for research, technological development and demonstration
|
||||
- [D4Science](https://cordis.europa.eu/project/id/212488) (grant no. 212488);
|
||||
- [D4Science-II](https://cordis.europa.eu/project/id/239019) (grant no.239019);
|
||||
- [ENVRI](https://cordis.europa.eu/project/id/283465) (grant no. 283465);
|
||||
- [iMarine](https://cordis.europa.eu/project/id/283644) (grant no. 283644);
|
||||
- [EUBrazilOpenBio](https://cordis.europa.eu/project/id/288754) (grant no. 288754).
|
||||
- the H2020 research and innovation programme
|
||||
- [SoBigData](https://cordis.europa.eu/project/id/654024) (grant no. 654024);
|
||||
- [PARTHENOS](https://cordis.europa.eu/project/id/654119) (grant no. 654119);
|
||||
- [EGI-Engage](https://cordis.europa.eu/project/id/654142) (grant no. 654142);
|
||||
- [ENVRI PLUS](https://cordis.europa.eu/project/id/654182) (grant no. 654182);
|
||||
- [BlueBRIDGE](https://cordis.europa.eu/project/id/675680) (grant no. 675680);
|
||||
- [PerformFISH](https://cordis.europa.eu/project/id/727610) (grant no. 727610);
|
||||
- [AGINFRA PLUS](https://cordis.europa.eu/project/id/731001) (grant no. 731001);
|
||||
- [DESIRA](https://cordis.europa.eu/project/id/818194) (grant no. 818194);
|
||||
- [ARIADNEplus](https://cordis.europa.eu/project/id/823914) (grant no. 823914);
|
||||
- [RISIS 2](https://cordis.europa.eu/project/id/824091) (grant no. 824091);
|
||||
- [EOSC-Pillar](https://cordis.europa.eu/project/id/857650) (grant no. 857650);
|
||||
- [Blue Cloud](https://cordis.europa.eu/project/id/862409) (grant no. 862409);
|
||||
- [SoBigData-PlusPlus](https://cordis.europa.eu/project/id/871042) (grant no. 871042);
|
@ -0,0 +1,50 @@
|
||||
# Information System Model Documentation Generator
|
||||
|
||||
Information System Model Documentation Generator automatically generate documentation
|
||||
in reStructuredText format for any Information System Model specializations.
|
||||
|
||||
## Built With
|
||||
|
||||
* [OpenJDK](https://openjdk.java.net/) - The JDK used
|
||||
* [Maven](https://maven.apache.org/) - Dependency Management
|
||||
|
||||
## Documentation
|
||||
|
||||
[Information System](https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model)
|
||||
|
||||
## Change log
|
||||
|
||||
See [Releases](https://code-repo.d4science.org/gCubeSystem/information-system-model/releases).
|
||||
|
||||
## Authors
|
||||
|
||||
* **Luca Frosini** ([ORCID](https://orcid.org/0000-0003-3183-2291)) - [ISTI-CNR Infrascience Group](http://nemis.isti.cnr.it/groups/infrascience)
|
||||
|
||||
## How to Cite this Software
|
||||
|
||||
Tell people how to cite this software.
|
||||
* Cite an associated paper?
|
||||
* Use a specific BibTeX entry for the software?
|
||||
|
||||
|
||||
@Manual{,
|
||||
title = {Information System Model Documentation Generator},
|
||||
author = {{Frosini, Luca}},
|
||||
organization = {ISTI - CNR},
|
||||
address = {Pisa, Italy},
|
||||
year = 2022,
|
||||
url = {http://www.gcube-system.org/}
|
||||
}
|
||||
|
||||
## License
|
||||
|
||||
This project is licensed under the EUPL V.1.1 License - see the [LICENSE.md](LICENSE.md) file for details.
|
||||
|
||||
|
||||
## About the gCube Framework
|
||||
This software is part of the [gCubeFramework](https://www.gcube-system.org/ "gCubeFramework"): an
|
||||
open-source software toolkit used for building and operating Hybrid Data
|
||||
Infrastructures enabling the dynamic deployment of Virtual Research Environments
|
||||
by favouring the realisation of reuse oriented policies.
|
||||
|
||||
The projects leading to this software have received funding from a series of European Union programmes see [FUNDING.md](FUNDING.md)
|
@ -0,0 +1,73 @@
|
||||
<project xmlns="http://maven.apache.org/POM/4.0.0"
|
||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
|
||||
<modelVersion>4.0.0</modelVersion>
|
||||
<parent>
|
||||
<groupId>org.gcube.tools</groupId>
|
||||
<artifactId>maven-parent</artifactId>
|
||||
<version>1.1.0</version>
|
||||
</parent>
|
||||
|
||||
<groupId>org.gcube.information-system</groupId>
|
||||
<artifactId>information-system-model-documentation-generator</artifactId>
|
||||
<version>1.0.0-SNAPSHOT</version>
|
||||
<name>Information System Model Documentation Generator</name>
|
||||
|
||||
<properties>
|
||||
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
|
||||
</properties>
|
||||
|
||||
<scm>
|
||||
<connection>scm:git:https://code-repo.d4science.org/gCubeSystem/${project.artifactId}.git</connection>
|
||||
<developerConnection>scm:git:https://code-repo.d4science.org/gCubeSystem/${project.artifactId}.git</developerConnection>
|
||||
<url>https://code-repo.d4science.org/gCubeSystem/${project.artifactId}</url>
|
||||
</scm>
|
||||
|
||||
<dependencyManagement>
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>org.gcube.distribution</groupId>
|
||||
<artifactId>gcube-bom</artifactId>
|
||||
<version>2.1.0</version>
|
||||
<type>pom</type>
|
||||
<scope>import</scope>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
</dependencyManagement>
|
||||
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>org.gcube.information-system</groupId>
|
||||
<artifactId>information-system-model</artifactId>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.gcube.common</groupId>
|
||||
<artifactId>gcube-jackson-databind</artifactId>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.gcube.common</groupId>
|
||||
<artifactId>gcube-jackson-annotations</artifactId>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.gcube.common</groupId>
|
||||
<artifactId>gcube-jackson-core</artifactId>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.slf4j</groupId>
|
||||
<artifactId>slf4j-api</artifactId>
|
||||
</dependency>
|
||||
<!-- Test Dependencies -->
|
||||
<dependency>
|
||||
<groupId>junit</groupId>
|
||||
<artifactId>junit</artifactId>
|
||||
<version>4.11</version>
|
||||
<scope>test</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>ch.qos.logback</groupId>
|
||||
<artifactId>logback-classic</artifactId>
|
||||
<scope>test</scope>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
|
||||
</project>
|
@ -0,0 +1,313 @@
|
||||
package org.gcube.informationsystem.utils.documentation;
|
||||
|
||||
import java.io.File;
|
||||
import java.util.HashSet;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import java.util.Set;
|
||||
|
||||
import org.gcube.informationsystem.types.reference.Type;
|
||||
import org.gcube.informationsystem.types.reference.properties.PropertyDefinition;
|
||||
import org.gcube.informationsystem.utils.discovery.Discovery;
|
||||
import org.gcube.informationsystem.utils.documentation.rst.Section;
|
||||
import org.gcube.informationsystem.utils.documentation.rst.Section.SectionType;
|
||||
import org.gcube.informationsystem.utils.documentation.rst.table.Cell;
|
||||
import org.gcube.informationsystem.utils.documentation.rst.table.Row;
|
||||
import org.gcube.informationsystem.utils.documentation.rst.table.RowType;
|
||||
import org.gcube.informationsystem.utils.documentation.rst.table.Table;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
|
||||
/**
|
||||
* @author Luca Frosini (ISTI - CNR)
|
||||
*/
|
||||
public class DocumentationGenerator {
|
||||
|
||||
private static final Logger logger = LoggerFactory.getLogger(DocumentationGenerator.class);
|
||||
|
||||
protected File baseDirectory;
|
||||
|
||||
public DocumentationGenerator(File baseDirectory) {
|
||||
this.baseDirectory = baseDirectory;
|
||||
}
|
||||
|
||||
/*
|
||||
* E.g. GCubeProperty extends Property
|
||||
*/
|
||||
protected StringBuffer getTypeDeclaration(Type type) {
|
||||
StringBuffer stringBuffer = new StringBuffer();
|
||||
stringBuffer.append("**");
|
||||
stringBuffer.append(type.getName());
|
||||
stringBuffer.append("**");
|
||||
stringBuffer.append(" ``extends`` ");
|
||||
boolean first = true;
|
||||
for(String superClass : type.getSuperClasses()) {
|
||||
if(!first) {
|
||||
stringBuffer.append(", ");
|
||||
}else {
|
||||
first = false;
|
||||
}
|
||||
stringBuffer.append("**");
|
||||
stringBuffer.append(superClass);
|
||||
stringBuffer.append("**");
|
||||
}
|
||||
return stringBuffer;
|
||||
}
|
||||
|
||||
protected StringBuffer getTypeChangelog(Type type) {
|
||||
StringBuffer stringBuffer = new StringBuffer();
|
||||
stringBuffer.append("The **");
|
||||
stringBuffer.append(type.getName());
|
||||
stringBuffer.append("** current version is ");
|
||||
stringBuffer.append(type.getVersionAsString());
|
||||
stringBuffer.append(".\n\n");
|
||||
Map<String, String> changelog = type.getChangelogWithVersionAsString();
|
||||
Set<String> keySet = changelog.keySet();
|
||||
stringBuffer.append("Changelog:\n\n");
|
||||
int i=0;
|
||||
for(String version : keySet) {
|
||||
stringBuffer.append("* **");
|
||||
stringBuffer.append(version);
|
||||
stringBuffer.append("**: ");
|
||||
stringBuffer.append(changelog.get(version));
|
||||
if(i==keySet.size()-1) {
|
||||
stringBuffer.append(".");
|
||||
}else {
|
||||
stringBuffer.append(";");
|
||||
}
|
||||
}
|
||||
stringBuffer.append("\n\n");
|
||||
return stringBuffer;
|
||||
}
|
||||
|
||||
protected Row getPropertyHeadingRow() {
|
||||
Row row = new Row(RowType.HEADING);
|
||||
Cell name = new Cell();
|
||||
name.setText("Name");
|
||||
row.appendCell(name);
|
||||
Cell type = new Cell();
|
||||
type.setText("Type");
|
||||
row.appendCell(type);
|
||||
Cell attributes = new Cell();
|
||||
attributes.setText("Attributes");
|
||||
row.appendCell(attributes);
|
||||
Cell description = new Cell();
|
||||
description.setText("Description");
|
||||
row.appendCell(description);
|
||||
return row;
|
||||
}
|
||||
|
||||
protected String getPropertyAttributes(PropertyDefinition propertyDefinition) {
|
||||
StringBuffer stringBuffer = new StringBuffer();
|
||||
|
||||
boolean mandatory = propertyDefinition.isMandatory();
|
||||
stringBuffer.append("``Mandatory:");
|
||||
stringBuffer.append(mandatory);
|
||||
|
||||
boolean readOnly = propertyDefinition.isReadonly();
|
||||
stringBuffer.append("`` ``ReadOnly:");
|
||||
stringBuffer.append(readOnly);
|
||||
|
||||
boolean notNull = propertyDefinition.isNotnull();
|
||||
stringBuffer.append("`` ``NotNull:");
|
||||
stringBuffer.append(notNull);
|
||||
|
||||
String regex = propertyDefinition.getRegexp();
|
||||
if(regex!=null && regex.compareTo("")!=0) {
|
||||
stringBuffer.append("`` ``Regex:");
|
||||
stringBuffer.append(regex);
|
||||
}
|
||||
|
||||
Integer max = propertyDefinition.getMax();
|
||||
if(max!=null) {
|
||||
stringBuffer.append("`` ``Max:");
|
||||
stringBuffer.append(max);
|
||||
}
|
||||
|
||||
Integer min = propertyDefinition.getMin();
|
||||
if(min!=null) {
|
||||
stringBuffer.append("`` ``Min:");
|
||||
stringBuffer.append(min);
|
||||
}
|
||||
stringBuffer.append("``");
|
||||
return stringBuffer.toString();
|
||||
}
|
||||
|
||||
protected Row getPropertyRow(PropertyDefinition propertyDefinition) {
|
||||
Row row = new Row(RowType.NORMAL);
|
||||
Cell name = new Cell();
|
||||
name.setText(propertyDefinition.getName());
|
||||
row.appendCell(name);
|
||||
Cell type = new Cell();
|
||||
type.setText(propertyDefinition.getType());
|
||||
row.appendCell(type);
|
||||
Cell attributes = new Cell();
|
||||
attributes.setText(getPropertyAttributes(propertyDefinition));
|
||||
row.appendCell(attributes);
|
||||
Cell description = new Cell();
|
||||
description.setText(propertyDefinition.getDescription());
|
||||
row.appendCell(description);
|
||||
return row;
|
||||
}
|
||||
|
||||
protected Table getTable(Type type) {
|
||||
|
||||
Table table = new Table();
|
||||
table.appendRow(getPropertyHeadingRow());
|
||||
Set<PropertyDefinition> properties = type.getProperties();
|
||||
if(properties!=null && properties.size()>0) {
|
||||
Set<PropertyDefinition> notManadatoryProperties = new HashSet<>();
|
||||
for(PropertyDefinition propertyDefinition : properties) {
|
||||
if(propertyDefinition.isMandatory()) {
|
||||
/*
|
||||
* Adding Mandatory properties first in the table
|
||||
*/
|
||||
table.appendRow(getPropertyRow(propertyDefinition));
|
||||
}else {
|
||||
notManadatoryProperties.add(propertyDefinition);
|
||||
}
|
||||
}
|
||||
for(PropertyDefinition propertyDefinition : notManadatoryProperties) {
|
||||
table.appendRow(getPropertyRow(propertyDefinition));
|
||||
}
|
||||
}else {
|
||||
table.appendRow(getNoPropertyRow());
|
||||
}
|
||||
return table;
|
||||
}
|
||||
|
||||
protected Row getNoPropertyRow() {
|
||||
Row row = new Row(RowType.NORMAL);
|
||||
Cell noProp = new Cell();
|
||||
noProp.setText("This type does not define any additional attributes.");
|
||||
row.appendCell(noProp);
|
||||
row.appendCell(noProp);
|
||||
row.appendCell(noProp);
|
||||
row.appendCell(noProp);
|
||||
return row;
|
||||
}
|
||||
|
||||
public StringBuffer generatePropertySection(Type type) {
|
||||
StringBuffer stringBuffer = new StringBuffer();
|
||||
stringBuffer.append("\n");
|
||||
String name = type.getName();
|
||||
Section section = new Section();
|
||||
stringBuffer.append(section.generateSection(SectionType.HEADING_3, name));
|
||||
stringBuffer.append(type.getDescription());
|
||||
stringBuffer.append("\n");
|
||||
|
||||
String tableTitle = getTypeDeclaration(type).toString();
|
||||
Table table = getTable(type);
|
||||
stringBuffer.append(table.generateTable(tableTitle));
|
||||
|
||||
stringBuffer.append(getTypeChangelog(type));
|
||||
|
||||
logger.info(stringBuffer.toString());
|
||||
return stringBuffer;
|
||||
}
|
||||
|
||||
public StringBuffer generateResourceSection(Type type) {
|
||||
StringBuffer stringBuffer = new StringBuffer();
|
||||
stringBuffer.append("\n");
|
||||
String name = type.getName();
|
||||
Section section = new Section();
|
||||
stringBuffer.append(section.generateSection(SectionType.HEADING_3, name));
|
||||
stringBuffer.append(type.getDescription());
|
||||
stringBuffer.append("\n");
|
||||
|
||||
String tableTitle = getTypeDeclaration(type).toString();
|
||||
Table table = getTable(type);
|
||||
stringBuffer.append(table.generateTable(tableTitle));
|
||||
|
||||
stringBuffer.append(getTypeChangelog(type));
|
||||
|
||||
logger.info(stringBuffer.toString());
|
||||
return stringBuffer;
|
||||
}
|
||||
|
||||
public StringBuffer generateFacetSection(Type type) {
|
||||
StringBuffer stringBuffer = new StringBuffer();
|
||||
stringBuffer.append("\n");
|
||||
String name = type.getName();
|
||||
Section section = new Section();
|
||||
stringBuffer.append(section.generateSection(SectionType.HEADING_3, name));
|
||||
stringBuffer.append(type.getDescription());
|
||||
stringBuffer.append("\n");
|
||||
|
||||
String tableTitle = getTypeDeclaration(type).toString();
|
||||
Table table = getTable(type);
|
||||
stringBuffer.append(table.generateTable(tableTitle));
|
||||
|
||||
stringBuffer.append(getTypeChangelog(type));
|
||||
|
||||
logger.info(stringBuffer.toString());
|
||||
return stringBuffer;
|
||||
}
|
||||
|
||||
public StringBuffer generateISRelatedToSection(Type type) {
|
||||
StringBuffer stringBuffer = new StringBuffer();
|
||||
stringBuffer.append("\n");
|
||||
String name = type.getName();
|
||||
Section section = new Section();
|
||||
stringBuffer.append(section.generateSection(SectionType.HEADING_3, name));
|
||||
stringBuffer.append(type.getDescription());
|
||||
stringBuffer.append("\n");
|
||||
|
||||
String tableTitle = getTypeDeclaration(type).toString();
|
||||
Table table = getTable(type);
|
||||
stringBuffer.append(table.generateTable(tableTitle));
|
||||
|
||||
stringBuffer.append(getTypeChangelog(type));
|
||||
|
||||
logger.info(stringBuffer.toString());
|
||||
return stringBuffer;
|
||||
}
|
||||
|
||||
public StringBuffer generateConsistsOfSection(Type type) {
|
||||
StringBuffer stringBuffer = new StringBuffer();
|
||||
stringBuffer.append("\n");
|
||||
String name = type.getName();
|
||||
Section section = new Section();
|
||||
stringBuffer.append(section.generateSection(SectionType.HEADING_3, name));
|
||||
stringBuffer.append(type.getDescription());
|
||||
stringBuffer.append("\n");
|
||||
|
||||
String tableTitle = getTypeDeclaration(type).toString();
|
||||
Table table = getTable(type);
|
||||
stringBuffer.append(table.generateTable(tableTitle));
|
||||
|
||||
stringBuffer.append(getTypeChangelog(type));
|
||||
|
||||
logger.info(stringBuffer.toString());
|
||||
return stringBuffer;
|
||||
}
|
||||
|
||||
public void generate(List<Package> pkgs) throws Exception {
|
||||
|
||||
DocumentationSchemaAction schemaAction = new DocumentationSchemaAction(pkgs);
|
||||
Discovery.discover(schemaAction);
|
||||
|
||||
Map<String, Type> propertyElements = schemaAction.getPropertyElement();
|
||||
Set<String> propertyNames = propertyElements.keySet();
|
||||
for(String name : propertyNames) {
|
||||
Type type = propertyElements.get(name);
|
||||
generatePropertySection(type);
|
||||
}
|
||||
|
||||
/*
|
||||
Map<String, Type> relationElements = schemaAction.getRelationElements();
|
||||
Set<String> relationNames = relationElements.keySet();
|
||||
for(String name : relationNames) {
|
||||
Type type = propertyElements.get(name);
|
||||
|
||||
}
|
||||
|
||||
Map<String, Type> entityElements = schemaAction.getEntityElement();
|
||||
Set<String> entityNames = entityElements.keySet();
|
||||
for(String name : entityNames) {
|
||||
Type type = propertyElements.get(name);
|
||||
|
||||
}
|
||||
*/
|
||||
}
|
||||
}
|
@ -0,0 +1,120 @@
|
||||
package org.gcube.informationsystem.utils.documentation;
|
||||
|
||||
import java.util.HashMap;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
|
||||
import org.gcube.informationsystem.base.reference.entities.EntityElement;
|
||||
import org.gcube.informationsystem.base.reference.properties.PropertyElement;
|
||||
import org.gcube.informationsystem.base.reference.relations.RelationElement;
|
||||
import org.gcube.informationsystem.model.reference.properties.Property;
|
||||
import org.gcube.informationsystem.types.TypeMapper;
|
||||
import org.gcube.informationsystem.types.reference.Type;
|
||||
import org.gcube.informationsystem.utils.discovery.SchemaAction;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
|
||||
/**
|
||||
* @author Luca Frosini (ISTI - CNR)
|
||||
*/
|
||||
public class DocumentationSchemaAction implements SchemaAction {
|
||||
|
||||
private static final Logger logger = LoggerFactory.getLogger(DocumentationSchemaAction.class);
|
||||
|
||||
protected List<Package> packagesToInclude;
|
||||
|
||||
protected Map<String, Type> relationElements;
|
||||
protected Map<String, Type> propertyElements;
|
||||
protected Map<String, Type> entityElements;
|
||||
|
||||
public DocumentationSchemaAction() {
|
||||
this.relationElements = new HashMap<>();
|
||||
this.propertyElements = new HashMap<>();
|
||||
this.entityElements = new HashMap<>();
|
||||
}
|
||||
|
||||
public DocumentationSchemaAction(List<Package> pkgs ) {
|
||||
this();
|
||||
this.packagesToInclude = pkgs;
|
||||
}
|
||||
|
||||
public Map<String, Type> getRelationElements() {
|
||||
return relationElements;
|
||||
}
|
||||
|
||||
public Map<String, Type> getPropertyElement() {
|
||||
return propertyElements;
|
||||
}
|
||||
|
||||
public Map<String, Type> getEntityElement() {
|
||||
return entityElements;
|
||||
}
|
||||
|
||||
@Override
|
||||
public <R extends RelationElement<? extends EntityElement, ? extends EntityElement>> void manageRelationClass(
|
||||
Class<R> r) throws Exception {
|
||||
if(r.isAssignableFrom(Type.class)) {
|
||||
return;
|
||||
}
|
||||
if(packagesToInclude!=null) {
|
||||
boolean found = false;
|
||||
for(Package packageToInclude : packagesToInclude) {
|
||||
if(r.getPackage().getName().startsWith(packageToInclude.getName())) {
|
||||
found = true;
|
||||
}
|
||||
}
|
||||
if(!found) {
|
||||
return;
|
||||
}
|
||||
}
|
||||
Type type = TypeMapper.createTypeDefinition(r);
|
||||
String name = type.getName();
|
||||
logger.debug("Found {} {}", RelationElement.NAME, name);
|
||||
relationElements.put(name, type);
|
||||
}
|
||||
|
||||
@Override
|
||||
public <P extends PropertyElement> void managePropertyClass(Class<P> p) throws Exception {
|
||||
if(p.isAssignableFrom(Type.class)) {
|
||||
return;
|
||||
}
|
||||
if(packagesToInclude!=null) {
|
||||
boolean found = false;
|
||||
for(Package packageToInclude : packagesToInclude) {
|
||||
if(p.getPackage().getName().startsWith(packageToInclude.getName())) {
|
||||
found = true;
|
||||
}
|
||||
}
|
||||
if(!found) {
|
||||
return;
|
||||
}
|
||||
}
|
||||
Type type = TypeMapper.createTypeDefinition(p);
|
||||
String name = type.getName();
|
||||
logger.debug("Found {} {}", PropertyElement.NAME, name);
|
||||
propertyElements.put(name, type);
|
||||
}
|
||||
|
||||
@Override
|
||||
public <E extends EntityElement> void manageEntityClass(Class<E> e) throws Exception {
|
||||
if(e.isAssignableFrom(Type.class)) {
|
||||
return;
|
||||
}
|
||||
if(packagesToInclude!=null) {
|
||||
boolean found = false;
|
||||
for(Package packageToInclude : packagesToInclude) {
|
||||
if(e.getPackage().getName().startsWith(packageToInclude.getName())) {
|
||||
found = true;
|
||||
}
|
||||
}
|
||||
if(!found) {
|
||||
return;
|
||||
}
|
||||
}
|
||||
Type type = TypeMapper.createTypeDefinition(e);
|
||||
String name = type.getName();
|
||||
logger.debug("Found {} {}", EntityElement.NAME, name);
|
||||
entityElements.put(name,type);
|
||||
}
|
||||
|
||||
}
|
@ -0,0 +1,45 @@
|
||||
package org.gcube.informationsystem.utils.documentation.rst;
|
||||
|
||||
/**
|
||||
* @author Luca Frosini (ISTI - CNR)
|
||||
*/
|
||||
public class Section {
|
||||
|
||||
public enum SectionType {
|
||||
HEADING_1(true, "*"),
|
||||
HEADING_2(false, "="),
|
||||
HEADING_3(false, "-"),
|
||||
HEADING_4(false, "^");
|
||||
|
||||
boolean both;
|
||||
String separator;
|
||||
|
||||
private SectionType(boolean both, String separator) {
|
||||
this.both = both;
|
||||
this.separator = separator;
|
||||
}
|
||||
}
|
||||
|
||||
protected StringBuffer getSectionSeparation(String separator, int lenght) {
|
||||
StringBuffer stringBuffer = new StringBuffer();
|
||||
for(int i=0; i<lenght; i++) {
|
||||
stringBuffer.append(separator);
|
||||
}
|
||||
return stringBuffer;
|
||||
}
|
||||
|
||||
public StringBuffer generateSection(SectionType sectionType, String sectionTitle) {
|
||||
StringBuffer stringBuffer = new StringBuffer();
|
||||
int lenght = sectionTitle.length();
|
||||
if(sectionType.both) {
|
||||
stringBuffer.append(getSectionSeparation(sectionType.separator, lenght));
|
||||
stringBuffer.append("\n");
|
||||
}
|
||||
stringBuffer.append(sectionTitle);
|
||||
stringBuffer.append("\n");
|
||||
stringBuffer.append(getSectionSeparation(sectionType.separator, lenght));
|
||||
stringBuffer.append("\n\n");
|
||||
return stringBuffer;
|
||||
}
|
||||
|
||||
}
|
@ -0,0 +1,57 @@
|
||||
package org.gcube.informationsystem.utils.documentation.rst.table;
|
||||
|
||||
/**
|
||||
* @author Luca Frosini (ISTI - CNR)
|
||||
*/
|
||||
public class Cell {
|
||||
|
||||
private Row row;
|
||||
|
||||
private int size;
|
||||
private String text;
|
||||
|
||||
/**
|
||||
* Cell Position in the row
|
||||
*/
|
||||
private Integer cellPosition;
|
||||
|
||||
public Cell() {
|
||||
this.size = 0;
|
||||
this.text = "";
|
||||
this.row = null;
|
||||
this.cellPosition = null;
|
||||
}
|
||||
|
||||
public int getSize() {
|
||||
return size;
|
||||
}
|
||||
|
||||
public String getText() {
|
||||
return text;
|
||||
}
|
||||
|
||||
public void setText(String text) {
|
||||
this.text = text;
|
||||
this.size = text.length();
|
||||
if(row!=null) {
|
||||
this.row.update(this);
|
||||
}
|
||||
}
|
||||
|
||||
protected void setRow(Row row) {
|
||||
if(this.row==null) {
|
||||
this.row = row;
|
||||
}
|
||||
}
|
||||
|
||||
protected Integer getCellPosition() {
|
||||
return cellPosition;
|
||||
}
|
||||
|
||||
protected void setPosition(Integer cellPosition) {
|
||||
if(this.cellPosition==null) {
|
||||
this.cellPosition = cellPosition;
|
||||
}
|
||||
}
|
||||
|
||||
}
|
@ -0,0 +1,122 @@
|
||||
package org.gcube.informationsystem.utils.documentation.rst.table;
|
||||
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
|
||||
/**
|
||||
* @author Luca Frosini (ISTI - CNR)
|
||||
*/
|
||||
public class Row {
|
||||
|
||||
private RowType rowType;
|
||||
|
||||
private Table table;
|
||||
/**
|
||||
* Row Position in the table
|
||||
*/
|
||||
private Integer rowPosition;
|
||||
|
||||
private List<Cell> cells;
|
||||
private List<Integer> cellSizes;
|
||||
|
||||
public Row() {
|
||||
this.rowType = RowType.NORMAL;
|
||||
this.cells = new ArrayList<>();
|
||||
this.cellSizes = new ArrayList<>();
|
||||
}
|
||||
|
||||
public Row(RowType rowType) {
|
||||
this.rowType = rowType;
|
||||
this.cells = new ArrayList<>();
|
||||
this.cellSizes = new ArrayList<>();
|
||||
}
|
||||
|
||||
public void setRowType(RowType rowType) {
|
||||
this.rowType = rowType;
|
||||
}
|
||||
|
||||
public RowType getRowType() {
|
||||
return rowType;
|
||||
}
|
||||
|
||||
// public void update() {
|
||||
// for(int position=0; position<cells.size(); position++) {
|
||||
// Integer size = cells.get(position).getSize();
|
||||
// if(position>0 && cells.get(position)==cells.get(position-1)) {
|
||||
// size=null;
|
||||
// }
|
||||
// cellSizes.add(position, size);
|
||||
// }
|
||||
// }
|
||||
|
||||
public void update(Cell cell) {
|
||||
Integer size = cell.getSize();
|
||||
int cellPosition = cell.getCellPosition();
|
||||
if(cellSizes.size()-1<cellPosition) {
|
||||
cellSizes.add(cellPosition, size);
|
||||
}else {
|
||||
cellSizes.set(cellPosition, size);
|
||||
}
|
||||
if(table!=null) {
|
||||
table.updateMaxSizePerCell(this);
|
||||
}
|
||||
}
|
||||
|
||||
public void appendCell(Cell cell) {
|
||||
int position = cells.size();
|
||||
setCell(position, cell);
|
||||
}
|
||||
|
||||
protected void setCell(int position, Cell cell) {
|
||||
if(position>cells.size()) {
|
||||
throw new RuntimeException("You can't add the cell in position " + position);
|
||||
}
|
||||
cells.add(position, cell);
|
||||
if(position==0 || cell!=cells.get(position-1)) {
|
||||
cell.setRow(this);
|
||||
cell.setPosition(position);
|
||||
update(cell);
|
||||
}else {
|
||||
cellSizes.add(position, 0);
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
public List<Cell> getCells() {
|
||||
return cells;
|
||||
}
|
||||
|
||||
public Cell getCell(int position) {
|
||||
try {
|
||||
return cells.get(position);
|
||||
}catch (IndexOutOfBoundsException e) {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
public List<Integer> getCellSizes() {
|
||||
return cellSizes;
|
||||
}
|
||||
|
||||
public Integer getCellSize(int position) {
|
||||
try {
|
||||
return cellSizes.get(position);
|
||||
}catch (IndexOutOfBoundsException e) {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
protected void setTable(Table table) {
|
||||
if(this.table==null) {
|
||||
this.table = table;
|
||||
}
|
||||
}
|
||||
|
||||
protected Integer getRowPosition() {
|
||||
return rowPosition;
|
||||
}
|
||||
|
||||
protected void setRowPosition(Integer rowPosition) {
|
||||
this.rowPosition = rowPosition;
|
||||
}
|
||||
}
|
@ -0,0 +1,16 @@
|
||||
package org.gcube.informationsystem.utils.documentation.rst.table;
|
||||
|
||||
public enum RowType {
|
||||
HEADING(Table.ROW_SEPARATOR_HEADING),
|
||||
NORMAL(Table.ROW_SEPARATOR);
|
||||
|
||||
protected String rowSeparator;
|
||||
|
||||
private RowType(String rowSeparator) {
|
||||
this.rowSeparator = rowSeparator;
|
||||
}
|
||||
|
||||
public String getRowSeparator() {
|
||||
return rowSeparator;
|
||||
}
|
||||
}
|
@ -0,0 +1,119 @@
|
||||
package org.gcube.informationsystem.utils.documentation.rst.table;
|
||||
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
|
||||
/**
|
||||
* @author Luca Frosini (ISTI - CNR)
|
||||
*/
|
||||
public class Table {
|
||||
|
||||
public static final String COLUMN_SEPARATOR_IN_SEPERATOR_ROW = "+";
|
||||
public static final String COLUMN_SEPARATOR_IN_CONTENT_ROW = "|";
|
||||
public static final String ROW_SEPARATOR = "-";
|
||||
public static final String ROW_SEPARATOR_HEADING = "=";
|
||||
|
||||
private List<Row> rows;
|
||||
private List<Integer> maxSizePerCell;
|
||||
|
||||
public Table() {
|
||||
rows = new ArrayList<>();
|
||||
maxSizePerCell = new ArrayList<>();
|
||||
}
|
||||
|
||||
protected void updateMaxSizePerCell(Row row) {
|
||||
List<Integer> cellSizes = row.getCellSizes();
|
||||
for(int i=0; i<cellSizes.size(); i++) {
|
||||
Integer cellSize = cellSizes.get(i);
|
||||
cellSize = cellSize!=null ? cellSize : 0;
|
||||
cellSize += 2; // We need to consider one space before and one after to calculate total column size
|
||||
Integer maxSize = 0;
|
||||
try {
|
||||
maxSize = maxSizePerCell.get(i);
|
||||
if(cellSize>=maxSize) {
|
||||
maxSizePerCell.set(i, cellSize);
|
||||
}
|
||||
} catch (IndexOutOfBoundsException e) {
|
||||
maxSizePerCell.add(i, cellSize);
|
||||
}
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
public void appendRow(Row row) {
|
||||
rows.add(row);
|
||||
row.setRowPosition(rows.size()-1);
|
||||
row.setTable(this);
|
||||
updateMaxSizePerCell(row);
|
||||
}
|
||||
|
||||
private StringBuffer addRowSeparator(String separator) {
|
||||
StringBuffer stringBuffer = new StringBuffer();
|
||||
stringBuffer.append("\t");
|
||||
stringBuffer.append(COLUMN_SEPARATOR_IN_SEPERATOR_ROW);
|
||||
for(int i=0; i<maxSizePerCell.size(); i++) {
|
||||
for(int j=0; j<maxSizePerCell.get(i); j++) {
|
||||
stringBuffer.append(separator);
|
||||
}
|
||||
stringBuffer.append(COLUMN_SEPARATOR_IN_SEPERATOR_ROW);
|
||||
}
|
||||
stringBuffer.append("\n");
|
||||
return stringBuffer;
|
||||
}
|
||||
|
||||
private StringBuffer addRowSeparator(Row row, String separator) {
|
||||
StringBuffer stringBuffer = new StringBuffer();
|
||||
stringBuffer.append("\t");
|
||||
stringBuffer.append(COLUMN_SEPARATOR_IN_SEPERATOR_ROW);
|
||||
for(int i=0; i<maxSizePerCell.size(); i++) {
|
||||
for(int j=0; j<maxSizePerCell.get(i); j++) {
|
||||
stringBuffer.append(separator);
|
||||
}
|
||||
stringBuffer.append(COLUMN_SEPARATOR_IN_SEPERATOR_ROW);
|
||||
}
|
||||
stringBuffer.append("\n");
|
||||
return stringBuffer;
|
||||
}
|
||||
|
||||
private StringBuffer addRow(Row row) {
|
||||
StringBuffer stringBuffer = new StringBuffer();
|
||||
stringBuffer.append("\t");
|
||||
for(int i=0; i<maxSizePerCell.size(); i++) {
|
||||
Cell cell = row.getCell(i);
|
||||
int sizeTosatisfy = maxSizePerCell.get(i);
|
||||
if(i>0 && cell==row.getCell(i-1)) {
|
||||
for(int j=0; j<sizeTosatisfy+1; j++) {
|
||||
stringBuffer.append(" ");
|
||||
}
|
||||
}else {
|
||||
stringBuffer.append(COLUMN_SEPARATOR_IN_CONTENT_ROW);
|
||||
int remaining = sizeTosatisfy - cell.getSize();
|
||||
stringBuffer.append(" ");
|
||||
stringBuffer.append(cell.getText());
|
||||
for(int j=0; j<remaining-1; j++) {
|
||||
stringBuffer.append(" ");
|
||||
}
|
||||
}
|
||||
}
|
||||
stringBuffer.append(COLUMN_SEPARATOR_IN_CONTENT_ROW);
|
||||
stringBuffer.append("\n");
|
||||
return stringBuffer;
|
||||
}
|
||||
|
||||
public StringBuffer generateTable(String title) {
|
||||
StringBuffer stringBuffer = new StringBuffer();
|
||||
stringBuffer.append("\n\n");
|
||||
stringBuffer.append(".. table:: ");
|
||||
stringBuffer.append(title!=null?title:"");
|
||||
stringBuffer.append("\n\n");
|
||||
stringBuffer.append(addRowSeparator(RowType.NORMAL.getRowSeparator()));
|
||||
for(Row row : rows) {
|
||||
stringBuffer.append(addRow(row));
|
||||
stringBuffer.append(addRowSeparator(row, row.getRowType().getRowSeparator()));
|
||||
}
|
||||
stringBuffer.append("\n\n");
|
||||
return stringBuffer;
|
||||
}
|
||||
|
||||
}
|
||||
|
@ -0,0 +1,79 @@
|
||||
package org.gcube.informationsystem.utils.documentation.table;
|
||||
|
||||
import org.gcube.informationsystem.utils.documentation.rst.table.Cell;
|
||||
import org.gcube.informationsystem.utils.documentation.rst.table.Row;
|
||||
import org.gcube.informationsystem.utils.documentation.rst.table.RowType;
|
||||
import org.gcube.informationsystem.utils.documentation.rst.table.Table;
|
||||
import org.junit.Test;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
|
||||
/**
|
||||
* @author Luca Frosini (ISTI - CNR)
|
||||
*/
|
||||
public class TableTest {
|
||||
|
||||
private static final Logger logger = LoggerFactory.getLogger(TableTest.class);
|
||||
|
||||
@Test
|
||||
public void test() throws Exception {
|
||||
Table table = new Table();
|
||||
|
||||
Row row1 = new Row(RowType.HEADING);
|
||||
table.appendRow(row1);
|
||||
|
||||
Cell cell11 = new Cell();
|
||||
cell11.setText("Column 1");
|
||||
row1.appendCell(cell11);
|
||||
|
||||
Cell cell12 = new Cell();
|
||||
cell12.setText("Column 2");
|
||||
row1.appendCell(cell12);
|
||||
|
||||
Cell cell13 = new Cell();
|
||||
cell13.setText("Column 3");
|
||||
row1.appendCell(cell13);
|
||||
|
||||
Row row2 = new Row();
|
||||
table.appendRow(row2);
|
||||
|
||||
Cell cell21 = new Cell();
|
||||
cell21.setText("Row 2 Content 1");
|
||||
row2.appendCell(cell21);
|
||||
|
||||
Cell cell22 = new Cell();
|
||||
cell22.setText("Row 2 Content 2");
|
||||
row2.appendCell(cell22);
|
||||
|
||||
Cell cell23 = new Cell();
|
||||
cell23.setText("Row 2 Content 3");
|
||||
row2.appendCell(cell23);
|
||||
|
||||
|
||||
Row row3 = new Row();
|
||||
table.appendRow(row3);
|
||||
|
||||
Cell cell31 = new Cell();
|
||||
cell31.setText("Row 3 Content 31");
|
||||
row3.appendCell(cell31);
|
||||
|
||||
Cell cell32 = new Cell();
|
||||
cell32.setText("Row 3 Content 32");
|
||||
row3.appendCell(cell32);
|
||||
|
||||
Cell cell33 = new Cell();
|
||||
cell33.setText("Row 3 Content 33");
|
||||
row3.appendCell(cell33);
|
||||
|
||||
StringBuffer stringBuffer = table.generateTable("Test 1");
|
||||
logger.info(stringBuffer.toString());
|
||||
|
||||
cell11.setText("Longer Longer Column 1");
|
||||
cell33.setText("Longer Longer Row 3 Content 33");
|
||||
|
||||
stringBuffer = table.generateTable("Test 2");
|
||||
logger.info(stringBuffer.toString());
|
||||
|
||||
}
|
||||
|
||||
}
|
Loading…
Reference in New Issue