Package org.dspace.identifier

Class DOIServiceImpl

java.lang.Object

org.dspace.identifier.DOIServiceImpl

All Implemented Interfaces:

DOIService

public class DOIServiceImpl
extends Object
implements DOIService

Service implementation for the DOI object. This class is responsible for all business logic calls for the DOI object and is autowired by spring. This class should never be accessed directly.

Author:

kevinvandevelde at atmire.com

Field Summary

Fields

Modifier and Type	Field	Description
protected DOIDAO	doiDAO

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DOIServiceImpl()

Method Summary

Modifier and Type	Method	Description
DOI	create(Context context)
String	DOIFromExternalFormat(String identifier)
String	DOIToExternalForm(String identifier)	This method helps to convert a DOI into a URL.
DOI	findByDoi(Context context, String doi)
DOI	findDOIByDSpaceObject(Context context, DSpaceObject dso)
DOI	findDOIByDSpaceObject(Context context, DSpaceObject dso, List<Integer> statusToExclude)
String	formatIdentifier(String identifier)	Recognize format of DOI and return it with leading doi-Scheme.
List<DOI>	getDOIsByStatus(Context context, List<Integer> statuses)
List<DOI>	getSimilarDOIsNotInState(Context context, String doiPattern, List<Integer> statuses, boolean dsoIsNotNull)	Find all DOIs that are similar to the specified pattern ant not in the specified states.
void	update(Context context, DOI doi)

Methods inherited from class java.lang.Object

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

Field Detail

doiDAO

@Autowired(required=true)
protected DOIDAO doiDAO

Constructor Detail

DOIServiceImpl

protected DOIServiceImpl()

Method Detail

update

public void update(Context context,
                   DOI doi)
            throws SQLException

Specified by:

update in interface DOIService

Throws:

SQLException

create

public DOI create(Context context)
           throws SQLException

Specified by:

create in interface DOIService

Throws:

SQLException

findByDoi

public DOI findByDoi(Context context,
                     String doi)
              throws SQLException

Specified by:

findByDoi in interface DOIService

Throws:

SQLException

findDOIByDSpaceObject

public DOI findDOIByDSpaceObject(Context context,
                                 DSpaceObject dso)
                          throws SQLException

Specified by:

findDOIByDSpaceObject in interface DOIService

Throws:

SQLException

findDOIByDSpaceObject

public DOI findDOIByDSpaceObject(Context context,
                                 DSpaceObject dso,
                                 List<Integer> statusToExclude)
                          throws SQLException

Specified by:

findDOIByDSpaceObject in interface DOIService

Throws:

SQLException

DOIToExternalForm

public String DOIToExternalForm(String identifier)
                         throws IdentifierException

Description copied from interface: DOIService

This method helps to convert a DOI into a URL. It takes DOIs in one of the following formats and returns it as URL (f.e. http://dx.doi.org/10.123/456). Allowed formats are:

• doi:10.123/456
• 10.123/456
• http://dx.doi.org/10.123/456

Specified by:

DOIToExternalForm in interface DOIService

Parameters:

identifier - A DOI that should be returned in external form.

Returns:

A String containing a URL to the official DOI resolver.

Throws:

IdentifierException - If identifier could not be recognized as valid DOI.

DOIFromExternalFormat

public String DOIFromExternalFormat(String identifier)
                             throws DOIIdentifierException

Specified by:

DOIFromExternalFormat in interface DOIService

Throws:

DOIIdentifierException

formatIdentifier

public String formatIdentifier(String identifier)
                        throws DOIIdentifierException

Description copied from interface: DOIService

Recognize format of DOI and return it with leading doi-Scheme.

Specified by:

formatIdentifier in interface DOIService

Parameters:

identifier - Identifier to format, following format are accepted: f.e. 10.123/456, doi:10.123/456, http://dx.doi.org/10.123/456.

Returns:

Given Identifier with DOI-Scheme, f.e. doi:10.123/456.

Throws:

DOIIdentifierException - If DOI could not be recognized.

getDOIsByStatus

public List<DOI> getDOIsByStatus(Context context,
                                 List<Integer> statuses)
                          throws SQLException

Specified by:

getDOIsByStatus in interface DOIService

Throws:

SQLException

getSimilarDOIsNotInState

public List<DOI> getSimilarDOIsNotInState(Context context,
                                          String doiPattern,
                                          List<Integer> statuses,
                                          boolean dsoIsNotNull)
                                   throws SQLException

Description copied from interface: DOIService

Find all DOIs that are similar to the specified pattern ant not in the specified states.

Specified by:

getSimilarDOIsNotInState in interface DOIService

Parameters:

context - DSpace context

doiPattern - The pattern, e.g. "10.5072/123.%"

statuses - The statuses the DOI should not be in, @{link DOIIdentifierProvider.DELETED}.

dsoIsNotNull - Boolean whether all DOIs should be excluded where the DSpaceObject is NULL.

Returns:

null or a list of DOIs

Throws:

SQLException - if database error