org.dspace.app.mediafilter

Class MediaFilterServiceImpl

java.lang.Object

org.dspace.app.mediafilter.MediaFilterServiceImpl

All Implemented Interfaces:

MediaFilterService, org.springframework.beans.factory.InitializingBean

public class MediaFilterServiceImpl
extends Object
implements MediaFilterService, org.springframework.beans.factory.InitializingBean

MediaFilterManager is the class that invokes the media/format filters over the repository's content. A few command line flags affect the operation of the MFM: -v verbose outputs all extracted text to STDOUT; -f force forces all bitstreams to be processed, even if they have been before; -n noindex does not recreate index after processing bitstreams; -i [identifier] limits processing scope to a community, collection or item; and -m [max] limits processing to a maximum number of items.

Field Summary

Fields

Modifier and Type	Field and Description
protected AuthorizeService	authorizeService
protected BitstreamFormatService	bitstreamFormatService
protected BitstreamService	bitstreamService
protected BundleService	bundleService
protected CollectionService	collectionService
protected CommunityService	communityService
protected ConfigurationService	configurationService
protected Item	currentItem
protected List<FormatFilter>	filterClasses
protected Map<String,List<String>>	filterFormats
protected GroupService	groupService
protected boolean	isForce
protected boolean	isQuiet
protected boolean	isVerbose
protected ItemService	itemService
protected int	max2Process
protected int	processed
protected List<String>	publicFiltersClasses
protected List<String>	skipList

Fields inherited from interface org.dspace.app.mediafilter.service.MediaFilterService

FILTER_PLUGIN_SEPARATOR

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MediaFilterServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
void	afterPropertiesSet()
void	applyFiltersAllItems(Context context)
void	applyFiltersCollection(Context context, Collection collection)
void	applyFiltersCommunity(Context context, Community community)
void	applyFiltersItem(Context c, Item item)
boolean	filterBitstream(Context context, Item myItem, Bitstream myBitstream) Attempt to filter a bitstream.
boolean	filterItem(Context context, Item myItem) Iterate through the item's bitstreams in the ORIGINAL bundle, applying filters if possible.
Item	getCurrentItem() Return the item that is currently being processed/filtered by the MediaFilterManager.
boolean	inSkipList(String identifier) Check whether or not to skip processing the given identifier.
boolean	processBitstream(Context context, Item item, Bitstream source, FormatFilter formatFilter) A utility class that calls the virtual methods from the current MediaFilter class.
void	setFilterClasses(List<FormatFilter> filterClasses)
void	setFilterFormats(Map<String,List<String>> filterFormats)
void	setForce(boolean isForce)
void	setMax2Process(int max2Process)
void	setQuiet(boolean isQuiet)
void	setSkipList(List<String> skipList)
void	setVerbose(boolean isVerbose)

Methods inherited from class java.lang.Object

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

Field Detail

authorizeService

@Autowired(required=true)
protected AuthorizeService authorizeService

bitstreamFormatService

@Autowired(required=true)
protected BitstreamFormatService bitstreamFormatService

bitstreamService

@Autowired(required=true)
protected BitstreamService bitstreamService

bundleService

@Autowired(required=true)
protected BundleService bundleService

collectionService

@Autowired(required=true)
protected CollectionService collectionService

communityService

@Autowired(required=true)
protected CommunityService communityService

groupService

@Autowired(required=true)
protected GroupService groupService

itemService

@Autowired(required=true)
protected ItemService itemService

configurationService

@Autowired(required=true)
protected ConfigurationService configurationService

max2Process

protected int max2Process

processed

protected int processed

currentItem

protected Item currentItem

filterClasses

protected List<FormatFilter> filterClasses

filterFormats

protected Map<String,List<String>> filterFormats

skipList

protected List<String> skipList

publicFiltersClasses

protected final List<String> publicFiltersClasses

isVerbose

protected boolean isVerbose

isQuiet

protected boolean isQuiet

isForce

protected boolean isForce

Constructor Detail

MediaFilterServiceImpl

protected MediaFilterServiceImpl()

Method Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

applyFiltersAllItems

public void applyFiltersAllItems(Context context)
                          throws Exception

Specified by:

applyFiltersAllItems in interface MediaFilterService

Throws:

Exception

applyFiltersCommunity

public void applyFiltersCommunity(Context context,
                         Community community)
                           throws Exception

Specified by:

applyFiltersCommunity in interface MediaFilterService

Throws:

Exception

applyFiltersCollection

public void applyFiltersCollection(Context context,
                          Collection collection)
                            throws Exception

Specified by:

applyFiltersCollection in interface MediaFilterService

Throws:

Exception

applyFiltersItem

public void applyFiltersItem(Context c,
                    Item item)
                      throws Exception

Specified by:

applyFiltersItem in interface MediaFilterService

Throws:

Exception

filterItem

public boolean filterItem(Context context,
                 Item myItem)
                   throws Exception

Description copied from interface: MediaFilterService

Iterate through the item's bitstreams in the ORIGINAL bundle, applying filters if possible.

Specified by:

filterItem in interface MediaFilterService

Parameters:

context - context

myItem - item

Returns:

true if any bitstreams processed, false if none

Throws:

Exception - if error

filterBitstream

public boolean filterBitstream(Context context,
                      Item myItem,
                      Bitstream myBitstream)
                        throws Exception

Description copied from interface: MediaFilterService

Attempt to filter a bitstream. An exception will be thrown if the media filter class cannot be instantiated. Exceptions from filtering will be logged to STDOUT and swallowed.

Specified by:

filterBitstream in interface MediaFilterService

Parameters:

context - context

myItem - item

myBitstream - bitstream

Returns:

true if bitstream processed, false if no applicable filter or already processed

Throws:

Exception - if error

processBitstream

public boolean processBitstream(Context context,
                       Item item,
                       Bitstream source,
                       FormatFilter formatFilter)
                         throws Exception

Description copied from interface: MediaFilterService

A utility class that calls the virtual methods from the current MediaFilter class. It scans the bitstreams in an item, and decides if a bitstream has already been filtered, and if not or if overWrite is set, invokes the filter.

Specified by:

processBitstream in interface MediaFilterService

Parameters:

context - context

item - item containing bitstream to process

source - source bitstream to process

formatFilter - FormatFilter to perform filtering

Returns:

true if new rendition is created, false if rendition already exists and overWrite is not set

Throws:

Exception - if error occurs

getCurrentItem

public Item getCurrentItem()

Description copied from interface: MediaFilterService

Return the item that is currently being processed/filtered by the MediaFilterManager.

This allows FormatFilters to retrieve the Item object in case they need access to item-level information for their format transformations/conversions.

Specified by:

getCurrentItem in interface MediaFilterService

Returns:

current Item being processed by MediaFilterManager

inSkipList

public boolean inSkipList(String identifier)

Description copied from interface: MediaFilterService

Check whether or not to skip processing the given identifier.

Specified by:

inSkipList in interface MediaFilterService

Parameters:

identifier - identifier (handle) of a community, collection or item

Returns:

true if this community, collection or item should be skipped during processing. Otherwise, return false.

setVerbose

public void setVerbose(boolean isVerbose)

Specified by:

setVerbose in interface MediaFilterService

setQuiet

public void setQuiet(boolean isQuiet)

Specified by:

setQuiet in interface MediaFilterService

setForce

public void setForce(boolean isForce)

Specified by:

setForce in interface MediaFilterService

setMax2Process

public void setMax2Process(int max2Process)

Specified by:

setMax2Process in interface MediaFilterService

setFilterClasses

public void setFilterClasses(List<FormatFilter> filterClasses)

Specified by:

setFilterClasses in interface MediaFilterService

setSkipList

public void setSkipList(List<String> skipList)

Specified by:

setSkipList in interface MediaFilterService

setFilterFormats

public void setFilterFormats(Map<String,List<String>> filterFormats)

Specified by:

setFilterFormats in interface MediaFilterService