org.dspace.app.mediafilter

Class MediaFilterManager

java.lang.Object

org.dspace.app.mediafilter.MediaFilterManager

public class MediaFilterManager
extends java.lang.Object

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
static java.lang.String	FILTER_PLUGIN_SEPARATOR
static java.lang.String	FILTER_PREFIX
static java.lang.String	INPUT_FORMATS_SUFFIX
static java.lang.String	MEDIA_FILTER_PLUGINS_KEY

Constructor Summary

Constructors

Constructor and Description
MediaFilterManager()

Method Summary

Methods

Modifier and Type	Method and Description
static void	applyFiltersAllItems(Context c)
static void	applyFiltersCollection(Context c, Collection collection)
static void	applyFiltersCommunity(Context c, Community community)
static void	applyFiltersItem(Context c, Item item)
static boolean	filterBitstream(Context c, Item myItem, Bitstream myBitstream) Attempt to filter a bitstream.
static boolean	filterItem(Context c, Item myItem) Iterate through the item's bitstreams in the ORIGINAL bundle, applying filters if possible.
static Item	getCurrentItem() Return the item that is currently being processed/filtered by the MediaFilterManager.
static boolean	inSkipList(java.lang.String identifier) Check whether or not to skip processing the given identifier.
static void	main(java.lang.String[] argv)
static boolean	processBitstream(Context c, Item item, Bitstream source, FormatFilter formatFilter) A utility class that calls the virtual methods from the current MediaFilter class.

Methods inherited from class java.lang.Object

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

Field Detail

MEDIA_FILTER_PLUGINS_KEY

public static final java.lang.String MEDIA_FILTER_PLUGINS_KEY

See Also:

Constant Field Values

FILTER_PREFIX

public static final java.lang.String FILTER_PREFIX

See Also:

Constant Field Values

INPUT_FORMATS_SUFFIX

public static final java.lang.String INPUT_FORMATS_SUFFIX

See Also:

Constant Field Values

FILTER_PLUGIN_SEPARATOR

public static final java.lang.String FILTER_PLUGIN_SEPARATOR

See Also:

Constant Field Values

Constructor Detail

MediaFilterManager

public MediaFilterManager()

Method Detail

main

public static void main(java.lang.String[] argv)
                 throws java.lang.Exception

Throws:

java.lang.Exception

applyFiltersAllItems

public static void applyFiltersAllItems(Context c)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

applyFiltersCommunity

public static void applyFiltersCommunity(Context c,
                         Community community)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

applyFiltersCollection

public static void applyFiltersCollection(Context c,
                          Collection collection)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

applyFiltersItem

public static void applyFiltersItem(Context c,
                    Item item)
                             throws java.lang.Exception

Throws:

java.lang.Exception

filterItem

public static boolean filterItem(Context c,
                 Item myItem)
                          throws java.lang.Exception

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

Returns:

true if any bitstreams processed, false if none

Throws:

java.lang.Exception

filterBitstream

public static boolean filterBitstream(Context c,
                      Item myItem,
                      Bitstream myBitstream)
                               throws java.lang.Exception

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.

Returns:

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

Throws:

java.lang.Exception

processBitstream

public static boolean processBitstream(Context c,
                       Item item,
                       Bitstream source,
                       FormatFilter formatFilter)
                                throws java.lang.Exception

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.

Parameters:

c - 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:

java.lang.Exception

getCurrentItem

public static Item getCurrentItem()

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.

Returns:

current Item being processed by MediaFilterManager

inSkipList

public static boolean inSkipList(java.lang.String identifier)

Check whether or not to skip processing the given identifier.

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.