Package org.dspace.identifier.doi

Class DOIOrganiser

java.lang.Object

org.dspace.identifier.doi.DOIOrganiser

public class DOIOrganiser
extends Object

Author:

Marsa Haoua, Pascal-Nicolas Becker

Field Summary

Fields

Modifier and Type	Field	Description
protected ConfigurationService	configurationService
protected DOIService	doiService
protected Filter	filter
protected HandleService	handleService
protected ItemService	itemService

Constructor Summary

Constructors

Constructor	Description
DOIOrganiser(Context context, DOIIdentifierProvider provider)	Constructor to be called within the main() method

Method Summary

Modifier and Type	Method	Description
void	delete(String identifier)	Delete a DOI
void	list(String processName, PrintStream out, PrintStream err, Integer... status)	list DOIs queued for reservation or registration
static void	main(String[] args)	Main command-line runner method as with other DSpace launcher commands
void	register(DOI doiRow)	Register DOI with the provider
void	register(DOI doiRow, Filter filter)	Register DOI with the provider
void	reserve(DOI doiRow)	Reserve DOI with the provider,
void	reserve(DOI doiRow, Filter filter)	Reserve DOI with the provider
DOI	resolveToDOI(String identifier)	Finds the TableRow in the Doi table that belongs to the specified DspaceObject.
static void	runCLI(Context context, DOIOrganiser organiser, String[] args)
void	update(DOI doiRow)	Update metadata for a DOI

Methods inherited from class java.lang.Object

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

Field Detail

handleService

protected HandleService handleService

itemService

protected ItemService itemService

doiService

protected DOIService doiService

configurationService

protected ConfigurationService configurationService

filter

protected Filter filter

Constructor Detail

DOIOrganiser

public DOIOrganiser(Context context,
                    DOIIdentifierProvider provider)

Constructor to be called within the main() method

Parameters:

context - - DSpace context

provider - - DOI identifier provider to use

Method Detail

main

public static void main(String[] args)

Main command-line runner method as with other DSpace launcher commands

Parameters:

args - - the command line arguments to parse as parameters

runCLI

public static void runCLI(Context context,
                          DOIOrganiser organiser,
                          String[] args)

list

public void list(String processName,
                 PrintStream out,
                 PrintStream err,
                 Integer... status)

list DOIs queued for reservation or registration

Parameters:

processName - - process name for display

out - - output stream (eg. STDOUT)

err - - error output stream (eg. STDERR)

status - - status codes

register

public void register(DOI doiRow,
                     Filter filter)
              throws SQLException,
                     DOIIdentifierException

Register DOI with the provider

Parameters:

doiRow - - doi to register

filter - - logical item filter to override

Throws:

SQLException

DOIIdentifierException

register

public void register(DOI doiRow)
              throws SQLException,
                     DOIIdentifierException

Register DOI with the provider

Parameters:

doiRow - - doi to register

Throws:

SQLException

DOIIdentifierException

reserve

public void reserve(DOI doiRow)

Reserve DOI with the provider,

Parameters:

doiRow - - doi to reserve

Throws:

SQLException

DOIIdentifierException

reserve

public void reserve(DOI doiRow,
                    Filter filter)

Reserve DOI with the provider

Parameters:

doiRow - - doi to reserve

Throws:

SQLException

DOIIdentifierException

update

public void update(DOI doiRow)

Update metadata for a DOI

Parameters:

doiRow - - DOI to update

delete

public void delete(String identifier)
            throws SQLException

Delete a DOI

Parameters:

identifier - - DOI to delete

Throws:

SQLException

resolveToDOI

public DOI resolveToDOI(String identifier)
                 throws SQLException,
                        IllegalArgumentException,
                        IllegalStateException,
                        IdentifierException

Finds the TableRow in the Doi table that belongs to the specified DspaceObject.

Parameters:

identifier - Either an ItemID, a DOI or a handle. If the identifier contains digits only we treat it as ItemID, if not we try to find a matching doi or a handle (in this order).

Returns:

The TableRow or null if the Object does not have a DOI.

Throws:

SQLException - if database error

IllegalArgumentException - If the identifier is null, an empty String or specifies an DSpaceObject that is not an item. We currently support DOIs for items only, but this may change once...

IllegalStateException - If the identifier was a valid DOI that is not stored in our database or if it is a handle that is not bound to an DSpaceObject.

IdentifierException - if identifier error