File | Date | Author | Commit |
---|---|---|---|
META-INF | 2014-12-10 | miguelnunes | [8a63d3] Adapted also to rcaap artefact extractor |
bundle | 2015-01-06 | miguelnunes | [b1dcb0] Developed cli. Now modulated to cli and bundle |
cli | 2015-01-06 | miguelnunes | [b1dcb0] Developed cli. Now modulated to cli and bundle |
src | 2015-01-06 | miguelnunes | [b1dcb0] Developed cli. Now modulated to cli and bundle |
.gitignore | 2014-11-19 | miguelnunes | [b4dd7f] First commit |
Readme.md | 2015-01-06 | miguelnunes | [a655ac] Updated Readme |
ontology-preview.png | 2014-12-10 | miguelnunes | [8a63d3] Adapted also to rcaap artefact extractor |
pom.xml | 2015-01-06 | miguelnunes | [b1dcb0] Developed cli. Now modulated to cli and bundle |
Read Me
Rcaap general Converter
Dspace AIP Converter converts the JSON output from both Dspace AIP Extractor and Rcaap Artefact Extractor and converts it to OWL, required for further integration into the Context Model. This OWL file contains Individuals and Data and Object Properties asserted through the usage of the TIMBUS DIO - Domain Independent Ontology and the Artefact DSO.
How to get the code
git clone https://opensourceprojects.eu/git/p/timbus/context-model/converters/json-xml/rcaap-general-artefact-converter
Install Requirements
Format UUID
This version of Rcaap general artefact Converter (which is currently able to convert output from both Rcaap artefact extractor and Dspace AIP extractor) accepts the format ea6f170e-5d74-40ae-bb02-53b07d84b9ac
Building the code
This converter is split into two different modules:
1. Bundle - To be used in the Context Population Framework
2. Cli - To be used through command-line
Apache Maven is used to manage dependencies and build the project, and all that's needed to successfully build the project is running the following command in the base directory:
1 | mvn clean package |
This command will freshly create a target subdirectory in both cli and bundle directories and place the output jar files there.
Running the cli modules
A simple example on running this module with a previous Perl Modules extraction is running the following command in the cli base directory:
1 | java -jar rcaap-general-artefact-converter-cli-1.0-SNAPSHOT.jar --json exampleextraction.json -f RDF |
This command requests a conversion from the exampleextraction.json file and will create a file within the current directory with the output directory. Further options are:
- -d,--directory - Output directory
- -f,--format (RDF|OWL) - Output format
- -h,--help - Shows help (no arguments)
- --json - Input JSON file(s)
- -n
- --dont-save - Does not save output to file (no arguments)
Note: A typical extraction within the Context Population Framework will encapsulate the result with the following header:
1 2 3 4 5 6 7 8 | { "format": { "multiple": false, "id": "ea6f170e-5d74-40ae-bb02-53b07d84b9ac" }, "UUID": "923fdec6-2ebf-11e4-bc19-ce2b29c0122c", "result": { ... ... ... |
The converter expects solely the result JSON Object. Any other format or header will result in an error.
Expected output
This module converts from JSON to OWL, more specifically to DIO and the Artefact DSO.
The Dspace AIP extractor, besides performing a backup in AIP format and returning its path, it also outputs the paths of all files which are likely to contain customizations, i.e, changes to the original Dspace installation.
As for the Rcaap Artefact Extractor, analogous to the Dspace AIP module, it returns a set of files that are susceptible to be result of an extension on the RCAAP Portal files.
The converter represents these files as Artefact individuals and links them to a Data Property contaning their path, "hasSourceLocation".
Author
Miguel Gama Nunes miguel.nunes@caixamagica.pt
License
Copyright (c) 2014, Caixa Magica Software Lda (CMS).
The work has been developed in the TIMBUS Project and the above-mentioned are Members of the TIMBUS Consortium.
TIMBUS is supported by the European Union under the 7th Framework Programme for research and technological development and demonstration activities (FP7/2007-2013) under grant agreement no. 269940.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at: http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTIBITLY, or FITNESS FOR A PARTICULAR PURPOSE. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law or agreed to in writing, shall any Contributor be liable for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work.
See the License for the specific language governing permissions and limitation under the License.