Package pt.ptcris.utils

Class ORCIDWorkHelper

java.lang.Object

pt.ptcris.utils.ORCIDHelper<org.um.dsi.gavea.orcid.model.work.Work,org.um.dsi.gavea.orcid.model.work.WorkSummary,org.um.dsi.gavea.orcid.model.activities.WorkGroup,org.um.dsi.gavea.orcid.model.work.WorkType>

pt.ptcris.utils.ORCIDWorkHelper

public final class ORCIDWorkHelper
extends ORCIDHelper<org.um.dsi.gavea.orcid.model.work.Work,org.um.dsi.gavea.orcid.model.work.WorkSummary,org.um.dsi.gavea.orcid.model.activities.WorkGroup,org.um.dsi.gavea.orcid.model.work.WorkType>

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
ORCIDWorkHelper(ORCIDClient orcidClient)	Initializes the helper with a given ORCID client.

Method Summary

Modifier and Type	Method	Description
org.um.dsi.gavea.orcid.model.work.Work	cloneE(org.um.dsi.gavea.orcid.model.work.Work work)	Clones an activity.
org.um.dsi.gavea.orcid.model.work.WorkSummary	cloneS(org.um.dsi.gavea.orcid.model.work.WorkSummary summary)	Clones an activity summary.
org.um.dsi.gavea.orcid.model.work.Work	createUpdate(org.um.dsi.gavea.orcid.model.work.Work 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.work.Work work)	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.work.WorkSummary summary)	Returns the non-null external identifiers of an activity summary (null becomes empty list).
void	setExternalIdsE(org.um.dsi.gavea.orcid.model.work.Work work, 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.work.WorkSummary 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

ORCIDWorkHelper

public ORCIDWorkHelper(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.work.Work work)

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.work.Work,org.um.dsi.gavea.orcid.model.work.WorkSummary,org.um.dsi.gavea.orcid.model.activities.WorkGroup,org.um.dsi.gavea.orcid.model.work.WorkType>

Parameters:

work - 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.work.WorkSummary summary)

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.work.Work,org.um.dsi.gavea.orcid.model.work.WorkSummary,org.um.dsi.gavea.orcid.model.activities.WorkGroup,org.um.dsi.gavea.orcid.model.work.WorkType>

Parameters:

summary - 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.work.Work work,
                            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.work.Work,org.um.dsi.gavea.orcid.model.work.WorkSummary,org.um.dsi.gavea.orcid.model.activities.WorkGroup,org.um.dsi.gavea.orcid.model.work.WorkType>

Parameters:

work - 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.work.WorkSummary 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.work.Work,org.um.dsi.gavea.orcid.model.work.WorkSummary,org.um.dsi.gavea.orcid.model.activities.WorkGroup,org.um.dsi.gavea.orcid.model.work.WorkType>

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.work.Work createUpdate(org.um.dsi.gavea.orcid.model.work.Work 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.work.Work,org.um.dsi.gavea.orcid.model.work.WorkSummary,org.um.dsi.gavea.orcid.model.activities.WorkGroup,org.um.dsi.gavea.orcid.model.work.WorkType>

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.work.WorkSummary cloneS(org.um.dsi.gavea.orcid.model.work.WorkSummary 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.work.Work cloneE(org.um.dsi.gavea.orcid.model.work.Work work)

Clones an activity.

Parameters:

work - the ORCID activity to be cloned

Returns:

the cloned ORCID activity