Package org.dspace.versioning

Class VersioningServiceImpl

java.lang.Object

org.dspace.versioning.VersioningServiceImpl

All Implemented Interfaces:

VersioningService

public class VersioningServiceImpl
extends Object
implements VersioningService

Author:

Fabio Bolognesi (fabio at atmire dot com), Mark Diggory (markd at atmire dot com), Ben Bosman (ben at atmire dot com), Pascal-Nicolas Becker (dspace at pascal dash becker dot de)

Field Summary

Fields

Modifier and Type	Field	Description
protected VersionDAO	versionDAO
protected WorkflowItemService	workflowItemService

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	VersioningServiceImpl()

Method Summary

Modifier and Type	Method	Description
int	countVersionsByHistoryWithItem(Context context, VersionHistory versionHistory)	This method count versions of an version history that have items assigned.
Version	createNewVersion(Context c, Item item)
Version	createNewVersion(Context c, Item item, String summary)
Version	createNewVersion(Context context, VersionHistory history, Item item, String summary, Date date, int versionNumber)
protected Version	createVersion(Context c, VersionHistory vh, Item item, String summary, Date date)
void	delete(Context c, Version version)	Delete a Version
protected int	getNextVersionNumer(Context c, VersionHistory vh)
Version	getVersion(Context c, int versionID)
Version	getVersion(Context c, Item item)
List<Version>	getVersionsByHistory(Context c, VersionHistory vh)	Returns all versions of a version history.
List<Version>	getVersionsByHistoryWithItems(Context c, VersionHistory vh, int offset, int limit)	Return a paginated list of versions of a version history.
void	removeVersion(Context c, Item item)
Version	restoreVersion(Context c, Version version)
Version	restoreVersion(Context c, Version version, String summary)
void	setProvider(DefaultItemVersionProvider provider)
void	update(Context context, Version version)	Update the Version
Version	updateVersion(Context c, Item item, String summary)

Methods inherited from class java.lang.Object

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

Field Detail

versionDAO

@Autowired(required=true)
protected VersionDAO versionDAO

workflowItemService

@Autowired(required=true)
protected WorkflowItemService workflowItemService

Constructor Detail

VersioningServiceImpl

protected VersioningServiceImpl()

Method Detail

setProvider

@Autowired(required=true)
public void setProvider(DefaultItemVersionProvider provider)

createNewVersion

public Version createNewVersion(Context c,
                                Item item)

Specified by:

createNewVersion in interface VersioningService

createNewVersion

public Version createNewVersion(Context c,
                                Item item,
                                String summary)

Specified by:

createNewVersion in interface VersioningService

delete

public void delete(Context c,
                   Version version)
            throws SQLException

Description copied from interface: VersioningService

Delete a Version

Specified by:

delete in interface VersioningService

Parameters:

c - context

version - version

Throws:

SQLException - if database error

removeVersion

public void removeVersion(Context c,
                          Item item)
                   throws SQLException

Specified by:

removeVersion in interface VersioningService

Throws:

SQLException

getVersion

public Version getVersion(Context c,
                          int versionID)
                   throws SQLException

Specified by:

getVersion in interface VersioningService

Throws:

SQLException

restoreVersion

public Version restoreVersion(Context c,
                              Version version)

Specified by:

restoreVersion in interface VersioningService

restoreVersion

public Version restoreVersion(Context c,
                              Version version,
                              String summary)

Specified by:

restoreVersion in interface VersioningService

updateVersion

public Version updateVersion(Context c,
                             Item item,
                             String summary)
                      throws SQLException

Specified by:

updateVersion in interface VersioningService

Throws:

SQLException

getVersion

public Version getVersion(Context c,
                          Item item)
                   throws SQLException

Specified by:

getVersion in interface VersioningService

Throws:

SQLException

createNewVersion

public Version createNewVersion(Context context,
                                VersionHistory history,
                                Item item,
                                String summary,
                                Date date,
                                int versionNumber)

Specified by:

createNewVersion in interface VersioningService

getVersionsByHistory

public List<Version> getVersionsByHistory(Context c,
                                          VersionHistory vh)
                                   throws SQLException

Description copied from interface: VersioningService

Returns all versions of a version history. To keep version numbers stable we do not delete versions, we do only set the item, date, summary and eperson null. This methods returns only those versions that have an item assigned.

Specified by:

getVersionsByHistory in interface VersioningService

Parameters:

c - The relevant DSpace Context.

vh - version history

Returns:

All versions of a version history that have an item assigned.

Throws:

SQLException - An exception that provides information on a database access error or other errors.

getVersionsByHistoryWithItems

public List<Version> getVersionsByHistoryWithItems(Context c,
                                                   VersionHistory vh,
                                                   int offset,
                                                   int limit)
                                            throws SQLException

Description copied from interface: VersioningService

Return a paginated list of versions of a version history. To keep version numbers stable we do not delete versions, we do only set the item, date, summary and eperson null. This methods returns only those versions that have an item assigned.

Specified by:

getVersionsByHistoryWithItems in interface VersioningService

Parameters:

c - The relevant DSpace Context.

vh - Version history

offset - The position of the first result to return

limit - Paging limit

Throws:

SQLException - If database error

createVersion

protected Version createVersion(Context c,
                                VersionHistory vh,
                                Item item,
                                String summary,
                                Date date)
                         throws SQLException

Throws:

SQLException

getNextVersionNumer

protected int getNextVersionNumer(Context c,
                                  VersionHistory vh)
                           throws SQLException

Throws:

SQLException

update

public void update(Context context,
                   Version version)
            throws SQLException

Description copied from interface: VersioningService

Update the Version

Specified by:

update in interface VersioningService

Parameters:

context - context

version - version

Throws:

SQLException - if database error

countVersionsByHistoryWithItem

public int countVersionsByHistoryWithItem(Context context,
                                          VersionHistory versionHistory)
                                   throws SQLException

Description copied from interface: VersioningService

This method count versions of an version history that have items assigned. We do not delete versions to keep version numbers stable. To remove a version we set the item, date, summary and eperson null. This method returns only versions that aren't soft deleted and have items assigned.

Specified by:

countVersionsByHistoryWithItem in interface VersioningService

Parameters:

context - The relevant DSpace Context.

versionHistory - Version history

Returns:

Total versions of an version history that have items assigned.

Throws:

SQLException - If database error