From b3a67e716c1d772fb51e1370627bc5a38cc0f65a Mon Sep 17 00:00:00 2001 From: Roeland Date: Wed, 13 Apr 2016 13:27:00 +0200 Subject: [PATCH] elaborating javadoc' --- .../service/other/ImportMetadataSourceServiceImpl.java | 3 ++- .../service/AbstractImportMetadataSourceService.java | 9 ++++++--- .../importer/external/service/other/MetadataSource.java | 4 +++- 3 files changed, 11 insertions(+), 5 deletions(-) diff --git a/dspace-api/src/main/java/org/dspace/importer/external/pubmed/service/other/ImportMetadataSourceServiceImpl.java b/dspace-api/src/main/java/org/dspace/importer/external/pubmed/service/other/ImportMetadataSourceServiceImpl.java index 81b992d53a..4b6f52457d 100644 --- a/dspace-api/src/main/java/org/dspace/importer/external/pubmed/service/other/ImportMetadataSourceServiceImpl.java +++ b/dspace-api/src/main/java/org/dspace/importer/external/pubmed/service/other/ImportMetadataSourceServiceImpl.java @@ -16,6 +16,7 @@ import org.dspace.content.Item; import org.dspace.importer.external.MetadataSourceException; import org.dspace.importer.external.Query; import org.dspace.importer.external.datamodel.ImportRecord; +import org.dspace.importer.external.service.AbstractImportMetadataSourceService; import org.jaxen.JaxenException; import javax.ws.rs.client.Client; @@ -33,7 +34,7 @@ import java.util.concurrent.Callable; /** * Implements a data source for querying pubmed central */ -public class ImportMetadataSourceServiceImpl extends org.dspace.importer.external.service.AbstractImportMetadataSourceService { +public class ImportMetadataSourceServiceImpl extends AbstractImportMetadataSourceService { private String baseAddress; private WebTarget pubmedWebTarget; diff --git a/dspace-api/src/main/java/org/dspace/importer/external/service/AbstractImportMetadataSourceService.java b/dspace-api/src/main/java/org/dspace/importer/external/service/AbstractImportMetadataSourceService.java index 594e9bb8a9..6f4c656573 100644 --- a/dspace-api/src/main/java/org/dspace/importer/external/service/AbstractImportMetadataSourceService.java +++ b/dspace-api/src/main/java/org/dspace/importer/external/service/AbstractImportMetadataSourceService.java @@ -20,8 +20,11 @@ import org.springframework.beans.factory.annotation.Required; import java.util.LinkedList; -/** AbstractImportSourceService has a generic type set 'RecordType'. - * In the importer implementation this type set should be the class of the records received from the remote source's response +/** + * This class is a partial implementaiton of {@link Imports}. It provides assistance with mapping metadata from source format to DSpace format. + * AbstractImportSourceService has a generic type set 'RecordType'. + * In the importer implementation this type set should be the class of the records received from the remote source's response. + * * @author Roeland Dillen (roeland at atmire dot com) * */ @@ -38,7 +41,7 @@ public abstract class AbstractImportMetadataSourceService extends Me } /** - * Set the {@link GenerateQueryService} used to create a {@link org.dspace.importer.external.Query} + * Set the {@link GenerateQueryService} used to create a {@link org.dspace.importer.external.Query} for a DSpace {@link org.dspace.content.Item} * @param generateQueryForItem */ @Autowired diff --git a/dspace-api/src/main/java/org/dspace/importer/external/service/other/MetadataSource.java b/dspace-api/src/main/java/org/dspace/importer/external/service/other/MetadataSource.java index d3a5feb512..e0f6c40d21 100644 --- a/dspace-api/src/main/java/org/dspace/importer/external/service/other/MetadataSource.java +++ b/dspace-api/src/main/java/org/dspace/importer/external/service/other/MetadataSource.java @@ -21,7 +21,9 @@ import java.util.concurrent.Callable; import java.util.concurrent.locks.ReentrantLock; /** - * This class contains functionality to handle request timeouts and to retry requests. + * This class contains primitives to handle request timeouts and to retry requests. + * This is achieved by classifying exceptions as fatal or as non fatal/retryable. + * Evidently only subclasses can make the proper determination of what is retryable and what isn't. * This is useful in case the service employs throttling and to deal with general network issues. * @author: Antoine Snyers (antoine at atmire dot com) */