org.dspace.content

Class Item

java.lang.Object

org.dspace.content.DSpaceObject

org.dspace.content.Item

public class Item
extends DSpaceObject

Class representing an item in DSpace.

This class holds in memory the item Dublin Core metadata, the bundles in the item, and the bitstreams in those bundles. When modifying the item, if you modify the Dublin Core or the "in archive" flag, you must call update for the changes to be written to the database. Creating, adding or removing bundles or bitstreams has immediate effect in the database.

Version:

$Revision$

Author:

Robert Tansley, Martin Hald

Field Summary

Fields

Modifier and Type	Field and Description
static String	ANY Wild card for Dublin Core metadata qualifiers/languages

Fields inherited from class org.dspace.content.DSpaceObject

allMetadataFields, metadataCache, modifiedMetadata, ourContext

Method Summary

Methods

Modifier and Type	Method and Description
void	addBundle(Bundle b) Add an existing bundle to this item.
void	adjustBundleBitstreamPolicies(Collection c)
void	adjustItemPolicies(Collection c)
boolean	canEdit() return TRUE if context's user can edit item, false otherwise
Bundle	createBundle(String name) Create a bundle in this item, with immediate effect
Bitstream	createSingleBitstream(InputStream is) Convenience method, calls createSingleBitstream() with name "ORIGINAL"
Bitstream	createSingleBitstream(InputStream is, String name) Create a single bitstream in a new bundle.
void	decache() Remove item and all its sub-structure from the context cache.
boolean	equals(Object obj) Return true if other is the same Item as this object, false otherwise
static Item	find(Context context, int id) Get an item from the database.
static ItemIterator	findAll(Context context) Get all the items in the archive.
static ItemIterator	findAllUnfiltered(Context context) Get all "final" items in the archive, both archived ("in archive" flag) or withdrawn items are included.
static ItemIterator	findByAuthorityValue(Context context, String schema, String element, String qualifier, String value) Find all the items in the archive with a given authority key value in the indicated metadata field.
static ItemIterator	findByMetadataField(Context context, String schema, String element, String qualifier, String value) Returns an iterator of Items possessing the passed metadata field, or only those matching the passed value, if value is not Item.ANY
static ItemIterator	findByMetadataFieldAuthority(Context context, String mdString, String authority)
static ItemIterator	findBySubmitter(Context context, EPerson eperson) Find all the items in the archive by a given submitter.
static ItemIterator	findBySubmitterDateSorted(Context context, EPerson eperson, Integer limit) Retrieve the list of Items submitted by eperson, ordered by recently submitted, optionally limitable
DSpaceObject	getAdminObject(int action) Return the dspace object where an ADMIN action right is sufficient to grant the initial authorize check.
protected void	getAuthoritiesAndConfidences(String fieldKey, String[] values, String[] authorities, int[] confidences, int i)
Bundle[]	getBundles() Get the bundles in this item.
Bundle[]	getBundles(String name) Get the bundles matching a bundle name (name corresponds roughly to type)
Collection[]	getCollections() Get the collections this item is in.
Collection[]	getCollectionsNotLinked() Get the collections this item is not in.
Community[]	getCommunities() Get the communities this item is in.
String	getHandle() Get the Handle of the object.
int	getID() Get the internal ID of this item.
Date	getLastModified() Get the date the item was last modified, or the current date if last_modified is null
String	getName() Get a proper name for the object.
Bitstream[]	getNonInternalBitstreams() Get all non-internal bitstreams in the item.
Collection	getOwningCollection() Get the owning Collection for the item
DSpaceObject	getParentObject() Return the dspace object that "own" the current object in the hierarchy.
EPerson	getSubmitter() Get the e-person that originally submitted this item
int	getType() return type found in Constants
int	hashCode()
boolean	hasUploadedFiles() Check the bundle ORIGINAL to see if there are any uploaded files
void	inheritCollectionDefaultPolicies(Collection c) remove all policies on an item and its contents, and replace them with the DEFAULT_ITEM_READ and DEFAULT_BITSTREAM_READ policies belonging to the collection.
boolean	isArchived() Find out if the item is part of the main archive
boolean	isDiscoverable() Find out if the item is discoverable
boolean	isIn(Collection collection) See whether this Item is contained by a given Collection.
boolean	isOwningCollection(Collection c) Return true if this Collection 'owns' this item
boolean	isWithdrawn() Find out if the item has been withdrawn
void	move(Collection from, Collection to) Moves the item from one collection to another one
void	move(Collection from, Collection to, boolean inheritDefaultPolicies) Moves the item from one collection to another one
void	reinstate() Reinstate a withdrawn item
void	removeBundle(Bundle b) Remove a bundle.
void	removeDSpaceLicense() Remove just the DSpace license from an item This is useful to update the current DSpace license, in case the user must accept the DSpace license again (either the item was rejected, or resumed after saving)
void	removeGroupPolicies(Group g) remove all of the policies for item's bitstreams and bundles that belong to a given Group
void	removeLicenses() Remove all licenses from an item - it was rejected
void	replaceAllBitstreamPolicies(List<ResourcePolicy> newpolicies) remove all of the policies for item's bitstreams and bundles and replace them with a new list of policies
void	replaceAllItemPolicies(List<ResourcePolicy> newpolicies) remove all of the policies for item and replace them with a new list of policies
void	setArchived(boolean isArchived) Set the "is_archived" flag.
void	setDiscoverable(boolean discoverable) Set the "discoverable" flag.
void	setOwningCollection(Collection c) Set the owning Collection for the item
void	setSubmitter(EPerson sub) Set the e-person that originally submitted this item.
void	update() Update the item "in archive" flag and Dublin Core metadata in the database
void	updateLastModified() Method that updates the last modified date of the item
void	withdraw() Withdraw the item from the archive.

Methods inherited from class org.dspace.content.DSpaceObject

addDC, addDC, addDetails, addMetadata, addMetadata, addMetadata, addMetadata, clearDC, clearDetails, clearMetadata, find, getDC, getDetails, getElements, getElementsFilled, getIdentifiers, getMDValueByField, getMDValueByLegacyField, getMetadata, getMetadata, getMetadata, getMetadata, getMetadata, getMetadataByMetadataString, getMetadataField, getMetadataFirstValue, getTypeText, removeMetadataFromDatabase, replaceMetadataValue, resetIdentifiersCache, setMetadataSingleValue, updateMetadata

Methods inherited from class java.lang.Object

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

Field Detail

ANY

public static final String ANY

Wild card for Dublin Core metadata qualifiers/languages

See Also:

Constant Field Values

Method Detail

find

public static Item find(Context context,
        int id)
                 throws SQLException

Get an item from the database. The item, its Dublin Core metadata, and the bundle and bitstream metadata are all loaded into memory.

Parameters:

context - DSpace context object

id - Internal ID of the item

Returns:

the item, or null if the internal ID is invalid.

Throws:

SQLException

findAll

public static ItemIterator findAll(Context context)
                            throws SQLException

Get all the items in the archive. Only items with the "in archive" flag set are included. The order of the list is indeterminate.

Parameters:

context - DSpace context object

Returns:

an iterator over the items in the archive.

Throws:

SQLException

findAllUnfiltered

public static ItemIterator findAllUnfiltered(Context context)
                                      throws SQLException

Get all "final" items in the archive, both archived ("in archive" flag) or withdrawn items are included. The order of the list is indeterminate.

Parameters:

context - DSpace context object

Returns:

an iterator over the items in the archive.

Throws:

SQLException

findBySubmitter

public static ItemIterator findBySubmitter(Context context,
                           EPerson eperson)
                                    throws SQLException

Find all the items in the archive by a given submitter. The order is indeterminate. Only items with the "in archive" flag set are included.

Parameters:

context - DSpace context object

eperson - the submitter

Returns:

an iterator over the items submitted by eperson

Throws:

SQLException

findByMetadataFieldAuthority

public static ItemIterator findByMetadataFieldAuthority(Context context,
                                        String mdString,
                                        String authority)
                                                 throws SQLException,
                                                        AuthorizeException,
                                                        IOException

Throws:

SQLException

AuthorizeException

IOException

findBySubmitterDateSorted

public static ItemIterator findBySubmitterDateSorted(Context context,
                                     EPerson eperson,
                                     Integer limit)
                                              throws SQLException

Retrieve the list of Items submitted by eperson, ordered by recently submitted, optionally limitable

Parameters:

context -

eperson -

limit - a positive integer to limit, -1 or null for unlimited

Returns:

Throws:

SQLException

getID

public int getID()

Get the internal ID of this item. In general, this shouldn't be exposed to users

Specified by:

getID in class DSpaceObject

Returns:

the internal identifier

getHandle

public String getHandle()

Description copied from class: DSpaceObject

Get the Handle of the object. This may return null

Specified by:

getHandle in class DSpaceObject

Returns:

Handle of the object, or null if it doesn't have one

See Also:

DSpaceObject.getHandle()

isArchived

public boolean isArchived()

Find out if the item is part of the main archive

Returns:

true if the item is in the main archive

isWithdrawn

public boolean isWithdrawn()

Find out if the item has been withdrawn

Returns:

true if the item has been withdrawn

isDiscoverable

public boolean isDiscoverable()

Find out if the item is discoverable

Returns:

true if the item is discoverable

getLastModified

public Date getLastModified()

Get the date the item was last modified, or the current date if last_modified is null

Returns:

the date the item was last modified, or the current date if the column is null.

updateLastModified

public void updateLastModified()

Method that updates the last modified date of the item

Specified by:

updateLastModified in class DSpaceObject

setArchived

public void setArchived(boolean isArchived)

Set the "is_archived" flag. This is public and only WorkflowItem.archive() should set this.

Parameters:

isArchived - new value for the flag

setDiscoverable

public void setDiscoverable(boolean discoverable)

Set the "discoverable" flag. This is public and only

Parameters:

discoverable - new value for the flag

setOwningCollection

public void setOwningCollection(Collection c)

Set the owning Collection for the item

Parameters:

c - Collection

getOwningCollection

public Collection getOwningCollection()
                               throws SQLException

Get the owning Collection for the item

Returns:

Collection that is the owner of the item

Throws:

SQLException

getSubmitter

public EPerson getSubmitter()
                     throws SQLException

Get the e-person that originally submitted this item

Returns:

the submitter

Throws:

SQLException

setSubmitter

public void setSubmitter(EPerson sub)

Set the e-person that originally submitted this item. This is a public method since it is handled by the WorkspaceItem class in the ingest package. update must be called to write the change to the database.

Parameters:

sub - the submitter

isIn

public boolean isIn(Collection collection)
             throws SQLException

See whether this Item is contained by a given Collection.

Parameters:

collection -

Returns:

true if collection contains this Item.

Throws:

SQLException

getCollections

public Collection[] getCollections()
                            throws SQLException

Get the collections this item is in. The order is indeterminate.

Returns:

the collections this item is in, if any.

Throws:

SQLException

getCommunities

public Community[] getCommunities()
                           throws SQLException

Get the communities this item is in. Returns an unordered array of the communities that house the collections this item is in, including parent communities of the owning collections.

Returns:

the communities this item is in.

Throws:

SQLException

getBundles

public Bundle[] getBundles()
                    throws SQLException

Get the bundles in this item.

Returns:

the bundles in an unordered array

Throws:

SQLException

getBundles

public Bundle[] getBundles(String name)
                    throws SQLException

Get the bundles matching a bundle name (name corresponds roughly to type)

Parameters:

name - name of bundle (ORIGINAL/TEXT/THUMBNAIL)

Returns:

the bundles in an unordered array

Throws:

SQLException

createBundle

public Bundle createBundle(String name)
                    throws SQLException,
                           AuthorizeException

Create a bundle in this item, with immediate effect

Parameters:

name - bundle name (ORIGINAL/TEXT/THUMBNAIL)

Returns:

the newly created bundle

Throws:

SQLException

AuthorizeException

addBundle

public void addBundle(Bundle b)
               throws SQLException,
                      AuthorizeException

Add an existing bundle to this item. This has immediate effect.

Parameters:

b - the bundle to add

Throws:

SQLException

AuthorizeException

removeBundle

public void removeBundle(Bundle b)
                  throws SQLException,
                         AuthorizeException,
                         IOException

Remove a bundle. This may result in the bundle being deleted, if the bundle is orphaned.

Parameters:

b - the bundle to remove

Throws:

SQLException

AuthorizeException

IOException

createSingleBitstream

public Bitstream createSingleBitstream(InputStream is,
                              String name)
                                throws AuthorizeException,
                                       IOException,
                                       SQLException

Create a single bitstream in a new bundle. Provided as a convenience method for the most common use.

Parameters:

is - the stream to create the new bitstream from

name - is the name of the bundle (ORIGINAL, TEXT, THUMBNAIL)

Returns:

Bitstream that is created

Throws:

AuthorizeException

IOException

SQLException

createSingleBitstream

public Bitstream createSingleBitstream(InputStream is)
                                throws AuthorizeException,
                                       IOException,
                                       SQLException

Convenience method, calls createSingleBitstream() with name "ORIGINAL"

Parameters:

is - InputStream

Returns:

created bitstream

Throws:

AuthorizeException

IOException

SQLException

getNonInternalBitstreams

public Bitstream[] getNonInternalBitstreams()
                                     throws SQLException

Get all non-internal bitstreams in the item. This is mainly used for auditing for provenance messages and adding format.* DC values. The order is indeterminate.

Returns:

non-internal bitstreams.

Throws:

SQLException

removeDSpaceLicense

public void removeDSpaceLicense()
                         throws SQLException,
                                AuthorizeException,
                                IOException

Remove just the DSpace license from an item This is useful to update the current DSpace license, in case the user must accept the DSpace license again (either the item was rejected, or resumed after saving)

This method is used by the org.dspace.submit.step.LicenseStep class

Throws:

SQLException

AuthorizeException

IOException

removeLicenses

public void removeLicenses()
                    throws SQLException,
                           AuthorizeException,
                           IOException

Remove all licenses from an item - it was rejected

Throws:

SQLException

AuthorizeException

IOException

update

public void update()
            throws SQLException,
                   AuthorizeException

Update the item "in archive" flag and Dublin Core metadata in the database

Specified by:

update in class DSpaceObject

Throws:

SQLException

AuthorizeException

withdraw

public void withdraw()
              throws SQLException,
                     AuthorizeException,
                     IOException

Withdraw the item from the archive. It is kept in place, and the content and metadata are not deleted, but it is not publicly accessible.

Throws:

SQLException

AuthorizeException

IOException

reinstate

public void reinstate()
               throws SQLException,
                      AuthorizeException,
                      IOException

Reinstate a withdrawn item

Throws:

SQLException

AuthorizeException

IOException

decache

public void decache()
             throws SQLException

Remove item and all its sub-structure from the context cache. Useful in batch processes where a single context has a long, multi-item lifespan

Throws:

SQLException

equals

public boolean equals(Object obj)

Return true if other is the same Item as this object, false otherwise

Overrides:

equals in class Object

Parameters:

obj - object to compare to

Returns:

true if object passed in represents the same item as this object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isOwningCollection

public boolean isOwningCollection(Collection c)

Return true if this Collection 'owns' this item

Parameters:

c - Collection

Returns:

true if this Collection owns this item

getType

public int getType()

return type found in Constants

Specified by:

getType in class DSpaceObject

Returns:

int Constants.ITEM

replaceAllItemPolicies

public void replaceAllItemPolicies(List<ResourcePolicy> newpolicies)
                            throws SQLException,
                                   AuthorizeException

remove all of the policies for item and replace them with a new list of policies

Parameters:

newpolicies - - this will be all of the new policies for the item and its contents

Throws:

SQLException

AuthorizeException

replaceAllBitstreamPolicies

public void replaceAllBitstreamPolicies(List<ResourcePolicy> newpolicies)
                                 throws SQLException,
                                        AuthorizeException

remove all of the policies for item's bitstreams and bundles and replace them with a new list of policies

Parameters:

newpolicies - - this will be all of the new policies for the bundle and bitstream contents

Throws:

SQLException

AuthorizeException

removeGroupPolicies

public void removeGroupPolicies(Group g)
                         throws SQLException

remove all of the policies for item's bitstreams and bundles that belong to a given Group

Parameters:

g - Group referenced by policies that needs to be removed

Throws:

SQLException

inheritCollectionDefaultPolicies

public void inheritCollectionDefaultPolicies(Collection c)
                                      throws SQLException,
                                             AuthorizeException

remove all policies on an item and its contents, and replace them with the DEFAULT_ITEM_READ and DEFAULT_BITSTREAM_READ policies belonging to the collection.

Parameters:

c - Collection

Throws:

SQLException - if an SQL error or if no default policies found. It's a bit draconian, but default policies must be enforced.

AuthorizeException

adjustBundleBitstreamPolicies

public void adjustBundleBitstreamPolicies(Collection c)
                                   throws SQLException,
                                          AuthorizeException

Throws:

SQLException

AuthorizeException

adjustItemPolicies

public void adjustItemPolicies(Collection c)
                        throws SQLException,
                               AuthorizeException

Throws:

SQLException

AuthorizeException

move

public void move(Collection from,
        Collection to)
          throws SQLException,
                 AuthorizeException,
                 IOException

Moves the item from one collection to another one

Throws:

SQLException

AuthorizeException

IOException

move

public void move(Collection from,
        Collection to,
        boolean inheritDefaultPolicies)
          throws SQLException,
                 AuthorizeException,
                 IOException

Moves the item from one collection to another one

Throws:

SQLException

AuthorizeException

IOException

hasUploadedFiles

public boolean hasUploadedFiles()
                         throws SQLException

Check the bundle ORIGINAL to see if there are any uploaded files

Returns:

true if there is a bundle named ORIGINAL with one or more bitstreams inside

Throws:

SQLException

getCollectionsNotLinked

public Collection[] getCollectionsNotLinked()
                                     throws SQLException

Get the collections this item is not in.

Returns:

the collections this item is not in, if any.

Throws:

SQLException

canEdit

public boolean canEdit()
                throws SQLException

return TRUE if context's user can edit item, false otherwise

Returns:

boolean true = current user can edit item

Throws:

SQLException

getName

public String getName()

Description copied from class: DSpaceObject

Get a proper name for the object. This may return null. Name should be suitable for display in a user interface.

Specified by:

getName in class DSpaceObject

Returns:

Name for the object, or null if it doesn't have one

findByMetadataField

public static ItemIterator findByMetadataField(Context context,
                               String schema,
                               String element,
                               String qualifier,
                               String value)
                                        throws SQLException,
                                               AuthorizeException,
                                               IOException

Returns an iterator of Items possessing the passed metadata field, or only those matching the passed value, if value is not Item.ANY

Parameters:

context - DSpace context object

schema - metadata field schema

element - metadata field element

qualifier - metadata field qualifier

value - field value or Item.ANY to match any value

Returns:

an iterator over the items matching that authority value

Throws:

SQLException, - AuthorizeException, IOException

SQLException

AuthorizeException

IOException

getAdminObject

public DSpaceObject getAdminObject(int action)
                            throws SQLException

Description copied from class: DSpaceObject

Return the dspace object where an ADMIN action right is sufficient to grant the initial authorize check.

Default behaviour is ADMIN right on the object grant right on all other action on the object itself. Subclass should override this method as needed.

Overrides:

getAdminObject in class DSpaceObject

Parameters:

action - ID of action being attempted, from org.dspace.core.Constants. The ADMIN action is not a valid parameter for this method, an IllegalArgumentException should be thrown

Returns:

the dspace object, if any, where an ADMIN action is sufficient to grant the original action

Throws:

SQLException

getParentObject

public DSpaceObject getParentObject()
                             throws SQLException

Description copied from class: DSpaceObject

Return the dspace object that "own" the current object in the hierarchy. Note that this method has a meaning slightly different from the getAdminObject because it is independent of the action but it is in a way related to it. It defines the "first" dspace object OTHER then the current one, where allowed ADMIN actions imply allowed ADMIN actions on the object self.

Overrides:

getParentObject in class DSpaceObject

Returns:

the dspace object that "own" the current object in the hierarchy

Throws:

SQLException

findByAuthorityValue

public static ItemIterator findByAuthorityValue(Context context,
                                String schema,
                                String element,
                                String qualifier,
                                String value)
                                         throws SQLException,
                                                AuthorizeException,
                                                IOException

Find all the items in the archive with a given authority key value in the indicated metadata field.

Parameters:

context - DSpace context object

schema - metadata field schema

element - metadata field element

qualifier - metadata field qualifier

value - the value of authority key to look for

Returns:

an iterator over the items matching that authority value

Throws:

SQLException, - AuthorizeException, IOException

SQLException

AuthorizeException

IOException

getAuthoritiesAndConfidences

protected void getAuthoritiesAndConfidences(String fieldKey,
                                String[] values,
                                String[] authorities,
                                int[] confidences,
                                int i)

Overrides:

getAuthoritiesAndConfidences in class DSpaceObject