Package pt.ptcris.utils

Class ORCIDFundingHelper

java.lang.Object

pt.ptcris.utils.ORCIDHelper<org.um.dsi.gavea.orcid.model.funding.Funding,org.um.dsi.gavea.orcid.model.funding.FundingSummary,org.um.dsi.gavea.orcid.model.activities.FundingGroup,org.um.dsi.gavea.orcid.model.funding.FundingType>

pt.ptcris.utils.ORCIDFundingHelper

public final class ORCIDFundingHelper
extends ORCIDHelper<org.um.dsi.gavea.orcid.model.funding.Funding,org.um.dsi.gavea.orcid.model.funding.FundingSummary,org.um.dsi.gavea.orcid.model.activities.FundingGroup,org.um.dsi.gavea.orcid.model.funding.FundingType>

An helper to simplify the use of the low-level ORCID client. Provides support for asynchronous communication with ORCID although it is only active for GET requests due to resource limitations.

Field Summary

Fields inherited from class pt.ptcris.utils.ORCIDHelper

client, INVALID_EXTERNALIDENTIFIERS, INVALID_ORGANIZATION, INVALID_PUBLICATIONDATE, INVALID_TITLE, INVALID_TYPE, INVALID_YEAR, OVERLAPPING_EIDs

Constructor Summary

Constructors

Constructor	Description
ORCIDFundingHelper(ORCIDClient orcidClient)	Initializes the helper with a given ORCID client.

Method Summary

Modifier and Type	Method	Description
org.um.dsi.gavea.orcid.model.funding.Funding	cloneE(org.um.dsi.gavea.orcid.model.funding.Funding funding)	Clones an activity.
org.um.dsi.gavea.orcid.model.funding.FundingSummary	cloneS(org.um.dsi.gavea.orcid.model.funding.FundingSummary summary)	Clones an activity summary.
org.um.dsi.gavea.orcid.model.funding.Funding	createUpdate(org.um.dsi.gavea.orcid.model.funding.Funding original, ExternalIdsDiff diff)	Creates an update to an activity given the difference on meta-data.
org.um.dsi.gavea.orcid.model.common.ExternalIds	getNonNullExternalIdsE(org.um.dsi.gavea.orcid.model.funding.Funding funding)	Returns the non-null external identifiers of an activity (null becomes empty list).
org.um.dsi.gavea.orcid.model.common.ExternalIds	getNonNullExternalIdsS(org.um.dsi.gavea.orcid.model.funding.FundingSummary funding)	Returns the non-null external identifiers of an activity summary (null becomes empty list).
void	setExternalIdsE(org.um.dsi.gavea.orcid.model.funding.Funding funding, org.um.dsi.gavea.orcid.model.common.ExternalIds eids)	Assigns a set of external identifiers to an activity.
void	setExternalIdsS(org.um.dsi.gavea.orcid.model.funding.FundingSummary summary, org.um.dsi.gavea.orcid.model.common.ExternalIds eids)	Assigns a set of external identifiers to an activity summary.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from class pt.ptcris.utils.ORCIDHelper

add, cleanWorkLocalKey, delete, deleteAllSourced, factoryStaticFundings, factoryStaticWorks, getActivityLocalKey, getActivityLocalKey, getAllTypedSummaries, getFulls, getPartOfExternalIdsE, getSelfExternalIdsDiffS, getSelfExternalIdsE, getSourcedSummaries, getTypeE, hasNewSelfIDs, isUpToDateE, isUpToDateS, testMinimalQuality, tryMinimalQualityE, update

Constructor Detail

ORCIDFundingHelper

public ORCIDFundingHelper(ORCIDClient orcidClient)

Initializes the helper with a given ORCID client.

Parameters:

orcidClient - the ORCID client

Method Detail

getNonNullExternalIdsE

public org.um.dsi.gavea.orcid.model.common.ExternalIds getNonNullExternalIdsE(org.um.dsi.gavea.orcid.model.funding.Funding funding)

Returns the non-null external identifiers of an activity (null becomes empty list). Cannot rely on ORCIDHelper.getNonNullExternalIdsS(ElementSummary) because ORCIDHelper.summarize(ElementSummary) itself calls this method.

Specified by:

getNonNullExternalIdsE in class ORCIDHelper<org.um.dsi.gavea.orcid.model.funding.Funding,org.um.dsi.gavea.orcid.model.funding.FundingSummary,org.um.dsi.gavea.orcid.model.activities.FundingGroup,org.um.dsi.gavea.orcid.model.funding.FundingType>

Parameters:

funding - the ORCID activity from which to retrieve the external identifiers

Returns:

the non-null external identifiers

getNonNullExternalIdsS

public org.um.dsi.gavea.orcid.model.common.ExternalIds getNonNullExternalIdsS(org.um.dsi.gavea.orcid.model.funding.FundingSummary funding)

Returns the non-null external identifiers of an activity summary (null becomes empty list).

Specified by:

getNonNullExternalIdsS in class ORCIDHelper<org.um.dsi.gavea.orcid.model.funding.Funding,org.um.dsi.gavea.orcid.model.funding.FundingSummary,org.um.dsi.gavea.orcid.model.activities.FundingGroup,org.um.dsi.gavea.orcid.model.funding.FundingType>

Parameters:

funding - the ORCID activity summary from which to retrieve the external identifiers

Returns:

the non-null external identifiers

setExternalIdsE

public void setExternalIdsE(org.um.dsi.gavea.orcid.model.funding.Funding funding,
                            org.um.dsi.gavea.orcid.model.common.ExternalIds eids)

Assigns a set of external identifiers to an activity.

Specified by:

setExternalIdsE in class ORCIDHelper<org.um.dsi.gavea.orcid.model.funding.Funding,org.um.dsi.gavea.orcid.model.funding.FundingSummary,org.um.dsi.gavea.orcid.model.activities.FundingGroup,org.um.dsi.gavea.orcid.model.funding.FundingType>

Parameters:

funding - the ORCID activity to which to assign the external identifiers

eids - the external identifiers to be assigned

setExternalIdsS

public void setExternalIdsS(org.um.dsi.gavea.orcid.model.funding.FundingSummary summary,
                            org.um.dsi.gavea.orcid.model.common.ExternalIds eids)

Assigns a set of external identifiers to an activity summary.

Specified by:

setExternalIdsS in class ORCIDHelper<org.um.dsi.gavea.orcid.model.funding.Funding,org.um.dsi.gavea.orcid.model.funding.FundingSummary,org.um.dsi.gavea.orcid.model.activities.FundingGroup,org.um.dsi.gavea.orcid.model.funding.FundingType>

Parameters:

summary - the ORCID activity summary to which to assign the external identifiers

eids - the external identifiers to be assigned

createUpdate

public org.um.dsi.gavea.orcid.model.funding.Funding createUpdate(org.um.dsi.gavea.orcid.model.funding.Funding original,
                                                                 ExternalIdsDiff diff)

Creates an update to an activity given the difference on meta-data. Essentially creates an activity with the same put-code as the original activity and with the new meta-data that must be assigned to it. Currently, only new external identifiers are considered.

Specified by:

createUpdate in class ORCIDHelper<org.um.dsi.gavea.orcid.model.funding.Funding,org.um.dsi.gavea.orcid.model.funding.FundingSummary,org.um.dsi.gavea.orcid.model.activities.FundingGroup,org.um.dsi.gavea.orcid.model.funding.FundingType>

Parameters:

original - the original ORCID activity

diff - the difference on external identifiers

Returns:

the update to be applied to the ORCID activity

cloneS

public org.um.dsi.gavea.orcid.model.funding.FundingSummary cloneS(org.um.dsi.gavea.orcid.model.funding.FundingSummary summary)

Clones an activity summary.

Parameters:

summary - the ORCID activity summary to be cloned

Returns:

the cloned ORCID activity summary

cloneE

public org.um.dsi.gavea.orcid.model.funding.Funding cloneE(org.um.dsi.gavea.orcid.model.funding.Funding funding)

Clones an activity.

Parameters:

funding - the ORCID activity to be cloned

Returns:

the cloned ORCID activity