initialising the component
This commit is contained in:
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,312 @@
|
|||
# European Union Public Licence V. 1.1
|
||||
|
||||
|
||||
EUPL © the European Community 2007
|
||||
|
||||
|
||||
This European Union Public Licence (the “EUPL”) applies to the Work or Software
|
||||
(as defined below) which is provided under the terms of this Licence. Any use of
|
||||
the Work, other than as authorised under this Licence is prohibited (to the
|
||||
extent such use is covered by a right of the copyright holder of the Work).
|
||||
|
||||
The Original Work is provided under the terms of this Licence when the Licensor
|
||||
(as defined below) has placed the following notice immediately following the
|
||||
copyright notice for the Original Work:
|
||||
|
||||
Licensed under the EUPL V.1.1
|
||||
|
||||
or has expressed by any other mean his willingness to license under the EUPL.
|
||||
|
||||
|
||||
|
||||
## 1. Definitions
|
||||
|
||||
In this Licence, the following terms have the following meaning:
|
||||
|
||||
- The Licence: this Licence.
|
||||
|
||||
- The Original Work or the Software: the software distributed and/or
|
||||
communicated by the Licensor under this Licence, available as Source Code and
|
||||
also as Executable Code as the case may be.
|
||||
|
||||
- Derivative Works: the works or software that could be created by the Licensee,
|
||||
based upon the Original Work or modifications thereof. This Licence does not
|
||||
define the extent of modification or dependence on the Original Work required
|
||||
in order to classify a work as a Derivative Work; this extent is determined by
|
||||
copyright law applicable in the country mentioned in Article 15.
|
||||
|
||||
- The Work: the Original Work and/or its Derivative Works.
|
||||
|
||||
- The Source Code: the human-readable form of the Work which is the most
|
||||
convenient for people to study and modify.
|
||||
|
||||
- The Executable Code: any code which has generally been compiled and which is
|
||||
meant to be interpreted by a computer as a program.
|
||||
|
||||
- The Licensor: the natural or legal person that distributes and/or communicates
|
||||
the Work under the Licence.
|
||||
|
||||
- Contributor(s): any natural or legal person who modifies the Work under the
|
||||
Licence, or otherwise contributes to the creation of a Derivative Work.
|
||||
|
||||
- The Licensee or “You”: any natural or legal person who makes any usage of the
|
||||
Software under the terms of the Licence.
|
||||
|
||||
- Distribution and/or Communication: any act of selling, giving, lending,
|
||||
renting, distributing, communicating, transmitting, or otherwise making
|
||||
available, on-line or off-line, copies of the Work or providing access to its
|
||||
essential functionalities at the disposal of any other natural or legal
|
||||
person.
|
||||
|
||||
|
||||
|
||||
## 2. Scope of the rights granted by the Licence
|
||||
|
||||
The Licensor hereby grants You a world-wide, royalty-free, non-exclusive,
|
||||
sub-licensable licence to do the following, for the duration of copyright vested
|
||||
in the Original Work:
|
||||
|
||||
- use the Work in any circumstance and for all usage, reproduce the Work, modify
|
||||
- the Original Work, and make Derivative Works based upon the Work, communicate
|
||||
- to the public, including the right to make available or display the Work or
|
||||
- copies thereof to the public and perform publicly, as the case may be, the
|
||||
- Work, distribute the Work or copies thereof, lend and rent the Work or copies
|
||||
- thereof, sub-license rights in the Work or copies thereof.
|
||||
|
||||
Those rights can be exercised on any media, supports and formats, whether now
|
||||
known or later invented, as far as the applicable law permits so.
|
||||
|
||||
In the countries where moral rights apply, the Licensor waives his right to
|
||||
exercise his moral right to the extent allowed by law in order to make effective
|
||||
the licence of the economic rights here above listed.
|
||||
|
||||
The Licensor grants to the Licensee royalty-free, non exclusive usage rights to
|
||||
any patents held by the Licensor, to the extent necessary to make use of the
|
||||
rights granted on the Work under this Licence.
|
||||
|
||||
|
||||
|
||||
## 3. Communication of the Source Code
|
||||
|
||||
The Licensor may provide the Work either in its Source Code form, or as
|
||||
Executable Code. If the Work is provided as Executable Code, the Licensor
|
||||
provides in addition a machine-readable copy of the Source Code of the Work
|
||||
along with each copy of the Work that the Licensor distributes or indicates, in
|
||||
a notice following the copyright notice attached to the Work, a repository where
|
||||
the Source Code is easily and freely accessible for as long as the Licensor
|
||||
continues to distribute and/or communicate the Work.
|
||||
|
||||
|
||||
|
||||
## 4. Limitations on copyright
|
||||
|
||||
Nothing in this Licence is intended to deprive the Licensee of the benefits from
|
||||
any exception or limitation to the exclusive rights of the rights owners in the
|
||||
Original Work or Software, of the exhaustion of those rights or of other
|
||||
applicable limitations thereto.
|
||||
|
||||
|
||||
|
||||
## 5. Obligations of the Licensee
|
||||
|
||||
The grant of the rights mentioned above is subject to some restrictions and
|
||||
obligations imposed on the Licensee. Those obligations are the following:
|
||||
|
||||
Attribution right: the Licensee shall keep intact all copyright, patent or
|
||||
trademarks notices and all notices that refer to the Licence and to the
|
||||
disclaimer of warranties. The Licensee must include a copy of such notices and a
|
||||
copy of the Licence with every copy of the Work he/she distributes and/or
|
||||
communicates. The Licensee must cause any Derivative Work to carry prominent
|
||||
notices stating that the Work has been modified and the date of modification.
|
||||
|
||||
Copyleft clause: If the Licensee distributes and/or communicates copies of the
|
||||
Original Works or Derivative Works based upon the Original Work, this
|
||||
Distribution and/or Communication will be done under the terms of this Licence
|
||||
or of a later version of this Licence unless the Original Work is expressly
|
||||
distributed only under this version of the Licence. The Licensee (becoming
|
||||
Licensor) cannot offer or impose any additional terms or conditions on the Work
|
||||
or Derivative Work that alter or restrict the terms of the Licence.
|
||||
|
||||
Compatibility clause: If the Licensee Distributes and/or Communicates Derivative
|
||||
Works or copies thereof based upon both the Original Work and another work
|
||||
licensed under a Compatible Licence, this Distribution and/or Communication can
|
||||
be done under the terms of this Compatible Licence. For the sake of this clause,
|
||||
“Compatible Licence” refers to the licences listed in the appendix attached to
|
||||
this Licence. Should the Licensee’s obligations under the Compatible Licence
|
||||
conflict with his/her obligations under this Licence, the obligations of the
|
||||
Compatible Licence shall prevail.
|
||||
|
||||
Provision of Source Code: When distributing and/or communicating copies of the
|
||||
Work, the Licensee will provide a machine-readable copy of the Source Code or
|
||||
indicate a repository where this Source will be easily and freely available for
|
||||
as long as the Licensee continues to distribute and/or communicate the Work.
|
||||
|
||||
Legal Protection: This Licence does not grant permission to use the trade names,
|
||||
trademarks, service marks, or names of the Licensor, except as required for
|
||||
reasonable and customary use in describing the origin of the Work and
|
||||
reproducing the content of the copyright notice.
|
||||
|
||||
|
||||
|
||||
## 6. Chain of Authorship
|
||||
|
||||
The original Licensor warrants that the copyright in the Original Work granted
|
||||
hereunder is owned by him/her or licensed to him/her and that he/she has the
|
||||
power and authority to grant the Licence.
|
||||
|
||||
Each Contributor warrants that the copyright in the modifications he/she brings
|
||||
to the Work are owned by him/her or licensed to him/her and that he/she has the
|
||||
power and authority to grant the Licence.
|
||||
|
||||
Each time You accept the Licence, the original Licensor and subsequent
|
||||
Contributors grant You a licence to their contributions to the Work, under the
|
||||
terms of this Licence.
|
||||
|
||||
|
||||
|
||||
## 7. Disclaimer of Warranty
|
||||
|
||||
The Work is a work in progress, which is continuously improved by numerous
|
||||
contributors. It is not a finished work and may therefore contain defects or
|
||||
“bugs” inherent to this type of software development.
|
||||
|
||||
For the above reason, the Work is provided under the Licence on an “as is” basis
|
||||
and without warranties of any kind concerning the Work, including without
|
||||
limitation merchantability, fitness for a particular purpose, absence of defects
|
||||
or errors, accuracy, non-infringement of intellectual property rights other than
|
||||
copyright as stated in Article 6 of this Licence.
|
||||
|
||||
This disclaimer of warranty is an essential part of the Licence and a condition
|
||||
for the grant of any rights to the Work.
|
||||
|
||||
|
||||
|
||||
## 8. Disclaimer of Liability
|
||||
|
||||
Except in the cases of wilful misconduct or damages directly caused to natural
|
||||
persons, the Licensor will in no event be liable for any direct or indirect,
|
||||
material or moral, damages of any kind, arising out of the Licence or of the use
|
||||
of the Work, including without limitation, damages for loss of goodwill, work
|
||||
stoppage, computer failure or malfunction, loss of data or any commercial
|
||||
damage, even if the Licensor has been advised of the possibility of such
|
||||
damage. However, the Licensor will be liable under statutory product liability
|
||||
laws as far such laws apply to the Work.
|
||||
|
||||
|
||||
|
||||
## 9. Additional agreements
|
||||
|
||||
While distributing the Original Work or Derivative Works, You may choose to
|
||||
conclude an additional agreement to offer, and charge a fee for, acceptance of
|
||||
support, warranty, indemnity, or other liability obligations and/or services
|
||||
consistent with this Licence. However, in accepting such obligations, You may
|
||||
act only on your own behalf and on your sole responsibility, not on behalf of
|
||||
the original Licensor or any other Contributor, and only if You agree to
|
||||
indemnify, defend, and hold each Contributor harmless for any liability incurred
|
||||
by, or claims asserted against such Contributor by the fact You have accepted
|
||||
any such warranty or additional liability.
|
||||
|
||||
|
||||
|
||||
## 10. Acceptance of the Licence
|
||||
|
||||
The provisions of this Licence can be accepted by clicking on an icon “I agree”
|
||||
placed under the bottom of a window displaying the text of this Licence or by
|
||||
affirming consent in any other similar way, in accordance with the rules of
|
||||
applicable law. Clicking on that icon indicates your clear and irrevocable
|
||||
acceptance of this Licence and all of its terms and conditions.
|
||||
|
||||
Similarly, you irrevocably accept this Licence and all of its terms and
|
||||
conditions by exercising any rights granted to You by Article 2 of this Licence,
|
||||
such as the use of the Work, the creation by You of a Derivative Work or the
|
||||
Distribution and/or Communication by You of the Work or copies thereof.
|
||||
|
||||
|
||||
|
||||
## 11. Information to the public
|
||||
|
||||
In case of any Distribution and/or Communication of the Work by means of
|
||||
electronic communication by You (for example, by offering to download the Work
|
||||
from a remote location) the distribution channel or media (for example, a
|
||||
website) must at least provide to the public the information requested by the
|
||||
applicable law regarding the Licensor, the Licence and the way it may be
|
||||
accessible, concluded, stored and reproduced by the Licensee.
|
||||
|
||||
|
||||
|
||||
## 12. Termination of the Licence
|
||||
|
||||
The Licence and the rights granted hereunder will terminate automatically upon
|
||||
any breach by the Licensee of the terms of the Licence.
|
||||
|
||||
Such a termination will not terminate the licences of any person who has
|
||||
received the Work from the Licensee under the Licence, provided such persons
|
||||
remain in full compliance with the Licence.
|
||||
|
||||
|
||||
|
||||
## 13. Miscellaneous
|
||||
|
||||
Without prejudice of Article 9 above, the Licence represents the complete
|
||||
agreement between the Parties as to the Work licensed hereunder.
|
||||
|
||||
If any provision of the Licence is invalid or unenforceable under applicable
|
||||
law, this will not affect the validity or enforceability of the Licence as a
|
||||
whole. Such provision will be construed and/or reformed so as necessary to make
|
||||
it valid and enforceable.
|
||||
|
||||
The European Commission may publish other linguistic versions and/or new
|
||||
versions of this Licence, so far this is required and reasonable, without
|
||||
reducing the scope of the rights granted by the Licence. New versions of the
|
||||
Licence will be published with a unique version number.
|
||||
|
||||
All linguistic versions of this Licence, approved by the European Commission,
|
||||
have identical value. Parties can take advantage of the linguistic version of
|
||||
their choice.
|
||||
|
||||
|
||||
|
||||
## 14. Jurisdiction
|
||||
|
||||
Any litigation resulting from the interpretation of this License, arising
|
||||
between the European Commission, as a Licensor, and any Licensee, will be
|
||||
subject to the jurisdiction of the Court of Justice of the European Communities,
|
||||
as laid down in article 238 of the Treaty establishing the European Community.
|
||||
|
||||
Any litigation arising between Parties, other than the European Commission, and
|
||||
resulting from the interpretation of this License, will be subject to the
|
||||
exclusive jurisdiction of the competent court where the Licensor resides or
|
||||
conducts its primary business.
|
||||
|
||||
|
||||
|
||||
## 15. Applicable Law
|
||||
|
||||
This Licence shall be governed by the law of the European Union country where
|
||||
the Licensor resides or has his registered office.
|
||||
|
||||
This licence shall be governed by the Belgian law if:
|
||||
|
||||
- a litigation arises between the European Commission, as a Licensor, and any
|
||||
- Licensee; the Licensor, other than the European Commission, has no residence
|
||||
- or registered office inside a European Union country.
|
||||
|
||||
|
||||
|
||||
## Appendix
|
||||
|
||||
|
||||
|
||||
“Compatible Licences” according to article 5 EUPL are:
|
||||
|
||||
|
||||
- GNU General Public License (GNU GPL) v. 2
|
||||
|
||||
- Open Software License (OSL) v. 2.1, v. 3.0
|
||||
|
||||
- Common Public License v. 1.0
|
||||
|
||||
- Eclipse Public License v. 1.0
|
||||
|
||||
- Cecill v. 2.0
|
||||
|
||||
|
|
@ -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