org.dspace.rdf.conversion.SimpleDSORelationsConverterPlugin Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of dspace-api Show documentation
Show all versions of dspace-api Show documentation
DSpace core data model and service APIs.
The newest version!
/**
* The contents of this file are subject to the license and copyright
* detailed in the LICENSE and NOTICE files at the root of the source
* tree and available online at
*
* http://www.dspace.org/license/
*/
package org.dspace.rdf.conversion;
import java.io.IOException;
import java.io.InputStream;
import java.io.UnsupportedEncodingException;
import java.sql.SQLException;
import java.util.Iterator;
import java.util.List;
import org.apache.commons.lang3.StringUtils;
import org.apache.jena.rdf.model.Model;
import org.apache.jena.rdf.model.ModelFactory;
import org.apache.jena.util.FileManager;
import org.apache.jena.util.FileUtils;
import org.apache.logging.log4j.Logger;
import org.dspace.app.util.Util;
import org.dspace.content.Bitstream;
import org.dspace.content.Bundle;
import org.dspace.content.Collection;
import org.dspace.content.Community;
import org.dspace.content.DSpaceObject;
import org.dspace.content.Item;
import org.dspace.content.Site;
import org.dspace.content.service.BitstreamService;
import org.dspace.content.service.CommunityService;
import org.dspace.content.service.ItemService;
import org.dspace.content.service.SiteService;
import org.dspace.core.Constants;
import org.dspace.core.Context;
import org.dspace.rdf.RDFUtil;
import org.dspace.services.ConfigurationService;
import org.springframework.beans.factory.annotation.Autowired;
/**
* @author Pascal-Nicolas Becker (dspace -at- pascal -hyphen- becker -dot- de)
*/
public class SimpleDSORelationsConverterPlugin
implements ConverterPlugin {
public static final String SIMPLE_RELATIONS_PREFIXES_KEY = "rdf.simplerelations.prefixes";
public static final String SIMPLE_RELATIONS_SITE2COMMUNITY_KEY = "rdf.simplerelations.site2community";
public static final String SIMPLE_RELATIONS_COMMUNITY2SITE_KEY = "rdf.simplerelations.community2site";
public static final String SIMPLE_RELATIONS_COMMUNITY2SUBCOMMUNITY_KEY = "rdf.simplerelations" +
".community2subcommunity";
public static final String SIMPLE_RELATIONS_SUBCOMMUNITY2COMMUNITY_KEY = "rdf.simplerelations" +
".subcommunity2community";
public static final String SIMPLE_RELATIONS_COMMUNITY2COLLECTION_KEY = "rdf.simplerelations.community2collection";
public static final String SIMPLE_RELATIONS_COLLECTION2COMMUNITY_KEY = "rdf.simplerelations.collection2community";
public static final String SIMPLE_RELATIONS_COLLECTION2ITEM_KEY = "rdf.simplerelations.collection2item";
public static final String SIMPLE_RELATIONS_ITEM2COLLECTION_KEY = "rdf.simplerelations.item2collection";
public static final String SIMPLE_RELATIONS_ITEM2BITSTREAM_KEY = "rdf.simplerelations.item2bitstream";
private static final Logger log =
org.apache.logging.log4j.LogManager.getLogger(SimpleDSORelationsConverterPlugin.class);
@Autowired(required = true)
protected BitstreamService bitstreamService;
@Autowired(required = true)
protected ItemService itemService;
@Autowired(required = true)
protected CommunityService communityService;
@Autowired(required = true)
protected SiteService siteService;
@Autowired(required = true)
protected ConfigurationService configurationService;
/**
* Loads the prefixes that should be used by the
* SimpleDSORelationsConverterPlugin. Please remember to close the model
* returned by this method.
*
* @return A model containing the content of the file used to configure the
* RDF-Prefixes that should be used by this plugin.
*/
protected Model getPrefixes() {
Model m = ModelFactory.createDefaultModel();
String prefixesPath = configurationService
.getProperty(SIMPLE_RELATIONS_PREFIXES_KEY);
if (!StringUtils.isEmpty(prefixesPath)) {
InputStream is = FileManager.get().open(prefixesPath);
if (is == null) {
log.warn("Cannot find file '" + prefixesPath + "', ignoring...");
} else {
m.read(is, null, FileUtils.guessLang(prefixesPath));
try {
is.close();
} catch (IOException ex) {
// nothing to do here.
}
}
} else {
log.warn("Configuration does not contain path to prefixes file for "
+ "SimpleDSORelationsConverterPlugin. Will proceed without "
+ "prefixes.");
}
return m;
}
@Override
public void setConfigurationService(ConfigurationService configurationService) {
this.configurationService = configurationService;
}
@Override
public Model convert(Context context, DSpaceObject dso)
throws SQLException {
switch (dso.getType()) {
case (Constants.SITE):
return convertSite(context, (Site) dso);
case (Constants.COMMUNITY):
return convertCommunity(context, (Community) dso);
case (Constants.COLLECTION):
return convertCollection(context, (Collection) dso);
case (Constants.ITEM):
return convertItem(context, (Item) dso);
default:
return null;
}
}
public Model convertSite(Context context, Site site)
throws SQLException {
String[] site2community = configurationService.getArrayProperty(SIMPLE_RELATIONS_SITE2COMMUNITY_KEY);
if (site2community == null || site2community.length == 0) {
log.info("Either there was a problem loading the configuration or "
+ "linking from the repository (SITE) to the top level "
+ "communities is disabled. Won't link from the repostitory "
+ "(SITE) to the top level communities.");
return null;
}
Model m = ModelFactory.createDefaultModel();
Model prefixes = this.getPrefixes();
m.setNsPrefixes(prefixes);
prefixes.close();
String myId = RDFUtil.generateIdentifier(context, site);
if (myId == null) {
return null;
}
List topLevelCommies = communityService.findAllTop(context);
for (Community community : topLevelCommies) {
if (!RDFUtil.isPublicBoolean(context, community)) {
continue;
}
String id = RDFUtil.generateIdentifier(context, community);
if (id == null) {
continue;
}
for (String link : site2community) {
m.add(m.createResource(myId),
m.createProperty(link),
m.createResource(id));
}
}
if (m.isEmpty()) {
log.info("There were no public sub communities we could link to.");
m.close();
return null;
}
return m;
}
public Model convertCommunity(Context context, Community community)
throws SQLException {
String[] community2site = configurationService.getArrayProperty(SIMPLE_RELATIONS_COMMUNITY2SITE_KEY);
if (community2site == null || community2site.length == 0) {
log.info("Either there was a problem loading the configuration or "
+ "linking from the top level communities to the repository "
+ "(SITE) is disabled. Won't link from the top level "
+ "communities to the repository (SITE).");
// don't return here, as we might have to add other links.
// ensure community2site is not null
community2site = new String[] {};
}
String[] community2subcommunity = configurationService
.getArrayProperty(SIMPLE_RELATIONS_COMMUNITY2SUBCOMMUNITY_KEY);
if (community2subcommunity == null || community2subcommunity.length == 0) {
log.info("Either there was a problem loading the configuration or "
+ "linking from communities to subcommunities was disabled. "
+ "Won't link from communities to subcommunities.");
// don't return here, as we might have to add other links.
// ensure community2subcommunity is not null
community2subcommunity = new String[] {};
}
String[] subcommunity2community = configurationService
.getArrayProperty(SIMPLE_RELATIONS_SUBCOMMUNITY2COMMUNITY_KEY);
if (subcommunity2community == null || subcommunity2community.length == 0) {
log.info("Either there was a problem loading the configuration or "
+ "linking from subcommunities to communities was disabled. "
+ "Won't link from subcommunities to communities.");
// don't return here, as we might have to add other links.
// ensure subcommunity2community is not null
subcommunity2community = new String[] {};
}
String[] community2collection = configurationService
.getArrayProperty(SIMPLE_RELATIONS_COMMUNITY2COLLECTION_KEY);
if (community2collection == null || community2collection.length == 0) {
log.info("Either there was a problem loading the configuration or "
+ "linking from communities to collections was disabled. "
+ "Won't link from collections to subcommunities.");
// don't return here, as we might have to add other links.
// ensure community2collection is not null
community2collection = new String[] {};
}
if (community2site.length == 0 && community2subcommunity.length == 0
&& subcommunity2community.length == 0 && community2collection.length == 0) {
return null;
}
Model m = ModelFactory.createDefaultModel();
Model prefixes = this.getPrefixes();
m.setNsPrefixes(prefixes);
prefixes.close();
String myId = RDFUtil.generateIdentifier(context, community);
if (myId == null) {
return null;
}
// add all parents
List communityParentList = communityService.getAllParents(context, community);
DSpaceObject[] parents = communityParentList.toArray(new DSpaceObject[communityParentList.size()]);
// check whether this is a top level community
if (parents.length == 0) {
parents = new DSpaceObject[] {siteService.findSite(context)};
}
for (DSpaceObject parent : parents) {
if (!RDFUtil.isPublicBoolean(context, parent)) {
continue;
}
String id = RDFUtil.generateIdentifier(context, parent);
if (id != null) {
if (parent instanceof Site) {
for (String link : community2site) {
m.add(m.createResource(myId),
m.createProperty(link),
m.createResource(id));
}
} else if (parent instanceof Community) {
for (String link : subcommunity2community) {
m.add(m.createResource(myId),
m.createProperty(link),
m.createResource(id));
}
}
}
}
// add all subcommunities
for (Community sub : community.getSubcommunities()) {
if (!RDFUtil.isPublicBoolean(context, sub)) {
continue;
}
String id = RDFUtil.generateIdentifier(context, sub);
if (id == null) {
continue;
}
for (String link : community2subcommunity) {
m.add(m.createResource(myId),
m.createProperty(link),
m.createResource(id));
}
}
// add all collections.
for (Collection col : communityService.getAllCollections(context, community)) {
if (!RDFUtil.isPublicBoolean(context, col)) {
continue;
}
String id = RDFUtil.generateIdentifier(context, col);
if (id == null) {
continue;
}
for (String link : community2collection) {
m.add(m.createResource(myId),
m.createProperty(link),
m.createResource(id));
}
}
if (m.isEmpty()) {
m.close();
return null;
}
return m;
}
public Model convertCollection(Context context, Collection collection)
throws SQLException {
String[] collection2community = configurationService
.getArrayProperty(SIMPLE_RELATIONS_COLLECTION2COMMUNITY_KEY);
if (collection2community == null || collection2community.length == 0) {
log.info("Either there was a problem loading the configuration or "
+ "linking from collections to communities was disabled. "
+ "Won't link from collections to communities.");
// don't return here, as we might have to link to items.
// ensure collection2community is not null
collection2community = new String[] {};
}
String[] collection2item = configurationService.getArrayProperty(SIMPLE_RELATIONS_COLLECTION2ITEM_KEY);
if (collection2item == null || collection2item.length == 0) {
log.info("Either there was a problem loading the configuration or "
+ "linking from collections to items was disabled. "
+ "Won't link from collections to items.");
// don't return here, as we might have to link to communities.
// ensure collection2item is not null
collection2item = new String[] {};
}
if (collection2community.length == 0 && collection2item.length == 0) {
return null;
}
Model m = ModelFactory.createDefaultModel();
Model prefixes = this.getPrefixes();
m.setNsPrefixes(prefixes);
prefixes.close();
String myId = RDFUtil.generateIdentifier(context, collection);
if (myId == null) {
return null;
}
// add all parents
for (DSpaceObject parent : communityService.getAllParents(context, collection)) {
if (!RDFUtil.isPublicBoolean(context, parent)) {
continue;
}
String id = RDFUtil.generateIdentifier(context, parent);
if (id != null) {
for (String link : collection2community) {
m.add(m.createResource(myId),
m.createProperty(link),
m.createResource(id));
}
}
}
// add all items
Iterator- items = itemService.findAllByCollection(context, collection);
while (items.hasNext()) {
String id = RDFUtil.generateIdentifier(context, items.next());
if (id != null) {
for (String link : collection2item) {
m.add(m.createResource(myId),
m.createProperty(link),
m.createResource(id));
}
}
}
if (m.isEmpty()) {
m.close();
return null;
}
return m;
}
public Model convertItem(Context context, Item item)
throws SQLException {
String[] item2collection = configurationService.getArrayProperty(SIMPLE_RELATIONS_ITEM2COLLECTION_KEY);
if (item2collection == null || item2collection.length == 0) {
log.info("Either there was a problem loading the configuration or "
+ "linking from items to collections was disabled. "
+ "Won't link from items to collections.");
// don't return here, as we might have to link to bitstreams.
// ensure item2collection is not null
item2collection = new String[] {};
}
String[] item2bitstream = configurationService.getArrayProperty(SIMPLE_RELATIONS_ITEM2BITSTREAM_KEY);
if (item2bitstream == null || item2bitstream.length == 0) {
log.info("Either there was a problem loading the configuration or "
+ "linking from items to bitstreams was disabled. "
+ "Won't link from items to bitstreams.");
// don't return here, as we might have to link to collections.
// ensure item2bitstream is not null
item2bitstream = new String[] {};
}
if (item2collection.length == 0 && item2bitstream.length == 0) {
return null;
}
Model m = ModelFactory.createDefaultModel();
Model prefixes = this.getPrefixes();
m.setNsPrefixes(prefixes);
prefixes.close();
String myId = RDFUtil.generateIdentifier(context, item);
if (myId == null) {
return null;
}
// add all parents
for (DSpaceObject parent : item.getCollections()) {
if (!RDFUtil.isPublicBoolean(context, parent)) {
continue;
}
String id = RDFUtil.generateIdentifier(context, parent);
if (id != null) {
for (String link : item2collection) {
m.add(m.createResource(myId),
m.createProperty(link),
m.createResource(id));
}
}
}
// add all items
for (Bundle bundle : item.getBundles()) {
// currently link only the original files
// TODO: Discuss if LICENSEs, THUMBNAILs and/or extracted TEXTs
// should be linked/exported as well (and if sutch a feature should
// be configurable).
if (bundle.getName().equals("ORIGINAL")) {
for (Bitstream bs : bundle.getBitstreams()) {
if (RDFUtil.isPublicBoolean(context, bs)) {
String url = bitstreamURI(context, bs);
if (url != null) {
for (String link : item2bitstream) {
m.add(m.createResource(myId),
m.createProperty(link),
m.createResource(url));
}
}
}
}
}
}
if (m.isEmpty()) {
m.close();
return null;
}
return m;
}
/**
* This methods generates a link to the provided Bitstream.
* As bitstreams currently don't get Persistent Identifier in DSpace, we have
* to link them using a link to the repository.
*
* @param context The relevant DSpace Context.
* @param bitstream Bitstream for which a URL should be generated.
* @return The link to the URL or null if the Bitstream is a Community or
* Collection logo.
* @throws SQLException if database error
*/
public String bitstreamURI(Context context, Bitstream bitstream)
throws SQLException {
DSpaceObject parent = bitstreamService.getParentObject(context, bitstream);
if (!(parent instanceof Item)) {
// Bitstream is a community or collection logo.
// we currently ignore those
return null;
}
String dspaceURL = configurationService.getProperty("dspace.ui.url");
String link = "";
try {
// the link to the bitstream in the UI
link = dspaceURL + "/bitstream/" + parent.getHandle() + "/"
+ bitstream.getSequenceID() + "/"
+ Util.encodeBitstreamName(bitstream.getName(), Constants.DEFAULT_ENCODING);
} catch (UnsupportedEncodingException ex) {
throw new RuntimeException("DSpace's default encoding is not supported.", ex);
}
return link;
}
@Override
public boolean supports(int type) {
switch (type) {
case (Constants.COLLECTION):
return true;
case (Constants.COMMUNITY):
return true;
case (Constants.ITEM):
return true;
case (Constants.SITE):
return true;
default:
return false;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy