Package org.dspace.pack.bagit

Class CommunityPacker

java.lang.Object

org.dspace.pack.bagit.CommunityPacker

All Implemented Interfaces:

Packer

public class CommunityPacker
extends Object
implements Packer

CommunityPacker Packs and unpacks Community AIPs in Bagit format.

Author:

richardrodgers

Constructor Summary

Constructors

Constructor	Description
CommunityPacker(org.dspace.core.Context context, org.dspace.content.Community community, String archFmt)

Method Summary

Modifier and Type	Method	Description
org.dspace.content.Community	getCommunity()
File	pack(File packDir)	Packs (maps) the contents of this object into an archive file.
void	setCommunity(org.dspace.content.Community community)
void	setContentFilter(String filter)	Sets a filter on this packer.
void	setReferenceFilter(String filter)
long	size(String method)	Estimate the size of the object as packed into a bag.
void	unpack(File archive)	Unpacks (maps) the contents of the passed archive file into this object.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommunityPacker

public CommunityPacker(org.dspace.core.Context context,
                       org.dspace.content.Community community,
                       String archFmt)

Method Detail

getCommunity

public org.dspace.content.Community getCommunity()

setCommunity

public void setCommunity(org.dspace.content.Community community)

pack

public File pack(File packDir)
          throws org.dspace.authorize.AuthorizeException,
                 SQLException,
                 IOException

Description copied from interface: Packer

Packs (maps) the contents of this object into an archive file.

Specified by:

pack in interface Packer

Parameters:

packDir - the locus of the packing

Returns:

the packed archive file

Throws:

org.dspace.authorize.AuthorizeException - if authorize error

SQLException - if database error

IOException - if I/O error

unpack

public void unpack(File archive)
            throws org.dspace.authorize.AuthorizeException,
                   IOException,
                   SQLException

Description copied from interface: Packer

Unpacks (maps) the contents of the passed archive file into this object.

Specified by:

unpack in interface Packer

Parameters:

archive - the archive file to unpack

Throws:

org.dspace.authorize.AuthorizeException - if authorize error

IOException - if I/O error

SQLException - if database error

size

public long size(String method)
          throws SQLException

Description copied from interface: Packer

Estimate the size of the object as packed into a bag. This estimate uses any defined content filters.

Specified by:

size in interface Packer

Parameters:

method - how to estimate - not currently implemented

Returns:

the bagged object size in bytes

Throws:

SQLException - if database error

setContentFilter

public void setContentFilter(String filter)

Description copied from interface: Packer

Sets a filter on this packer. A filter will ignore (skip) object content when packing to a bag. Filter syntax: ["+"]{BundleName,}+ That is, a list of Item bundle names taken to be exclusions, unless preceeded by a '+", where the list is taken to be inclusive.

Specified by:

setContentFilter in interface Packer

Parameters:

filter - filter

setReferenceFilter

public void setReferenceFilter(String filter)

Specified by:

setReferenceFilter in interface Packer