org.dspace.content

Class Bundle

java.lang.Object

org.dspace.content.DSpaceObject

org.dspace.content.Bundle

public class Bundle
extends DSpaceObject

Class representing bundles of bitstreams stored in the DSpace system

The corresponding Bitstream objects are loaded into memory. At present, there is no metadata associated with bundles - they are simple containers. Thus, the update method doesn't do much yet. Creating, adding or removing bitstreams has instant effect in the database.

Version:

$Revision$

Author:

Robert Tansley

Method Summary

Methods

Modifier and Type	Method and Description
void	addBitstream(Bitstream b) Add an existing bitstream to this bundle
Bitstream	createBitstream(java.io.InputStream is) Create a new bitstream in this bundle.
static Bundle	find(Context context, int id) Get a bundle from the database.
DSpaceObject	getAdminObject(int action) Return the dspace object where an ADMIN action right is sufficient to grant the initial authorize check.
Bitstream	getBitstreamByName(java.lang.String name)
java.util.List<ResourcePolicy>	getBitstreamPolicies()
Bitstream[]	getBitstreams() Get the bitstreams in this bundle
java.util.List<ResourcePolicy>	getBundlePolicies()
java.lang.String	getHandle() Get the Handle of the object.
int	getID() Get the internal identifier of this bundle
Item[]	getItems() Get the items this bundle appears in
java.lang.String	getName() Get the name of the bundle
DSpaceObject	getParentObject() Return the dspace object that "own" the current object in the hierarchy.
int	getPrimaryBitstreamID() Get the primary bitstream ID of the bundle
int	getType() return type found in Constants
void	inheritCollectionDefaultPolicies(Collection c) remove all policies on the bundle and its contents, and replace them with the DEFAULT_BITSTREAM_READ policies belonging to the collection.
Bitstream	registerBitstream(int assetstore, java.lang.String bitstreamPath) Create a new bitstream in this bundle.
void	removeBitstream(Bitstream b) Remove a bitstream from this bundle - the bitstream is only deleted if this was the last reference to it
void	replaceAllBitstreamPolicies(java.util.List<ResourcePolicy> newpolicies) remove all of the policies for the bundle and bitstream contents and replace them with a new list of policies
void	setName(java.lang.String name) Set the name of the bundle
void	setOrder(int[] bitstreamIds) Changes bitstream order according to the array
void	setPrimaryBitstreamID(int bitstreamID) Set the primary bitstream ID of the bundle
void	unsetPrimaryBitstreamID() Unset the primary bitstream ID of the bundle
void	update() Update the bundle metadata
void	updateLastModified()

Methods inherited from class org.dspace.content.DSpaceObject

addDetails, clearDetails, find, getDetails, getTypeText

Methods inherited from class java.lang.Object

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

Method Detail

find

public static Bundle find(Context context,
          int id)
                   throws java.sql.SQLException

Get a bundle from the database. The bundle and bitstream metadata are all loaded into memory.

Parameters:

context - DSpace context object

id - ID of the bundle

Returns:

the bundle, or null if the ID is invalid.

Throws:

java.sql.SQLException

getID

public int getID()

Get the internal identifier of this bundle

Specified by:

getID in class DSpaceObject

Returns:

the internal identifier

getName

public java.lang.String getName()

Get the name of the bundle

Specified by:

getName in class DSpaceObject

Returns:

name of the bundle (ORIGINAL, TEXT, THUMBNAIL) or NULL if not set

setName

public void setName(java.lang.String name)

Set the name of the bundle

Parameters:

name - string name of the bundle (ORIGINAL, TEXT, THUMBNAIL) are the values currently used

getPrimaryBitstreamID

public int getPrimaryBitstreamID()

Get the primary bitstream ID of the bundle

Returns:

primary bitstream ID or -1 if not set

setPrimaryBitstreamID

public void setPrimaryBitstreamID(int bitstreamID)

Set the primary bitstream ID of the bundle

Parameters:

bitstreamID - int ID of primary bitstream (e.g. index html file)

unsetPrimaryBitstreamID

public void unsetPrimaryBitstreamID()

Unset the primary bitstream ID of the bundle

getHandle

public java.lang.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

getBitstreamByName

public Bitstream getBitstreamByName(java.lang.String name)

Parameters:

name - name of the bitstream you're looking for

Returns:

the bitstream or null if not found

getBitstreams

public Bitstream[] getBitstreams()

Get the bitstreams in this bundle

Returns:

the bitstreams

getItems

public Item[] getItems()
                throws java.sql.SQLException

Get the items this bundle appears in

Returns:

array of Item s this bundle appears in

Throws:

java.sql.SQLException

createBitstream

public Bitstream createBitstream(java.io.InputStream is)
                          throws AuthorizeException,
                                 java.io.IOException,
                                 java.sql.SQLException

Create a new bitstream in this bundle.

Parameters:

is - the stream to read the new bitstream from

Returns:

the newly created bitstream

Throws:

AuthorizeException

java.io.IOException

java.sql.SQLException

registerBitstream

public Bitstream registerBitstream(int assetstore,
                          java.lang.String bitstreamPath)
                            throws AuthorizeException,
                                   java.io.IOException,
                                   java.sql.SQLException

Create a new bitstream in this bundle. This method is for registering bitstreams.

Parameters:

assetstore - corresponds to an assetstore in dspace.cfg

bitstreamPath - the path and filename relative to the assetstore

Returns:

the newly created bitstream

Throws:

java.io.IOException

java.sql.SQLException

AuthorizeException

addBitstream

public void addBitstream(Bitstream b)
                  throws java.sql.SQLException,
                         AuthorizeException

Add an existing bitstream to this bundle

Parameters:

b - the bitstream to add

Throws:

java.sql.SQLException

AuthorizeException

setOrder

public void setOrder(int[] bitstreamIds)
              throws AuthorizeException,
                     java.sql.SQLException

Changes bitstream order according to the array

Parameters:

bitstreamIds - the identifiers in the order they are to be set

Throws:

java.sql.SQLException - when an SQL error has occurred (querying DSpace)

AuthorizeException - If the user can't make the changes

removeBitstream

public void removeBitstream(Bitstream b)
                     throws AuthorizeException,
                            java.sql.SQLException,
                            java.io.IOException

Remove a bitstream from this bundle - the bitstream is only deleted if this was the last reference to it

If the bitstream in question is the primary bitstream recorded for the bundle the primary bitstream field is unset in order to free the bitstream from the foreign key constraint so that the cleanup process can run normally.

Parameters:

b - the bitstream to remove

Throws:

AuthorizeException

java.sql.SQLException

java.io.IOException

update

public void update()
            throws java.sql.SQLException,
                   AuthorizeException

Update the bundle metadata

Specified by:

update in class DSpaceObject

Throws:

java.sql.SQLException

AuthorizeException

getType

public int getType()

return type found in Constants

Specified by:

getType in class DSpaceObject

Returns:

type of the object

inheritCollectionDefaultPolicies

public void inheritCollectionDefaultPolicies(Collection c)
                                      throws java.sql.SQLException,
                                             AuthorizeException

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

Parameters:

c - Collection

Throws:

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

AuthorizeException

replaceAllBitstreamPolicies

public void replaceAllBitstreamPolicies(java.util.List<ResourcePolicy> newpolicies)
                                 throws java.sql.SQLException,
                                        AuthorizeException

remove all of the policies for the bundle and bitstream contents 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:

java.sql.SQLException

AuthorizeException

getBundlePolicies

public java.util.List<ResourcePolicy> getBundlePolicies()
                                                 throws java.sql.SQLException

Throws:

java.sql.SQLException

getBitstreamPolicies

public java.util.List<ResourcePolicy> getBitstreamPolicies()
                                                    throws java.sql.SQLException

Throws:

java.sql.SQLException

getAdminObject

public DSpaceObject getAdminObject(int action)
                            throws java.sql.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:

java.sql.SQLException

getParentObject

public DSpaceObject getParentObject()
                             throws java.sql.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:

java.sql.SQLException

updateLastModified

public void updateLastModified()

Specified by:

updateLastModified in class DSpaceObject