comments, documentation

src/main/java/pt/ptcris/utils/ExternalIdsDiff.java

@@ -71,7 +71,10 @@ public ExternalIdsDiff(ExternalIds weids1, ExternalIds weids2) {
 	 * identifiers. Only considered duplicate if external identifiers have the
 	 * same relationship and are not "part of".
 	 *
-	 * TODO: optimize
+	 * TODO: the URLs assigned to the external identifiers are being ignored;
+	 * this means that ids with different URLs are considered the same; also,
+	 * the selection of the id to "same" when there is a match is arbitrary.
+	 * TODO: optimize.
 	 *
 	 * @param eids1
 	 *            a set of UIDs

src/main/java/pt/ptcris/utils/ORCIDFundingHelper.java

@@ -230,8 +230,8 @@ protected FundingSummary group(FundingGroup group) throws IllegalArgumentExcepti
 	 * {@inheritDoc}
 	 *
 	 * The considered fields are: title, start date (year), funding type and
-	 * part-of external identifiers. All this meta-data is available in funding
-	 * summaries.
+	 * part-of external identifiers (excluding URLs). All this meta-data is
+	 * available in funding summaries.
 	 * 
 	 * TODO: contributors are not being considered as they are not contained in
 	 * the summaries.

src/main/java/pt/ptcris/utils/ORCIDHelper.java

@@ -977,6 +977,9 @@ public final Map<E, ExternalIdsDiff> getSelfExternalIdsDiffS(S summary, Collecti
 	 * Tests whether two sets of (non-exclusively self or part-of) external
 	 * identifiers are identical.
 	 * 
+	 * TODO: the URLs assigned to the external ids are not being considered in
+	 * this comparison.
+	 * 
 	 * @param eids1
 	 *            the first set of external identifiers
 	 * @param eids2
@@ -1020,6 +1023,7 @@ public final boolean hasNewSelfIDs(E preElement, S posElement) {
 	/**
 	 * Checks whether an activity is already up to date regarding another one,
 	 * considering the self {@link ExternalIdentifier external identifiers}.
+	 * This comparison disregards the URLs assigned to the identifiers.
 	 *
 	 * @param preElement
 	 *            the potentially out of date ORCID activity

src/main/java/pt/ptcris/utils/ORCIDWorkHelper.java

@@ -267,8 +267,8 @@ protected WorkSummary group(WorkGroup group) throws IllegalArgumentException {
 	 * {@inheritDoc}
 	 *
 	 * The considered fields are: title, publication date (year), work type and
-	 * part-of external identifiers. All this meta-data is available in work
-	 * summaries.
+	 * part-of external identifiers (excluding URLs). All this meta-data is
+	 * available in work summaries.
 	 * 
 	 * TODO: contributors are not being considered as they are not contained in
 	 * the summaries.