diff --git a/apps/dnet-exporter-api/src/main/java/eu/dnetlib/openaire/common/ReadOnlyRepository.java b/apps/dnet-exporter-api/src/main/java/eu/dnetlib/openaire/common/ReadOnlyRepository.java new file mode 100644 index 00000000..34a6cc49 --- /dev/null +++ b/apps/dnet-exporter-api/src/main/java/eu/dnetlib/openaire/common/ReadOnlyRepository.java @@ -0,0 +1,22 @@ +package eu.dnetlib.openaire.common; + +import java.util.Optional; + +import org.springframework.data.domain.Page; +import org.springframework.data.domain.Pageable; +import org.springframework.data.repository.NoRepositoryBean; +import org.springframework.data.repository.Repository; + +@NoRepositoryBean +public interface ReadOnlyRepository extends Repository { + + Optional findById(ID id); + + boolean existsById(ID id); + + Page findAll(Pageable pageable); + + Iterable findAll(); + + long count(); +} diff --git a/apps/dnet-exporter-api/src/main/java/eu/dnetlib/openaire/funders/ConversionUtils.java b/apps/dnet-exporter-api/src/main/java/eu/dnetlib/openaire/funders/ConversionUtils.java deleted file mode 100644 index be41be45..00000000 --- a/apps/dnet-exporter-api/src/main/java/eu/dnetlib/openaire/funders/ConversionUtils.java +++ /dev/null @@ -1,91 +0,0 @@ -package eu.dnetlib.openaire.funders; - -import java.io.StringReader; -import java.util.stream.Collectors; - -import eu.dnetlib.openaire.exporter.model.funders.ExtendedFunderDetails; -import eu.dnetlib.openaire.exporter.model.funders.FunderDetails; -import eu.dnetlib.openaire.exporter.model.funders.FundingStream; -import eu.dnetlib.openaire.funders.domain.db.FunderDbEntry; -import eu.dnetlib.openaire.funders.domain.db.FundingPathDbEntry; -import org.dom4j.Document; -import org.dom4j.DocumentException; -import org.dom4j.io.SAXReader; - -import static org.apache.commons.lang3.StringUtils.*; - -public class ConversionUtils { - - public static final String SEPARATOR = "::"; - - public static FunderDetails asFunderDetails(final FunderDbEntry fdb) { - final FunderDetails f = new FunderDetails(); - - f.setId(fdb.getId()); - f.setName(fdb.getName()); - f.setShortname(fdb.getShortname()); - f.setJurisdiction(fdb.getJurisdiction()); - f.setRegistrationDate(fdb.getRegistrationdate()); - f.setLastUpdateDate(fdb.getLastupdatedate()); - - return f; - } - - public static ExtendedFunderDetails asExtendedFunderDetails(final FunderDbEntry fdb) { - final ExtendedFunderDetails f = new ExtendedFunderDetails(asFunderDetails(fdb)); - - if (fdb.getFundingpaths() != null) { - f.setFundingStreams( - fdb.getFundingpaths().stream() - .map(ConversionUtils::asFundingStream) - .collect(Collectors.toList())); - } - - return f; - } - - private static FundingStream asFundingStream(final FundingPathDbEntry pathDbEntry) { - final FundingStream f = new FundingStream(); - - try { - final Document xml = new SAXReader().read(new StringReader(pathDbEntry.getPath())); - - for(int i=2;i>=0;i--) { - if (hasFundingLevel(i, xml)) { - f.setId(getId(i, xml)); - f.setName(getName(i, xml)); - break; - } - } - - if (isBlank(f.getId()) && isNoneBlank(xml.valueOf("//funder/id/text()"))) { - f.setId(xml.valueOf("//funder/shortname/text()")); - f.setName(xml.valueOf("//funder/name/text()")); - } - - if (isBlank(f.getId())) { - throw new IllegalStateException("invalid funding path:\n" + xml.asXML()); - } - - return f; - - } catch (DocumentException e) { - throw new IllegalStateException("unable to parse funding path:\n" + pathDbEntry.getPath()); - } - } - - private static String getName(int level, final Document d) { - return d.valueOf(String.format("//funding_level_%s/description/text()", level)); - } - - private static String getId(int level, final Document d) { - return substringAfter( - d.valueOf( - String.format("//funding_level_%s/id/text()", level) - ), SEPARATOR); - } - - private static boolean hasFundingLevel(int level, Document d) { - return isNotBlank(getId(level, d)); - } -} diff --git a/apps/dnet-exporter-api/src/main/java/eu/dnetlib/openaire/funders/FunderDao.java b/apps/dnet-exporter-api/src/main/java/eu/dnetlib/openaire/funders/FunderDao.java index 9c79afc5..5cde4c94 100644 --- a/apps/dnet-exporter-api/src/main/java/eu/dnetlib/openaire/funders/FunderDao.java +++ b/apps/dnet-exporter-api/src/main/java/eu/dnetlib/openaire/funders/FunderDao.java @@ -9,8 +9,7 @@ import org.springframework.data.domain.PageRequest; import org.springframework.stereotype.Component; import eu.dnetlib.openaire.exporter.exceptions.FundersApiException; -import eu.dnetlib.openaire.exporter.model.funders.ExtendedFunderDetails; -import eu.dnetlib.openaire.exporter.model.funders.FunderDetails; +import eu.dnetlib.openaire.funders.domain.db.FunderDbEntry; @Component @ConditionalOnProperty(value = "openaire.exporter.enable.funders", havingValue = "true") @@ -19,25 +18,23 @@ public class FunderDao { @Autowired private FunderRepository funderRepository; - public ExtendedFunderDetails getExtendedFunderDetails(final String funderId) throws FundersApiException { - return ConversionUtils - .asExtendedFunderDetails(funderRepository.findById(funderId).orElseThrow(() -> new FundersApiException("Funder not found. ID: " + funderId))); + public FunderDbEntry findFunder(final String funderId) throws FundersApiException { + return funderRepository.findById(funderId).orElseThrow(() -> new FundersApiException("Funder not found. ID: " + funderId)); } - public List listFunderDetails(final int page, final int size) throws FundersApiException { + public List listFunders(final int page, final int size) throws FundersApiException { return funderRepository.findAll(PageRequest.of(page, size)) - .getContent() - .stream() - .map(ConversionUtils::asFunderDetails) - .collect(Collectors.toList()); + .getContent() + .stream() + .collect(Collectors.toList()); } public List listFunderIds(final int page, final int size) throws FundersApiException { return funderRepository.findAll(PageRequest.of(page, size)) - .getContent() - .stream() - .map(f -> f.getId()) - .collect(Collectors.toList()); + .getContent() + .stream() + .map(FunderDbEntry::getId) + .collect(Collectors.toList()); } } diff --git a/apps/dnet-exporter-api/src/main/java/eu/dnetlib/openaire/funders/FunderRepository.java b/apps/dnet-exporter-api/src/main/java/eu/dnetlib/openaire/funders/FunderRepository.java index 39bec085..57aeebc3 100644 --- a/apps/dnet-exporter-api/src/main/java/eu/dnetlib/openaire/funders/FunderRepository.java +++ b/apps/dnet-exporter-api/src/main/java/eu/dnetlib/openaire/funders/FunderRepository.java @@ -1,10 +1,11 @@ package eu.dnetlib.openaire.funders; -import eu.dnetlib.openaire.funders.domain.db.FunderDbEntry; -import org.springframework.data.jpa.repository.JpaRepository; import org.springframework.stereotype.Repository; +import eu.dnetlib.openaire.common.ReadOnlyRepository; +import eu.dnetlib.openaire.funders.domain.db.FunderDbEntry; + @Repository -public interface FunderRepository extends JpaRepository { +public interface FunderRepository extends ReadOnlyRepository { } diff --git a/apps/dnet-exporter-api/src/main/java/eu/dnetlib/openaire/funders/FundersApiController.java b/apps/dnet-exporter-api/src/main/java/eu/dnetlib/openaire/funders/FundersApiController.java index d1533826..e1e16177 100644 --- a/apps/dnet-exporter-api/src/main/java/eu/dnetlib/openaire/funders/FundersApiController.java +++ b/apps/dnet-exporter-api/src/main/java/eu/dnetlib/openaire/funders/FundersApiController.java @@ -2,8 +2,6 @@ package eu.dnetlib.openaire.funders; import java.util.List; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; import org.springframework.web.bind.annotation.CrossOrigin; @@ -14,8 +12,7 @@ import org.springframework.web.bind.annotation.RestController; import eu.dnetlib.openaire.common.AbstractExporterController; import eu.dnetlib.openaire.exporter.exceptions.FundersApiException; -import eu.dnetlib.openaire.exporter.model.funders.ExtendedFunderDetails; -import eu.dnetlib.openaire.exporter.model.funders.FunderDetails; +import eu.dnetlib.openaire.funders.domain.db.FunderDbEntry; import io.swagger.v3.oas.annotations.Operation; import io.swagger.v3.oas.annotations.responses.ApiResponse; import io.swagger.v3.oas.annotations.responses.ApiResponses; @@ -23,57 +20,53 @@ import io.swagger.v3.oas.annotations.tags.Tag; @RestController @CrossOrigin(origins = { - "*" + "*" }) @ConditionalOnProperty(value = "openaire.exporter.enable.funders", havingValue = "true") @Tag(name = "OpenAIRE funders API", description = "the OpenAIRE funders API") public class FundersApiController extends AbstractExporterController { - private static final Log log = LogFactory.getLog(FundersApiController.class); - @Autowired private FunderDao fDao; @RequestMapping(value = "/funders", produces = { - "application/json" + "application/json" }, method = RequestMethod.GET) - @Operation(summary = "get basic information about funders", description = "basic information about funders: id, name, shortname, last update date, registration date") + @Operation(summary = "get basic information about funders", description = "basic information about funders: id, name, shortname, registration date") @ApiResponses(value = { - @ApiResponse(responseCode = "200", description = "OK"), - @ApiResponse(responseCode = "500", description = "unexpected error") + @ApiResponse(responseCode = "200", description = "OK"), + @ApiResponse(responseCode = "500", description = "unexpected error") }) - public List getFunders( - @PathVariable final int page, - @PathVariable final int size) throws FundersApiException { + public List getFunders( + @PathVariable final int page, + @PathVariable final int size) throws FundersApiException { - return fDao.listFunderDetails(page, size); + return fDao.listFunders(page, size); } @RequestMapping(value = "/funder/{id}", produces = { - "application/json" + "application/json" }, method = RequestMethod.GET) @Operation(summary = "get the funder details", description = "complete funder information") @ApiResponses(value = { - @ApiResponse(responseCode = "200", description = "OK"), - @ApiResponse(responseCode = "500", description = "unexpected error") + @ApiResponse(responseCode = "200", description = "OK"), + @ApiResponse(responseCode = "500", description = "unexpected error") }) - public ExtendedFunderDetails getFunderDetails( - @PathVariable final String id) throws FundersApiException { - - return fDao.getExtendedFunderDetails(id); + public FunderDbEntry getFunderDetails(@PathVariable final String id) throws FundersApiException { + return fDao.findFunder(id); } @RequestMapping(value = "/funder/ids", produces = { - "application/json" + "application/json" }, method = RequestMethod.GET) @Operation(summary = "get the list of funder ids", description = "get the list of funder ids") @ApiResponses(value = { - @ApiResponse(responseCode = "200", description = "OK"), - @ApiResponse(responseCode = "500", description = "unexpected error") + @ApiResponse(responseCode = "200", description = "OK"), + @ApiResponse(responseCode = "500", description = "unexpected error") }) - public List getFunderIds( - @PathVariable final int page, - @PathVariable final int size) throws FundersApiException { + public List listFunderIds( + @PathVariable final int page, + @PathVariable final int size) throws FundersApiException { return fDao.listFunderIds(page, size); } diff --git a/apps/dnet-exporter-api/src/main/java/eu/dnetlib/openaire/funders/domain/db/FunderDbEntry.java b/apps/dnet-exporter-api/src/main/java/eu/dnetlib/openaire/funders/domain/db/FunderDbEntry.java index a47c8d51..0d66ed8f 100644 --- a/apps/dnet-exporter-api/src/main/java/eu/dnetlib/openaire/funders/domain/db/FunderDbEntry.java +++ b/apps/dnet-exporter-api/src/main/java/eu/dnetlib/openaire/funders/domain/db/FunderDbEntry.java @@ -1,38 +1,43 @@ package eu.dnetlib.openaire.funders.domain.db; -import java.sql.Date; -import java.util.Set; -import javax.persistence.*; +import java.io.Serializable; +import java.time.LocalDateTime; -import eu.dnetlib.openaire.dsm.domain.db.IdentityDbEntry; +import javax.persistence.Column; +import javax.persistence.Entity; +import javax.persistence.Id; +import javax.persistence.Table; @Entity @Table(name = "funders") -public class FunderDbEntry { +public class FunderDbEntry implements Serializable { + + private static final long serialVersionUID = 1290088460508203016L; @Id + @Column(name = "id") private String id; - private String name; - private String shortname; - private String jurisdiction; - private String websiteurl; - private String policy; - private Date registrationdate; - private Date lastupdatedate; - @OneToMany( - cascade = { CascadeType.PERSIST, CascadeType.MERGE }, - fetch = FetchType.LAZY ) - @JoinTable( - name = "funder_identity", - joinColumns = @JoinColumn(name = "funder"), - inverseJoinColumns = @JoinColumn(name = "pid")) - private Set pids; + @Column(name = "legalshortname") + private String legalShortName; - @OneToMany(mappedBy = "funderid", cascade = CascadeType.ALL, fetch = FetchType.LAZY) - private Set fundingpaths; + @Column(name = "legalname") + private String legalName; - public FunderDbEntry() {} + @Column(name = "websiteurl") + private String websiteUrl; + + @Column(name = "logourl") + private String logoUrl; + + @Column(name = "country") + private String country; + + @Column(name = "registrationdate") + private LocalDateTime registrationDate; + + @Column(name = "registered") + private boolean registered; public String getId() { return id; @@ -42,75 +47,60 @@ public class FunderDbEntry { this.id = id; } - public String getName() { - return name; + public String getLegalShortName() { + return legalShortName; } - public void setName(final String name) { - this.name = name; + public void setLegalShortName(final String legalShortName) { + this.legalShortName = legalShortName; } - public String getShortname() { - return shortname; + public String getLegalName() { + return legalName; } - public void setShortname(final String shortname) { - this.shortname = shortname; + public void setLegalName(final String legalName) { + this.legalName = legalName; } - public String getJurisdiction() { - return jurisdiction; + public String getWebsiteUrl() { + return websiteUrl; } - public void setJurisdiction(final String jurisdiction) { - this.jurisdiction = jurisdiction; + public void setWebsiteUrl(final String websiteUrl) { + this.websiteUrl = websiteUrl; } - public String getWebsiteurl() { - return websiteurl; + public String getLogoUrl() { + return logoUrl; } - public void setWebsiteurl(final String websiteurl) { - this.websiteurl = websiteurl; + public void setLogoUrl(final String logoUrl) { + this.logoUrl = logoUrl; } - public String getPolicy() { - return policy; + public String getCountry() { + return country; } - public void setPolicy(final String policy) { - this.policy = policy; + public void setCountry(final String country) { + this.country = country; } - public Date getRegistrationdate() { - return registrationdate; + public LocalDateTime getRegistrationDate() { + return registrationDate; } - public void setRegistrationdate(final Date registrationdate) { - this.registrationdate = registrationdate; + public void setRegistrationDate(final LocalDateTime registrationDate) { + this.registrationDate = registrationDate; } - public Date getLastupdatedate() { - return lastupdatedate; + public boolean isRegistered() { + return registered; } - public void setLastupdatedate(final Date lastupdatedate) { - this.lastupdatedate = lastupdatedate; + public void setRegistered(final boolean registered) { + this.registered = registered; } - public Set getPids() { - return pids; - } - - public void setPids(final Set pids) { - this.pids = pids; - } - - public Set getFundingpaths() { - return fundingpaths; - } - - public void setFundingpaths(final Set fundingpaths) { - this.fundingpaths = fundingpaths; - } } diff --git a/apps/dnet-exporter-api/src/main/java/eu/dnetlib/openaire/funders/domain/db/OldFunderDbEntry.java b/apps/dnet-exporter-api/src/main/java/eu/dnetlib/openaire/funders/domain/db/OldFunderDbEntry.java new file mode 100644 index 00000000..2a79306b --- /dev/null +++ b/apps/dnet-exporter-api/src/main/java/eu/dnetlib/openaire/funders/domain/db/OldFunderDbEntry.java @@ -0,0 +1,118 @@ +package eu.dnetlib.openaire.funders.domain.db; + +import java.sql.Date; +import java.util.Set; + +import javax.persistence.CascadeType; +import javax.persistence.FetchType; +import javax.persistence.Id; +import javax.persistence.JoinColumn; +import javax.persistence.JoinTable; +import javax.persistence.OneToMany; + +import eu.dnetlib.openaire.dsm.domain.db.IdentityDbEntry; + +// @Entity +// @Table(name = "funders") +@Deprecated +public class OldFunderDbEntry { + + @Id + private String id; + private String name; + private String shortname; + private String jurisdiction; + private String websiteurl; + private String policy; + private Date registrationdate; + private Date lastupdatedate; + + @OneToMany(cascade = { CascadeType.PERSIST, CascadeType.MERGE }, fetch = FetchType.LAZY) + @JoinTable(name = "funder_identity", joinColumns = @JoinColumn(name = "funder"), inverseJoinColumns = @JoinColumn(name = "pid")) + private Set pids; + + @OneToMany(mappedBy = "funderid", cascade = CascadeType.ALL, fetch = FetchType.LAZY) + private Set fundingpaths; + + public OldFunderDbEntry() {} + + public String getId() { + return id; + } + + public void setId(final String id) { + this.id = id; + } + + public String getName() { + return name; + } + + public void setName(final String name) { + this.name = name; + } + + public String getShortname() { + return shortname; + } + + public void setShortname(final String shortname) { + this.shortname = shortname; + } + + public String getJurisdiction() { + return jurisdiction; + } + + public void setJurisdiction(final String jurisdiction) { + this.jurisdiction = jurisdiction; + } + + public String getWebsiteurl() { + return websiteurl; + } + + public void setWebsiteurl(final String websiteurl) { + this.websiteurl = websiteurl; + } + + public String getPolicy() { + return policy; + } + + public void setPolicy(final String policy) { + this.policy = policy; + } + + public Date getRegistrationdate() { + return registrationdate; + } + + public void setRegistrationdate(final Date registrationdate) { + this.registrationdate = registrationdate; + } + + public Date getLastupdatedate() { + return lastupdatedate; + } + + public void setLastupdatedate(final Date lastupdatedate) { + this.lastupdatedate = lastupdatedate; + } + + public Set getPids() { + return pids; + } + + public void setPids(final Set pids) { + this.pids = pids; + } + + public Set getFundingpaths() { + return fundingpaths; + } + + public void setFundingpaths(final Set fundingpaths) { + this.fundingpaths = fundingpaths; + } +} diff --git a/apps/dnet-exporter-api/src/main/java/eu/dnetlib/openaire/funders/domain/db/FundingPathDbEntry.java b/apps/dnet-exporter-api/src/main/java/eu/dnetlib/openaire/funders/domain/db/OldFundingPathDbEntry.java similarity index 88% rename from apps/dnet-exporter-api/src/main/java/eu/dnetlib/openaire/funders/domain/db/FundingPathDbEntry.java rename to apps/dnet-exporter-api/src/main/java/eu/dnetlib/openaire/funders/domain/db/OldFundingPathDbEntry.java index 2f7dc534..d5711b66 100644 --- a/apps/dnet-exporter-api/src/main/java/eu/dnetlib/openaire/funders/domain/db/FundingPathDbEntry.java +++ b/apps/dnet-exporter-api/src/main/java/eu/dnetlib/openaire/funders/domain/db/OldFundingPathDbEntry.java @@ -1,12 +1,15 @@ package eu.dnetlib.openaire.funders.domain.db; -import javax.persistence.*; +import javax.persistence.Column; +import javax.persistence.Id; +import javax.persistence.Transient; import com.fasterxml.jackson.annotation.JsonIgnore; -@Entity -@Table(name = "fundingpaths") -public class FundingPathDbEntry { +// @Entity +// @Table(name = "fundingpaths") +@Deprecated +public class OldFundingPathDbEntry { @JsonIgnore @Transient @@ -28,7 +31,7 @@ public class FundingPathDbEntry { private String funderid; - public FundingPathDbEntry() {} + public OldFundingPathDbEntry() {} public String getDnetresourceidentifier() { return dnetresourceidentifier; diff --git a/apps/dnet-exporter-api/src/main/resources/sql/funders-schema.sql b/apps/dnet-exporter-api/src/main/resources/sql/funders-schema.sql new file mode 100644 index 00000000..db0178bf --- /dev/null +++ b/apps/dnet-exporter-api/src/main/resources/sql/funders-schema.sql @@ -0,0 +1,17 @@ +ALTER TABLE dsm_organizations ADD COLUMN registered_funder boolean; + +CREATE VIEW funders_view AS SELECT + o.id AS id, + o.legalshortname AS legalshortname, + o.legalname AS legalname, + o.websiteurl AS websiteurl, + o.logourl AS logourl, + o.country AS country, + o.dateofcollection AS registrationdate, + o.registered_funder AS registered +FROM + dsm_organizations o + JOIN dsm_service_organization so ON (o.id = so.organization) + JOIN dsm_services s ON (so.service = s.id) + JOIN projects p ON (p.collectedfrom = s.id) +GROUP BY o.id; \ No newline at end of file diff --git a/libs/dnet-exporter-model/src/main/java/eu/dnetlib/openaire/exporter/model/funders/ExtendedFunderDetails.java b/libs/dnet-exporter-model/src/main/java/eu/dnetlib/openaire/exporter/model/funders/ExtendedFunderDetails.java index 723feafb..51e0ecff 100644 --- a/libs/dnet-exporter-model/src/main/java/eu/dnetlib/openaire/exporter/model/funders/ExtendedFunderDetails.java +++ b/libs/dnet-exporter-model/src/main/java/eu/dnetlib/openaire/exporter/model/funders/ExtendedFunderDetails.java @@ -4,6 +4,7 @@ import java.util.List; import com.fasterxml.jackson.annotation.JsonAutoDetect; +@Deprecated @JsonAutoDetect public class ExtendedFunderDetails extends FunderDetails { diff --git a/libs/dnet-exporter-model/src/main/java/eu/dnetlib/openaire/exporter/model/funders/FundingStream.java b/libs/dnet-exporter-model/src/main/java/eu/dnetlib/openaire/exporter/model/funders/FundingStream.java index 863a443b..0f234854 100644 --- a/libs/dnet-exporter-model/src/main/java/eu/dnetlib/openaire/exporter/model/funders/FundingStream.java +++ b/libs/dnet-exporter-model/src/main/java/eu/dnetlib/openaire/exporter/model/funders/FundingStream.java @@ -1,5 +1,6 @@ package eu.dnetlib.openaire.exporter.model.funders; +@Deprecated public class FundingStream { private String id;