org.dspace.orcid.model.OrcidFundingFieldMapping 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
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.orcid.model;

import static java.util.function.Function.identity;
import static java.util.stream.Collectors.toMap;
import static org.dspace.orcid.model.factory.OrcidFactoryUtils.parseConfigurations;

import java.util.Arrays;
import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;

import org.dspace.orcid.model.factory.OrcidFactoryUtils;
import org.dspace.util.SimpleMapConverter;
import org.orcid.jaxb.model.common.FundingContributorRole;

/**
 * Class that contains all the mapping between {@link Funding} and DSpace
 * metadata fields.
 *
 * @author Luca Giamminonni (luca.giamminonni at 4science.it)
 *
 */
public class OrcidFundingFieldMapping {

    /**
     * The metadata fields related to the funding contributors.
     */
    private Map contributorFields;

    /**
     * The metadata fields related to the funding external identifiers.
     */
    private Map externalIdentifierFields;

    /**
     * The metadata field related to the funding title.
     */
    private String titleField;

    /**
     * The metadata field related to the funding type.
     */
    private String typeField;

    /**
     * The funding type converter.
     */
    private SimpleMapConverter typeConverter;

    /**
     * The metadata field related to the funding amount.
     */
    private String amountField;

    /**
     * The metadata field related to the funding amount's currency.
     */
    private String amountCurrencyField;

    /**
     * The funding amount's currency converter.
     */
    private SimpleMapConverter amountCurrencyConverter;

    /**
     * The metadata field related to the funding start date.
     */
    private String startDateField;

    /**
     * The metadata field related to the funding end date.
     */
    private String endDateField;

    /**
     * The metadata field related to the funding description.
     */
    private String descriptionField;

    /**
     * The type of the relationship between the funding and the organization.
     */
    private String organizationRelationshipType;

    private Map parseContributors(String contributors) {
        Map contributorsMap = parseConfigurations(contributors);
        return contributorsMap.keySet().stream()
            .collect(toMap(identity(), field -> parseContributorRole(contributorsMap.get(field))));
    }

    private FundingContributorRole parseContributorRole(String contributorRole) {
        try {
            return FundingContributorRole.fromValue(contributorRole);
        } catch (IllegalArgumentException ex) {
            throw new IllegalArgumentException("The funding contributor role " + contributorRole +
                " is invalid, allowed values are " + getAllowedContributorRoles(), ex);
        }
    }

    private List getAllowedContributorRoles() {
        return Arrays.asList(FundingContributorRole.values()).stream()
            .map(FundingContributorRole::value)
            .collect(Collectors.toList());
    }

    public Map getExternalIdentifierFields() {
        return externalIdentifierFields;
    }

    public void setExternalIdentifierFields(String externalIdentifierFields) {
        this.externalIdentifierFields = OrcidFactoryUtils.parseConfigurations(externalIdentifierFields);
    }

    public Map getContributorFields() {
        return contributorFields;
    }

    public void setContributorFields(String contributorFields) {
        this.contributorFields = parseContributors(contributorFields);
    }

    public String getTitleField() {
        return titleField;
    }

    public void setTitleField(String titleField) {
        this.titleField = titleField;
    }

    public String getStartDateField() {
        return startDateField;
    }

    public void setStartDateField(String startDateField) {
        this.startDateField = startDateField;
    }

    public String getEndDateField() {
        return endDateField;
    }

    public void setEndDateField(String endDateField) {
        this.endDateField = endDateField;
    }

    public String getDescriptionField() {
        return descriptionField;
    }

    public void setDescriptionField(String descriptionField) {
        this.descriptionField = descriptionField;
    }

    public String getOrganizationRelationshipType() {
        return organizationRelationshipType;
    }

    public void setOrganizationRelationshipType(String organizationRelationshipType) {
        this.organizationRelationshipType = organizationRelationshipType;
    }

    public String getTypeField() {
        return typeField;
    }

    public void setTypeField(String typeField) {
        this.typeField = typeField;
    }

    public String getAmountField() {
        return amountField;
    }

    public void setAmountField(String amountField) {
        this.amountField = amountField;
    }

    public String getAmountCurrencyField() {
        return amountCurrencyField;
    }

    public void setAmountCurrencyField(String amountCurrencyField) {
        this.amountCurrencyField = amountCurrencyField;
    }

    public String convertAmountCurrency(String currency) {
        return amountCurrencyConverter != null ? amountCurrencyConverter.getValue(currency) : currency;
    }

    public void setAmountCurrencyConverter(SimpleMapConverter amountCurrencyConverter) {
        this.amountCurrencyConverter = amountCurrencyConverter;
    }

    public String convertType(String type) {
        return typeConverter != null ? typeConverter.getValue(type) : type;
    }

    public void setTypeConverter(SimpleMapConverter typeConverter) {
        this.typeConverter = typeConverter;
    }

}