Package org.dspace.content

Class BitstreamFormatServiceImpl

java.lang.Object

org.dspace.content.BitstreamFormatServiceImpl

All Implemented Interfaces:

BitstreamFormatService, DSpaceCRUDService<BitstreamFormat>

public class BitstreamFormatServiceImpl
extends Object
implements BitstreamFormatService

Service implementation for the BitstreamFormat object. This class is responsible for all business logic calls for the BitstreamFormat object and is autowired by spring. This class should never be accessed directly.

Author:

kevinvandevelde at atmire.com

Field Summary

Fields

Modifier and Type	Field	Description
protected AuthorizeService	authorizeService
protected BitstreamFormatDAO	bitstreamFormatDAO
protected String[]	supportLevelText	translate support-level ID to string.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BitstreamFormatServiceImpl()

Method Summary

Modifier and Type	Method	Description
BitstreamFormat	create(Context context)
void	delete(Context context, BitstreamFormat bitstreamFormat)
BitstreamFormat	find(Context context, int id)	Get a bitstream format from the database.
List<BitstreamFormat>	findAll(Context context)	Retrieve all bitstream formats from the registry, ordered by ID
BitstreamFormat	findByMIMEType(Context context, String mimeType)	Find a bitstream format by its (unique) MIME type.
BitstreamFormat	findByShortDescription(Context context, String desc)	Find a bitstream format by its (unique) short description
List<BitstreamFormat>	findNonInternal(Context context)	Retrieve all non-internal bitstream formats from the registry.
BitstreamFormat	findUnknown(Context context)	Get the generic "unknown" bitstream format.
int	getSupportLevelID(String supportLevel)	If you know the support level string, look up the corresponding type ID constant.
String	getSupportLevelText(BitstreamFormat bitstreamFormat)	Get the support level text for this bitstream format - one of UNKNOWN,KNOWN or SUPPORTED.
BitstreamFormat	guessFormat(Context context, Bitstream bitstream)	Attempt to identify the format of a particular bitstream.
void	setShortDescription(Context context, BitstreamFormat bitstreamFormat, String shortDescription)	Set the short description of the bitstream format
void	setSupportLevel(BitstreamFormat bitstreamFormat, int supportLevel)	Set the support level for this bitstream format - one of UNKNOWN,KNOWN or SUPPORTED.
void	update(Context context, List<BitstreamFormat> bitstreamFormats)	Persist a collection of model objects.
void	update(Context context, BitstreamFormat bitstreamFormat)	Persist a model object.

Methods inherited from class java.lang.Object

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

Field Detail

bitstreamFormatDAO

@Autowired(required=true)
protected BitstreamFormatDAO bitstreamFormatDAO

authorizeService

@Autowired(required=true)
protected AuthorizeService authorizeService

supportLevelText

protected final String[] supportLevelText

translate support-level ID to string. MUST keep this table in sync with support level definitions above.

Constructor Detail

BitstreamFormatServiceImpl

protected BitstreamFormatServiceImpl()

Method Detail

find

public BitstreamFormat find(Context context,
                            int id)
                     throws SQLException

Get a bitstream format from the database.

Specified by:

find in interface DSpaceCRUDService<BitstreamFormat>

Parameters:

context - DSpace context object

id - ID of the bitstream format

Returns:

the bitstream format, or null if the ID is invalid.

Throws:

SQLException - if database error

findByMIMEType

public BitstreamFormat findByMIMEType(Context context,
                                      String mimeType)
                               throws SQLException

Description copied from interface: BitstreamFormatService

Find a bitstream format by its (unique) MIME type. If more than one bitstream format has the same MIME type, the one returned is unpredictable.

Specified by:

findByMIMEType in interface BitstreamFormatService

Parameters:

context - DSpace context object

mimeType - MIME type value

Returns:

the corresponding bitstream format, or null if there's no bitstream format with the given MIMEtype.

Throws:

SQLException - if database error

findByShortDescription

public BitstreamFormat findByShortDescription(Context context,
                                              String desc)
                                       throws SQLException

Description copied from interface: BitstreamFormatService

Find a bitstream format by its (unique) short description

Specified by:

findByShortDescription in interface BitstreamFormatService

Parameters:

context - DSpace context object

desc - the short description

Returns:

the corresponding bitstream format, or null if there's no bitstream format with the given short description

Throws:

SQLException - if database error

findUnknown

public BitstreamFormat findUnknown(Context context)
                            throws SQLException

Description copied from interface: BitstreamFormatService

Get the generic "unknown" bitstream format.

Specified by:

findUnknown in interface BitstreamFormatService

Parameters:

context - DSpace context object

Returns:

the "unknown" bitstream format.

Throws:

SQLException - if database error

findAll

public List<BitstreamFormat> findAll(Context context)
                              throws SQLException

Description copied from interface: BitstreamFormatService

Retrieve all bitstream formats from the registry, ordered by ID

Specified by:

findAll in interface BitstreamFormatService

Parameters:

context - DSpace context object

Returns:

the bitstream formats.

Throws:

SQLException - if database error

findNonInternal

public List<BitstreamFormat> findNonInternal(Context context)
                                      throws SQLException

Description copied from interface: BitstreamFormatService

Retrieve all non-internal bitstream formats from the registry. The "unknown" format is not included, and the formats are ordered by support level (highest first) first then short description.

Specified by:

findNonInternal in interface BitstreamFormatService

Parameters:

context - DSpace context object

Returns:

the bitstream formats.

Throws:

SQLException - if database error

create

public BitstreamFormat create(Context context)
                       throws SQLException,
                              AuthorizeException

Specified by:

create in interface DSpaceCRUDService<BitstreamFormat>

Throws:

SQLException

AuthorizeException

setShortDescription

public void setShortDescription(Context context,
                                BitstreamFormat bitstreamFormat,
                                String shortDescription)
                         throws SQLException

Description copied from interface: BitstreamFormatService

Set the short description of the bitstream format

Specified by:

setShortDescription in interface BitstreamFormatService

Parameters:

context - context

bitstreamFormat - format

shortDescription - the new short description

Throws:

SQLException - if database error

getSupportLevelText

public String getSupportLevelText(BitstreamFormat bitstreamFormat)

Description copied from interface: BitstreamFormatService

Get the support level text for this bitstream format - one of UNKNOWN,KNOWN or SUPPORTED.

Specified by:

getSupportLevelText in interface BitstreamFormatService

Parameters:

bitstreamFormat - format

Returns:

the support level

setSupportLevel

public void setSupportLevel(BitstreamFormat bitstreamFormat,
                            int supportLevel)

Description copied from interface: BitstreamFormatService

Set the support level for this bitstream format - one of UNKNOWN,KNOWN or SUPPORTED.

Specified by:

setSupportLevel in interface BitstreamFormatService

Parameters:

bitstreamFormat - format

supportLevel - the new support level

update

public void update(Context context,
                   BitstreamFormat bitstreamFormat)
            throws SQLException,
                   AuthorizeException

Description copied from interface: DSpaceCRUDService

Persist a model object.

Specified by:

update in interface DSpaceCRUDService<BitstreamFormat>

bitstreamFormat - object to be persisted.

Throws:

SQLException - passed through.

AuthorizeException - passed through.

update

public void update(Context context,
                   List<BitstreamFormat> bitstreamFormats)
            throws SQLException,
                   AuthorizeException

Description copied from interface: DSpaceCRUDService

Persist a collection of model objects.

Specified by:

update in interface DSpaceCRUDService<BitstreamFormat>

bitstreamFormats - object to be persisted.

Throws:

SQLException - passed through.

AuthorizeException - passed through.

delete

public void delete(Context context,
                   BitstreamFormat bitstreamFormat)
            throws SQLException,
                   AuthorizeException

Specified by:

delete in interface DSpaceCRUDService<BitstreamFormat>

Throws:

SQLException

AuthorizeException

getSupportLevelID

public int getSupportLevelID(String supportLevel)

Description copied from interface: BitstreamFormatService

If you know the support level string, look up the corresponding type ID constant.

Specified by:

getSupportLevelID in interface BitstreamFormatService

Parameters:

supportLevel - String with the name of the action (must be exact match)

Returns:

the corresponding action ID, or -1 if the action string is unknown

guessFormat

public BitstreamFormat guessFormat(Context context,
                                   Bitstream bitstream)
                            throws SQLException

Description copied from interface: BitstreamFormatService

Attempt to identify the format of a particular bitstream. If the format is unknown, null is returned.

Specified by:

guessFormat in interface BitstreamFormatService

Parameters:

context - context

bitstream - the bitstream to identify the format of

Returns:

a format from the bitstream format registry, or null

Throws:

SQLException - if database error