org.dspace.app.bulkedit

Class BulkEditChange

java.lang.Object

org.dspace.app.bulkedit.BulkEditChange

public class BulkEditChange
extends Object

Utility class to store changes to item that may occur during a batch edit.

Author:

Stuart Lewis

Constructor Summary

Constructors

Constructor and Description
BulkEditChange() Initialise a change holder for a new item
BulkEditChange(Item i) Initialise a new change holder for an existing item

Method Summary

Methods

Modifier and Type	Method and Description
void	changeOwningCollection(Collection oldC, Collection newC) Register a change to the owning collection
List<BulkEditMetadataValue>	getAdds() Get the list of elements and their values that have been added.
List<BulkEditMetadataValue>	getComplete() Get the list of all values
List<BulkEditMetadataValue>	getConstant() Get the list of unchanged values
Item	getItem() Get the DSpace Item that these changes are applicable to.
List<Collection>	getNewMappedCollections() Get the list of new mapped Collections
Collection	getNewOwningCollection() Get the new owning collection
List<Collection>	getOldMappedCollections() Get the list of old mapped Collections
Collection	getOldOwningCollection() Get the old owning collection
List<BulkEditMetadataValue>	getRemoves() Get the list of elements and their values that have been removed.
boolean	hasChanges() Have any changes actually been recorded, or is this empty?
boolean	isDeleted() Does this change object represent a deleted item?
boolean	isNewItem() Does this change object represent a new item?
boolean	isReinstated() Does this change object represent a reinstated item?
boolean	isWithdrawn() Does this change object represent a withdrawn item?
void	registerAdd(BulkEditMetadataValue dcv) Add an added metadata value
void	registerConstant(BulkEditMetadataValue dcv) Add an unchanged metadata value
void	registerNewMappedCollection(Collection c) Add a new mapped Collection
void	registerOldMappedCollection(Collection c) Add an old mapped Collection
void	registerRemove(BulkEditMetadataValue dcv) Add a removed metadata value
void	setDeleted() Set that this item has been deleted
void	setItem(Item i) Store the item - used when a new item is created
void	setOwningCollection(Collection newC) Set the owning collection of an item
void	setReinstated() Set that this item has been deleted
void	setWithdrawn() Set that this item has been withdrawn

Methods inherited from class java.lang.Object

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

Constructor Detail

BulkEditChange

public BulkEditChange()

Initialise a change holder for a new item

BulkEditChange

public BulkEditChange(Item i)

Initialise a new change holder for an existing item

Parameters:

i - The Item to store

Method Detail

setItem

public void setItem(Item i)

Store the item - used when a new item is created

Parameters:

i - The item

registerAdd

public void registerAdd(BulkEditMetadataValue dcv)

Add an added metadata value

Parameters:

dcv - The value to add

registerRemove

public void registerRemove(BulkEditMetadataValue dcv)

Add a removed metadata value

Parameters:

dcv - The value to remove

registerConstant

public void registerConstant(BulkEditMetadataValue dcv)

Add an unchanged metadata value

Parameters:

dcv - The value to keep unchanged

registerNewMappedCollection

public void registerNewMappedCollection(Collection c)

Add a new mapped Collection

Parameters:

c - The new mapped Collection

registerOldMappedCollection

public void registerOldMappedCollection(Collection c)

Add an old mapped Collection

Parameters:

c - The old mapped Collection

changeOwningCollection

public void changeOwningCollection(Collection oldC,
                          Collection newC)

Register a change to the owning collection

Parameters:

oldC - The old owning collection

newC - The new owning collection

setOwningCollection

public void setOwningCollection(Collection newC)

Set the owning collection of an item

Parameters:

newC - The new owning collection

getItem

public Item getItem()

Get the DSpace Item that these changes are applicable to.

Returns:

The item

getAdds

public List<BulkEditMetadataValue> getAdds()

Get the list of elements and their values that have been added.

Returns:

the list of elements and their values that have been added.

getRemoves

public List<BulkEditMetadataValue> getRemoves()

Get the list of elements and their values that have been removed.

Returns:

the list of elements and their values that have been removed.

getConstant

public List<BulkEditMetadataValue> getConstant()

Get the list of unchanged values

Returns:

the list of unchanged values

getComplete

public List<BulkEditMetadataValue> getComplete()

Get the list of all values

Returns:

the list of all values

getNewMappedCollections

public List<Collection> getNewMappedCollections()

Get the list of new mapped Collections

Returns:

the list of new mapped collections

getOldMappedCollections

public List<Collection> getOldMappedCollections()

Get the list of old mapped Collections

Returns:

the list of old mapped collections

getOldOwningCollection

public Collection getOldOwningCollection()

Get the old owning collection

Returns:

the old owning collection

getNewOwningCollection

public Collection getNewOwningCollection()

Get the new owning collection

Returns:

the new owning collection

isNewItem

public boolean isNewItem()

Does this change object represent a new item?

Returns:

Whether or not this is for a new item

isDeleted

public boolean isDeleted()

Does this change object represent a deleted item?

Returns:

Whether or not this is for a deleted item

setDeleted

public void setDeleted()

Set that this item has been deleted

isWithdrawn

public boolean isWithdrawn()

Does this change object represent a withdrawn item?

Returns:

Whether or not this is for a withdrawn item

setWithdrawn

public void setWithdrawn()

Set that this item has been withdrawn

isReinstated

public boolean isReinstated()

Does this change object represent a reinstated item?

Returns:

Whether or not this is for a reinstated item

setReinstated

public void setReinstated()

Set that this item has been deleted

hasChanges

public boolean hasChanges()

Have any changes actually been recorded, or is this empty?

Returns:

Whether or not changes have been made